Workspace 類別

將私人端點新增至工作區。

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

參數

傳回

建立新的 Azure Machine Learning 工作區。

如果工作區已經存在，或未滿足任何工作區需求，則會擲回例外狀況。

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 資源識別碼格式重複使用現有的 Azure 資源。 您可以透過 Azure 入口網站或 SDK 擷取特定的 Azure 資源識別碼。 這假設資源群組、儲存體帳戶、金鑰保存庫、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 Machine Learning 工作區相關聯的資源。

delete(delete_dependent_resources=False, no_wait=False)

參數

傳回

刪除工作區的連線。

delete_connection(name)

參數

刪除工作區的私人端點連線。

delete_private_endpoint_connection(private_endpoint_connection_name)

參數

診斷工作區設定問題。

diagnose_workspace(diagnose_parameters)

參數

傳回

從現有的 Azure Machine Learning 工作區傳回工作區物件。

從檔案讀取工作區組態。 如果找不到組態檔，則會擲回例外狀況。

方法提供簡單的方法，可在多個 Python 筆記本或項目中重複使用相同的工作區。 使用者可以使用 write_config 方法來儲存工作區 Azure Resource Manager （ARM） 屬性，並使用此方法在不同的 Python 筆記本或專案中載入相同的工作區，而不需要重新系結工作區 ARM 屬性。

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

參數

傳回

傳回現有 Azure Machine Learning 工作區的工作區物件。

如果工作區不存在，或必要的字段無法唯一識別工作區，則會擲回例外狀況。

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，其中包含訂用帳戶標識碼、資源群組和工作區名稱。

• name：此工作區的名稱。

• location：工作區區域。

• type：格式為 “{providerName}/workspaces” 的 URI。

• 標籤：目前未使用。

• workspaceid：此工作區的標識符。

• 描述：目前未使用。

• friendlyName：UI 中顯示的工作區易記名稱。

• creationTime：建立此工作區的時間，ISO8601格式。

• containerRegistry：用來提取和推送實驗和Web服務映像的工作區容器登錄。

• keyVault：用來儲存使用者新增至工作區之認證的工作區密鑰保存庫。

• applicationInsights：工作區將使用Application Insights來記錄Web服務事件。

• 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'，在此情況下，工作區會建立具有認證的系統數據存放區。 如果設定為 「身分識別」，工作區將會建立沒有認證的系統數據存放區。

如需這些機碼/值組的詳細資訊，請參閱 create。

取得工作區的 MLflow 追蹤 URI。

MLflow （https://mlflow.org/） 是一個開放原始碼平臺，用於追蹤機器學習實驗和管理模型。 您可以將 MLflow 記錄 API 與 Azure Machine Learning 搭配使用，以便將計量、模型和成品記錄到您的 Azure Machine Learning 工作區。

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 Resource Manager （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。

傳回

傳回此工作區的訂用帳戶標識碼。

傳回

傳回此工作區的標籤。

傳回

傳回工作區中的 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'