Workspace クラス

リファレンス

トレーニングおよびデプロイの成果物を管理するための Azure Machine Learning リソースを定義します。

ワークスペースは、Azure Machine Learning での機械学習のための基本的なリソースです。ワークスペースを使用して、機械学習モデルを実験、トレーニング、デプロイします。各ワークスペースは、Azure サブスクリプションとリソースグループに関連付けられており、SKU が関連付けられています。

ワークスペースの詳細については、以下を参照してください。

既存の Azure Machine Learning ワークスペースを読み込むクラスワークスペースコンストラクター。

継承: builtins.object

Workspace

コンストラクター

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	ServicePrincipalAuthentication または InteractiveLoginAuthentication または MsiAuthentication 認証オブジェクト。詳細については、https://aka.ms/aml-notebook-auth を参照してください。None の場合は、既定の Azure CLI 資格情報が使用されるか、API によって資格情報の入力が求められます。規定値: None
_location	str 内部使用のみ。規定値: None
_disable_service_check	bool 内部使用のみ。規定値: 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 必須	ServicePrincipalAuthentication または InteractiveLoginAuthentication または MsiAuthentication 認証オブジェクト。詳細については、https://aka.ms/aml-notebook-auth を参照してください。None の場合は、既定の Azure CLI 資格情報が使用されるか、API によって資格情報の入力が求められます。
_location 必須	str 内部使用のみ。
_disable_service_check 必須	bool 内部使用のみ。
_workspace_id 必須	str 内部使用のみ。
sku 必須	str このパラメーターは下位互換性のために存在するもので、無視されます。
tags	dict ワークスペースに関連付けるタグ。規定値: 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 Machine Learning での認証」を参照してください。

メソッド

