通过

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

az ml workspace

Note

此参考是 Azure CLI（版本 2.0.28 或更高版本）的 azure-cli-ml 扩展的一部分。 该扩展将在首次运行 az ml workspace 命令时自动安装。 了解更多关于扩展的信息。

工作区子组命令。

命令

名称 说明 类型 Status
az ml workspace create

创建工作区。

 Extension GA
az ml workspace delete

删除工作区。

 Extension GA
az ml workspace diagnose

诊断工作区设置问题。

 Extension GA
az ml workspace list

列出工作区。

 Extension GA
az ml workspace list-keys

列出依赖资源的工作区密钥，例如存储、acr 和应用见解。

 Extension GA
az ml workspace private-endpoint

工作区专用终结点子组命令。

 Extension GA
az ml workspace private-endpoint add

将专用终结点添加到工作区。

 Extension GA
az ml workspace private-endpoint delete

删除工作区中的指定专用终结点连接。

 Extension GA
az ml workspace private-endpoint list

列出工作区中的所有专用终结点。

 Extension GA
az ml workspace share

与具有给定角色的其他用户共享工作区。

 Extension GA
az ml workspace show

显示工作区。

 Extension GA
az ml workspace sync-keys

同步依赖资源的工作区密钥，例如存储、acr 和应用见解。

 Extension GA
az ml workspace update

更新工作区。

 Extension GA
az ml workspace update-dependencies

更新工作区相关资源。

 Extension GA

az ml workspace create

创建工作区。

az ml workspace create --workspace-name
                       [--adb-workspace]
                       [--application-insights]
                       [--cmk-keyvault]
                       [--container-registry]
                       [--exist-ok]
                       [--friendly-name]
                       [--hbi-workspace]
                       [--keyvault]
                       [--location]
                       [--pe-auto-approval]
                       [--pe-name]
                       [--pe-resource-group]
                       [--pe-subnet-name]
                       [--pe-subscription-id]
                       [--pe-vnet-name]
                       [--primary-user-assigned-identity]
                       [--resource-cmk-uri]
                       [--resource-group]
                       [--sku]
                       [--storage-account]
                       [--system_datastores_auth_mode]
                       [--tags]
                       [--user-assigned-identity-for-cmk-encryption]
                       [--v1-legacy-mode]
                       [--yes]

必需参数

--workspace-name -w

工作区名称。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--adb-workspace

要链接到此工作区的 Adb 工作区。

--application-insights

要与此工作区关联的 Application Insights。

--cmk-keyvault

包含 Azure 资源 ID 格式的客户托管密钥的密钥保管库。

--container-registry

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

--exist-ok

如果工作区存在，请不要失败。

属性 值
默认值: False
--friendly-name -f

此工作区的友好名称。

--hbi-workspace

指定客户数据是否具有高业务影响（HBI），即是否包含敏感的业务信息。

属性 值
默认值: False
--keyvault

要与此工作区关联的 Key Vault。

--location -l

资源的位置。

--pe-auto-approval

是否应自动批准通过专用链接与工作区资源的专用终结点连接。

属性 值
默认值: False
--pe-name

工作区专用终结点的名称。 使用此参数通过专用终结点限制对专用网络的工作区访问。

--pe-resource-group

要在其中创建工作区专用终结点的现有资源组的名称。 vnet 应位于同一资源组中。 如果未指定，将使用工作区的资源组。

--pe-subnet-name

要在其中创建工作区专用终结点的现有子网的名称。

属性 值
默认值: default
--pe-subscription-id

要在其中创建工作区专用终结点的现有订阅的 ID。 vnet 应位于同一订阅中。 如果未指定，将使用工作区的订阅 ID。

--pe-vnet-name

要在其中创建工作区专用终结点的现有 vnet 的名称。

--primary-user-assigned-identity

用于表示工作区标识的用户分配标识的 resourceId。

--resource-cmk-uri

用于加密静态数据的客户托管密钥的密钥 URI。

--resource-group -g

资源组名称。

--sku

工作区的 SKU/版本 -can 为“基本”工作区或功能丰富的“企业”工作区。

属性 值
默认值: basic
--storage-account

要与此工作区关联的存储帐户。

--system_datastores_auth_mode

确定是否使用工作区“workspaceblobstore”和“workspacefilestore”的系统数据存储的凭据。 默认值为“accessKey”，在这种情况下，工作区将使用凭据创建系统数据存储。 如果设置为“identity”，工作区将创建没有凭据的系统数据存储。

属性 值
默认值: accessKey
--tags -t

与此工作区关联的标记与“key=value”语法相关联。

--user-assigned-identity-for-cmk-encryption

需要用于访问加密密钥的用户分配标识的 resourceId。

--v1-legacy-mode -v

如果设置此参数 true，则阻止在公共 Azure 资源管理器上使用 v2 API 服务。 在 aka.ms/amlv2network 了解详细信息。

--yes -y

为此工作区创建资源组。

属性 值
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az ml workspace delete

删除工作区。

