Workspace 类

定义用于管理训练和部署项目的 Azure 机器学习资源。

工作区是 Azure 机器学习中机器学习的基本资源。 使用工作区来试验、训练和部署机器学习模型。 每个工作区都绑定到 Azure 订阅和资源组,并具有关联的 SKU。

有关工作区的详细信息,请参阅:

用于加载现有 Azure 机器学习工作区的类工作区构造函数。

构造函数

Workspace(subscription_id, resource_group, workspace_name, auth=None, _location=None, _disable_service_check=False, _workspace_id=None, sku='basic', tags=None, _cloud='AzureCloud')

参数

名称 说明
subscription_id
必需
str

包含工作区的 Azure 订阅 ID。

resource_group
必需
str

包含工作区的资源组。

workspace_name
必需
str

现有工作区名称。

auth

身份验证对象。 有关更多详细信息,请参阅 https://aka.ms/aml-notebook-auth。如果为 None,将使用默认的 Azure CLI 凭据,否则 API 将提示输入凭据。

默认值: None
_location
str

仅供内部使用。

默认值: None
_disable_service_check

仅供内部使用。

默认值: False
_workspace_id
str

仅供内部使用。

默认值: None
sku
str

参数存在以实现向后兼容性,将被忽略。

默认值: basic
_cloud
str

仅供内部使用。

默认值: AzureCloud
subscription_id
必需
str

包含工作区的 Azure 订阅 ID。

resource_group
必需
str

包含工作区的资源组。

workspace_name
必需
str

工作区名称。 名称的长度必须介于 2 到 32 个字符之间。 名称的第一个字符必须是字母数字(字母或数字),但名称的其余部分可能包含字母数字、连字符和下划线。 不允许空格。

auth
必需

身份验证对象。 有关更多详细信息,请参阅 https://aka.ms/aml-notebook-auth。如果为 None,将使用默认的 Azure CLI 凭据,否则 API 将提示输入凭据。

_location
必需
str

仅供内部使用。

_disable_service_check
必需

仅供内部使用。

_workspace_id
必需
str

仅供内部使用。

sku
必需
str

参数存在以实现向后兼容性,将被忽略。

tags

要与工作区关联的标记。

默认值: None
_cloud
必需
str

仅供内部使用。

注解

以下示例演示如何创建工作区。


   from azureml.core import Workspace
   ws = Workspace.create(name='myworkspace',
               subscription_id='<azure-subscription-id>',
               resource_group='myresourcegroup',
               create_resource_group=True,
               location='eastus2'
               )

如果需要将一个现有的 Azure 资源组用于该工作区,请将 create_resource_group 设置为 False。

若要在多个环境中使用相同的工作区,请创建 JSON 配置文件。 配置文件保存订阅、资源和工作区名称,以便可以轻松加载它。 若要保存配置,请使用 write_config 该方法。


   ws.write_config(path="./file-path", file_name="ws_config.json")

有关配置文件的示例,请参阅 “创建工作区配置文件 ”。

若要从配置文件加载工作区,请使用 from_config 该方法。


   ws = Workspace.from_config()
   ws.get_details()

或者,使用 get 该方法在不使用配置文件的情况下加载现有工作区。


   ws = Workspace.get(name="myworkspace",
               subscription_id='<azure-subscription-id>',
               resource_group='myresourcegroup')

上面的示例可能会提示你使用交互式登录对话框提供 Azure 身份验证凭据。 有关其他用例,包括使用 Azure CLI 在自动化工作流中进行身份验证和身份验证,请参阅 Azure 机器学习中的身份验证。

方法

add_private_endpoint

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

create

创建新的 Azure 机器学习工作区。

如果工作区已存在或未满足任何工作区要求,则引发异常。

delete

删除 Azure 机器学习工作区关联的资源。

delete_connection

删除工作区的连接。

delete_private_endpoint_connection

删除与工作区的专用终结点连接。

diagnose_workspace

诊断工作区设置问题。

from_config

从现有的 Azure 机器学习工作区中返回工作区对象。

从文件读取工作区配置。 如果找不到配置文件,则引发异常。

该方法提供了一种在多个 Python 笔记本或项目中重复使用同一工作区的简单方法。 用户可以使用 write_config 该方法保存工作区 Azure 资源管理器 (ARM) 属性,并使用此方法在不同的 Python 笔记本或项目中加载同一工作区,而无需重新设置工作区 ARM 属性。

