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

Workspaces - Update

汇报具有指定参数的机器学习工作区。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}?api-version=2024-04-01

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

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

subscriptionId
path True

string

目标订阅的 ID。

workspaceName
path True

string

Azure 机器学习工作区的名称。

正则表达式模式: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

api-version
query True

string

要用于此操作的 API 版本。

请求正文

名称 类型 说明
identity

ManagedServiceIdentity

资源的标识。

properties.applicationInsights

string

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

properties.containerRegistry

string

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

properties.description

string

此工作区的说明。

properties.enableDataIsolation

boolean

properties.encryption

EncryptionUpdateProperties

properties.featureStoreSettings

FeatureStoreSettings

特征存储类型工作区的设置。

properties.friendlyName

string

此工作区的友好名称。

properties.imageBuildCompute

string

映像生成的计算名称

properties.managedNetwork

ManagedNetworkSettings

机器学习工作区的托管网络设置。

properties.primaryUserAssignedIdentity

string

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

properties.publicNetworkAccess

PublicNetworkAccess

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

properties.serverlessComputeSettings

ServerlessComputeSettings

在工作区中创建的无服务器计算设置

properties.serviceManagedResourcesSettings

ServiceManagedResourcesSettings

服务托管的资源设置。

properties.v1LegacyMode

boolean

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

sku

Sku

工作区的 SKU。

tags

object

机器学习工作区的资源标记。

响应

名称 类型 说明
200 OK

Workspace

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

202 Accepted

已接受

标头

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Update Workspace

示例请求

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace?api-version=2024-04-01

{
  "properties": {
    "friendlyName": "New friendly name",
    "description": "new description",
    "publicNetworkAccess": "Disabled"
  }
}

示例响应

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace",
  "name": "testworkspace",
  "type": "Microsoft.MachineLearningServices/workspaces",
  "location": "eastus2euap",
  "identity": {
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444",
    "type": "SystemAssigned"
  },
  "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": "New friendly name",
    "description": "new description",
    "publicNetworkAccess": "Disabled"
  }
}
Location: example_location

定义

名称 说明
ComputeRuntimeDto

功能存储类型工作区的计算运行时配置。

CosmosDbSettings
createdByType

创建资源的标识类型。

EncryptionKeyVaultProperties
EncryptionKeyVaultUpdateProperties
EncryptionProperty
EncryptionStatus

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

EncryptionUpdateProperties
ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

FeatureStoreSettings

功能存储类型工作区的设置。

FqdnOutboundRule

机器学习工作区的托管网络的 FQDN 出站规则。

IdentityForCmk

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

IsolationMode

机器学习工作区托管网络的隔离模式。

ManagedNetworkProvisionStatus

机器学习工作区托管网络的预配状态。

ManagedNetworkSettings

机器学习工作区的托管网络设置。

ManagedNetworkStatus

机器学习工作区的托管网络的状态。

ManagedServiceIdentity

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

ManagedServiceIdentityType

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

NotebookPreparationError
NotebookResourceInfo
PrivateEndpoint

专用终结点资源。

PrivateEndpointConnection

专用终结点连接资源。

PrivateEndpointConnectionProvisioningState

当前预配状态。

PrivateEndpointDestination

机器学习工作区托管网络的专用终结点出站规则的专用终结点目标。

PrivateEndpointOutboundRule

机器学习工作区的托管网络的专用终结点出站规则。

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

PrivateLinkServiceConnectionState

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

ProvisioningState

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

PublicNetworkAccess

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

RuleAction

网络规则的操作枚举。

RuleCategory

机器学习工作区的托管网络出站规则的类别。

RuleStatus

机器学习工作区的托管网络出站规则的类型。

RuleType

机器学习工作区的托管网络出站规则的类型。

ServerlessComputeSettings
ServiceManagedResourcesSettings
ServiceTagDestination

机器学习工作区的托管网络的服务标记出站规则的服务标记目标。

ServiceTagOutboundRule

机器学习工作区的托管网络的服务标记出站规则。

SharedPrivateLinkResource
Sku

表示 SKU 的资源模型定义

SkuTier

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

systemData

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

UserAssignedIdentity

用户分配的标识属性

Workspace

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

WorkspaceHubConfig

WorkspaceHub 的配置对象。

WorkspaceUpdateParameters

用于更新机器学习工作区的参数。

ComputeRuntimeDto

功能存储类型工作区的计算运行时配置。

名称 类型 说明
sparkRuntimeVersion

string

CosmosDbSettings

名称 类型 说明
collectionsThroughput

integer

cosmosdb 数据库中集合的吞吐量

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

EncryptionKeyVaultProperties

名称 类型 说明
identityClientId

string

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

keyIdentifier

string

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

keyVaultArmId

string

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

EncryptionKeyVaultUpdateProperties

名称 类型 说明
keyIdentifier

string

EncryptionProperty

名称 类型 说明
identity

IdentityForCmk

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

keyVaultProperties

EncryptionKeyVaultProperties

客户密钥保管库属性。

status

EncryptionStatus

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

EncryptionStatus

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