add_private_endpoint	ワークスペースにプライベートエンドポイントを追加します。
create	新しい Azure Machine Learning ワークスペースを作成します。ワークスペースが既に存在する場合、またはワークスペースの要件のいずれかが満たされていない場合は、例外をスローします。
delete	Azure Machine Learning ワークスペースに関連付けられているリソースを削除します。
delete_connection	ワークスペースの接続を削除します。
delete_private_endpoint_connection	ワークスペースへのプライベートエンドポイント接続を削除します。
diagnose_workspace	ワークスペースのセットアップに関する問題を診断します。
from_config	既存の Azure Machine Learning ワークスペースからワークスペースオブジェクトを返します。ファイルからワークスペースの構成を読み取ります。構成ファイルが見つからない場合は、例外をスローします。このメソッドを使用すると、複数の Python ノートブックまたはプロジェクト間で同じワークスペースを簡単に再利用できます。ユーザーは write_config メソッドを使用して、ワークスペースの Azure Resource Manager (ARM) のプロパティを保存できます。また、このメソッドを使用すると、ワークスペースの ARM プロパティを再入力することなく、別の Python ノートブックやプロジェクトに同じワークスペースを読み込むことができます。
get	既存の Azure Machine Learning ワークスペースのワークスペースオブジェクトを返します。ワークスペースが存在しない場合、または必須フィールドによってワークスペースが一意に識別されない場合、例外をスローします。
get_connection	ワークスペースの接続を取得します。
get_default_compute_target	ワークスペースの既定のコンピューティングターゲットを取得します。
get_default_datastore	ワークスペースの既定のデータストアを取得します。
get_default_keyvault	ワークスペースの既定のキーコンテナーオブジェクトを取得します。
get_details	ワークスペースの詳細を返します。
get_mlflow_tracking_uri	ワークスペースの MLflow 追跡 URI を取得します。 MLflow (https://mlflow.org/) は、機械学習実験を追跡するため、およびモデルを管理するためのオープンソースプラットフォームです。 Azure Machine Learning ワークスペースにメトリック、モデル、成果物がログとして記録されるようにするために、Azure Machine Learning で MLflow ロギング API を使用できます。
get_run	ワークスペース内の指定された run_id を持つ実行を返します。
list	ユーザーがサブスクリプション内でアクセス権を持つすべてのワークスペースをリストします。ワークスペースのリストは、リソースグループに基づいてフィルター処理できます。
list_connections	このワークスペース下の接続をリストします。
list_keys	現在のワークスペースのキーをリストします。
set_connection	ワークスペース下に接続を追加または更新します。
set_default_datastore	ワークスペースの既定のデータストアを設定します。
setup	新しいワークスペースを作成するか、既存のワークスペースを取得します。
sync_keys	ワークスペースをトリガーして、キーをただちに同期します。ワークスペース内のリソースのキーが変更された場合、それらのキーが自動的に更新されるのに約 1 時間かかる場合があります。この関数を使用すると、必要に応じてキーを更新できます。たとえば、ストレージキーを再生成した後、ストレージにただちにアクセスする必要がある場合などに使用します。
update	ワークスペースに関連付けられているフレンドリ名、説明、タグ、イメージビルドコンピューティング、その他の設定を更新します。
update_dependencies	次の場合は、ワークスペースに関連付けられている既存のリソースを更新します。 a) ユーザーが関連付けられている既存のリソースを誤って削除し、ワークスペース全体を再作成せずにそのリソースを新しいリソースで更新したい場合。 b) ユーザーが関連付けられている既存のリソースを所有し、ワークスペースに関連付けられている現在のリソースを置き換えたい場合。 c) 関連付けられているリソースがまだ作成されていない一方で、ユーザーが既に所有している既存のリソースを使用したい場合 (コンテナーレジストリにのみ適用されます)。
write_config	ワークスペースの Azure Resource Manager (ARM) プロパティを構成ファイルに書き込みます。ワークスペースの ARM プロパティは、from_config メソッドを使用して後で読み込むことができます。 `path` の既定値は、現在の作業ディレクトリ内の '.azureml/' で、`file_name` の既定値は 'config.json' です。このメソッドを使用すると、複数の Python ノートブックまたはプロジェクト間で同じワークスペースを簡単に再利用できます。ユーザーは、この関数を使用してワークスペース ARM プロパティを保存し、from_config を使用してワークスペースの ARM プロパティを再入力することなく、別の Python ノートブックまたはプロジェクトに同じワークスペースを読み込むことができます。

add_private_endpoint

ワークスペースにプライベートエンドポイントを追加します。

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

パラメーター

名前	説明
private_endpoint_config 必須	PrivateEndPointConfig ワークスペースにプライベートエンドポイントを作成するためのプライベートエンドポイント構成。
private_endpoint_auto_approval	bool プライベートエンドポイントの作成を Azure Private Link センターから自動承認するか、手動で承認するかを示すブール値フラグ。手動による承認の場合、ユーザーは Private Link ポータルで保留中の要求を表示して、その要求を承認または拒否できます。規定値: True
location	string プライベートエンドポイントの場所 (既定値はワークスペースの場所) 規定値: None
show_output	bool ワークスペース作成の進行状況を表示するためのフラグ規定値: True
tags	dict ワークスペースに関連付けるタグ。規定値: None

戻り値

型	説明
PrivateEndPoint	作成された PrivateEndPoint オブジェクト。

create

新しい 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)

パラメーター

