az ml workspace

Note

このリファレンスは、Azure CLI (バージョン 2.15.0 以降) の ml 拡張機能の一部です。 拡張機能は、 az ml workspace コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

Azure ML ワークスペースを管理します。

Azure ML ワークスペースは、Azure Machine Learning の最上位のリソースです。 ML ワークフローで使用される資産とリソースと、トレーニング ジョブから生成されたログと成果物を追跡するための一元的な場所が提供されます。

CLI v1 から v2 にアップグレードする場合は、ワークスペース管理のスコープに次の 2 つの変更が必要です。

• az ml workspace private-endpointコマンドを同等のaz network private-endpointコマンドにアップグレードします。
• また、 az ml workspace share コマンドを同等の az role assignment create コマンドにアップグレードします。

コマンド

名前	説明	型	Status
az ml workspace create	ワークスペースを作成します。	拡張子	GA
az ml workspace delete	ワークスペースを削除します。	拡張子	GA
az ml workspace diagnose	ワークスペースのセットアップに関する問題を診断します。	拡張子	GA
az ml workspace list	サブスクリプション内のすべてのワークスペースを一覧表示します。	拡張子	GA
az ml workspace list-keys	Azure Storage、Azure Container Registry、Azure アプリlication Insights などの依存リソースのワークスペース キーを一覧表示します。	拡張子	GA
az ml workspace outbound-rule	Azure ML ワークスペースのマネージド ネットワークの送信規則を管理します。	拡張子	GA
az ml workspace outbound-rule list	ワークスペースのすべてのマネージド ネットワーク送信規則を一覧表示します。	拡張子	GA
az ml workspace outbound-rule remove	ワークスペースのマネージド ネットワークから送信規則を削除します。	拡張子	GA
az ml workspace outbound-rule set	ワークスペースのマネージド ネットワークで送信規則を追加または更新します。	拡張子	GA
az ml workspace outbound-rule show	ワークスペースのマネージド ネットワーク送信規則の詳細を表示します。	拡張子	GA
az ml workspace provision-network	ワークスペースのマネージド ネットワークをプロビジョニングします。	拡張子	GA
az ml workspace show	ワークスペースの詳細を表示します。	拡張子	GA
az ml workspace sync-keys	Azure Storage、Azure Container Registry、Azure アプリlication Insights などの依存リソースのワークスペース キーを同期します。	拡張子	GA
az ml workspace update	ワークスペースを更新します。	拡張子	GA

az ml workspace create

ワークスペースを作成します。

ワークスペースが作成されると、Azure ML で使用される複数の Azure リソースも既定で作成されます。Azure Storage、Azure Container Registry、Azure Key Vault、Azure アプリlication Insights です。 代わりに、ワークスペース構成 YAML ファイルでリソース ID を指定することで、ワークスペースの作成時に既存の Azure リソース インスタンスを使用できます。

az ml workspace create --resource-group
                       [--allow-roleassignment-on-rg]
                       [--application-insights]
                       [--container-registry]
                       [--default-resource-group]
                       [--description]
                       [--display-name]
                       [--enable-data-isolation]
                       [--file]
                       [--hub-id]
                       [--image-build-compute]
                       [--key-vault]
                       [--kind]
                       [--location]
                       [--managed-network]
                       [--name]
                       [--no-wait]
                       [--primary-user-assigned-identity]
                       [--public-network-access]
                       [--set]
                       [--storage-account]
                       [--system-datastores-auth-mode]
                       [--tags]
                       [--update-dependent-resources]

例

YAML 仕様ファイルからワークスペースを作成します。

az ml workspace create --file workspace.yml --resource-group my-resource-group

必須のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--allow-roleassignment-on-rg -r

プレビュー

ワークスペースがリソース グループ レベルでロールの割り当てを持つことができるかどうかを判断するフラグ。

既定値: True

--application-insights -a

このワークスペースに関連付けられているアプリケーション分析情報の ARM ID。

--container-registry -c

このワークスペースに関連付けられているコンテナー レジストリの ARM ID。

--default-resource-group

プレビュー

ハブの種類のみ。 設定した場合、このハブの子プロジェクトでは、リソース グループによって既定で設定されます。

--description

Azure ML ワークスペースの説明。

--display-name

ワークスペースの表示名。

--enable-data-isolation -e

ワークスペースでデータ分離が有効になっているかどうかを判断するフラグ。 フラグは作成段階でのみ設定でき、更新することはできません。

既定値: False

--file -f

Azure ML ワークスペース仕様を含む YAML ファイルへのローカル パス。 ワークスペースの YAML リファレンス ドキュメントは、 https://aka.ms/ml-cli-v2-workspace-yaml-referenceにあります。

--hub-id

プレビュー

プロジェクトの種類のみ: このプロジェクトの親ハブを定義する ARM ID。

--image-build-compute -i

