az ml workspace

リファレンス

Note

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

ワークスペースサブグループコマンド。

コマンド

名前	説明	型	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	ストレージ、acr、アプリの分析情報などの依存リソースのワークスペースキーを一覧表示します。	拡張子	GA
az ml workspace private-endpoint	ワークスペースプライベートエンドポイントサブグループコマンド。	拡張子	GA
az ml workspace private-endpoint add	ワークスペースにプライベートエンドポイントを追加します。	拡張子	GA
az ml workspace private-endpoint delete	ワークスペース内の指定したプライベートエンドポイント接続を削除します。	拡張子	GA
az ml workspace private-endpoint list	ワークスペース内のすべてのプライベートエンドポイントを一覧表示します。	拡張子	GA
az ml workspace share	特定のロールを持つ別のユーザーとワークスペースを共有します。	拡張子	GA
az ml workspace show	ワークスペースを表示します。	拡張子	GA
az ml workspace sync-keys	ストレージ、acr、アプリの分析情報などの依存リソースのワークスペースキーを同期します。	拡張子	GA
az ml workspace update	ワークスペースを更新します。	拡張子	GA
az ml workspace update-dependencies	ワークスペース依存リソースを更新します。	拡張子	GA

az ml workspace create

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

az ml workspace create --workspace-name
                       [--adb-workspace]
                       [--application-insights]
                       [--cmk-keyvault]
                       [--container-registry]
                       [--exist-ok]
                       [--friendly-name]
                       [--hbi-workspace]
                       [--keyvault]
                       [--location]
                       [--pe-auto-approval]
                       [--pe-name]
                       [--pe-resource-group]
                       [--pe-subnet-name]
                       [--pe-subscription-id]
                       [--pe-vnet-name]
                       [--primary-user-assigned-identity]
                       [--resource-cmk-uri]
                       [--resource-group]
                       [--sku]
                       [--storage-account]
                       [--system_datastores_auth_mode]
                       [--tags]
                       [--user-assigned-identity-for-cmk-encryption]
                       [--v1-legacy-mode]
                       [--yes]

必須のパラメーター

--workspace-name -w

ワークスペース名。

省略可能のパラメーター

--adb-workspace

このワークスペースにリンクする Adb ワークスペース。

--application-insights

このワークスペースに関連付けるアプリケーションインサイト。

--cmk-keyvault

Azure リソース ID 形式のカスタマーマネージドキーを含むキーコンテナー。

--container-registry

このワークスペースに関連付けるコンテナーレジストリ。

--exist-ok

ワークスペースが存在する場合は失敗しません。

既定値: False

--friendly-name -f

このワークスペースのフレンドリ名。

--hbi-workspace

顧客データにビジネスへの影響が大きい (HBI) かどうかを指定します。つまり、機密性の高いビジネス情報が含まれます。

既定値: False

--keyvault

このワークスペースに関連付ける Key Vault。

--location -l

リソースの場所。

--pe-auto-approval

プライベートリンクを介したワークスペースリソースへのプライベートエンドポイント接続を自動承認する必要があるかどうか。

既定値: False

--pe-name

ワークスペースのプライベートエンドポイントの名前。プライベートエンドポイント経由でプライベートネットワークへのワークスペースアクセスを制限するには、このパラメーターを使用します。

--pe-resource-group

ワークスペースのプライベートエンドポイントを作成する既存のリソースグループの名前。 vnet は同じリソースグループ内に存在する必要があります。指定しない場合は、ワークスペースのリソースグループが使用されます。

--pe-subnet-name

ワークスペースのプライベートエンドポイントを作成する既存のサブネットの名前。

既定値: default

--pe-subscription-id

ワークスペースのプライベートエンドポイントを作成する既存のサブスクリプションの ID。 vnet は同じサブスクリプションに存在する必要があります。指定しない場合は、ワークスペースのサブスクリプション ID が使用されます。

--pe-vnet-name

ワークスペースのプライベートエンドポイントを作成する既存の vnet の名前。

--primary-user-assigned-identity

ワークスペース ID を表すために使用されたユーザー割り当て ID の resourceId。

--resource-cmk-uri

保存データを暗号化するためのカスタマーマネージドキーのキー URI。

--resource-group -g

リソースグループ名。

--sku

ワークスペースの SKU/エディションは、"基本" ワークスペースでも、機能豊富な "エンタープライズ" ワークスペースでもかまいません。

既定値: basic

--storage-account

このワークスペースに関連付けるストレージアカウント。

--system_datastores_auth_mode

'workspaceblobstore' および 'workspacefilestore' ワークスペースのシステムデータストアに資格情報を使用するかどうかを決定します。既定値は 'accessKey' です。この値を使用すると、ワークスペースで資格情報を使用してシステムデータストアが作成されます。 'identity' に設定すると、ワークスペースで資格情報を使用せずにシステムデータストアが作成されます。

既定値: accessKey

--tags -t

'key=value' 構文を持つこのワークスペースに関連付けられているタグ。

--user-assigned-identity-for-cmk-encryption