名前	説明
name 必須	str 新しいワークスペースの名前。名前は 2 から 32 文字の長さでなければなりません。名前の最初の文字は英数字 (英文字または数字) である必要がありますが、名前の残りの部分には、英数字、ハイフン、アンダースコアを含めることができます。空白は使用できません。
auth	ServicePrincipalAuthentication または InteractiveLoginAuthentication 認証オブジェクト。詳細については、https://aka.ms/aml-notebook-auth を参照してください。None の場合は、既定の Azure CLI 資格情報が使用されるか、API によって資格情報の入力が求められます。規定値: None
subscription_id	str 新しいワークスペースの包含元サブスクリプションのサブスクリプション ID。ユーザーが複数のサブスクリプションへのアクセス権を持つ場合、このパラメーターは必須です。規定値: None
resource_group	str ワークスペースを含む Azure リソースグループ。このパラメーターの既定値は、ワークスペース名の変化形です。規定値: None
location	str ワークスペースの場所。このパラメーターの既定値は、リソースグループの場所です。この場所は、Azure Machine Learning でサポートされているリージョンである必要があります。規定値: None
create_resource_group	bool リソースグループが存在しない場合に作成するかどうかを示します。規定値: True
sku	str このパラメーターは下位互換性のために存在するもので、無視されます。規定値: basic
tags	dict ワークスペースに関連付けるタグ。規定値: 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 のリソース 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」のように入力します。キーを作成してその URI を取得する手順については、https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal を参照してください。規定値: None
hbi_workspace	bool ワークスペースに High Business Impact (HBI) のデータが含まれているかどうか、つまり、ビジネスに関連する機密情報が含まれているかどうかを指定します。このフラグは、ワークスペースの作成時にのみ設定できます。ワークスペースが作成された後、この値は変更できません。既定値は False です。 True に設定すると、追加の暗号化手順が実行され、SDK コンポーネントによっては、内部的に収集されたテレメトリで編集済みの情報が生成されます。詳細については、「データの暗号化」を参照してください。このフラグが True に設定されていると、1 つの影響として、問題のトラブルシューティングが困難になる可能性があります。これは、このフラグが True である場合は、一部のテレメトリが Microsoft に送信されず、成功率または問題の種類への可視性が低下し、それによって事前に対応できなくなる可能性があるために発生することがあります。このフラグでは、True にする厳密な必要性がない限り、既定値の False を使用することをお勧めします。規定値: False
default_cpu_compute_target	AmlComputeProvisioningConfiguration (非推奨) CPU コンピューティングの作成に使用する構成。パラメーターの既定値は {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} です。None の場合、コンピューティングは作成されません。規定値: None
default_gpu_compute_target	AmlComputeProvisioningConfiguration (非推奨) GPU コンピューティングの作成に使用する構成。パラメーターの既定値は {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} です。None の場合、コンピューティングは作成されません。規定値: None
private_endpoint_config	PrivateEndPointConfig Azure ML ワークスペースにプライベートエンドポイントを作成するためのプライベートエンドポイント構成。規定値: None
private_endpoint_auto_approval	bool プライベートエンドポイントの作成を Azure Private Link センターから自動承認するか、手動で承認するかを示すブール値フラグ。手動による承認の場合、ユーザーは Private Link ポータルで保留中の要求を表示して、その要求を承認または拒否できます。規定値: True
exist_ok	bool ワークスペースが既に存在する場合に、このメソッドを成功させるかどうかを指定します。 False の場合、ワークスペースが存在する場合には、このメソッドは失敗します。 True の場合、ワークスペースが存在する場合には、このメソッドはその既存のワークスペースを返します。規定値: False
show_output	bool このメソッドで進行状況を段階的に出力するかどうかを指定します。規定値: True
user_assigned_identity_for_cmk_encryption	str カスタマーマネージドキーへのアクセスに使用する必要があるユーザー割り当て ID のリソース ID 規定値: None
system_datastores_auth_mode	str 'workspaceblobstore' および 'workspacefilestore' ワークスペースのシステムデータストアに資格情報を使用するかどうかを決定します。既定値は 'accessKey' です。この値を使用すると、ワークスペースで資格情報を使用してシステムデータストアが作成されます。 'identity' に設定すると、ワークスペースで資格情報を使用せずにシステムデータストアが作成されます。規定値: accessKey
v1_legacy_mode	bool パブリック Azure Resource Managerでの v2 API サービスの使用を禁止する規定値: None

戻り値

型	説明
Workspace	ワークスペースオブジェクト。

例外

型	説明
WorkspaceException	ワークスペースの作成に問題がある場合に発生します。

