Providers

PreviousStatus NextAvd

Was this helpful?

Get

get

Retrieve a specific Provider by ID.

Path parameters

idinteger · int32required

Provider ID

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Provider/{id}'

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:04:38.601Z",
  "timeLastMod": "2025-04-06T01:04:38.601Z",
  "enabled": true,
  "description": "text",
  "siteId": 1,
  "inheritDefaultAgentSettings": true,
  "vdiAgent": "text",
  "preferredBrokerId": 1,
  "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",
  "hostPort": 1,
  "vdiPort": 1
}

Success

Delete

delete

Delete a Provider server from a site. The VDI agent will be uninstalled from the server by default. You can optionally keep it by including the noUninstall parameter.

Path parameters

idinteger · int32required

Provider ID

Query parameters

noUninstallbooleanoptional

If this parameter is included, the VDI agent will not be uninstalled from the server. To uninstall the agent, omit this parameter. When uninstalling the agent, your RAS admin credentials will be used by default. You can specify different credentials if needed using the Username and Password parameters.

usernamestringoptional

An administrator account to remotely uninstall the VDI agent from the server. If this parameter is omitted, your RAS admin username (and password) will be used by default.

passwordstringoptional

The password of the account specified in the Username parameter.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/Provider/{id}'

204

401

404

No Content

List

get

Retrieve a list of Provider settings.

Query parameters

SiteIdinteger · int32optional

Site ID for which to retrieve Provider settings (optional)

Namestringoptional

Filter the result by Provider name (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Provider'

200

401

404

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-06T01:04:38.601Z",
    "timeLastMod": "2025-04-06T01:04:38.601Z",
    "enabled": true,
    "description": "text",
    "siteId": 1,
    "inheritDefaultAgentSettings": true,
    "vdiAgent": "text",
    "preferredBrokerId": 1,
    "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",
    "hostPort": 1,
    "vdiPort": 1
  }
]

Success

Deprecated

Create Provider

post

Create a new 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. Deprecated path - To create a new provider specify the type in the url ex: api/provider/hyperv

Query parameters

noInstallbooleanoptional

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.

usernamestringoptional

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.

passwordstringoptional

The password of the account specified in the Username parameter.

noRestartbooleanoptional

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.

noFireWallRulesbooleanoptional

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

Create a new Provider

namestring | nullableoptional

The name of the Provider.

serverstring | nullableoptional

A Provider server FQDN or IP addresses.

siteIdinteger · int32optional

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

preferredBrokerIdinteger · int32 | nullableoptional

The preferred Connection Broker ID.

useAllGuestsboolean | nullableoptional

Use all guests.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Provider' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "server": "text",
    "siteId": 1,
    "preferredBrokerId": 1,
    "useAllGuests": true
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:04:38.601Z",
  "timeLastMod": "2025-04-06T01:04:38.601Z",
  "enabled": true,
  "description": "text",
  "siteId": 1,
  "inheritDefaultAgentSettings": true,
  "vdiAgent": "text",
  "preferredBrokerId": 1,
  "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",
  "hostPort": 1,
  "vdiPort": 1
}

Created

Update Provider

put

Modify Provider server settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

Path parameters

idinteger · int32required

Provider ID

Body

Update an existing Provider settings

enabledboolean | nullableoptional

Enables or disables the specified Provider server in a site.

namestring | nullableoptional

A new name for the Provider.

newServerstring | nullableoptional

The name of the target Provider server. This must be the actual server name used in the RAS farm.

descriptionstring | nullableoptional

A user-defined Provider server description.

directAddressstring | nullableoptional

Specifies the Provider server direct address.

portinteger · int32 | nullableoptional

Specifies the port number for the RAS VDI Agent.

vdiAgentstring | nullableoptional

FQDN or IP address of the server where the RAS VDI Agent is running. You only need to specify this parameter if the RAS VDI Agent is dedicated.

allowURLAndMailRedirectionstring · enumoptional

URL and Mail Redirection values.

Available options:

supportShellURLNamespaceObjectsboolean | nullableoptional

Enable or disable the 'Support Shell URL Namespace Objects' option.

allowDragAndDropboolean | nullableoptional

Set the Drag and Drop option.

allowFileTransferboolean | nullableoptionalDeprecated

Deprecated: use FileTransferMode instead. Enable or disable the 'Allow file transfer' option.

fileTransferModestring · enumoptional

File Transfer Control modes.

