Assignment

List

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

GET/api/AVD/HostPool/{id}/Assignment

Path parameters

id*integer (int32)

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

Response

200401404

Success

Body

application/json; api-version=1.0

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

azureActiveDirectorynullable string

Azure Active Directory

azureActiveDirectoryIdnullable string

Azure Active Directory Id

Request

JavaScriptCurlPython

const response = await fetch('/api/AVD/HostPool/{id}/Assignment', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

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

Add

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

POST/api/AVD/HostPool/{id}/Assignment

Path parameters

id*integer (int32)

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

Body

application/json; api-version=1.0

Assignment configuration.

accountnullable string

The name of the account to add to the Assignments.

sidnullable string

The SID of the account to add to the Assignments.

Response

201401404409

Created

Request

JavaScriptCurlPython

const response = await fetch('/api/AVD/HostPool/{id}/Assignment', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404409

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Remove

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

DELETE/api/AVD/HostPool/{id}/Assignment

Path parameters

id*integer (int32)

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

Body

application/json; api-version=1.0

Assignment configuration.

accountnullable string

The name of the account to remove from the Assignments.

sidnullable string

The SID of the account to remove from the Assignments.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/AVD/HostPool/{id}/Assignment', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}