名称 类型 说明
Disabled

string

Enabled

string

EncryptionUpdateProperties

名称 类型 说明
keyVaultProperties

EncryptionKeyVaultUpdateProperties

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

FeatureStoreSettings

功能存储类型工作区的设置。

名称 类型 说明
computeRuntime

ComputeRuntimeDto

功能存储类型工作区的计算运行时配置。

offlineStoreConnectionName

string

onlineStoreConnectionName

string

FqdnOutboundRule

机器学习工作区的托管网络的 FQDN 出站规则。

名称 类型 说明
category

RuleCategory

机器学习工作区的托管网络出站规则的类别。

destination

string

status

RuleStatus

机器学习工作区的托管网络出站规则的类型。

type string:

FQDN

机器学习工作区的托管网络出站规则的类型。

IdentityForCmk

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

名称 类型 说明
userAssignedIdentity

string

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

IsolationMode

机器学习工作区托管网络的隔离模式。

名称 类型 说明
AllowInternetOutbound

string

AllowOnlyApprovedOutbound

string

Disabled

string

ManagedNetworkProvisionStatus

机器学习工作区托管网络的预配状态。

名称 类型 说明
sparkReady

boolean

status

ManagedNetworkStatus

机器学习工作区的托管网络的状态。

ManagedNetworkSettings

机器学习工作区的托管网络设置。

名称 类型 说明
isolationMode

IsolationMode

机器学习工作区托管网络的隔离模式。

networkId

string

outboundRules

object

status

ManagedNetworkProvisionStatus

机器学习工作区托管网络的预配状态。

ManagedNetworkStatus

机器学习工作区的托管网络的状态。

名称 类型 说明
Active

string

Inactive

string

ManagedServiceIdentity

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

名称 类型 说明
principalId

string

系统分配的标识的服务主体 ID。 仅为系统分配的标识提供此属性。

tenantId

string

系统分配的标识的租户 ID。 仅为系统分配的标识提供此属性。

type

ManagedServiceIdentityType

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

userAssignedIdentities

<string,  UserAssignedIdentity>

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

ManagedServiceIdentityType

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

名称 类型 说明
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

NotebookPreparationError

名称 类型 说明
errorMessage

string

statusCode

integer

NotebookResourceInfo

名称 类型 说明
fqdn

string

notebookPreparationError

NotebookPreparationError

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

resourceId

string

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

PrivateEndpoint

专用终结点资源。

名称 类型 说明
id

string

专用终结点的 ARM 标识符

PrivateEndpointConnection

专用终结点连接资源。

名称 类型 说明
id

string

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

identity

ManagedServiceIdentity

资源的标识。

location

string

指定资源的位置。

name

string

资源的名称

properties.privateEndpoint

PrivateEndpoint

专用终结点的资源。

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

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

properties.provisioningState

PrivateEndpointConnectionProvisioningState

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

sku

Sku

工作区的 SKU。

systemData

systemData

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

tags

object

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

type

string

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

PrivateEndpointConnectionProvisioningState

当前预配状态。

名称 类型 说明
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointDestination

机器学习工作区托管网络的专用终结点出站规则的专用终结点目标。

名称 类型 说明
serviceResourceId

string

sparkEnabled

boolean

sparkStatus

RuleStatus

机器学习工作区的托管网络出站规则的类型。

subresourceTarget

string

PrivateEndpointOutboundRule

机器学习工作区的托管网络的专用终结点出站规则。

名称 类型 说明
category

RuleCategory

机器学习工作区的托管网络出站规则的类别。

destination

PrivateEndpointDestination

机器学习工作区托管网络的专用终结点出站规则的专用终结点目标。

status

RuleStatus

机器学习工作区的托管网络出站规则的类型。

type string:

PrivateEndpoint

机器学习工作区的托管网络出站规则的类型。

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

名称 类型 说明
Approved

string

Disconnected

string

Pending

string

Rejected

string

Timeout

string

PrivateLinkServiceConnectionState

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

名称 类型 说明
actionsRequired

string

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

description

string

批准/拒绝连接的原因。

status

PrivateEndpointServiceConnectionStatus

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

ProvisioningState

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

名称 类型 说明
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Unknown

string

Updating

string

PublicNetworkAccess

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

名称 类型 说明
Disabled

string

Enabled

string

RuleAction

网络规则的操作枚举。

名称 类型 说明
Allow

string

Deny

string

RuleCategory

机器学习工作区的托管网络出站规则的类别。

名称 类型 说明
Dependency

string

Recommended

string

Required

string

UserDefined

string

RuleStatus

机器学习工作区的托管网络出站规则的类型。

名称 类型 说明
Active

string

Inactive

string

RuleType

机器学习工作区的托管网络出站规则的类型。

名称 类型 说明
FQDN

string

PrivateEndpoint

string

ServiceTag

string

ServerlessComputeSettings

名称 类型 说明
serverlessComputeCustomSubnet

string

应在其中部署无服务器计算节点的现有虚拟网络子网的资源 ID

serverlessComputeNoPublicIP

boolean

