Host Pools - Retrieve Registration Token

Reference

Service:: Desktop Virtualization

API Version:: 2022-02-10-preview

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
hostPoolName	path	True	string	The name of the host pool within the specified resource group
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	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	RegistrationInfo	Successfully retrieved host pool in resource group.
Other Status Codes	CloudError	Automation error response describing why the operation failed.

Examples

HostPools_RetrieveRegistrationToken_Post

POST https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/retrieveRegistrationToken?api-version=2022-02-10-preview

package armdesktopvirtualization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/desktopvirtualization/armdesktopvirtualization/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2022-02-10-preview/examples/HostPools_RetrieveRegistrationToken_Post.json
func ExampleHostPoolsClient_RetrieveRegistrationToken() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armdesktopvirtualization.NewHostPoolsClient("daefabc0-95b4-48b3-b645-8a753a63c4fa", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.RetrieveRegistrationToken(ctx,
		"resourceGroup1",
		"hostPool1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "expirationTime": "2008-09-22T14:01:54.9571247Z",
  "token": "token",
  "registrationTokenOperation": "Update"
}

Definitions

Name	Description
CloudError	Cloud error object.
CloudErrorProperties	Cloud error object properties.
RegistrationInfo	Represents a RegistrationInfo definition.
RegistrationTokenOperation	The type of resetting the token.

CloudError

Cloud error object.

Name	Type	Description
error	CloudErrorProperties	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	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

Share via