az ml workspace delete [--all-resources]
                       [--no-wait]
                       [--output-metadata-file]
                       [--path]
                       [--resource-group]
                       [--subscription-id]
                       [--workspace-name]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--all-resources

删除此工作区依赖的资源，例如存储、acr、kv 和应用见解。

属性 值
默认值: False
--no-wait

不要等待工作区删除完成。

属性 值
默认值: False
--output-metadata-file -t

为结构化对象输出提供可选的输出文件位置。

--path

用于运行配置文件的根目录的路径。

属性 值
默认值: .
--resource-group -g

资源组名称。

--subscription-id

指定订阅 ID。

--workspace-name -w

工作区名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az ml workspace diagnose

诊断工作区设置问题。

az ml workspace diagnose [--output-metadata-file]
                         [--path]
                         [--resource-group]
                         [--subscription-id]
                         [--workspace-name]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

为结构化对象输出提供可选的输出文件位置。

--path

用于运行配置文件的根目录的路径。

属性 值
默认值: .
--resource-group -g

资源组名称。

--subscription-id

指定订阅 ID。

--workspace-name -w

工作区名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az ml workspace list

列出工作区。

az ml workspace list [--resource-group]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

资源组名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az ml workspace list-keys

列出依赖资源的工作区密钥，例如存储、acr 和应用见解。

az ml workspace list-keys [--output-metadata-file]
                          [--path]
                          [--resource-group]
                          [--subscription-id]
                          [--workspace-name]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

为结构化对象输出提供可选的输出文件位置。

--path

用于运行配置文件的根目录的路径。

属性 值
默认值: .
--resource-group -g

资源组名称。

--subscription-id

指定订阅 ID。

--workspace-name -w

工作区名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az ml workspace share

与具有给定角色的其他用户共享工作区。

az ml workspace share --role
                      --user
                      [--output-metadata-file]
                      [--path]
                      [--resource-group]
                      [--subscription-id]
                      [--workspace-name]

必需参数

--role

要分配给此用户的角色。

--user

与之共享此工作区的用户。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

为结构化对象输出提供可选的输出文件位置。

--path

用于运行配置文件的根目录的路径。

属性 值
默认值: .
--resource-group -g

资源组名称。

--subscription-id

指定订阅 ID。

--workspace-name -w

工作区名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az ml workspace show

显示工作区。

az ml workspace show [--output-metadata-file]
                     [--path]
                     [--resource-group]
                     [--subscription-id]
                     [--workspace-name]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

为结构化对象输出提供可选的输出文件位置。

--path

用于运行配置文件的根目录的路径。

属性 值
默认值: .
--resource-group -g

资源组名称。

--subscription-id

指定订阅 ID。

--workspace-name -w

工作区名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az ml workspace sync-keys

同步依赖资源的工作区密钥，例如存储、acr 和应用见解。

az ml workspace sync-keys [--output-metadata-file]
                          [--path]
                          [--resource-group]
                          [--subscription-id]
                          [--workspace-name]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

为结构化对象输出提供可选的输出文件位置。

--path

用于运行配置文件的根目录的路径。

属性 值
默认值: .
--resource-group -g

资源组名称。

--subscription-id

指定订阅 ID。

--workspace-name -w

工作区名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az ml workspace update

更新工作区。

az ml workspace update [--allow-public-access]
                       [--description]
                       [--friendly-name]
                       [--image-build-compute]
                       [--output-metadata-file]
                       [--path]
                       [--primary-user-assigned-identity]
                       [--resource-group]
                       [--subscription-id]
                       [--tags]
                       [--v1-legacy-mode]
                       [--workspace-name]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--allow-public-access

允许公共访问专用链接工作区。

--description -d

此工作区的说明。

--friendly-name -f

友好名称。

--image-build-compute

映像生成的计算目标。

--output-metadata-file -t

为结构化对象输出提供可选的输出文件位置。

--path

用于运行配置文件的根目录的路径。

属性 值
默认值: .
--primary-user-assigned-identity

用于表示工作区标识的用户分配标识的 resourceId。

--resource-group -g

资源组名称。

--subscription-id

指定订阅 ID。

--tags

与此工作区关联的标记与“key=value”语法相关联。

--v1-legacy-mode -v

如果设置此参数 true，则阻止在公共 Azure 资源管理器上使用 v2 API 服务。 在 aka.ms/amlv2network 了解详细信息。

--workspace-name -w

工作区名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az ml workspace update-dependencies

更新工作区相关资源。

az ml workspace update-dependencies [--acr]
                                    [--force]
                                    [--output-metadata-file]
                                    [--path]
                                    [--resource-group]
                                    [--subscription-id]
                                    [--workspace-name]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acr

要更新此工作区的容器注册表的 arm ID。

--force

在没有用户确认的情况下强制更新依赖资源。

属性 值
默认值: False
--output-metadata-file -t

为结构化对象输出提供可选的输出文件位置。

--path

用于运行配置文件的根目录的路径。

属性 值
默认值: .
--resource-group -g

资源组名称。

--subscription-id

指定订阅 ID。

--workspace-name -w

工作区名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False