注釈

この最初の例では、最小限の項目のみ指定する必要があり、すべての依存リソースとリソースグループは自動的に作成されます。


   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 リソース ID は、Azure portal または SDK を使用して取得できます。ここでは、リソースグループ、ストレージアカウント、キーコンテナー、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 Machine Learning ワークスペースに関連付けられているリソースを削除します。

delete(delete_dependent_resources=False, no_wait=False)

パラメーター

名前	説明
delete_dependent_resources	bool ワークスペースに関連付けられているリソース (コンテナーレジストリ、ストレージアカウント、キーコンテナー、Application Insights など) を削除するかどうか。既定値は False です。これらのリソースを削除するには、True に設定します。規定値: False
no_wait	bool ワークスペースの削除が完了するまで待機するかどうか。規定値: False

戻り値

型	説明
None	成功した場合は None を返し、それ以外の場合はエラーをスローします。

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 Machine Learning ワークスペースからワークスペースオブジェクトを返します。

ファイルからワークスペースの構成を読み取ります。構成ファイルが見つからない場合は、例外をスローします。

このメソッドを使用すると、複数の Python ノートブックまたはプロジェクト間で同じワークスペースを簡単に再利用できます。ユーザーは write_config メソッドを使用して、ワークスペースの Azure Resource Manager (ARM) のプロパティを保存できます。また、このメソッドを使用すると、ワークスペースの ARM プロパティを再入力することなく、別の Python ノートブックやプロジェクトに同じワークスペースを読み込むことができます。

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

パラメーター

名前	説明
path	str 検索する構成ファイルまたは開始ディレクトリへのパス。このパラメーターは、既定では、現在のディレクトリから検索を開始することに設定されます。規定値: None
auth	ServicePrincipalAuthentication または InteractiveLoginAuthentication 認証オブジェクト。詳細については、https://aka.ms/aml-notebook-auth を参照してください。None の場合は、既定の Azure CLI 資格情報が使用されるか、API によって資格情報の入力が求められます。規定値: None
_logger	Logger 既定のロガーをオーバーライドできるようにします。規定値: None
_file_name	str パスがディレクトリパスである場合に、検索する構成ファイル名をオーバーライドできるようにします。規定値: None

戻り値

型	説明
Workspace	既存の Azure ML ワークスペースのワークスペースオブジェクト。

get

既存の Azure Machine Learning ワークスペースのワークスペースオブジェクトを返します。

ワークスペースが存在しない場合、または必須フィールドによってワークスペースが一意に識別されない場合、例外をスローします。

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

パラメーター

名前	説明
name 必須	str 取得するワークスペースの名前。
auth	ServicePrincipalAuthentication または InteractiveLoginAuthentication 認証オブジェクト。詳細については、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

戻り値

型	説明
Workspace	ワークスペースオブジェクト。

get_connection

ワークスペースの接続を取得します。

get_connection(name)

パラメーター

名前	説明
name 必須	str ワークスペース下の接続の一意の名前

get_default_compute_target

ワークスペースの既定のコンピューティングターゲットを取得します。

get_default_compute_target(type)

パラメーター

名前	説明
type 必須	str コンピューティングの種類。使用できる値は、'CPU' または 'GPU' です。

戻り値

型	説明
ComputeTarget	指定されたコンピューティングの種類の既定のコンピューティングターゲット。

get_default_datastore

ワークスペースの既定のデータストアを取得します。

get_default_datastore()

戻り値

型	説明
Datastore	既定のデータストア。

get_default_keyvault

ワークスペースの既定のキーコンテナーオブジェクトを取得します。

get_default_keyvault()

戻り値

型	説明
Keyvault	ワークスペースに関連付けられている KeyVault オブジェクト。

get_details

ワークスペースの詳細を返します。

get_details()

戻り値

型	説明
dict[str, str]	ディクショナリ形式のワークスペースの詳細。

注釈

返されるディクショナリには、次のキーと値のペアが含まれます。

