Assignment

PreviousApp Package Assigned NextAuto Upgrade

Last updated 1 year ago

Was this helpful?

List

get

Retrieve Assignment List of an AVD Host Pool with the specified ID.

Path parameters

idinteger · int32required

The ID of an AVD Host Pool for which to retrieve the Assignment settings.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/HostPool/{id}/Assignment'

200

401

404

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text",
    "azureActiveDirectory": "text",
    "azureActiveDirectoryId": "text"
  }
]

Success

Add

post

Add a user or group to the Assignment List of the AVD Host Pool.

Path parameters

idinteger · int32required

The ID of an AVD Host Pool for which to modify the Assignment settings.

Body

accountstring | nullableoptional

The name of the account to add to the Assignments.

sidstring | nullableoptional

The SID of the account to add to the Assignments.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/AVD/HostPool/{id}/Assignment' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

201

401

404

409

No body

Created

Remove

delete

Remove a user or group from the Assignment List of the AVD Host Pool.

Path parameters

idinteger · int32required

The ID of an AVD Host Pool for which to modify the Assignment settings.

Body

accountstring | nullableoptional

The name of the account to remove from the Assignments.

sidstring | nullableoptional

The SID of the account to remove from the Assignments.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/AVD/HostPool/{id}/Assignment' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

204

401

404

No body

No Content