get

返回现有 Azure 机器学习工作区的工作区对象。

如果工作区不存在或必填字段不唯一标识工作区,则引发异常。

get_connection

获取工作区的连接。

get_default_compute_target

获取工作区的默认计算目标。

get_default_datastore

获取工作区的默认数据存储。

get_default_keyvault

获取工作区的默认密钥保管库对象。

get_details

返回工作区的详细信息。

get_mlflow_tracking_uri

获取工作区的 MLflow 跟踪 URI。

MLflow (https://mlflow.org/) 是一个开源平台,用于跟踪机器学习试验和管理模型。 可以将 MLflow 日志记录 API 与 Azure 机器学习配合使用,以便将指标、模型和项目记录到 Azure 机器学习工作区。

get_run

返回工作区中具有指定run_id的运行。

list

列出用户有权在订阅中访问的所有工作区。

可以根据资源组筛选工作区列表。

list_connections

列出此工作区下的连接。

list_keys

列出当前工作区的密钥。

set_connection

在工作区下添加或更新连接。

set_default_datastore

设置工作区的默认数据存储。

setup

创建新工作区或检索现有工作区。

sync_keys

触发工作区以立即同步密钥。

如果工作区中任何资源的密钥已更改,则可能需要大约一个小时才能自动更新它们。 此函数允许在请求时更新密钥。 例如,在重新生成存储密钥后,需要立即访问存储。

update

更新与工作区关联的友好名称、说明、标记、映像生成计算和其他设置。

update_dependencies

在以下情况下更新工作区的现有关联资源。

a) 当用户意外删除现有关联资源,并希望使用新资源进行更新,而无需重新创建整个工作区。 b) 当用户具有现有的关联资源并想要替换与工作区关联的当前资源时。 c) 如果尚未创建关联的资源,并且想要使用它们已有的现有资源(仅适用于容器注册表)。

write_config

将工作区 Azure 资源管理器 (ARM) 属性写入配置文件。

稍后可以使用该方法 from_config 加载工作区 ARM 属性。 默认 path 为当前工作目录中的“.azureml/”, file_name 默认为“config.json”。

该方法提供了在多个 Python 笔记本或项目中重用同一工作区的简单方法。 用户可以使用此函数保存工作区 ARM 属性,并使用from_config在不同的 Python 笔记本或项目中加载同一工作区,而无需重新设置工作区 ARM 属性。

add_private_endpoint

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

add_private_endpoint(private_endpoint_config, private_endpoint_auto_approval=True, location=None, show_output=True, tags=None)

参数

名称 说明
private_endpoint_config
必需

用于创建专用终结点到工作区的专用终结点配置。

private_endpoint_auto_approval

一个布尔标志,表示是否应从 Azure 专用链接中心自动批准或手动批准专用终结点创建。 在手动批准的情况下,用户可以在专用链接门户中查看挂起的请求,以批准/拒绝请求。

默认值: True
location

专用终结点的位置,默认值为工作区位置

默认值: None
show_output

显示工作区创建进度的标志

默认值: True
tags

要与工作区关联的标记。

默认值: None

返回

类型 说明

创建的 PrivateEndPoint 对象。

create

创建新的 Azure 机器学习工作区。

如果工作区已存在或未满足任何工作区要求,则引发异常。

static create(name, auth=None, subscription_id=None, resource_group=None, location=None, create_resource_group=True, sku='basic', tags=None, friendly_name=None, storage_account=None, key_vault=None, app_insights=None, container_registry=None, adb_workspace=None, primary_user_assigned_identity=None, cmk_keyvault=None, resource_cmk_uri=None, hbi_workspace=False, default_cpu_compute_target=None, default_gpu_compute_target=None, private_endpoint_config=None, private_endpoint_auto_approval=True, exist_ok=False, show_output=True, user_assigned_identity_for_cmk_encryption=None, system_datastores_auth_mode='accessKey', v1_legacy_mode=None)

参数

名称 说明
name
必需
str

新的工作区名称。 名称的长度必须介于 2 到 32 个字符之间。 名称的第一个字符必须是字母数字(字母或数字),但名称的其余部分可能包含字母数字、连字符和下划线。 不允许空格。