暗号化キーへのアクセスに使用する必要があるユーザー割り当て ID の resourceId。

--v1-legacy-mode -v

このパラメーターを true に設定した場合は、パブリック Azure Resource Manager で v2 API サービスを使用しないようにします。詳細については、aka.ms/amlv2network を参照してください。

--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 delete

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

az ml workspace delete [--all-resources]
                       [--no-wait]
                       [--output-metadata-file]
                       [--path]
                       [--resource-group]
                       [--subscription-id]
                       [--workspace-name]

省略可能のパラメーター

--all-resources

このワークスペースが依存するリソース (ストレージ、acr、kv、アプリの分析情報など) を削除します。

既定値: False

--no-wait

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

既定値: False

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルートディレクトリへのパス。

既定値: .

--resource-group -g

リソースグループ名。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

グローバルパラメーター

--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 [--output-metadata-file]
                         [--path]
                         [--resource-group]
                         [--subscription-id]
                         [--workspace-name]

省略可能のパラメーター

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルートディレクトリへのパス。

既定値: .

--resource-group -g

リソースグループ名。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

グローバルパラメーター

--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 [--resource-group]

省略可能のパラメーター

--resource-group -g

リソースグループ名。

グローバルパラメーター

--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

ストレージ、acr、アプリの分析情報などの依存リソースのワークスペースキーを一覧表示します。

az ml workspace list-keys [--output-metadata-file]
                          [--path]
                          [--resource-group]
                          [--subscription-id]
                          [--workspace-name]

省略可能のパラメーター

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルートディレクトリへのパス。

既定値: .

--resource-group -g

リソースグループ名。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

グローバルパラメーター

--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 share --role
                      --user
                      [--output-metadata-file]
                      [--path]
                      [--resource-group]
                      [--subscription-id]
                      [--workspace-name]

--role

このユーザーに割り当てるロール。

--user

このワークスペースを共有するユーザー。

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルートディレクトリへのパス。

既定値: .

--resource-group -g

リソースグループ名。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

グローバルパラメーター

--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 [--output-metadata-file]
                     [--path]
                     [--resource-group]
                     [--subscription-id]
                     [--workspace-name]

省略可能のパラメーター

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルートディレクトリへのパス。

既定値: .

--resource-group -g

リソースグループ名。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

グローバルパラメーター

--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

ストレージ、acr、アプリの分析情報などの依存リソースのワークスペースキーを同期します。

az ml workspace sync-keys [--output-metadata-file]
                          [--path]
                          [--resource-group]
                          [--subscription-id]
                          [--workspace-name]

省略可能のパラメーター

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルートディレクトリへのパス。

既定値: .

--resource-group -g

リソースグループ名。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

グローバルパラメーター

--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

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

az ml workspace update [--allow-public-access]
                       [--description]
                       [--friendly-name]
                       [--image-build-compute]
                       [--output-metadata-file]
                       [--path]
                       [--primary-user-assigned-identity]
                       [--resource-group]
                       [--subscription-id]
                       [--tags]
                       [--v1-legacy-mode]
                       [--workspace-name]

省略可能のパラメーター

--allow-public-access

プライベートリンクワークスペースへのパブリックアクセスを許可します。

--description -d

このワークスペースの説明。

--friendly-name -f

フレンドリ名。

--image-build-compute

イメージビルドのコンピューティング先。

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルートディレクトリへのパス。

既定値: .

--primary-user-assigned-identity

ワークスペース ID を表すために使用されたユーザー割り当て ID の resourceId。

--resource-group -g

リソースグループ名。

--subscription-id

サブスクリプション ID を指定します。

--tags

'key=value' 構文を持つこのワークスペースに関連付けられているタグ。

--v1-legacy-mode -v

--workspace-name -w

ワークスペース名。

グローバルパラメーター

--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-dependencies

ワークスペース依存リソースを更新します。

az ml workspace update-dependencies [--acr]
                                    [--force]
                                    [--output-metadata-file]
                                    [--path]
                                    [--resource-group]
                                    [--subscription-id]
                                    [--workspace-name]

省略可能のパラメーター

--acr

このワークスペースを更新するコンテナーレジストリの arm ID。

--force

ユーザーの確認なしで依存リソースを強制的に更新します。

既定値: False

--output-metadata-file -t

構造化オブジェクト出力のオプションの出力ファイルの場所を指定します。

--path

実行構成ファイルのルートディレクトリへのパス。

既定値: .

--resource-group -g

リソースグループ名。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

ワークスペース名。

グローバルパラメーター

--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

コマンド

az ml workspace create

必須のパラメーター

省略可能のパラメーター

az ml workspace delete

省略可能のパラメーター

az ml workspace diagnose

省略可能のパラメーター

az ml workspace list

省略可能のパラメーター

az ml workspace list-keys

省略可能のパラメーター

az ml workspace show

省略可能のパラメーター

az ml workspace sync-keys

省略可能のパラメーター

az ml workspace update

省略可能のパラメーター

az ml workspace update-dependencies

省略可能のパラメーター

その他のリソース