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

Application Groups - Create Or Update

创建或更新 applicationGroup。

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

URI 参数

Name In Required Type Description
applicationGroupName
path True
  • string

应用程序组的名称

resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

请求正文

Name Required Type Description
properties.applicationGroupType True

ApplicationGroup 的资源类型。

properties.hostPoolArmPath True
  • string

ApplicationGroup 的 HostPool arm 路径。

identity
kind
  • string

门户/工具/etc 用于为相同类型的资源呈现不同的 UX 体验的元数据;例如,ApiApps 是 Microsoft.Web/sites 类型的类型。 如果受支持,资源提供程序必须验证并保留此值。

location
  • string

资源所在的地理位置

managedBy
  • string

管理此资源的资源的完全限定资源 ID。 指示此资源是否由另一个 Azure 资源管理。 如果存在这种情况,则如果从模板中删除该资源,则完整模式部署不会删除该资源,因为该资源由另一个资源管理。

plan
properties.description
  • string

ApplicationGroup 的说明。

properties.friendlyName
  • string

ApplicationGroup 的友好名称。

properties.migrationRequest

HostPool 的注册信息。

sku
tags
  • object

资源标记。

响应

Name Type Description
200 OK

已成功更新应用程序组。

201 Created

已成功创建应用程序组。

Other Status Codes

描述操作失败原因的自动化错误响应。

示例

ApplicationGroup_Create

Sample Request

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

{
  "location": "centralus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "description": "des1",
    "friendlyName": "friendly",
    "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
    "applicationGroupType": "RemoteApp",
    "migrationRequest": {
      "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}",
      "operation": "Start"
    }
  }
}

Sample Response

{
  "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,
    "migrationRequest": {
      "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}",
      "operation": "Start"
    }
  }
}
{
  "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,
    "migrationRequest": {
      "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}",
      "operation": "Start"
    }
  }
}

定义

ApplicationGroup

表示 ApplicationGroup 定义。

ApplicationGroupType

ApplicationGroup 的资源类型。

CloudError

云错误对象。

CloudErrorProperties

云错误对象属性。

createdByType

创建资源的标识的类型。

Identity
MigrationRequestProperties

arm 迁移的属性。

Operation

迁移操作的类型。

Plan
ResourceIdentityType

标识类型。

Sku
SkuTier

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

systemData

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

ApplicationGroup

表示 ApplicationGroup 定义。

Name Type Description
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。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity
kind
  • string

门户/工具/etc 用于为相同类型的资源呈现不同的 UX 体验的元数据;例如,ApiApps 是 Microsoft.Web/sites 类型的类型。 如果受支持,资源提供程序必须验证并保留此值。

location
  • string

资源所在的地理位置

managedBy
  • string

管理此资源的资源的完全限定资源 ID。 指示此资源是否由另一个 Azure 资源管理。 如果存在这种情况,则如果从模板中删除该资源,则完整模式部署不会删除该资源,因为该资源由另一个资源管理。

name
  • string

资源的名称

plan
properties.applicationGroupType

ApplicationGroup 的资源类型。

properties.cloudPcResource
  • boolean

云电脑资源。

properties.description
  • string

ApplicationGroup 的说明。

properties.friendlyName
  • string

ApplicationGroup 的友好名称。

properties.hostPoolArmPath
  • string

ApplicationGroup 的 HostPool arm 路径。

properties.migrationRequest

HostPool 的注册信息。

properties.objectId
  • string

ApplicationGroup 的 ObjectId。 (内部使用)

properties.workspaceArmPath
  • string

ApplicationGroup 的工作区 arm 路径。

sku
systemData

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

tags
  • object

资源标记。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

ApplicationGroupType

ApplicationGroup 的资源类型。

Name Type Description
Desktop
  • string
RemoteApp
  • string

CloudError

云错误对象。

Name Type Description
error

云错误对象属性。

CloudErrorProperties

云错误对象属性。

Name Type Description
code
  • string

错误代码

message
  • string

指示操作失败的原因的错误消息。

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

Identity

Name Type Description
principalId
  • string

资源标识的主体 ID。

tenantId
  • string

资源的租户 ID。

type

标识类型。

MigrationRequestProperties

arm 迁移的属性。

Name Type Description
migrationPath
  • string

要迁移的旧对象的路径。

operation

迁移操作的类型。

Operation

迁移操作的类型。

Name Type Description
Complete
  • string

完成迁移。

Hide
  • string

隐藏主机池。

Revoke
  • string

撤销迁移。

Start
  • string

开始迁移。

Unhide
  • string

取消隐藏主机池。

Plan

Name Type Description
name
  • string

要采购的第三方项目的用户定义的名称。

product
  • string

正在采购的第三方项目。 例如 NewRelic。 产品映射到在数据市场载入时为项目指定的 OfferID。

promotionCode
  • string

发布者为上述产品/项目提供数据市场中预配的促销代码。

publisher
  • string

正在购买的第三方项目的发布者。 例如 NewRelic

version
  • string

所需产品/项目的版本。

ResourceIdentityType

标识类型。

Name Type Description
SystemAssigned
  • string

Sku

Name Type Description
capacity
  • integer

如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果资源无法横向扩展/缩小,则可能会省略。

family
  • string

如果服务具有不同代的硬件(对于同一 SKU,则可以在此处捕获)。

name
  • string

SKU 的名称。 前 - P3。 它通常是字母+数字代码

size
  • string

SKU 大小。 当名称字段是层和其他一些值的组合时,这将是独立的代码。

tier

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

SkuTier

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

Name Type Description
Basic
  • string
Free
  • string
Premium
  • string
Standard
  • string

systemData

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

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

上次修改资源的标识的类型。