Workspace 类

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

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

参数

返回

创建新的 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)

参数

返回

例外

注解

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

   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)

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

delete(delete_dependent_resources=False, no_wait=False)

参数

返回

删除工作区的连接。

delete_connection(name)

参数

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

delete_private_endpoint_connection(private_endpoint_connection_name)

参数

诊断工作区设置问题。

diagnose_workspace(diagnose_parameters)

参数

返回

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

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

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

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

参数

返回

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

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

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

参数

返回

获取工作区的连接。

get_connection(name)

参数

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

get_default_compute_target(type)

参数

返回

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

get_default_datastore()

返回

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

get_default_keyvault()

返回

返回工作区的详细信息。

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。

获取工作区的 MLflow 跟踪 URI。

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

get_mlflow_tracking_uri(_with_auth=False)

参数

返回

注解

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

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

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

get_run(run_id)

参数

返回

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

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

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

参数

返回

列出此工作区下的连接。

list_connections(category=None, target=None)

参数

列出当前工作区的密钥。

list_keys()

返回

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

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

参数

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

set_default_datastore(name)

参数

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

static setup()

返回

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

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

sync_keys(no_wait=False)

参数

返回

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

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)

参数

返回

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

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

update_dependencies(container_registry=None, force=False)

参数

返回

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

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

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

write_config(path=None, file_name=None)

参数

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

返回

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

返回

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

返回

返回此工作区的发现 URL。

返回

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

返回

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

返回

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

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

返回

例外

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

返回

返回此工作区的位置。

返回

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

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

返回

例外

返回工作区名称。

返回

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

返回

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

返回

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

返回

返回此工作区的 SKU。

返回

返回此工作区的订阅 ID。

返回

返回此工作区的标记。

返回

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

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

返回

例外

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

DEFAULT_CPU_CLUSTER_NAME = 'cpu-cluster'

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

DEFAULT_GPU_CLUSTER_NAME = 'gpu-cluster'