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

Workspaces - Update

更新工作区。

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

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

目标订阅的 ID。

workspaceName
path True
  • string

工作区的名称

api-version
query True
  • string

要用于此操作的 API 版本。

请求正文

Name Type Description
properties.applicationGroupReferences
  • string[]

applicationGroup 链接列表。

properties.description
  • string

工作区的说明。

properties.friendlyName
  • string

工作区的友好名称。

properties.publicNetworkAccess

已启用以允许从公共网络访问此资源

tags
  • object

要更新的标记

响应

Name Type Description
200 OK

已成功更新工作区。

Other Status Codes

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

示例

Workspace_Update

Sample Request

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

{
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "description": "des1",
    "friendlyName": "friendly",
    "publicNetworkAccess": "Enabled"
  }
}

Sample Response

{
  "name": "workspace1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1",
  "type": "Microsoft.DesktopVirtualization/workspaces",
  "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",
    "cloudPcResource": false,
    "publicNetworkAccess": "Enabled"
  }
}

定义

CloudError

云错误对象。

CloudErrorProperties

云错误对象属性。

createdByType

创建资源的标识的类型。

Identity
Plan
PrivateEndpoint

专用终结点资源。

PrivateEndpointConnection

专用终结点连接资源。

PrivateEndpointConnectionProvisioningState

当前预配状态。

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

PrivateLinkServiceConnectionState

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

PublicNetworkAccess

启用允许从公共和专用网络访问此资源,禁用允许仅通过专用终结点访问此资源

ResourceIdentityType

标识类型。

Sku
SkuTier

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

systemData

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

Workspace

表示工作区定义。

WorkspacePatch

可以修补的工作区属性。

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

标识类型。

Plan

Name Type Description
name
  • string

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

product
  • string

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

promotionCode
  • string

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

publisher
  • string

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

version
  • string

所需产品/项目的版本。

PrivateEndpoint

专用终结点资源。

Name Type Description
id
  • string

专用终结点的 ARM 标识符

PrivateEndpointConnection

专用终结点连接资源。

Name Type Description
id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

资源的名称

properties.privateEndpoint

专用终结点的资源。

properties.privateLinkServiceConnectionState

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

properties.provisioningState

专用终结点连接资源的预配状态。

type
  • string

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

PrivateEndpointConnectionProvisioningState

当前预配状态。

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

Name Type Description
Approved
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

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

Name Type Description
actionsRequired
  • string

一条消息,指示服务提供商上的更改是否需要对使用者进行任何更新。

description
  • string

批准/拒绝连接的原因。

status

指示是否已由服务的所有者批准/拒绝/删除连接。

PublicNetworkAccess

启用允许从公共和专用网络访问此资源,禁用允许仅通过专用终结点访问此资源

Name Type Description
Disabled
  • string
Enabled
  • 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

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

Workspace

表示工作区定义。

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

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

location
  • string

资源所在的地理位置

managedBy
  • string

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

name
  • string

资源的名称

plan
properties.applicationGroupReferences
  • string[]

applicationGroup 资源 ID 的列表。

properties.cloudPcResource
  • boolean

云电脑资源。

properties.description
  • string

工作区的说明。

properties.friendlyName
  • string

工作区的友好名称。

properties.objectId
  • string

Workspace 的 ObjectId。 (内部使用)

properties.privateEndpointConnections

与指定资源关联的专用终结点连接列表

properties.publicNetworkAccess

启用允许从公共和专用网络访问此资源,禁用允许仅通过专用终结点访问此资源

sku
systemData

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

tags
  • object

资源标记。

type
  • string

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

WorkspacePatch

可以修补的工作区属性。

Name Type Description
properties.applicationGroupReferences
  • string[]

applicationGroup 链接列表。

properties.description
  • string

工作区的说明。

properties.friendlyName
  • string

工作区的友好名称。

properties.publicNetworkAccess

已启用以允许从公共网络访问此资源

tags
  • object

要更新的标记