Host Pools - List Registration Tokens

Service:

Desktop Virtualization

API Version:

2024-04-03

Operation to list the RegistrationTokens associated with the HostPool

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/listRegistrationTokens?api-version=2024-04-03

URI Parameters

Name	In	Required	Type	Description
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	The name of the host pool within the specified resource group
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	RegistrationTokenList	Successfully retrieved host pool in resource group.
Other Status Codes	CloudError	Automation error response describing why the operation failed.

Examples

HostPools_ListRegistrationToken_Post

Sample request

HTTP

POST https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/listRegistrationTokens?api-version=2024-04-03

Java

/**
 * Samples for HostPools ListRegistrationTokens.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/
     * HostPools_ListRegistrationToken_Post.json
     */
    /**
     * Sample code: HostPools_ListRegistrationToken_Post.
     * 
     * @param manager Entry point to DesktopVirtualizationManager.
     */
    public static void hostPoolsListRegistrationTokenPost(
        com.azure.resourcemanager.desktopvirtualization.DesktopVirtualizationManager manager) {
        manager.hostPools().listRegistrationTokensWithResponse("resourceGroup1", "hostPool1",
            com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.desktopvirtualization import DesktopVirtualizationMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-desktopvirtualization
# USAGE
    python host_pools_list_registration_token_post.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DesktopVirtualizationMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="daefabc0-95b4-48b3-b645-8a753a63c4fa",
    )

    response = client.host_pools.list_registration_tokens(
        resource_group_name="resourceGroup1",
        host_pool_name="hostPool1",
    )
    print(response)


# x-ms-original-file: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/HostPools_ListRegistrationToken_Post.json
if __name__ == "__main__":
    main()

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

Go

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/blob/4883fa5dbf6f2c9093fac8ce334547e9dfac68fa/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/HostPools_ListRegistrationToken_Post.json
func ExampleHostPoolsClient_ListRegistrationTokens() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdesktopvirtualization.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewHostPoolsClient().ListRegistrationTokens(ctx, "resourceGroup1", "hostPool1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RegistrationTokenList = armdesktopvirtualization.RegistrationTokenList{
	// 	Value: []*armdesktopvirtualization.RegistrationTokenMinimal{
	// 		{
	// 			ExpirationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2008-09-22T14:01:54.957Z"); return t}()),
	// 			Token: to.Ptr("token"),
	// 	}},
	// }
}

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

JavaScript

const { DesktopVirtualizationAPIClient } = require("@azure/arm-desktopvirtualization");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Operation to list the RegistrationTokens associated with the HostPool
 *
 * @summary Operation to list the RegistrationTokens associated with the HostPool
 * x-ms-original-file: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/HostPools_ListRegistrationToken_Post.json
 */
async function hostPoolsListRegistrationTokenPost() {
  const subscriptionId =
    process.env["DESKTOPVIRTUALIZATION_SUBSCRIPTION_ID"] || "daefabc0-95b4-48b3-b645-8a753a63c4fa";
  const resourceGroupName = process.env["DESKTOPVIRTUALIZATION_RESOURCE_GROUP"] || "resourceGroup1";
  const hostPoolName = "hostPool1";
  const credential = new DefaultAzureCredential();
  const client = new DesktopVirtualizationAPIClient(credential, subscriptionId);
  const result = await client.hostPools.listRegistrationTokens(resourceGroupName, hostPoolName);
  console.log(result);
}

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

{
  "value": [
    {
      "expirationTime": "2008-09-22T14:01:54.9571247Z",
      "token": "token"
    }
  ]
}

Definitions

Name	Description
CloudError	Cloud error object.
CloudErrorProperties	Cloud error object properties.
RegistrationTokenList	RegistrationTokenList
RegistrationTokenMinimal	Represents a Minimal set of properties for RegistrationToken definition.

CloudError

Object

Cloud error object.

Name	Type	Description
error	CloudErrorProperties	Cloud error object properties.

CloudErrorProperties

Object

Cloud error object properties.

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.

RegistrationTokenList

Object

RegistrationTokenList

Name	Type	Description
nextLink	string	Link to the next page of results.
value	RegistrationTokenMinimal[]	List of RegistrationToken definitions.

RegistrationTokenMinimal

Object

Represents a Minimal set of properties for RegistrationToken definition.

Name	Type	Description
expirationTime	string (date-time)	Expiration time of registration token.
token	string	The registration token base64 encoded string.