id: このワークスペースリソースを指し、サブスクリプション ID、リソースグループ、ワークスペース名を含む URI。
name: このワークスペースの名前。
location: ワークスペースのリージョン。
type: "{providerName}/workspaces" という形式の URI。
tags: 現在使用されていません。
workspaceid: このワークスペースの ID。
description: 現在使用されていません。
friendlyName: UI に表示されるワークスペースのフレンドリ名。
creationTime: このワークスペースが作成された時刻 (ISO8601 形式)。
containerRegistry: 実験用イメージと Web サービス用イメージの両方をプルおよびプッシュするために使用されるワークスペースコンテナーレジストリ。
keyVault: ユーザーがワークスペースに追加した資格情報を保存するために使用されるワークスペースキーコンテナー。
applicationInsights: Web サービスイベントをログに記録するためにワークスペースで使用される Application Insights。
identityPrincipalId:
identityTenantId
identityType
storageAccount: 実行出力、コード、ログなどを保存するためにワークスペースで使用されるストレージ。
sku: ワークスペース SKU (エディションとも呼ばれます)。このパラメーターは下位互換性のために存在するもので、無視されます。
resourceCmkUri: 保存データを暗号化するためのカスタマーマネージドキーのキー URI。キーを作成してその URI を取得する手順については、https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 を参照してください。
hbiWorkspace: 顧客データがビジネスに大きな影響を与える場合に指定します。
imageBuildCompute: イメージビルドのためのコンピューティングターゲット。
systemDatastoresAuthMode: 'workspaceblobstore' および 'workspacefilestore' ワークスペースのシステムデータストアに資格情報を使用するかどうかを決定します。既定値は 'accessKey' です。この値を使用すると、ワークスペースで資格情報を使用してシステムデータストアが作成されます。 'identity' に設定すると、ワークスペースで資格情報を使用せずにシステムデータストアが作成されます。

これらのキーと値のペアの詳細については、「create」を参照してください。

get_mlflow_tracking_uri

ワークスペースの MLflow 追跡 URI を取得します。

MLflow (https://mlflow.org/) は、機械学習実験を追跡するため、およびモデルを管理するためのオープンソースプラットフォームです。 Azure Machine Learning ワークスペースにメトリック、モデル、成果物がログとして記録されるようにするために、Azure Machine Learning で MLflow ロギング API を使用できます。

get_mlflow_tracking_uri(_with_auth=False)

パラメーター

名前	説明
_with_auth	bool (非推奨) 追跡 URI に認証情報を追加します。規定値: False

戻り値

型	説明
str	MLflow と互換性のある追跡 URI。

注釈

次のサンプルを使用すると、Azure ML ワークスペースにデータを送信するように MLflow 追跡を構成できます。


   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 必須	string 実行 ID。

戻り値

型	説明
Run	送信された実行。

list

ユーザーがサブスクリプション内でアクセス権を持つすべてのワークスペースをリストします。

ワークスペースのリストは、リソースグループに基づいてフィルター処理できます。

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

パラメーター

名前	説明
subscription_id 必須	str ワークスペースをリストする対象のサブスクリプション ID。
auth	ServicePrincipalAuthentication または InteractiveLoginAuthentication 認証オブジェクト。詳細については、https://aka.ms/aml-notebook-auth を参照してください。None の場合は、既定の Azure CLI 資格情報が使用されるか、API によって資格情報の入力が求められます。規定値: None
resource_group	str 返されたワークスペースをフィルター処理するためのリソースグループ。 None の場合、このメソッドでは、指定されたサブスクリプション内のすべてのワークスペースがリストされます。規定値: None

戻り値

型	説明
dict	キーとしてワークスペース名を含み、値としてワークスペースオブジェクトのリストを含むディクショナリ。

list_connections

このワークスペース下の接続をリストします。

list_connections(category=None, target=None)

パラメーター

名前	説明
type 必須	str フィルター処理するこの接続の種類
target	str フィルター処理するこの接続のターゲット規定値: None
category	規定値: None

list_keys

現在のワークスペースのキーをリストします。

list_keys()

戻り値

型	説明
object

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

ワークスペースをトリガーして、キーをただちに同期します。

ワークスペース内のリソースのキーが変更された場合、それらのキーが自動的に更新されるのに約 1 時間かかる場合があります。この関数を使用すると、必要に応じてキーを更新できます。たとえば、ストレージキーを再生成した後、ストレージにただちにアクセスする必要がある場合などに使用します。

sync_keys(no_wait=False)

パラメーター

名前	説明
no_wait	bool ワークスペースでキーの同期が完了するまで待機するかどうか。規定値: False

戻り値

型	説明
None	成功した場合は None を返し、それ以外の場合はエラーをスローします。

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	dict ワークスペースに関連付けるタグ。規定値: 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 を表すユーザー割り当て ID のリソース ID。規定値: None
allow_public_access_when_behind_vnet	bool プライベートリンクワークスペースへのパブリックアクセスを許可します。規定値: None
v1_legacy_mode	bool パブリック Azure Resource Managerで v2 API サービスを使用しないようにする規定値: None

戻り値

型	説明
dict[str, str]	更新された情報のディクショナリ。

update_dependencies

次の場合は、ワークスペースに関連付けられている既存のリソースを更新します。

a) ユーザーが関連付けられている既存のリソースを誤って削除し、ワークスペース全体を再作成せずにそのリソースを新しいリソースで更新したい場合。 b) ユーザーが関連付けられている既存のリソースを所有し、ワークスペースに関連付けられている現在のリソースを置き換えたい場合。 c) 関連付けられているリソースがまだ作成されていない一方で、ユーザーが既に所有している既存のリソースを使用したい場合 (コンテナーレジストリにのみ適用されます)。