コンテナー レジストリが VNet の背後にある場合に環境 Docker イメージの構築に使用するコンピューティング ターゲットの名前。

--key-vault -k

このワークスペースに関連付けられているキー コンテナーの ARM ID。

--kind

プレビュー

ワークスペースを特定の種類として指定し、YAML で割り当てられた値 (存在する場合) をオーバーライドします。 既定値は既定値です。 有効な種類は、既定、ハブ、プロジェクトです。

--location -l

新しいワークスペースに使用する場所。

--managed-network -m

プレビュー

ワークスペースのマネージド ネットワーク分離モード。

--name -n

Azure ML ワークスペースの名前。

--no-wait

ワークスペースの作成が完了するまで待つ必要はありません。

既定値: False

--primary-user-assigned-identity -p

複数のユーザー割り当てマネージド ID が指定されている場合の、プライマリ ユーザー割り当てマネージド ID の ARM 識別子。 クラスターレス コンピューティングの既定のマネージド ID でもあります。

--public-network-access

ワークスペースがプライベート リンクが有効になっている場合は、パブリック エンドポイント接続を許可します。

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。

--storage-account -s

このワークスペースに関連付けられているストレージ アカウントの ARM ID。

--system-datastores-auth-mode -d

プレビュー

システム データ ストアの認証モードを指定します。 有効なモードは、アクセスキーと ID です。

--tags

オブジェクトのタグのスペース区切りのキーと値のペア。

--update-dependent-resources -u

--update_dependent_resources を指定すると、ワークスペース依存リソースを更新することに同意できます。 ワークスペースにアタッチされた Azure Container Registry または Application Insights リソースを更新すると、以前のジョブ、デプロイされた推論エンドポイント、またはこのワークスペース内の以前のジョブを再実行する機能の系列が壊れる可能性があります。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml workspace delete

ワークスペースを削除します。

既定では、ワークスペースに関連付けられている依存リソース (Azure Storage、Azure Container Registry、Azure Key Vault、Azure アプリlication Insights) は削除されません。 それらも削除するには、--all-resources を含めます。 ワークスペースを完全に削除するには、--permanently-delete を含めます。

az ml workspace delete --name
                       --resource-group
                       [--all-resources]
                       [--no-wait]
                       [--permanently-delete]
                       [--yes]

必須のパラメーター

--name -n

Azure ML ワークスペースの名前。 既定のワークスペースは、 az configure --defaults workspace=<name>を使用して構成できます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--all-resources

ワークスペースに関連付けられているすべての依存リソース (Azure Storage アカウント、Azure Container Registry、Azure アプリlication Insights、Azure Key Vault) を削除します。

既定値: False

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。 既定値は False です。

既定値: False

--permanently-delete -p

ワークスペースは、ワークスペース データの回復を許可するために、既定で論理的に削除された状態です。 論理的な削除の動作をオーバーライドし、ワークスペースを完全に削除するには、このフラグを設定します。

既定値: False

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml workspace diagnose

ワークスペースのセットアップに関する問題を診断します。

ワークスペースが想定どおりに動作していない場合は、この診断を実行して、ワークスペースが破損しているかどうかを確認できます。 プライベート エンドポイント ワークスペースの場合は、このワークスペースとその依存リソースに対するネットワークセットアップに問題があるかどうかを確認することもできます。

az ml workspace diagnose --name
                         --resource-group
                         [--no-wait]

例

ワークスペースを診断します。

az ml workspace diagnose --name my-workspace-name --no-wait -g my-resource-group

必須のパラメーター

--name -n

Azure ML ワークスペースの名前。 既定のワークスペースは、 az configure --defaults workspace=<name>を使用して構成できます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。 既定値は False です。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml workspace list

サブスクリプション内のすべてのワークスペースを一覧表示します。

ワークスペースの一覧は、リソース グループでフィルター処理できます。

az ml workspace list [--filtered-kinds]
                     [--max-results]
                     [--resource-group]

例

リソース グループ内のすべてのワークスペースを一覧表示する

az ml workspace list --resource-group my-resource-group

--query 引数を使用してすべてのワークスペースを一覧表示し、コマンドの結果に対して JMESPath クエリを実行します。

az ml workspace list --query "[].{Name:name}"  --output table --resource-group my-resource-group

省略可能のパラメーター

--filtered-kinds

プレビュー

指定した種類のワークスペースのみをコンマ区切りリストとして一覧表示します。 有効な種類は、既定、ハブ、プロジェクトです。

--max-results -r

返される結果の最大数。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml workspace list-keys

Azure Storage、Azure Container Registry、Azure アプリlication Insights などの依存リソースのワークスペース キーを一覧表示します。

az ml workspace list-keys --name
                          --resource-group

必須のパラメーター

--name -n

Azure ML ワークスペースの名前。 既定のワークスペースは、 az configure --defaults workspace=<name>を使用して構成できます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml workspace provision-network

