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

Application Groups - List By Subscription

参考

Service:: Desktop Virtualization

API Version:: 2022-02-10-preview

列出订阅中的 applicationGroups。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups?api-version=2022-02-10-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups?api-version=2022-02-10-preview&$filter={$filter}

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。
$filter	query		string	OData 筛选器表达式。用于筛选的有效属性是 applicationGroupType。

响应

名称	类型	说明
200 OK	ApplicationGroupList	已成功在订阅中检索到应用程序组。
Other Status Codes	CloudError	描述操作失败原因的自动化错误响应。

示例

ApplicationGroup_List

GET https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/providers/Microsoft.DesktopVirtualization/applicationGroups?api-version=2022-02-10-preview&$filter=applicationGroupType eq 'RailApplication'

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/tree/main/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2022-02-10-preview/examples/ApplicationGroup_ListBySubscription.json
func ExampleApplicationGroupsClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armdesktopvirtualization.NewApplicationGroupsClient("daefabc0-95b4-48b3-b645-8a753a63c4fa", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(&armdesktopvirtualization.ApplicationGroupsClientListBySubscriptionOptions{Filter: to.Ptr("applicationGroupType eq 'RailApplication'")})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

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": [
    {
      "name": "applicationGroup1",
      "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1",
      "type": "Microsoft.DesktopVirtualization/applicationGroups",
      "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",
        "description": "des1",
        "friendlyName": "friendly",
        "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
        "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
        "applicationGroupType": "RemoteApp",
        "cloudPcResource": false
      }
    },
    {
      "name": "applicationGroup2",
      "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2",
      "type": "Microsoft.DesktopVirtualization/applicationGroups",
      "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",
        "description": "des1",
        "friendlyName": "friendly",
        "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
        "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
        "applicationGroupType": "RemoteApp",
        "cloudPcResource": false
      }
    }
  ]
}

定义

名称	说明
ApplicationGroup	表示 ApplicationGroup 定义。
ApplicationGroupList	ApplicationGroupList
ApplicationGroupType	ApplicationGroup 的资源类型。
CloudError	云错误对象。
CloudErrorProperties	云错误对象属性。
createdByType	创建资源的标识类型。
Identity
MigrationRequestProperties	arm 迁移的属性。
Operation	迁移的操作类型。
Plan
ResourceIdentityType	标识类型。
Sku
SkuTier	如果服务具有多个层，但 PUT 上不需要此字段，则资源提供程序必须实现此字段。
systemData	与资源的创建和上次修改相关的元数据。

ApplicationGroup

表示 ApplicationGroup 定义。

名称	类型	说明
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	资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity
kind	string	门户/工具等用于呈现相同类型资源的不同 UX 体验的元数据;例如，ApiApps 是一种 Microsoft.Web/sites 类型。如果支持，资源提供程序必须验证并保留此值。
location	string	资源所在的地理位置
managedBy	string	管理此资源的资源的完全限定资源 ID。指示此资源是否由另一个 Azure 资源管理。如果存在这种情况，如果从模板中删除资源，则完整模式部署不会删除该资源，因为它由其他资源管理。
name	string	资源的名称
plan	Plan
properties.applicationGroupType	ApplicationGroupType	ApplicationGroup 的资源类型。
properties.cloudPcResource	boolean	云电脑资源。
properties.description	string	ApplicationGroup 的说明。
properties.friendlyName	string	ApplicationGroup 的友好名称。
properties.hostPoolArmPath	string	ApplicationGroup 的 HostPool arm 路径。
properties.migrationRequest	MigrationRequestProperties	HostPool 的注册信息。
properties.objectId	string	ApplicationGroup 的 ObjectId。 (内部使用)
properties.workspaceArmPath	string	ApplicationGroup 的工作区 arm 路径。
sku	Sku
systemData	systemData	与资源的创建和上次修改相关的元数据。
tags	object	资源标记。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ApplicationGroupList

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

ApplicationGroupType

ApplicationGroup 的资源类型。

名称	类型	说明
Desktop	string
RemoteApp	string

CloudError

云错误对象。

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

CloudErrorProperties

云错误对象属性。

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

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

Identity

名称	类型	说明
principalId	string	资源标识的主体 ID。
tenantId	string	资源的租户 ID。
type	ResourceIdentityType	标识类型。

MigrationRequestProperties

arm 迁移的属性。

名称	类型	说明
migrationPath	string	要迁移的旧对象的路径。
operation	Operation	迁移的操作类型。

Operation

迁移的操作类型。

名称	类型	说明
Complete	string	完成迁移。
Hide	string	隐藏主机池。
Revoke	string	撤消迁移。
Start	string	开始迁移。
Unhide	string	取消隐藏主机池。

Plan

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

ResourceIdentityType

标识类型。

名称	类型	说明
SystemAssigned	string

Sku

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

SkuTier

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

名称	类型	说明
Basic	string
Free	string
Premium	string
Standard	string

systemData

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

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