update_dependencies(container_registry=None, force=False)

パラメーター

名前	説明
container_registry	str コンテナーレジストリの ARM ID。規定値: None
force	bool 確認のメッセージを表示せずに依存リソースを強制的に更新するかどうか。規定値: False

戻り値

型	説明
Workspace

write_config

ワークスペースの Azure Resource Manager (ARM) プロパティを構成ファイルに書き込みます。

ワークスペースの ARM プロパティは、from_config メソッドを使用して後で読み込むことができます。 path の既定値は、現在の作業ディレクトリ内の '.azureml/' で、file_name の既定値は 'config.json' です。

このメソッドを使用すると、複数の Python ノートブックまたはプロジェクト間で同じワークスペースを簡単に再利用できます。ユーザーは、この関数を使用してワークスペース ARM プロパティを保存し、from_config を使用してワークスペースの ARM プロパティを再入力することなく、別の Python ノートブックまたはプロジェクトに同じワークスペースを読み込むことができます。

write_config(path=None, file_name=None)

パラメーター

名前	説明
path	str config.json ファイルを書き込むためにユーザーが指定した場所。パラメーターの既定値は、現在の作業ディレクトリ内の '.azureml/' です。規定値: None
file_name	str 構成ファイルに使用する名前。このパラメーターの既定値は config.json です。規定値: None

属性

compute_targets

ワークスペース内のすべてのコンピューティングターゲットをリストします。

戻り値

型	説明
dict[str, ComputeTarget]	キーとしてコンピューティングターゲットの名前を含み、値として ComputeTarget オブジェクトを含むディクショナリ。

datasets

ワークスペース内のすべてのデータセットをリストします。

戻り値

型	説明
dict[str, Dataset]	キーとしてデータセット名を含み、値として Dataset オブジェクトを含むディクショナリ。

datastores

ワークスペース内のすべてのデータストアをリストします。この操作では、データストアの資格情報は返されません。

戻り値

型	説明
dict[str, Datastore]	キーとしてデータストア名を含み、値として Datastore オブジェクトを含むディクショナリ。

discovery_url

