Host Pools - Retrieve Registration Token
Registration token of the host pool.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/retrieveRegistrationToken?api-version=2022-02-10-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
host
|
path | True |
string |
The name of the host pool within the specified resource group |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Successfully retrieved host pool in resource group. |
|
Other Status Codes |
Automation error response describing why the operation failed. |
Examples
HostPools_RetrieveRegistrationToken_Post
Sample request
Sample response
{
"expirationTime": "2008-09-22T14:01:54.9571247Z",
"token": "token",
"registrationTokenOperation": "Update"
}
Definitions
Name | Description |
---|---|
Cloud |
Cloud error object. |
Cloud |
Cloud error object properties. |
Registration |
Represents a RegistrationInfo definition. |
Registration |
The type of resetting the token. |
CloudError
Cloud error object.
Name | Type | Description |
---|---|---|
error |
Cloud error object properties. |
CloudErrorProperties
Cloud error object properties.
Name | Type | Description |
---|---|---|
code |
string |
Error code |
message |
string |
Error message indicating why the operation failed. |
RegistrationInfo
Represents a RegistrationInfo definition.
Name | Type | Description |
---|---|---|
expirationTime |
string |
Expiration time of registration token. |
registrationTokenOperation |
The type of resetting the token. |
|
token |
string |
The registration token base64 encoded string. |
RegistrationTokenOperation
The type of resetting the token.
Name | Type | Description |
---|---|---|
Delete |
string |
|
None |
string |
|
Update |
string |