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

Workspaces - List By Resource Group

列出指定资源组下的所有可用机器学习工作区。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces?api-version=2022-05-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces?api-version=2022-05-01&$skip={$skip}

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

$skip
query
  • string

分页的延续标记。

响应

Name Type Description
200 OK

请求成功;请求格式正确且已正确接收。

Other Status Codes

描述操作失败原因的错误响应

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Get Workspaces by Resource Group

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces?api-version=2022-05-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace",
      "name": "testworkspace",
      "type": "Microsoft.MachineLearningServices/workspaces",
      "location": "eastus2euap",
      "properties": {
        "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry",
        "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv",
        "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights",
        "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount",
        "discoveryUrl": "http://example.com",
        "friendlyName": "HelloName",
        "description": "test description"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace1",
      "name": "testworkspace1",
      "type": "Microsoft.MachineLearningServices/workspaces",
      "location": "eastus2euap",
      "properties": {
        "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew",
        "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew",
        "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights",
        "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld",
        "discoveryUrl": "http://example.com",
        "friendlyName": "HelloName 1",
        "description": "test description"
      }
    }
  ],
  "nextLink": "nextLink"
}

定义

CosmosDbSettings
createdByType

创建资源的标识的类型。

EncryptionKeyVaultProperties
EncryptionProperty
EncryptionStatus

指示是否为工作区启用加密。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

IdentityForCmk

将用于访问密钥保管库进行静态加密的标识

ManagedServiceIdentity

托管服务标识 (系统分配和/或用户分配的标识)

ManagedServiceIdentityType

(允许使用 SystemAssigned 和 UserAssigned 类型的托管服务标识类型) 。

NotebookPreparationError
NotebookResourceInfo
PrivateEndpoint

专用终结点资源。

PrivateEndpointConnection

专用终结点连接资源。

PrivateEndpointConnectionProvisioningState

当前预配状态。

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

PrivateLinkServiceConnectionState

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

ProvisioningState

工作区资源的当前部署状态。 provisioningState 用于指示资源预配的状态。

PublicNetworkAccess

是否允许来自公用网络的请求。

ServiceManagedResourcesSettings
SharedPrivateLinkResource
Sku

表示 SKU 的资源模型定义

SkuTier

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

systemData

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

UserAssignedIdentity

用户分配的标识属性

Workspace

表示机器学习工作区的对象。

WorkspaceListResult

列出机器学习工作区的请求的结果。

CosmosDbSettings

Name Type Description
collectionsThroughput
  • integer

cosmosdb 数据库中集合的吞吐量

createdByType

创建资源的标识的类型。

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

EncryptionKeyVaultProperties

Name Type Description
identityClientId
  • string

将来使用 - 将用于访问密钥保管库的标识的客户端 ID。

keyIdentifier
  • string

用于访问加密密钥的密钥保管库 URI。

keyVaultArmId
  • string

客户拥有加密密钥的 keyVault 的 ArmId。

EncryptionProperty

Name Type Description
identity

将用于访问密钥保管库的标识进行静态加密。

keyVaultProperties

客户密钥保管库属性。

status

指示是否为工作区启用加密。

EncryptionStatus

指示是否为工作区启用加密。

Name Type Description
Disabled
  • string
Enabled
  • string

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。

IdentityForCmk

将用于访问密钥保管库进行静态加密的标识

Name Type Description
userAssignedIdentity
  • string

将用于访问客户托管密钥保管库的用户分配标识的 ArmId

ManagedServiceIdentity

托管服务标识 (系统分配和/或用户分配的标识)

Name Type Description
principalId
  • string

系统分配标识的服务主体 ID。 此属性仅适用于系统分配的标识。

tenantId
  • string

系统分配标识的租户 ID。 此属性仅适用于系统分配的标识。

type