Available options:

fileTransferLocationstring | nullableoptional

Location where the File Transfer takes place, if and where it is allowed.

fileTransferLockLocationboolean | nullableoptional

Lock Location where the File Transfer takes place, if and where it is allowed.

removeClientNameFromPrinterNameboolean | nullableoptional

Enable or disable the 'Remove client name from printer name' option.

removeSessionNumberFromPrinterNameboolean | nullableoptional

Enable or disable the 'Remove session number from printer name' option.

printerNameFormatstring · enumoptional

Printer Name Format

Available options:

autoPreferredBrokerbooleanoptionalDefault: false

enableDriveRedirectionCacheboolean | nullableoptional

Enable or disable the 'Enable Drive Redirection Cache' option.

manageRDPTransportProtocolstring · enumoptional

Manage RDP transport protocol.

Available options:

providerUsernamestring | nullableoptional

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.

providerPasswordstring | nullableoptional

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.

vdiPortinteger · int32 | nullableoptional

The port to communicate with the dedicated VDIAgent specified in the VDIAgent parameter.

preferredBrokerIdinteger · int32 | nullableoptional

The preferred Connection Broker ID.

useAllGuestsboolean | nullableoptional

Use all guests.

costOptimizeTimeoutinteger · int32 | nullableoptional

Cost Optimize Timeout in seconds. Applicable to: AVD (Experimental) and Azure.

enableCostOptimizeboolean | nullableoptional

Enable Cost Optimize. Applicable to: AVD (Experimental) and Azure.

feedURLstring | nullableoptional

The Feed URL. Applicable to: AVD (Experimental).

webAccessURLstring | nullableoptional

The Web Access URL. Applicable to: AVD (Experimental).

adTypestring · enumoptional

Active Directory Domain Service Type

Available options:

accessKeyIDstring | nullableoptional

The access key ID of the Amazon Web Service account. Applicable to: AWSEC2.

secretAccessKeystring | nullableoptional

The secret access key of the Amazon Web Service account. Applicable to: AWSEC2.

locationTypestring · enumoptional

Amazon Elastic Compute Cloud Location Type

Available options:

regionNamestring | nullableoptional

The region name of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.

regionCodestring | nullableoptional

The region code of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2.

endpointUrlstring | nullableoptional

The endpoint URL of the Amazon Elastic Compute Cloud. Applicable to: AWSEC2. Example: https://ec2.us-east01.amazonaws.com.

hyperVVersionstring · enumoptional

HyperV Version

Available options:

hyperVFailoverVersionstring · enumoptional

HyperV Failover Cluster Version

Available options:

startMacAddressstring | nullableoptional

Starting MAC Address. Applicable to: HyperV Failover.

endMacAddressstring | nullableoptional

Ending MAC Address. Applicable to: HyperV Failover.

enableMacManagementboolean | nullableoptional

Specifies if the MAC Management is enabled or not. Applicable to: HyperV Failover.

nutanixVersionstring · enumoptional

Nutanix Version

Available options:

domainTargetOUstring | nullableoptional

Domain Target OU. Applicable to: Remote PC Dynamic.

remotePCDynamicSubnetstring | nullableoptional

The subnet of the remote PC dynamic. Applicable to: Remote PC Dynamic.

scaleVersionstring · enumoptional

Scale Version

Available options:

vCenterVersionstring · enumoptional

Vmware VCenter Version

Available options:

resourcePoolstring | nullableoptional

Resource Pool. Applicable to: VCenter

vmwareESXiVersionstring · enumoptional

Vmware ESX Version

