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

Workspaces - List By Subscription

列出订阅中的工作区。

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

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

WorkspaceList

已成功检索订阅中的工作区。

Other Status Codes

CloudError

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

示例

Workspace_ListBySubscription

示例请求

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

示例响应

{
  "value": [
    {
      "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"
      }
    },
    {
      "name": "workspace2",
      "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2",
      "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

表示工作区定义。

WorkspaceList

WorkspaceList

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

标识类型。

Plan

名称 类型 说明
name

string

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

product

string

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

promotionCode

string

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

publisher

string

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

version

string

所需产品/项目的版本。

PrivateEndpoint

专用终结点资源。

名称 类型 说明
id

string

专用终结点的 ARM 标识符

PrivateEndpointConnection

专用终结点连接资源。

名称 类型 说明
id

string

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

name

string

资源的名称

properties.privateEndpoint

PrivateEndpoint

专用终结点的资源。

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

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

properties.provisioningState

PrivateEndpointConnectionProvisioningState

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

type

string

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

PrivateEndpointConnectionProvisioningState

当前预配状态。

名称 类型 说明
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

名称 类型 说明
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

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

名称 类型 说明
actionsRequired

string

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

description

string

批准/拒绝连接的原因。

status

PrivateEndpointServiceConnectionStatus

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

PublicNetworkAccess

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

名称 类型 说明
Disabled

string

Enabled

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

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

Workspace

表示工作区定义。

名称 类型 说明
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.applicationGroupReferences

string[]

applicationGroup 资源 ID 的列表。

properties.cloudPcResource

boolean

是云电脑资源。

properties.description

string

工作区的说明。

properties.friendlyName

string

工作区的友好名称。

properties.objectId

string

Workspace 的 ObjectId。 (内部使用)

properties.privateEndpointConnections

PrivateEndpointConnection[]

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

properties.publicNetworkAccess

PublicNetworkAccess

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

sku

Sku

systemData

systemData

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

tags

object

资源标记。

type

string

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

WorkspaceList

WorkspaceList

名称 类型 说明
nextLink

string

链接到结果的下一页。

value

Workspace[]

工作区定义列表。