你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Host Pools - List By Resource Group

参考

服务:: Desktop Virtualization

API 版本:: 2024-04-03

列出 hostPools。

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

具有可选参数:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools?api-version=2024-04-03&pageSize={pageSize}&isDescending={isDescending}&initialSkip={initialSkip}

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。
initialSkip	query		integer (int32)	要跳过的初始项数。
isDescending	query		boolean	指示集合是否降序。
pageSize	query		integer (int32)	每页的项数。

响应

名称	类型	说明
200 OK	HostPoolList	已成功检索到资源组中的主机池。
Other Status Codes	CloudError	描述操作失败原因的自动化错误响应。

示例

HostPool_ListByResourceGroup

示例请求

GET https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools?api-version=2024-04-03&pageSize=10&isDescending=True&initialSkip=0


/**
 * Samples for HostPools ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/
     * HostPool_ListByResourceGroup.json
     */
    /**
     * Sample code: HostPool_ListByResourceGroup.
     * 
     * @param manager Entry point to DesktopVirtualizationManager.
     */
    public static void hostPoolListByResourceGroup(
        com.azure.resourcemanager.desktopvirtualization.DesktopVirtualizationManager manager) {
        manager.hostPools().listByResourceGroup("resourceGroup1", 10, true, 0, 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.desktopvirtualization import DesktopVirtualizationMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-desktopvirtualization
# USAGE
    python host_pool_list_by_resource_group.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_by_resource_group(
        resource_group_name="resourceGroup1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/HostPool_ListByResourceGroup.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

package armdesktopvirtualization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/HostPool_ListByResourceGroup.json
func ExampleHostPoolsClient_NewListByResourceGroupPager() {
	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)
	}
	pager := clientFactory.NewHostPoolsClient().NewListByResourceGroupPager("resourceGroup1", &armdesktopvirtualization.HostPoolsClientListByResourceGroupOptions{PageSize: to.Ptr[int32](10),
		IsDescending: to.Ptr(true),
		InitialSkip:  to.Ptr[int32](0),
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.HostPoolList = armdesktopvirtualization.HostPoolList{
		// 	Value: []*armdesktopvirtualization.HostPool{
		// 		{
		// 			Name: to.Ptr("hostPool1"),
		// 			Type: to.Ptr("/Microsoft.DesktopVirtualization/hostPools"),
		// 			ID: to.Ptr("/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1"),
		// 			SystemData: &armdesktopvirtualization.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
		// 				CreatedBy: to.Ptr("user1"),
		// 				CreatedByType: to.Ptr(armdesktopvirtualization.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("user2"),
		// 				LastModifiedByType: to.Ptr(armdesktopvirtualization.CreatedByTypeUser),
		// 			},
		// 			Location: to.Ptr("centralus"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 				"key2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armdesktopvirtualization.HostPoolProperties{
		// 				Description: to.Ptr("des1"),
		// 				AgentUpdate: &armdesktopvirtualization.AgentUpdateProperties{
		// 					Type: to.Ptr(armdesktopvirtualization.SessionHostComponentUpdateTypeScheduled),
		// 					MaintenanceWindowTimeZone: to.Ptr("Alaskan Standard Time"),
		// 					MaintenanceWindows: []*armdesktopvirtualization.MaintenanceWindowProperties{
		// 						{
		// 							DayOfWeek: to.Ptr(armdesktopvirtualization.DayOfWeekFriday),
		// 							Hour: to.Ptr[int32](7),
		// 						},
		// 						{
		// 							DayOfWeek: to.Ptr(armdesktopvirtualization.DayOfWeekSaturday),
		// 							Hour: to.Ptr[int32](8),
		// 					}},
		// 					UseSessionHostLocalTime: to.Ptr(false),
		// 				},
		// 				CloudPcResource: to.Ptr(false),
		// 				FriendlyName: to.Ptr("friendly"),
		// 				HostPoolType: to.Ptr(armdesktopvirtualization.HostPoolTypePooled),
		// 				LoadBalancerType: to.Ptr(armdesktopvirtualization.LoadBalancerTypeBreadthFirst),
		// 				MaxSessionLimit: to.Ptr[int32](999999),
		// 				ObjectID: to.Ptr("7877fb31-4bde-49fd-9df3-c046e0ec5325"),
		// 				PersonalDesktopAssignmentType: to.Ptr(armdesktopvirtualization.PersonalDesktopAssignmentTypeAutomatic),
		// 				PreferredAppGroupType: to.Ptr(armdesktopvirtualization.PreferredAppGroupTypeDesktop),
		// 				RegistrationInfo: &armdesktopvirtualization.RegistrationInfo{
		// 					ExpirationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2008-09-22T14:01:54.957Z"); return t}()),
		// 					RegistrationTokenOperation: to.Ptr(armdesktopvirtualization.RegistrationTokenOperationUpdate),
		// 					Token: to.Ptr("token"),
		// 				},
		// 				SsoClientID: to.Ptr("client"),
		// 				SsoClientSecretKeyVaultPath: to.Ptr("https://keyvault/secret"),
		// 				SsoSecretType: to.Ptr(armdesktopvirtualization.SSOSecretTypeSharedKey),
		// 				SsoadfsAuthority: to.Ptr("https://adfs"),
		// 				StartVMOnConnect: to.Ptr(false),
		// 				VMTemplate: to.Ptr("{json:json}"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("hostPool2"),
		// 			Type: to.Ptr("/Microsoft.DesktopVirtualization/hostPools"),
		// 			ID: to.Ptr("/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2"),
		// 			SystemData: &armdesktopvirtualization.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
		// 				CreatedBy: to.Ptr("user1"),
		// 				CreatedByType: to.Ptr(armdesktopvirtualization.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("user2"),
		// 				LastModifiedByType: to.Ptr(armdesktopvirtualization.CreatedByTypeUser),
		// 			},
		// 			Location: to.Ptr("centralus"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 				"key2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armdesktopvirtualization.HostPoolProperties{
		// 				Description: to.Ptr("des1"),
		// 				AgentUpdate: &armdesktopvirtualization.AgentUpdateProperties{
		// 					Type: to.Ptr(armdesktopvirtualization.SessionHostComponentUpdateTypeScheduled),
		// 					MaintenanceWindowTimeZone: to.Ptr("Alaskan Standard Time"),
		// 					MaintenanceWindows: []*armdesktopvirtualization.MaintenanceWindowProperties{
		// 						{
		// 							DayOfWeek: to.Ptr(armdesktopvirtualization.DayOfWeekFriday),
		// 							Hour: to.Ptr[int32](7),
		// 						},
		// 						{
		// 							DayOfWeek: to.Ptr(armdesktopvirtualization.DayOfWeekSaturday),
		// 							Hour: to.Ptr[int32](8),
		// 					}},
		// 					UseSessionHostLocalTime: to.Ptr(false),
		// 				},
		// 				CloudPcResource: to.Ptr(false),
		// 				FriendlyName: to.Ptr("friendly"),
		// 				HostPoolType: to.Ptr(armdesktopvirtualization.HostPoolTypePooled),
		// 				LoadBalancerType: to.Ptr(armdesktopvirtualization.LoadBalancerTypeBreadthFirst),
		// 				MaxSessionLimit: to.Ptr[int32](999999),
		// 				ObjectID: to.Ptr("7877fb31-4bde-49fd-9df3-c046e0ec5325"),
		// 				PersonalDesktopAssignmentType: to.Ptr(armdesktopvirtualization.PersonalDesktopAssignmentTypeAutomatic),
		// 				PreferredAppGroupType: to.Ptr(armdesktopvirtualization.PreferredAppGroupTypeDesktop),
		// 				RegistrationInfo: &armdesktopvirtualization.RegistrationInfo{
		// 					ExpirationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2008-09-22T14:01:54.957Z"); return t}()),
		// 					RegistrationTokenOperation: to.Ptr(armdesktopvirtualization.RegistrationTokenOperationUpdate),
		// 					Token: to.Ptr("token"),
		// 				},
		// 				SsoClientID: to.Ptr("client"),
		// 				SsoClientSecretKeyVaultPath: to.Ptr("https://keyvault/secret"),
		// 				SsoSecretType: to.Ptr(armdesktopvirtualization.SSOSecretTypeSharedKey),
		// 				SsoadfsAuthority: to.Ptr("https://adfs"),
		// 				StartVMOnConnect: to.Ptr(false),
		// 				VMTemplate: to.Ptr("{json:json}"),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to List hostPools.
 *
 * @summary List hostPools.
 * x-ms-original-file: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/HostPool_ListByResourceGroup.json
 */
async function hostPoolListByResourceGroup() {
  const subscriptionId =
    process.env["DESKTOPVIRTUALIZATION_SUBSCRIPTION_ID"] || "daefabc0-95b4-48b3-b645-8a753a63c4fa";
  const resourceGroupName = process.env["DESKTOPVIRTUALIZATION_RESOURCE_GROUP"] || "resourceGroup1";
  const pageSize = 10;
  const isDescending = true;
  const initialSkip = 0;
  const options = {
    pageSize,
    isDescending,
    initialSkip,
  };
  const credential = new DefaultAzureCredential();
  const client = new DesktopVirtualizationAPIClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.hostPools.listByResourceGroup(resourceGroupName, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DesktopVirtualization.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.DesktopVirtualization;

// Generated from example definition: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/HostPool_ListByResourceGroup.json
// this example is just showing the usage of "HostPools_ListByResourceGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "daefabc0-95b4-48b3-b645-8a753a63c4fa";
string resourceGroupName = "resourceGroup1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this HostPoolResource
HostPoolCollection collection = resourceGroupResource.GetHostPools();

// invoke the operation and iterate over the result
int? pageSize = 10;
bool? isDescending = true;
int? initialSkip = 0;
await foreach (HostPoolResource item in collection.GetAllAsync(pageSize: pageSize, isDescending: isDescending, initialSkip: initialSkip))
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    HostPoolData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

示例响应

状态代码:: 200

{
  "value": [
    {
      "name": "hostPool1",
      "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
      "type": "/Microsoft.DesktopVirtualization/hostPools",
      "location": "centralus",
      "tags": {
        "key1": "value1",
        "key2": "value2"
      },
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "properties": {
        "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325",
        "friendlyName": "friendly",
        "description": "des1",
        "hostPoolType": "Pooled",
        "personalDesktopAssignmentType": "Automatic",
        "customRdpProperty": null,
        "maxSessionLimit": 999999,
        "loadBalancerType": "BreadthFirst",
        "validationEnvironment": null,
        "ring": null,
        "registrationInfo": {
          "expirationTime": "2008-09-22T14:01:54.9571247Z",
          "token": "token",
          "registrationTokenOperation": "Update"
        },
        "vmTemplate": "{json:json}",
        "ssoadfsAuthority": "https://adfs",
        "ssoClientId": "client",
        "ssoClientSecretKeyVaultPath": "https://keyvault/secret",
        "ssoSecretType": "SharedKey",
        "preferredAppGroupType": "Desktop",
        "startVMOnConnect": false,
        "cloudPcResource": false,
        "agentUpdate": {
          "type": "Scheduled",
          "useSessionHostLocalTime": false,
          "maintenanceWindowTimeZone": "Alaskan Standard Time",
          "maintenanceWindows": [
            {
              "hour": 7,
              "dayOfWeek": "Friday"
            },
            {
              "hour": 8,
              "dayOfWeek": "Saturday"
            }
          ]
        }
      }
    },
    {
      "name": "hostPool2",
      "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2",
      "type": "/Microsoft.DesktopVirtualization/hostPools",
      "location": "centralus",
      "tags": {
        "key1": "value1",
        "key2": "value2"
      },
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "properties": {
        "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325",
        "friendlyName": "friendly",
        "description": "des1",
        "hostPoolType": "Pooled",
        "personalDesktopAssignmentType": "Automatic",
        "customRdpProperty": null,
        "maxSessionLimit": 999999,
        "loadBalancerType": "BreadthFirst",
        "validationEnvironment": null,
        "ring": null,
        "registrationInfo": {
          "expirationTime": "2008-09-22T14:01:54.9571247Z",
          "token": "token",
          "registrationTokenOperation": "Update"
        },
        "vmTemplate": "{json:json}",
        "ssoadfsAuthority": "https://adfs",
        "ssoClientId": "client",
        "ssoClientSecretKeyVaultPath": "https://keyvault/secret",
        "ssoSecretType": "SharedKey",
        "preferredAppGroupType": "Desktop",
        "startVMOnConnect": false,
        "cloudPcResource": false,
        "agentUpdate": {
          "type": "Scheduled",
          "useSessionHostLocalTime": false,
          "maintenanceWindowTimeZone": "Alaskan Standard Time",
          "maintenanceWindows": [
            {
              "hour": 7,
              "dayOfWeek": "Friday"
            },
            {
              "hour": 8,
              "dayOfWeek": "Saturday"
            }
          ]
        }
      }
    }
  ]
}

定义

名称	说明
AgentUpdateProperties	用于更新代理、监视代理和堆栈组件的会话主机配置。
CloudError	云错误对象。
CloudErrorProperties	云错误对象属性。
createdByType	创建资源的标识的类型。
DayOfWeek	一周中的一天。
HostPool	表示 HostPool 定义。
HostPoolList	HostPoolList
HostpoolPublicNetworkAccess	启用后，可从公共和专用网络访问此资源，禁用后，只能通过专用终结点访问此资源
HostPoolType	适用于桌面的 HostPool 类型。
Identity
LoadBalancerType	负载均衡器的类型。
MaintenanceWindowProperties	维护时段从一周中的小时和一天开始。
PersonalDesktopAssignmentType	HostPool 的 PersonalDesktopAssignment 类型。
Plan
PreferredAppGroupType	首选应用程序组类型的类型，默认为桌面应用程序组
PrivateEndpoint	专用终结点资源。
PrivateEndpointConnection	专用终结点连接资源。
PrivateEndpointConnectionProvisioningState	当前预配状态。
PrivateEndpointServiceConnectionStatus	专用终结点连接状态。
PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
RegistrationInfo	表示 RegistrationInfo 定义。
RegistrationTokenOperation	重置令牌的类型。
ResourceIdentityType	标识类型。
SessionHostComponentUpdateType	会话主机组件的维护类型。
Sku
SkuTier	如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。
SSOSecretType	单一登录机密类型的类型。
systemData	与创建和上次修改资源相关的元数据。

AgentUpdateProperties

Object

用于更新代理、监视代理和堆栈组件的会话主机配置。

名称	类型	说明
maintenanceWindowTimeZone	string	https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0中定义的维护时区。如果 useLocalTime 为 true，则必须设置。
maintenanceWindows	MaintenanceWindowProperties[]	维护时段列表。维护时段长 2 小时。
type	SessionHostComponentUpdateType	会话主机组件的维护类型。
useSessionHostLocalTime	boolean	是否使用虚拟机的 localTime。

CloudError

Object

云错误对象。

名称	类型	说明
error	CloudErrorProperties	云错误对象属性。

CloudErrorProperties

Object

云错误对象属性。

名称	类型	说明
code	string	错误代码
message	string	指示操作失败的原因的错误消息。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DayOfWeek

枚举

一周中的一天。

值	说明
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

HostPool

Object

表示 HostPool 定义。

名称	类型	说明
etag	string	etag 字段不需要。如果在响应正文中提供，则还必须根据正常的 etag 约定将其作为标头提供。实体标记用于比较同一请求资源的两个或多个实体。 HTTP/1.1 在 etag（第 14.19 节）、If-Match（第 14.24 节）、If-None-Match（第 14.26 节）和 If-Range（第 14.27 节）标头字段中使用实体标记。
id	string (arm-id)	资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
identity	Identity
kind	string pattern: ^[-\w\._,\(\)]+$	门户/工具等用于为相同类型的资源呈现不同的 UX 体验的元数据。例如，ApiApps 是一种 Microsoft.Web/sites 类型。如果受支持，资源提供程序必须验证并保留此值。
location	string	资源所在的地理位置
managedBy	string	管理此资源的资源的完全限定资源 ID。指示此资源是否由另一个 Azure 资源管理。如果存在，则完全模式部署不会删除资源（如果从模板中删除，因为它由另一个资源管理）。
name	string	资源的名称
plan	Plan
properties.agentUpdate	AgentUpdateProperties	用于更新代理、监视代理和堆栈组件的会话主机配置。
properties.appAttachPackageReferences	string[]	应用附加包链接的列表。
properties.applicationGroupReferences	string[]	applicationGroup 链接列表。
properties.cloudPcResource	boolean	云电脑资源。
properties.customRdpProperty	string	HostPool 的自定义 rdp 属性。
properties.description	string	HostPool 的说明。
properties.friendlyName	string	HostPool 的友好名称。
properties.hostPoolType	HostPoolType	适用于桌面的 HostPool 类型。
properties.loadBalancerType	LoadBalancerType	负载均衡器的类型。
properties.maxSessionLimit	integer (int32)	HostPool 的最大会话限制。
properties.objectId	string	HostPool 的 ObjectId。（内部使用）
properties.personalDesktopAssignmentType	PersonalDesktopAssignmentType	HostPool 的 PersonalDesktopAssignment 类型。
properties.preferredAppGroupType	PreferredAppGroupType	首选应用程序组类型的类型，默认为桌面应用程序组
properties.privateEndpointConnections	PrivateEndpointConnection[]	与指定资源关联的专用终结点连接列表
properties.publicNetworkAccess	HostpoolPublicNetworkAccess	启用后，可从公共和专用网络访问此资源，禁用后，只能通过专用终结点访问此资源
properties.registrationInfo	RegistrationInfo	HostPool 的注册信息。
properties.ring	integer (int32)	HostPool 的环号。
properties.ssoClientId	string	用于颁发 WVD SSO 证书的已注册信赖方的 ClientId。
properties.ssoClientSecretKeyVaultPath	string	存储用于与 ADFS 通信的机密的 Azure KeyVault 的路径。
properties.ssoSecretType	SSOSecretType	单一登录机密类型的类型。
properties.ssoadfsAuthority	string	用于对 WVD SSO 证书进行签名的客户 ADFS 服务器的 URL。
properties.startVMOnConnect	boolean	要打开/关闭 StartVMOnConnect 功能的标志。
properties.validationEnvironment	boolean	验证环境。
properties.vmTemplate	string	主机池中会话主机配置的 VM 模板。
sku	Sku
systemData	systemData	与创建和上次修改资源相关的元数据。
tags	object	资源标记。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

HostPoolList

Object

HostPoolList

名称	类型	说明
nextLink	string	链接到结果的下一页。
value	HostPool[]	HostPool 定义列表。

HostpoolPublicNetworkAccess

枚举

启用后，可从公共和专用网络访问此资源，禁用后，只能通过专用终结点访问此资源

值	说明
Disabled
Enabled
EnabledForClientsOnly
EnabledForSessionHostsOnly

HostPoolType

枚举

适用于桌面的 HostPool 类型。

值	说明
BYODesktop	用户分配自己的计算机，负载均衡逻辑与个人逻辑保持不变。 PersonalDesktopAssignmentType 必须是 Direct。
Personal	管理员（PersonalDesktopAssignmentType = Direct）或连接到池时（PersonalDesktopAssignmentType = Automatic）将为用户分配 SessionHost。它们将始终重定向到其分配的 SessionHost。
Pooled	用户每次连接到 HostPool 时都会获得新的（随机） SessionHost。

Identity

Object

名称	类型	说明
principalId	string (uuid)	资源标识的主体 ID。该值必须是 UUID。
tenantId	string (uuid)	资源的租户 ID。该值必须是 UUID。
type	ResourceIdentityType	标识类型。

LoadBalancerType

枚举

负载均衡器的类型。

值	说明
BreadthFirst
DepthFirst
Persistent

MaintenanceWindowProperties

Object

维护时段从一周中的小时和一天开始。

名称	类型	说明
dayOfWeek	DayOfWeek	一周中的一天。
hour	integer (int32)	当天的更新开始时间。 (0 - 23)

PersonalDesktopAssignmentType

枚举

HostPool 的 PersonalDesktopAssignment 类型。

值	说明
Automatic
Direct

Plan

Object

名称	类型	说明
name	string	正在采购的第三方项目的用户定义的名称。
product	string	正在采购的第三方项目。例如 NewRelic。产品映射到在数据市场载入时为项目指定的 OfferID。
promotionCode	string	发布者为上述产品/项目提供数据市场中预配的促销代码。
publisher	string	正在购买的第三方项目的发布者。例如 NewRelic
version	string	所需产品/项目的版本。

PreferredAppGroupType

枚举

首选应用程序组类型的类型，默认为桌面应用程序组

值	说明
Desktop
None
RailApplications

PrivateEndpoint

Object

专用终结点资源。

名称	类型	说明
id	string	专用终结点的 ARM 标识符。

PrivateEndpointConnection

Object

专用终结点连接资源。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.groupIds	string[]	专用终结点资源的组 ID。
properties.privateEndpoint	PrivateEndpoint	专用终结点资源。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	专用终结点连接资源的预配状态。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProvisioningState

枚举

当前预配状态。

值	说明
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

枚举

专用终结点连接状态。

值	说明
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

有关服务使用者与提供程序之间的连接状态的信息集合。

名称	类型	说明
actionsRequired	string	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。
description	string	批准/拒绝连接的原因。
status	PrivateEndpointServiceConnectionStatus	指示连接是否已被服务的所有者批准/拒绝/删除。

RegistrationInfo

Object

表示 RegistrationInfo 定义。

名称	类型	说明
expirationTime	string (date-time)	注册令牌的过期时间。
registrationTokenOperation	RegistrationTokenOperation	重置令牌的类型。
token	string	注册令牌 base64 编码字符串。

RegistrationTokenOperation

枚举

重置令牌的类型。

值	说明
Delete
None
Update

ResourceIdentityType

枚举

标识类型。

值	说明
SystemAssigned

SessionHostComponentUpdateType

枚举

会话主机组件的维护类型。

值	说明
Default	代理和其他代理端组件交付计划由 WVD Infra 控制。
Scheduled	TenantAdmin 已选择加入计划组件更新功能。

Sku

Object

名称	类型	说明
capacity	integer (int32)	如果 SKU 支持横向扩展/缩减，则应包含容量整数。如果资源无法横向扩展/缩小，则可能会省略此范围。
family	string	如果服务具有不同代的硬件（对于同一 SKU，则可以在此处捕获）。
name	string	SKU 的名称。例如 P3。它通常是字母+数字代码
size	string	SKU 大小。当名称字段是层和其他一些值的组合时，这将是独立的代码。
tier	SkuTier	如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。

SkuTier

枚举

如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。

值	说明
Basic
Free
Premium
Standard

SSOSecretType

枚举

单一登录机密类型的类型。

值	说明
Certificate
CertificateInKeyVault
SharedKey
SharedKeyInKeyVault

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。