auth

身份验证对象。 有关更多详细信息,请参阅 https://aka.ms/aml-notebook-auth。如果为 None,将使用默认的 Azure CLI 凭据,否则 API 将提示输入凭据。

默认值: None
subscription_id
str

新工作区的包含订阅的订阅 ID。 如果用户有权访问多个订阅,则需要此参数。

默认值: None
resource_group
str

包含工作区的 Azure 资源组。 参数默认为工作区名称的突变。

默认值: None
location
str

工作区的位置。 参数默认为资源组位置。 该位置必须是 Azure 机器学习 支持的区域 。

默认值: None
create_resource_group

指示是否创建资源组(如果不存在)。

默认值: True
sku
str

参数存在以实现向后兼容性,将被忽略。

默认值: basic
tags

要与工作区关联的标记。

默认值: None
friendly_name
str

可在 UI 中显示的工作区的可选友好名称。

默认值: None
storage_account
str

Azure 资源 ID 格式的现有存储帐户。 工作区将使用存储来保存运行输出、代码、日志等。如果为 None,将创建新的存储帐户。

默认值: None
key_vault
str

Azure 资源 ID 格式的现有密钥保管库。 有关 Azure 资源 ID 格式的详细信息,请参阅以下示例代码。 密钥保管库将由工作区用来存储用户添加到工作区的凭据。 如果为 None,将创建新的密钥保管库。

默认值: None
app_insights
str

Azure 资源 ID 格式的现有 Application Insights。 有关 Azure 资源 ID 格式的详细信息,请参阅以下示例代码。 工作区将使用 Application Insights 记录 Web 服务事件。 如果为 None,将创建新的 Application Insights。

默认值: None
container_registry
str

Azure 资源 ID 格式的现有容器注册表(有关 Azure 资源 ID 格式的详细信息,请参阅下面的示例代码)。 工作区将使用容器注册表来拉取和推送试验和 Web 服务映像。 如果为 None,则仅在需要时创建新的容器注册表,而不随工作区创建一起创建。

默认值: None
adb_workspace
str

Azure 资源 ID 格式的现有 Adb 工作区(有关 Azure 资源 ID 格式的详细信息,请参阅下面的示例代码)。 Adb 工作区将用于与工作区链接。 如果为 None,则不会发生工作区链接。

默认值: None
primary_user_assigned_identity
str

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

默认值: None
cmk_keyvault
str

包含 Azure 资源 ID 格式的客户托管密钥的密钥保管库: /subscriptions/<azure-subscription-id>/resourcegroups/<azure-resource-group>/providers/microsoft.keyvault/vaults/<azure-keyvault-name> 例如:“/subscriptions/d139f240-94e6-4175-87a7-954b9d27db16/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault”有关 Azure 资源 ID 格式的更多详细信息,请参阅以下示例代码。

默认值: None
resource_cmk_uri
str

用于加密静态数据的客户托管密钥的密钥 URI。 URI 格式为: https://<keyvault-dns-name>/keys/<key-name>/<key-version>。 例如,“https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b”。 请参阅 https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal 有关如何创建密钥并获取其 URI 的步骤。

默认值: None
hbi_workspace

指定工作区是否包含高业务影响(HBI)的数据,即是否包含敏感的业务信息。 只能在创建工作区期间设置此标志。 创建工作区后,无法更改其值。 默认值为 False。

设置为 True 时,将执行进一步的加密步骤,并根据 SDK 组件,在内部收集的遥测中生成经过修订的信息。 有关详细信息,请参阅 数据加密。

如果此标志设置为 True,则故障排除问题可能会增加一个可能的影响。 这可能是因为某些遥测未发送到Microsoft,并且成功率或问题类型的可见性较低,因此当此标志为 True 时可能无法主动做出反应。 建议将此标志的默认值为 False,除非严格要求为 True。

默认值: False
default_cpu_compute_target

(已弃用)将用于创建 CPU 计算的配置。 参数默认为 {min_nodes=0,max_nodes=2,vm_size=“STANDARD_DS2_V2”, vm_priority=“dedicated”} 如果为 None,则不会创建计算。

默认值: None
default_gpu_compute_target