ワークスペースのマネージド ネットワークをプロビジョニングします。

マネージド ネットワークをプロビジョニングするワークスペースをトリガーします。 Spark 対応フラグを指定すると、Spark をサポートするためにワークスペースのマネージド ネットワークが準備されます。 既定値は false (指定しない場合) ですが、後でこのフラグを指定してこのコマンドを再度実行することで有効にできます。 一度有効にすると、無効にすることはできません。

az ml workspace provision-network --name
                                  --resource-group
                                  [--include-spark]
                                  [--no-wait]

例

マネージド ネットワークをプロビジョニングします。

az ml workspace provision-network --include-spark --name my-workspace-name --no-wait -g my-resource-group

必須のパラメーター

--name -n

Azure ML ワークスペースの名前。 既定のワークスペースは、 az configure --defaults workspace=<name>を使用して構成できます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--include-spark

Spark ジョブを考慮するためにマネージド ネットワークをプロビジョニングする必要がある場合のブール値 [true/false] です。 フラグが設定されていない場合、既定値は false です。 このフラグを指定してこのコマンドを再度実行することで、後で有効にすることができます。

既定値: False

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。 既定値は False です。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml workspace show

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

az ml workspace show --name
                     --resource-group

必須のパラメーター

--name -n

Azure ML ワークスペースの名前。 既定のワークスペースは、 az configure --defaults workspace=<name>を使用して構成できます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml workspace sync-keys

Azure Storage、Azure Container Registry、Azure アプリlication Insights などの依存リソースのワークスペース キーを同期します。

ワークスペース内の任意のリソースのキーが変更された場合、自動的に更新されるまでに約 1 時間かかることがあります。 このコマンドにより、ワークスペースがトリガーされ、キーが直ちに同期されます。 考えられるシナリオは、ストレージ キーを再生成した後にストレージにすぐにアクセスする必要がある場合です。

az ml workspace sync-keys --name
                          --resource-group
                          [--no-wait]

必須のパラメーター

--name -n

Azure ML ワークスペースの名前。 既定のワークスペースは、 az configure --defaults workspace=<name>を使用して構成できます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。 既定値は False です。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az ml workspace update

ワークスペースを更新します。

'description'、'tags'、および 'friendly_name' のプロパティを更新できます。

az ml workspace update --name
                       --resource-group
                       [--add]
                       [--allow-roleassignment-on-rg]
                       [--application-insights]
                       [--container-registry]
                       [--description]
                       [--display-name]
                       [--file]
                       [--force-string]
                       [--image-build-compute]
                       [--managed-network]
                       [--no-wait]
                       [--primary-user-assigned-identity]
                       [--public-network-access]
                       [--remove]
                       [--set]
                       [--system-datastores-auth-mode]
                       [--update-dependent-resources]

例

YAML 仕様ファイルからワークスペースを更新します。

az ml workspace update --resource-group my-resource-group --name my-workspace-name --file workspace.yml

必須のパラメーター

--name -n

Azure ML ワークスペースの名前。 既定のワークスペースは、 az configure --defaults workspace=<name>を使用して構成できます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

既定値: []

--allow-roleassignment-on-rg -r

プレビュー

ワークスペースがリソース グループ レベルでロールの割り当てを持つことができるかどうかを判断するフラグ。

--application-insights -a

このワークスペースに関連付けられているアプリケーション分析情報の ARM ID。

--container-registry -c

このワークスペースに関連付けられているコンテナー レジストリの ARM ID。

--description

Azure ML ワークスペースの説明。

--display-name

ワークスペースの表示名。

--file -f

Azure ML ワークスペース仕様を含む YAML ファイルへのローカル パス。 ワークスペースの YAML リファレンス ドキュメントは、 https://aka.ms/ml-cli-v2-workspace-yaml-referenceにあります。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

既定値: False

--image-build-compute -i

コンテナー レジストリが VNet の背後にある場合に環境 Docker イメージの構築に使用するコンピューティング ターゲットの名前。

--managed-network -m

プレビュー

ワークスペースのマネージド ネットワーク分離モード。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。 既定値は False です。

既定値: False

--primary-user-assigned-identity -p

このワークスペースに関連付けられているプライマリ ユーザー割り当て ID の ARM ID。

--public-network-access

ワークスペースがプライベート リンクが有効になっている場合は、パブリック エンドポイント接続を許可します。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

既定値: []

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

既定値: []

--system-datastores-auth-mode -d

プレビュー

システム データ ストアの認証モードを指定します。 有効なモードは、アクセスキーと ID です。

--update-dependent-resources -u

--update_dependent_resources を指定すると、ワークスペース依存リソースを更新することに同意できます。 ワークスペースにアタッチされた Azure Container Registry または Application Insights リソースを更新すると、以前のジョブ、デプロイされた推論エンドポイント、またはこのワークスペース内の以前のジョブを再実行する機能の系列が壊れる可能性があります。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。