指示是否在自定义 vNet 中部署的无服务器计算节点对于具有专用终结点的工作区没有公共 IP 地址的标志

ServiceManagedResourcesSettings

名称 类型 说明
cosmosDb

CosmosDbSettings

服务托管 cosmosdb 帐户的设置。

ServiceTagDestination

机器学习工作区的托管网络的服务标记出站规则的服务标记目标。

名称 类型 说明
action

RuleAction

网络规则的操作枚举。

addressPrefixes

string[]

可选,如果提供,将忽略 ServiceTag 属性。

portRanges

string

protocol

string

serviceTag

string

ServiceTagOutboundRule

机器学习工作区的托管网络的服务标记出站规则。

名称 类型 说明
category

RuleCategory

机器学习工作区的托管网络出站规则的类别。

destination

ServiceTagDestination

机器学习工作区的托管网络的服务标记出站规则的服务标记目标。

status

RuleStatus

机器学习工作区的托管网络出站规则的类型。

type string:

ServiceTag

机器学习工作区的托管网络出站规则的类型。

SharedPrivateLinkResource

名称 类型 说明
name

string

专用链接的唯一名称。

properties.groupId

string

专用链接资源组 ID。

properties.privateLinkResourceId

string

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

properties.requestMessage

string

请求消息。

properties.status

PrivateEndpointServiceConnectionStatus

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

Sku

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

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

UserAssignedIdentity

用户分配的标识属性

名称 类型 说明
clientId

string

分配的标识的客户端 ID。

principalId

string

已分配标识的主体 ID。

Workspace

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

名称 类型 默认值 说明
id

string

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

identity

ManagedServiceIdentity

资源的标识。

kind

string

location

string

指定资源的位置。

name

string

资源的名称

properties.allowPublicAccessWhenBehindVnet

boolean

False

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

properties.applicationInsights

string

与此工作区关联的应用程序见解的 ARM ID。

properties.associatedWorkspaces

string[]

properties.containerRegistry

string

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

properties.description

string

此工作区的说明。

properties.discoveryUrl

string

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

properties.enableDataIsolation

boolean

properties.encryption

EncryptionProperty

Azure ML 工作区的加密设置。

properties.featureStoreSettings

FeatureStoreSettings

功能存储类型工作区的设置。

properties.friendlyName

string

此工作区的友好名称。 此名称以可变为单位

properties.hbiWorkspace

boolean

False

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

properties.hubResourceId

string

properties.imageBuildCompute

string

映像生成的计算名称

properties.keyVault

string

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

properties.managedNetwork

ManagedNetworkSettings

机器学习工作区的托管网络设置。

properties.mlFlowTrackingUri

string

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

properties.notebookInfo

NotebookResourceInfo

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

properties.primaryUserAssignedIdentity

string

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

properties.privateEndpointConnections

PrivateEndpointConnection[]

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

properties.privateLinkCount

integer

工作区中的专用连接计数

properties.provisioningState

ProvisioningState

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

properties.publicNetworkAccess

PublicNetworkAccess

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

properties.serverlessComputeSettings

ServerlessComputeSettings

在工作区中创建的无服务器计算的设置

properties.serviceManagedResourcesSettings

ServiceManagedResourcesSettings

服务托管的资源设置。

properties.serviceProvisionedResourceGroup

string

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

properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

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

properties.storageAccount

string

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

properties.storageHnsEnabled

boolean

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

properties.tenantId

string

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

properties.v1LegacyMode

boolean

False

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

properties.workspaceHubConfig

WorkspaceHubConfig

WorkspaceHub 的配置对象。

properties.workspaceId

string

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

sku

Sku

工作区的 SKU。

systemData

systemData

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

tags

object

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

type

string

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

WorkspaceHubConfig

WorkspaceHub 的配置对象。

名称 类型 说明
additionalWorkspaceStorageAccounts

string[]

defaultWorkspaceResourceGroup

string

WorkspaceUpdateParameters

用于更新机器学习工作区的参数。

名称 类型 说明
identity

ManagedServiceIdentity

资源的标识。

properties.applicationInsights

string

与此工作区关联的应用程序见解的 ARM ID。

properties.containerRegistry

string

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

properties.description

string

此工作区的说明。

properties.enableDataIsolation

boolean

properties.encryption

EncryptionUpdateProperties

properties.featureStoreSettings

FeatureStoreSettings

功能存储类型工作区的设置。

properties.friendlyName

string

此工作区的友好名称。

properties.imageBuildCompute

string

映像生成的计算名称

properties.managedNetwork

ManagedNetworkSettings

机器学习工作区的托管网络设置。

properties.primaryUserAssignedIdentity

string

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

properties.publicNetworkAccess

PublicNetworkAccess

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

properties.serverlessComputeSettings

ServerlessComputeSettings

在工作区中创建的无服务器计算的设置

properties.serviceManagedResourcesSettings

ServiceManagedResourcesSettings

服务托管的资源设置。

properties.v1LegacyMode

boolean

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

sku

Sku

工作区的 SKU。

tags

object

机器学习工作区的资源标记。