(已弃用)将用于创建 GPU 计算的配置。 参数默认为 {min_nodes=0, max_nodes=2, vm_size=“STANDARD_NC6”, vm_priority=“dedicated”} 如果为 None,则不会创建计算。

默认值: None
private_endpoint_config

专用终结点配置,用于创建 Azure ML 工作区的专用终结点。

默认值: None
private_endpoint_auto_approval

一个布尔标志,表示是否应从 Azure 专用链接中心自动批准或手动批准专用终结点创建。 在手动批准的情况下,用户可以在专用链接门户中查看挂起的请求,以批准/拒绝请求。

默认值: True
exist_ok

指示如果工作区已存在,则此方法是否成功。 如果为 False,则此方法在工作区存在时失败。 如果为 True,则此方法返回现有工作区(如果存在)。

默认值: False
show_output

指示此方法是否会输出增量进度。

默认值: True
user_assigned_identity_for_cmk_encryption
str

需要用于访问客户管理密钥的用户分配标识的资源 ID

默认值: None
system_datastores_auth_mode
str

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

默认值: accessKey
v1_legacy_mode

阻止在公共 Azure 资源管理器上使用 v2 API 服务

默认值: None

返回

类型 说明

工作区对象。

例外

类型 说明

创建工作区时出现问题。

注解

第一个示例只需要最少的规范,并且将自动创建所有依赖资源以及资源组。


   from azureml.core import Workspace
   ws = Workspace.create(name='myworkspace',
                         subscription_id='<azure-subscription-id>',
                         resource_group='myresourcegroup',
                         create_resource_group=True,
                         location='eastus2')

以下示例演示如何使用 Azure 资源 ID 格式重用现有的 Azure 资源。 可以通过 Azure 门户或 SDK 检索特定的 Azure 资源 ID。 这假定资源组、存储帐户、密钥保管库、App Insights 和容器注册表已存在。


   import os
   from azureml.core import Workspace
   from azureml.core.authentication import ServicePrincipalAuthentication

   service_principal_password = os.environ.get("AZUREML_PASSWORD")

   service_principal_auth = ServicePrincipalAuthentication(
       tenant_id="<tenant-id>",
       username="<application-id>",
       password=service_principal_password)

   ws = Workspace.create(name='myworkspace',
                         auth=service_principal_auth,
                         subscription_id='<azure-subscription-id>',
                         resource_group='myresourcegroup',
                         create_resource_group=False,
                         location='eastus2',
                         friendly_name='My workspace',
                         storage_account='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.storage/storageaccounts/mystorageaccount',
                         key_vault='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault',
                         app_insights='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.insights/components/myappinsights',
                         container_registry='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.containerregistry/registries/mycontainerregistry',
                         exist_ok=False)

delete

删除 Azure 机器学习工作区关联的资源。

delete(delete_dependent_resources=False, no_wait=False)

参数

名称 说明
delete_dependent_resources

是否删除与工作区关联的资源,例如容器注册表、存储帐户、密钥保管库和应用程序见解。 默认值为 False。 设置为 True 以删除这些资源。

默认值: False
no_wait

是否等待工作区删除完成。

默认值: False

返回

类型 说明

如果成功,则无;否则,将引发错误。

delete_connection

删除工作区的连接。

delete_connection(name)

参数

名称 说明
name
必需
str

工作区下连接的唯一名称

delete_private_endpoint_connection

删除与工作区的专用终结点连接。

delete_private_endpoint_connection(private_endpoint_connection_name)

参数

名称 说明
private_endpoint_connection_name
必需
str

工作区下专用终结点连接的唯一名称

diagnose_workspace

诊断工作区设置问题。

diagnose_workspace(diagnose_parameters)

参数

名称 说明
diagnose_parameters
必需
<xref:_restclient.models.DiagnoseWorkspaceParameters>

诊断工作区运行状况的参数

返回

类型 说明
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.DiagnoseResponseResult>]

返回 DiagnoseResponseResult 的 AzureOperationPoller 实例

from_config

从现有的 Azure 机器学习工作区中返回工作区对象。

从文件读取工作区配置。 如果找不到配置文件,则引发异常。

该方法提供了一种在多个 Python 笔记本或项目中重复使用同一工作区的简单方法。 用户可以使用 write_config 该方法保存工作区 Azure 资源管理器 (ARM) 属性,并使用此方法在不同的 Python 笔记本或项目中加载同一工作区,而无需重新设置工作区 ARM 属性。