允许) SystemAssigned 和 UserAssigned 类型的托管服务标识 (。

userAssignedIdentities

User-Assigned标识
与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥的格式为 ARM 资源 ID:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是请求中 ({}) 的空对象。

ManagedServiceIdentityType

(允许使用 SystemAssigned 和 UserAssigned 类型的托管服务标识类型) 。

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

NotebookPreparationError

Name Type Description
errorMessage
  • string
statusCode
  • integer

NotebookResourceInfo

Name Type Description
fqdn
  • string
notebookPreparationError

准备笔记本时发生的错误。

resourceId
  • string

用于初始化笔记本组件的数据平面 resourceId

PrivateEndpoint

专用终结点资源。

Name Type Description
id
  • string

专用终结点的 ARM 标识符

subnetArmId
  • string

专用终结点链接到的子网资源的 ARM 标识符

PrivateEndpointConnection

专用终结点连接资源。

Name Type Description
id
  • string

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

identity

资源的标识。

location
  • string

指定资源的位置。

name
  • string

资源的名称

properties.privateEndpoint

专用终结点的资源。

properties.privateLinkServiceConnectionState

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

properties.provisioningState

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

sku

工作区的 SKU。

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

tags
  • object

包含定义为键/值对的资源标记。

type
  • string

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

PrivateEndpointConnectionProvisioningState

当前预配状态。

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

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

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

PrivateLinkServiceConnectionState

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

Name Type Description
actionsRequired
  • string

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

description
  • string

批准/拒绝连接的原因。

status

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

ProvisioningState

工作区资源的当前部署状态。 provisioningState 用于指示资源预配的状态。

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Unknown
  • string
Updating
  • string

PublicNetworkAccess

是否允许来自公用网络的请求。

Name Type Description
Disabled
  • string
Enabled
  • string

ServiceManagedResourcesSettings

Name Type Description
cosmosDb

服务托管 cosmosdb 帐户的设置。

SharedPrivateLinkResource

Name Type Description
name
  • string

专用链接的唯一名称。

properties.groupId
  • string

专用链接资源组 ID。

properties.privateLinkResourceId
  • string

专用链接链接到的资源 ID。

properties.requestMessage
  • string

请求消息。

properties.status

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

Sku

表示 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

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

UserAssignedIdentity

用户分配的标识属性

Name Type Description
clientId
  • string

分配的标识的客户端 ID。

principalId
  • string

分配的标识的主体 ID。

Workspace

表示机器学习工作区的对象。

Name Type Default Value Description
id
  • string

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

identity

资源的标识。

location
  • string

指定资源的位置。

name
  • string

资源的名称

properties.allowPublicAccessWhenBehindVnet
  • boolean
False

指示在 VNet 后面是否允许公共访问的标志。

properties.applicationInsights
  • string

与此工作区关联的 Application Insights 的 ARM ID。

properties.containerRegistry
  • string

与此工作区关联的容器注册表的 ARM ID。

properties.description
  • string

此工作区的说明。

properties.discoveryUrl
  • string

用于标识机器学习试验服务的区域终结点的发现服务的 URL

properties.encryption

Azure ML 工作区的加密设置。

properties.friendlyName
  • string

此工作区的友好名称。 此名称在可变

properties.hbiWorkspace
  • boolean
False

用于向工作区中的 HBI 数据发出信号并减少服务收集的诊断数据的标志

properties.imageBuildCompute
  • string

映像生成的计算名称

properties.keyVault
  • string

与此工作区关联的密钥保管库的 ARM ID。 创建工作区后,无法更改此更改

properties.mlFlowTrackingUri
  • string

与此工作区关联的 URI,机器学习流必须指向以设置跟踪。

properties.notebookInfo

Azure ML 工作区的笔记本信息。

properties.primaryUserAssignedIdentity
  • string

表示工作区标识的用户分配的标识资源 ID。

properties.privateEndpointConnections

工作区中的专用终结点连接列表。

properties.privateLinkCount
  • integer

工作区中的专用连接计数

properties.provisioningState

工作区资源的当前部署状态。 provisioningState 用于指示资源预配的状态。

properties.publicNetworkAccess

是否允许来自公用网络的请求。

properties.serviceManagedResourcesSettings

服务托管资源设置。

properties.serviceProvisionedResourceGroup
  • string

如果工作区是 CMK 工作区,则客户订阅中工作区 RP 创建的托管资源组的名称

properties.sharedPrivateLinkResources

此工作区中共享的专用链接资源列表。

properties.storageAccount
  • string

与此工作区关联的存储帐户的 ARM ID。 创建工作区后,无法更改此更改

properties.storageHnsEnabled
  • boolean

如果与工作区关联的存储已启用分层命名空间 (HNS) 。

properties.tenantId
  • string

与此工作区关联的租户 ID。

properties.v1LegacyMode
  • boolean
False

启用 v1_legacy_mode 可能会阻止你使用 v2 API 提供的功能。

properties.workspaceId
  • string

与此工作区关联的不可变 ID。

sku

工作区的 SKU。

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

tags
  • object

包含定义为键/值对的资源标记。

type
  • string

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

WorkspaceListResult

列出机器学习工作区的请求的结果。

Name Type Description
nextLink
  • string

可用于请求下一个机器学习工作区列表的 URI。

value

机器学习工作区的列表。 由于此列表可能不完整,因此下一个Link 字段应用于请求下一个机器学习工作区列表。