Available options:

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/Provider/{id}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "enabled": true,
    "name": "text",
    "newServer": "text",
    "description": "text",
    "directAddress": "text",
    "port": 1,
    "vdiAgent": "text",
    "allowURLAndMailRedirection": [
      "0 = Disabled",
      "1 = Enabled",
      "2 = EnabledWithAppRegistration"
    ],
    "supportShellURLNamespaceObjects": true,
    "allowDragAndDrop": true,
    "fileTransferMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "fileTransferLocation": "text",
    "fileTransferLockLocation": true,
    "removeClientNameFromPrinterName": true,
    "removeSessionNumberFromPrinterName": true,
    "printerNameFormat": [
      "0 = PrnFormat_PRN_CMP_SES",
      "1 = PrnFormat_SES_CMP_PRN",
      "2 = PrnFormat_PRN_REDSES"
    ],
    "autoPreferredBroker": true,
    "enableDriveRedirectionCache": true,
    "manageRDPTransportProtocol": [
      "0 = Disabled",
      "1 = BothUDPTCP",
      "2 = OnlyTCP",
      "3 = EitherUDPTCP"
    ],
    "providerUsername": "text",
    "providerPassword": "text",
    "vdiPort": 1,
    "preferredBrokerId": 1,
    "useAllGuests": true,
    "costOptimizeTimeout": 1,
    "enableCostOptimize": true,
    "feedURL": "text",
    "webAccessURL": "text",
    "adType": [
      "1 = WindowsServerADDS",
      "2 = AzureADDS"
    ],
    "accessKeyID": "text",
    "secretAccessKey": "text",
    "locationType": [
      "0 = Default",
      "1 = OptedIn",
      "2 = EndpointUrl"
    ],
    "regionName": "text",
    "regionCode": "text",
    "endpointUrl": "text",
    "hyperVVersion": [
      "0 = HyperV",
      "11 = Win2012R2Std",
      "12 = Win2012R2Dtc",
      "13 = Win2012R2Srv",
      "14 = Win2016Std",
      "15 = Win2016Dtc",
      "16 = Win2016Srv",
      "17 = Win2019Std",
      "18 = Win2019Dtc",
      "19 = Win2019Srv",
      "20 = Win2022Std",
      "21 = Win2022Dtc",
      "22 = Win2022DtcAzure",
      "589824 = HyperV_Depr",
      "589835 = Win2012R2Std_Depr",
      "589836 = Win2012R2Dtc_Depr",
      "589837 = Win2012R2Srv_Depr",
      "589838 = Win2016Std_Depr",
      "589839 = Win2016Dtc_Depr",
      "589840 = Win2016Srv_Depr",
      "589841 = Win2019Std_Depr",
      "589842 = Win2019Dtc_Depr",
      "589843 = Win2019Srv_Depr",
      "589844 = Win2022Std_Depr",
      "589845 = Win2022Dtc_Depr",
      "589846 = Win2022DtcAzure_Depr"
    ],
    "hyperVFailoverVersion": [
      "0 = HyperVFailoverCluster",
      "1 = Ent",
      "2 = Dtc",
      "3 = Win2012",
      "4 = Win2012R2",
      "5 = Win2016",
      "6 = Win2019",
      "7 = Win2022",
      "1048576 = HyperVFailoverCluster_Depr",
      "1048577 = Ent_Depr",
      "1048578 = Dtc_Depr",
      "1048579 = Win2012_Depr",
      "1048580 = Win2012R2_Depr",
      "1048581 = Win2016_Depr",
      "1048582 = Win2019_Depr",
      "1048583 = Win2022_Depr"
    ],
    "startMacAddress": "text",
    "endMacAddress": "text",
    "enableMacManagement": true,
    "nutanixVersion": [
      "0 = Nutanix",
      "4 = v5_15",
      "5 = v5_20",
      "6 = v6_5",
      "1179648 = Nutanix_Depr",
      "1179652 = v5_15_Depr",
      "1179653 = v5_20_Depr",
      "1179654 = v6_5_Depr"
    ],
    "domainTargetOU": "text",
    "remotePCDynamicSubnet": "text",
    "scaleVersion": [
      "0 = Scale",
      "4 = v8_9",
      "5 = v9_1",
      "6 = v9_2",
      "1310720 = Scale_Depr",
      "1310724 = v8_9_Depr",
      "1310725 = v9_1_Depr"
    ],
    "vCenterVersion": [
      "0 = VmwareVCenter",
      "7 = v6_5",
      "8 = v6_7",
      "9 = v7_0",
      "10 = v8_0",
      "983040 = VmwareVCenter_Depr",
      "983047 = v6_5_Depr",
      "983048 = v6_7_Depr",
      "983049 = v7_0_Depr",
      "983050 = v8_0_Depr"
    ],
    "resourcePool": "text",
    "vmwareESXiVersion": [
      "0 = VmwareESXi",
      "11 = v6_5",
      "12 = v6_7",
      "13 = v7_0",
      "14 = v8_0",
      "655360 = VmwareESXi_Depr",
      "655371 = v6_5_Depr",
      "655372 = v6_7_Depr",
      "655373 = v7_0_Depr",
      "655374 = v8_0_Depr"
    ]
  }'

204

401

404

No Content