このワークスペースの探索 URL を返します。

戻り値

型	説明
str	このワークスペースの探索 URL。

environments

ワークスペース内のすべての環境をリストします。

戻り値

型	説明
dict[str, Environment]	キーとして環境名を含み、値として Environment オブジェクトを含むディクショナリ。

experiments

ワークスペース内のすべての実験をリストします。

戻り値

型	説明
dict[str, Experiment]	キーとして実験名を含み、値として Experiment オブジェクトを含むディクショナリ。

images

ワークスペース内のイメージのリストを返します。

モデル管理サービスとの対話で問題が発生した場合、WebserviceException を発生させます。

戻り値

型	説明
dict[str, Image]	キーとしてイメージ名を含み、値として Image オブジェクトを含むディクショナリ。

例外

型	説明
WebserviceException	モデル管理サービスとの対話で問題が発生しました。

linked_services

ワークスペース内のリンクされたすべてのサービスをリストします。

戻り値

型	説明
dict[str, LinkedService]	キーとしてリンクされたサービスの名前を含み、値として LinkedService オブジェクトを含むディクショナリ。

location

このワークスペースの場所を返します。

戻り値

型	説明
str	このワークスペースの場所。

models

ワークスペース内のモデルのリストを返します。

モデル管理サービスとの対話で問題が発生した場合、WebserviceException を発生させます。

戻り値

型	説明
dict[str, Model]	キーとしてモデル名を含み、値として Model オブジェクトを含む、モデルのディクショナリ。

例外

型	説明
WebserviceException	モデル管理サービスとの対話で問題が発生しました。

name

ワークスペース名を返します。

戻り値

型	説明
str	ワークスペース名。

private_endpoints

ワークスペースのすべてのプライベートエンドポイントをリストします。

戻り値

型	説明
dict[str, PrivateEndPoint]	ワークスペースに関連付けられている PrivateEndPoint オブジェクトのディクショナリ。キーはプライベートエンドポイント名です。

resource_group

このワークスペースのリソースグループ名を返します。

戻り値

型	説明
str	リソースグループ名。

service_context

このワークスペースのサービスコンテキストを返します。

戻り値

型	説明
<xref:azureml._restclient.service_context.ServiceContext>	ServiceContext オブジェクトを返します。

sku

このワークスペースの SKU を返します。

戻り値

型	説明
str	このワークスペースの SKU。

subscription_id

このワークスペースのサブスクリプション ID を返します。

戻り値

型	説明
str	サブスクリプション ID です。

webservices

ワークスペース内の Web サービスのリストを返します。

リストを返すときに問題が発生した場合、WebserviceException を発生させます。

戻り値

型	説明
dict[str, Webservice]	ワークスペース内の Web サービスのリスト。

例外

型	説明
WebserviceException	リストを返すときに問題が発生しました。

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'

次の方法で共有

Workspace クラス

コンストラクター

パラメーター

注釈

メソッド

add_private_endpoint

パラメーター

戻り値

create

パラメーター

戻り値

例外

注釈

delete

パラメーター

戻り値

delete_connection

パラメーター

delete_private_endpoint_connection

パラメーター

diagnose_workspace

パラメーター

戻り値

from_config

パラメーター

戻り値

get

パラメーター

戻り値

get_connection

パラメーター

get_default_compute_target

パラメーター

戻り値

get_default_datastore

戻り値

get_default_keyvault

戻り値

get_details

戻り値

注釈

get_mlflow_tracking_uri

パラメーター

戻り値

注釈

get_run

パラメーター

戻り値

list

パラメーター

戻り値

list_connections

パラメーター

list_keys

戻り値

set_connection

パラメーター

set_default_datastore

パラメーター

setup

戻り値

sync_keys

パラメーター

戻り値

update

パラメーター

戻り値

update_dependencies

パラメーター

戻り値

write_config

パラメーター

属性

compute_targets

戻り値

datasets

戻り値

datastores

戻り値