Avd

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

Provider settings

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.

providerUsername*nullable string

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.

providerPassword*nullable string

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.

subscriptionID*nullable string

Azure Subscription ID.

tenantID*nullable string

Azure Tenant ID.

authenticationURLnullable string

Azure Authentication URL.

managementURLnullable string

Azure Management URL.

resourceURInullable string

Azure Resource URI.

avdVersion*AVDVersion (enum)

AVD Version (Experimental)

0 = AVD,1441792 = AVD_Depr

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

enabledboolean

Whether the server is enabled or not.

descriptionnullable string

Description of the server.

siteIdinteger (int32)

ID of the site.

inheritDefaultAgentSettingsboolean

Whether the default Agent settings are inherited or not.

vdiAgentnullable string

FQDN or IP address of the server where the RAS VDI Agent is running.

preferredBrokerIdinteger (int32)

ID of the preferred Connection Broker.

servernullable string

Server name.

namenullable string

Name of the Provider.

typeProviderMajorType (enum)

Provider Major Type

9 = HyperV,10 = VMwareESXi,15 = VMwarevCenter,16 = HyperVFailover,18 = Nutanix,20 = ScaleComputing,21 = Azure,22 = AVD,23 = RemotePCStatic,24 = RemotePCDynamic,25 = AWSEC2

providerUsernamenullable string

A user account to log in to the hypervisor management tool (e.g. VMware vCenter).

hostPortinteger (int32)

Specifies the port number for the Provider.

vdiPortinteger (int32)

The port to communicate with the dedicated provider.

versionAVDVersion (enum)

AVD Version (Experimental)

0 = AVD,1441792 = AVD_Depr

graphURLnullable string

The Graph URL.

feedURLnullable string

The Feed URL.

adTypeADType (enum)

Active Directory Domain Service Type

1 = WindowsServerADDS,2 = AzureADDS

webAccessURLnullable string

The Web Access URL.

vdiAzureCloudInfoVDIAzureInfo (object)

VDI Azure Information

authenticationURLnullable string

Azure authentication URL

managementURLnullable string

Azure management URL

resourceURInullable string

Azure resource URI

subscriptionIDnullable string

Azure subscription ID

tenantIDnullable string

Azure tenant ID

costOptimizeTimeoutinteger (int32)

Azure Cost Optimize Timeout in seconds

enableCostOptimizeboolean

Enable Azure Cost Optimize

Request

Response

Create

POST/api/Provider/avd

Query parameters

noInstallboolean

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

Provider settings

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.

providerUsername*nullable string

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.

providerPassword*nullable string

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.

subscriptionID*nullable string

Azure Subscription ID.

tenantID*nullable string

Azure Tenant ID.

authenticationURLnullable string

Azure Authentication URL.

managementURLnullable string

Azure Management URL.

resourceURInullable string

Azure Resource URI.

avdVersion*AVDVersion (enum)

AVD Version (Experimental)

0 = AVD,1441792 = AVD_Depr

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

enabledboolean

Whether the server is enabled or not.

descriptionnullable string

Description of the server.

siteIdinteger (int32)

ID of the site.

inheritDefaultAgentSettingsboolean

Whether the default Agent settings are inherited or not.

vdiAgentnullable string

FQDN or IP address of the server where the RAS VDI Agent is running.

preferredBrokerIdinteger (int32)

ID of the preferred Connection Broker.

servernullable string

Server name.

namenullable string

Name of the Provider.

typeProviderMajorType (enum)

Provider Major Type

9 = HyperV,10 = VMwareESXi,15 = VMwarevCenter,16 = HyperVFailover,18 = Nutanix,20 = ScaleComputing,21 = Azure,22 = AVD,23 = RemotePCStatic,24 = RemotePCDynamic,25 = AWSEC2

providerUsernamenullable string

A user account to log in to the hypervisor management tool (e.g. VMware vCenter).

hostPortinteger (int32)

Specifies the port number for the Provider.

vdiPortinteger (int32)

The port to communicate with the dedicated provider.

versionAVDVersion (enum)

AVD Version (Experimental)

0 = AVD,1441792 = AVD_Depr

graphURLnullable string

The Graph URL.

feedURLnullable string

The Feed URL.

adTypeADType (enum)

Active Directory Domain Service Type

1 = WindowsServerADDS,2 = AzureADDS

webAccessURLnullable string

The Web Access URL.

vdiAzureCloudInfoVDIAzureInfo (object)

VDI Azure Information

authenticationURLnullable string

Azure authentication URL

managementURLnullable string

Azure management URL

resourceURInullable string

Azure resource URI

subscriptionIDnullable string

Azure subscription ID

tenantIDnullable string

Azure tenant ID

costOptimizeTimeoutinteger (int32)

Azure Cost Optimize Timeout in seconds

enableCostOptimizeboolean

Enable Azure Cost Optimize

Request

Response

const response = await fetch('/api/Provider/avd', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "avdVersion": [
        "0 = AVD",
        "1441792 = AVD_Depr"
      ],
      "providerPassword": "text",
      "providerUsername": "text",
      "subscriptionID": "text",
      "tenantID": "text"
    }),
});
const data = await response.json();

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:16:16.761Z",
  "timeLastMod": "2024-11-07T10:16:16.761Z",
  "enabled": false,
  "description": "text",
  "inheritDefaultAgentSettings": false,
  "vdiAgent": "text",
  "server": "text",
  "name": "text",
  "type": [
    "9 = HyperV",
    "10 = VMwareESXi",
    "15 = VMwarevCenter",
    "16 = HyperVFailover",
    "18 = Nutanix",
    "20 = ScaleComputing",
    "21 = Azure",
    "22 = AVD",
    "23 = RemotePCStatic",
    "24 = RemotePCDynamic",
    "25 = AWSEC2"
  ],
  "providerUsername": "text",
  "version": [
    "0 = AVD",
    "1441792 = AVD_Depr"
  ],
  "graphURL": "text",
  "feedURL": "text",
  "adType": [
    "1 = WindowsServerADDS",
    "2 = AzureADDS"
  ],
  "webAccessURL": "text",
  "vdiAzureCloudInfo": {
    "authenticationURL": "text",
    "managementURL": "text",
    "resourceURI": "text",
    "subscriptionID": "text",
    "tenantID": "text",
    "enableCostOptimize": false
  }
}