static from_config(path=None, auth=None, _logger=None, _file_name=None)

参数

名称 说明
path
str

配置文件的路径或要搜索的起始目录。 参数默认在当前目录中启动搜索。

默认值: None
auth

身份验证对象。 有关更多详细信息,请参阅 https://aka.ms/aml-notebook-auth。如果为 None,将使用默认的 Azure CLI 凭据,否则 API 将提示输入凭据。

默认值: None
_logger

允许重写默认记录器。

默认值: None
_file_name
str

允许重写配置文件名称以在路径为目录路径时搜索。

默认值: None

返回

类型 说明

现有 Azure ML 工作区的工作区对象。

get

返回现有 Azure 机器学习工作区的工作区对象。

如果工作区不存在或必填字段不唯一标识工作区,则引发异常。

static get(name, auth=None, subscription_id=None, resource_group=None, location=None, cloud='AzureCloud', id=None)

参数

名称 说明
name
必需
str

要获取的工作区的名称。

auth

身份验证对象。 有关更多详细信息, https://aka.ms/aml-notebook-auth请参阅 。如果为 None,将使用默认的 Azure CLI 凭据,否则 API 将提示输入凭据。

默认值: None
subscription_id
str

要使用的订阅 ID。 如果用户有权访问多个订阅,则需要此参数。

默认值: None
resource_group
str

要使用的资源组。 如果为 None,该方法将搜索订阅中的所有资源组。

默认值: None
location
str

工作区位置。

默认值: None
cloud
str

目标云的名称。 可以是“AzureCloud”、“AzureChinaCloud”或“AzureUSGovernment”之一。 如果未指定任何云,则使用“AzureCloud”。

默认值: AzureCloud
id
str

工作区的 ID。

默认值: None

返回

类型 说明

工作区对象。

get_connection

获取工作区的连接。

get_connection(name)

参数

名称 说明
name
必需
str

工作区下连接的唯一名称

get_default_compute_target

获取工作区的默认计算目标。

get_default_compute_target(type)

参数

名称 说明
type
必需
str

计算类型。 可能的值为“CPU”或“GPU”。

返回

类型 说明

给定计算类型的默认计算目标。

get_default_datastore

获取工作区的默认数据存储。

get_default_datastore()

返回

类型 说明

默认数据存储。

get_default_keyvault

获取工作区的默认密钥保管库对象。

get_default_keyvault()

返回

类型 说明

与工作区关联的 KeyVault 对象。

get_details

返回工作区的详细信息。

get_details()

返回

类型 说明

字典格式的工作区详细信息。

注解

返回的字典包含以下键值对。

  • id:指向此工作区资源的 URI,其中包含订阅 ID、资源组和工作区名称。

  • 名称:此工作区的名称。

  • 位置:工作区区域。

  • 类型:格式为“{providerName}/workspaces”的 URI。

  • 标记:当前未使用。

  • workspaceid:此工作区的 ID。

  • 说明:当前未使用。

  • friendlyName:UI 中显示的工作区的友好名称。

  • creationTime:创建此工作区的时间,ISO8601格式。

  • containerRegistry:用于拉取和推送试验和 Web 服务映像的工作区容器注册表。

  • keyVault:用于存储用户添加到工作区的凭据的工作区密钥保管库。

  • applicationInsights:工作区将使用 Application Insights 记录 Webservices 事件。

  • identityPrincipalId:

  • identityTenantId

  • identityType

  • storageAccount:工作区将使用存储来保存运行输出、代码、日志等。

  • sku:工作区 SKU(也称为版本)。 参数存在以实现向后兼容性,将被忽略。

  • resourceCmkUri:用于加密静态数据的客户托管密钥的密钥 URI。 请参阅 https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 有关如何创建密钥并获取其 URI 的步骤。

  • hbiWorkspace:指定客户数据是否具有较高的业务影响。

  • imageBuildCompute:映像生成的计算目标。

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

有关这些键值对的详细信息,请参阅 create。

get_mlflow_tracking_uri

获取工作区的 MLflow 跟踪 URI。

