Avd

Was this helpful?

Create

Create a new AVD Provider server to a site. The VDI agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter. This is an Experimental feature which is subject to slight changes.

post

/api/Provider/avd

Query parameters

noInstallboolean

Specifies not to install the VDI agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.

usernamestring

An administrator account for push installing the VDI agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.

passwordstring

The password of the account specified in the Username parameter.

noRestartboolean

Specifies not to restart the server after the RAS VDI Agent is installed when installing the VDI Agent. If this parameter is omitted, the server will be restarted if required.

noFireWallRulesboolean

Specifies not to add firewall rules to allow the RAS VDI Agent to communicate when installing the VDI Agent. If this parameter is omitted, the firewall rules will not be added.

Body

avdVersionenumrequired

AVD Version (Experimental)

Options: 0 = AVD,1441792 = AVD_Depr

namenullable string

The name of the Provider.

servernullable string

A Provider server FQDN or IP addresses.

siteIdinteger int32

The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.

providerUsernamenullable stringrequired

A user account to log in to the hypervisor management tool (e.g. VMware vCenter). In case of Azure, it is an ID of the application which will be used by VDI agent to manage Azure resources.

providerPasswordnullable stringrequired

The password of the account specified in the ProviderUsername parameter. In case of Azure, it is a secret key of the application which will be used by VDI agent to manage Azure resources.

portnullable integer int32

The port to communicate with the Provider specified in Server parameter. In case of Azure, it is not required.

preferredBrokerIdnullable integer int32

The preferred Connection Broker ID.

useAllGuestsnullable boolean

Use all guests.

subscriptionIDnullable stringrequired

Azure Subscription ID.

tenantIDnullable stringrequired

Azure Tenant ID.

authenticationURLnullable string

Azure Authentication URL.

managementURLnullable string

Azure Management URL.

resourceURInullable string

Azure Resource URI.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Provider/avd' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{"avdVersion":["0 = AVD","1441792 = AVD_Depr"],"providerUsername":"text","providerPassword":"text","subscriptionID":"text","tenantID":"text"}'

201

401

409

{
  "type": [
    "9 = HyperV",
    "10 = VMwareESXi",
    "15 = VMwarevCenter",
    "16 = HyperVFailover",
    "18 = Nutanix",
    "20 = ScaleComputing",
    "21 = Azure",
    "22 = AVD",
    "23 = RemotePCStatic",
    "24 = RemotePCDynamic",
    "25 = AWSEC2"
  ],
  "version": [
    "0 = AVD",
    "1441792 = AVD_Depr"
  ],
  "adType": [
    "1 = WindowsServerADDS",
    "2 = AzureADDS"
  ],
  "vdiAzureCloudInfo": {
    "authenticationURL": "text",
    "managementURL": "text",