MLflow (https://mlflow.org/) 是一个开源平台,用于跟踪机器学习试验和管理模型。 可以将 MLflow 日志记录 API 与 Azure 机器学习配合使用,以便将指标、模型和项目记录到 Azure 机器学习工作区。

get_mlflow_tracking_uri(_with_auth=False)

参数

名称 说明
_with_auth

(已弃用)添加身份验证信息以跟踪 URI。

默认值: False

返回

类型 说明
str

与 MLflow 兼容的跟踪 URI。

注解

使用以下示例将 MLflow 跟踪配置为将数据发送到 Azure ML 工作区:


   import mlflow
   from azureml.core import Workspace
   workspace = Workspace.from_config()
   mlflow.set_tracking_uri(workspace.get_mlflow_tracking_uri())

get_run

返回工作区中具有指定run_id的运行。

get_run(run_id)

参数

名称 说明
run_id
必需

运行 ID。

返回

类型 说明
Run

提交的运行。

list

列出用户有权在订阅中访问的所有工作区。

可以根据资源组筛选工作区列表。

static list(subscription_id, auth=None, resource_group=None)

参数

名称 说明
subscription_id
必需
str

要为其列出工作区的订阅 ID。

auth

身份验证对象。 有关更多详细信息, https://aka.ms/aml-notebook-auth请参阅 。如果为 None,将使用默认的 Azure CLI 凭据,否则 API 将提示输入凭据。

默认值: None
resource_group
str

用于筛选返回的工作区的资源组。 如果为 None,该方法将列出指定订阅中的所有工作区。

默认值: None

返回

类型 说明

一个字典,其中键是工作区名称,值是 Workspace 对象的列表。

list_connections

列出此工作区下的连接。

list_connections(category=None, target=None)

参数

名称 说明
type
必需
str

要筛选的此连接的类型

target
str

要筛选的此连接的目标

默认值: None
category
默认值: None

list_keys

列出当前工作区的密钥。

list_keys()

返回

类型 说明

set_connection

在工作区下添加或更新连接。

set_connection(name, category, target, authType, value)

参数

名称 说明
name
必需
str

工作区下连接的唯一名称

category
必需
str

此连接的类别

target
必需
str

此连接连接到的目标

authType
必需
str

此连接的授权类型

value
必需
str

连接详细信息的 json 格式序列化字符串

set_default_datastore

设置工作区的默认数据存储。

set_default_datastore(name)

参数

名称 说明
name
必需
str

要设置为默认值的名称 Datastore 。

setup

创建新工作区或检索现有工作区。

static setup()

返回

类型 说明

Workspace 对象。

sync_keys

触发工作区以立即同步密钥。

如果工作区中任何资源的密钥已更改,则可能需要大约一个小时才能自动更新它们。 此函数允许在请求时更新密钥。 例如,在重新生成存储密钥后,需要立即访问存储。

sync_keys(no_wait=False)

参数

名称 说明
no_wait

是否等待工作区同步密钥完成。

默认值: False

返回

类型 说明

如果成功,则无;否则,将引发错误。

update

更新与工作区关联的友好名称、说明、标记、映像生成计算和其他设置。

update(friendly_name=None, description=None, tags=None, image_build_compute=None, service_managed_resources_settings=None, primary_user_assigned_identity=None, allow_public_access_when_behind_vnet=None, v1_legacy_mode=None)

参数

名称 说明
friendly_name
str

可在 UI 中显示的工作区的友好名称。

默认值: None
description
str

工作区的说明。

默认值: None
tags

要与工作区关联的标记。

默认值: None
image_build_compute
str

映像生成的计算名称。

默认值: None
service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>

服务托管资源设置。

默认值: None
primary_user_assigned_identity
str

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

默认值: None
allow_public_access_when_behind_vnet

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

默认值: None
v1_legacy_mode

阻止在公共 Azure 资源管理器上使用 v2 API 服务

默认值: None

返回

类型 说明

已更新信息的字典。

update_dependencies

在以下情况下更新工作区的现有关联资源。

a) 当用户意外删除现有关联资源,并希望使用新资源进行更新,而无需重新创建整个工作区。 b) 当用户具有现有的关联资源并想要替换与工作区关联的当前资源时。 c) 如果尚未创建关联的资源,并且想要使用它们已有的现有资源(仅适用于容器注册表)。

update_dependencies(container_registry=None, force=False)

参数

名称 说明
container_registry
str

容器注册表的 ARM ID。

默认值: None
force

如果在未提示确认的情况下强制更新依赖资源。

默认值: False

返回

类型 说明

write_config

将工作区 Azure 资源管理器 (ARM) 属性写入配置文件。

稍后可以使用该方法 from_config 加载工作区 ARM 属性。 默认 path 为当前工作目录中的“.azureml/”, file_name 默认为“config.json”。

该方法提供了在多个 Python 笔记本或项目中重用同一工作区的简单方法。 用户可以使用此函数保存工作区 ARM 属性,并使用from_config在不同的 Python 笔记本或项目中加载同一工作区,而无需重新设置工作区 ARM 属性。

write_config(path=None, file_name=None)

参数

名称 说明
path
str

用户提供的位置来写入 config.json 文件。 参数默认为当前工作目录中的“.azureml/”。

默认值: None
file_name
str

要用于配置文件的名称。 参数默认为 config.json。

默认值: None

属性

compute_targets

列出工作区中的所有计算目标。

返回

类型 说明

将键作为计算目标名称和值作为 ComputeTarget 对象的字典。

datasets

列出工作区中的所有数据集。

返回

类型 说明

包含键作为数据集名称和值作为 Dataset 对象的字典。

datastores

列出工作区中的所有数据存储。 此作不会返回数据存储的凭据。

返回

类型 说明

将键作为数据存储名称和值作为 Datastore 对象的字典。

discovery_url

返回此工作区的发现 URL。

返回

类型 说明
str

此工作区的发现 URL。

environments

列出工作区中的所有环境。

返回

类型 说明

将键作为环境名称和值作为 Environment 对象的字典。

experiments

列出工作区中的所有试验。

返回

类型 说明

将键作为试验名称和值作为 Experiment 对象的字典。

images

返回工作区中的图像列表。

如果与模型管理服务交互时遇到问题,则引发此问题 WebserviceException 。

返回

类型 说明

将键作为图像名称和值作为 Image 对象的字典。

例外

类型 说明

与模型管理服务交互时出现问题。

linked_services

列出工作区中的所有链接服务。

返回

类型 说明

一个字典,其中键是链接的服务名称和值是一个 LinkedService 对象。

location

返回此工作区的位置。

返回

类型 说明
str

此工作区的位置。

models

返回工作区中的模型列表。

如果与模型管理服务交互时遇到问题,则引发此问题 WebserviceException 。

返回

类型 说明

将键作为模型名称和值作为 Model 对象的模型字典。

例外

类型 说明

与模型管理服务交互时出现问题。

name

返回工作区名称。

返回

类型 说明
str

工作区名称。

private_endpoints

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

返回

类型 说明

与工作区关联的 PrivateEndPoint 对象的听写。 密钥是专用终结点名称。

resource_group

返回此工作区的资源组名称。

返回

类型 说明
str

资源组名称。

service_context

返回此工作区的服务上下文。

返回

类型 说明
<xref:azureml._restclient.service_context.ServiceContext>

返回 ServiceContext 对象。

sku

返回此工作区的 SKU。

返回

类型 说明
str

此工作区的 SKU。

subscription_id

返回此工作区的订阅 ID。

返回

类型 说明
str

订阅 ID。

tags

返回此工作区的标记。

返回

类型 说明

此工作区的标记。

webservices

返回工作区中的 Web 服务列表。

如果返回列表时出现问题,则引发错误 WebserviceException 。

返回

类型 说明

工作区中的 Web 服务列表。

例外

类型 说明

返回列表时出现问题。

DEFAULT_CPU_CLUSTER_CONFIGURATION

DEFAULT_CPU_CLUSTER_CONFIGURATION = <azureml.core.compute.amlcompute.AmlComputeProvisioningConfiguration object>

DEFAULT_CPU_CLUSTER_NAME

DEFAULT_CPU_CLUSTER_NAME = 'cpu-cluster'

DEFAULT_GPU_CLUSTER_CONFIGURATION

DEFAULT_GPU_CLUSTER_CONFIGURATION = <azureml.core.compute.amlcompute.AmlComputeProvisioningConfiguration object>

DEFAULT_GPU_CLUSTER_NAME

DEFAULT_GPU_CLUSTER_NAME = 'gpu-cluster'