az ml component

リファレンス

手記

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

Azure ML コンポーネントを管理します。

Azure ML コンポーネントは、パイプラインジョブのコンポーネントの構成を定義します。入力/出力ポート、実行環境、およびコンポーネントのコマンドを構成できます。コンポーネントが作成されたら、パイプラインジョブ内のコンポーネントを参照して、Docker コンテナーで実行できます。

コマンド

名前	説明	型	状態
az ml component archive	コンポーネントをアーカイブします。	延長	ジョージア州
az ml component create	コンポーネントを作成します。	延長	ジョージア州
az ml component list	ワークスペース内のコンポーネントを一覧表示します。	延長	ジョージア州
az ml component prepare-for-sign	署名用のコンポーネントを準備します。	延長	ジョージア州
az ml component restore	アーカイブされたコンポーネントを復元します。	延長	ジョージア州
az ml component show	コンポーネントの詳細を表示します。	延長	ジョージア州
az ml component update	コンポーネントを更新します。現在、更新プログラムをサポートするフィールド (説明、display_name) はごくわずかです。	延長	ジョージア州

az ml component archive

コンポーネントをアーカイブします。

コンポーネントをアーカイブすると、既定ではリストクエリ (az ml component list) から非表示になります。引き続きパイプラインでアーカイブされたコンポーネントを参照して使用できます。コンポーネントコンテナーまたは特定のコンポーネントバージョンをアーカイブできます。コンポーネントコンテナーをアーカイブすると、その名前の下にあるコンポーネントのすべてのバージョンがアーカイブされます。アーカイブされたコンポーネントは、az ml component restoreを使用して復元できます。コンポーネントコンテナー全体がアーカイブされている場合、コンポーネントの個々のバージョンを復元することはできません。コンポーネントコンテナーを復元する必要があります。

az ml component archive --name
                        [--label]
                        [--registry-name]
                        [--resource-group]
                        [--version]
                        [--workspace-name]

例

コンポーネントコンテナーをアーカイブする (そのコンポーネントのすべてのバージョンをアーカイブする)

az ml component archive --name my-component --resource-group my-resource-group --workspace-name my-workspace

特定のコンポーネントバージョンをアーカイブする

az ml component archive --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

コンポーネントの名前。

省略可能のパラメーター

--label -l

コンポーネントのラベル。

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。そのため、リソースグループとワークスペースは必要ありません。

--resource-group -g

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

--version -v

コンポーネントのバージョン。

--workspace-name -w

Azure ML ワークスペースの名前。 az configure --defaults workspace=<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 component create

コンポーネントを作成します。

az ml component create --file
                       [--name]
                       [--registry-name]
                       [--resource-group]
                       [--set]
                       [--skip-validation]
                       [--version]
                       [--workspace-name]

例

YAML 仕様ファイルからコンポーネントを作成する

az ml component create --file my_component.yml --resource-group my-resource-group --workspace-name my-workspace

指定したバージョンの YAML 仕様ファイルからコンポーネントを作成する

az ml component create --file my_component.yml --version 1 --resource-group my-resource-group --workspace-name my-workspace

YAML 仕様ファイルからレジストリにコンポーネントを作成する

az ml component create --file my_component.yml --registry-name my-registry-name --resource-group my-resource-group

指定されたバージョンの YAML 仕様ファイルからレジストリにコンポーネントを作成する

az ml component create --file my_component.yml --version 1 --registry-name my-registry-name --resource-group my-resource-group

必須のパラメーター

--file -f

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

省略可能のパラメーター

--name -n

コンポーネントの名前。

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。そのため、リソースグループとワークスペースは必要ありません。

--resource-group -g

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

--set

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

--skip-validation

リソースの作成で検証をスキップします。依存リソースは、作成時に検証をスキップしないことに注意してください。

規定値: False

--version -v

コンポーネントのバージョン。

--workspace-name -w

Azure ML ワークスペースの名前。 az configure --defaults workspace=<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 component list

ワークスペース内のコンポーネントを一覧表示します。

az ml component list [--archived-only]
                     [--include-archived]
                     [--max-results]
                     [--name]
                     [--registry-name]
                     [--resource-group]
                     [--workspace-name]

例

ワークスペース内のすべてのコンポーネントを一覧表示する

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

ワークスペース内の指定した名前のすべてのコンポーネントバージョンを一覧表示する

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

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

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

レジストリ内のすべてのコンポーネントを一覧表示する

az ml component list --registry-name my-registry-name --resource-group my-resource-group

レジストリ内の指定した名前のすべてのコンポーネントバージョンを一覧表示する

az ml component list --name my-component --registry-name my-registry-name --resource-group my-resource-group

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

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

省略可能のパラメーター

--archived-only

アーカイブされたコンポーネントのみを一覧表示します。

規定値: False

--include-archived

アーカイブされたコンポーネントとアクティブなコンポーネントを一覧表示します。

規定値: False

--max-results -r

返される結果の最大数。

--name -n

コンポーネントの名前。

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。そのため、リソースグループとワークスペースは必要ありません。

--resource-group -g

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

--workspace-name -w

Azure ML ワークスペースの名前。 az configure --defaults workspace=<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 component prepare-for-sign

署名用のコンポーネントを準備します。

コンポーネントを署名用に準備すると、2 つのファイルが生成されます。catalog.json と .sig catalog.json。これらのファイルには、ターゲットフォルダーに存在するファイルごとに生成された SHA256 が含まれます。ファイルが既に存在する場合は、削除され、署名が更新された新しいファイルが作成されます。

az ml component prepare-for-sign --file
                                 [--registry-name]
                                 [--resource-group]
                                 [--workspace-name]

例

署名のために YAML 仕様ファイルからコンポーネントを準備する

az ml component prepare-for-sign --file my_component.yml --resource-group my-resource-group --workspace-name my-workspace

署名用の YAML 仕様ファイルからレジストリ内のコンポーネントを準備する

az ml component prepare-for-sign --file my_component.yml --registry-name my-registry-name --resource-group my-resource-group

必須のパラメーター

--file -f

省略可能のパラメーター

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。そのため、リソースグループとワークスペースは必要ありません。

--resource-group -g

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

--workspace-name -w

Azure ML ワークスペースの名前。 az configure --defaults workspace=<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 component restore

アーカイブされたコンポーネントを復元します。

アーカイブされたコンポーネントが復元されると、リストクエリ (az ml component list) から非表示にされなくなります。コンポーネントコンテナー全体がアーカイブされている場合は、そのアーカイブされたコンテナーを復元できます。これにより、指定された名前のコンポーネントのすべてのバージョンが復元されます。コンポーネントコンテナー全体がアーカイブされている場合、特定のコンポーネントバージョンのみを復元することはできません。コンテナー全体を復元する必要があります。個々のコンポーネントバージョンのみがアーカイブされた場合は、その特定のバージョンを復元できます。

az ml component restore --name
                        [--label]
                        [--registry-name]
                        [--resource-group]
                        [--version]
                        [--workspace-name]

例

アーカイブされたコンポーネントコンテナーを復元する (そのコンポーネントのすべてのバージョンを復元します)

az ml component restore --name my-component --resource-group my-resource-group --workspace-name my-workspace

アーカイブされた特定のコンポーネントバージョンを復元する

az ml component restore --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

コンポーネントの名前。

省略可能のパラメーター

--label -l

コンポーネントのラベル。

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。そのため、リソースグループとワークスペースは必要ありません。

--resource-group -g

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

--version -v

コンポーネントのバージョン。

--workspace-name -w

Azure ML ワークスペースの名前。 az configure --defaults workspace=<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 component show

コンポーネントの詳細を表示します。

az ml component show --name
                     [--label]
                     [--registry-name]
                     [--resource-group]
                     [--version]
                     [--workspace-name]

例

指定した名前とバージョンを持つコンポーネントの詳細を表示する

az ml component show --name my-component --version 1 --resource-group my-resource-group --workspace-name my-workspace

指定した名前とバージョンを持つレジストリ内のコンポーネントの詳細を表示する

az ml component show --name my-component --version 1 --registry-name my-registry-name --resource-group my-resource-group

必須のパラメーター

--name -n

コンポーネントの名前。

省略可能のパラメーター

--label -l

コンポーネントのラベル。

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。そのため、リソースグループとワークスペースは必要ありません。

--resource-group -g

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

--version -v

コンポーネントのバージョン。

--workspace-name -w

Azure ML ワークスペースの名前。 az configure --defaults workspace=<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 component update

コンポーネントを更新します。現在、更新プログラムをサポートするフィールド (説明、display_name) はごくわずかです。

az ml component update --name
                       --resource-group
                       --workspace-name
                       [--add]
                       [--force-string]
                       [--label]
                       [--registry-name]
                       [--remove]
                       [--set]
                       [--version]

例

コンポーネントの説明を更新する

az ml component update -n my_component -v 1 --set description="new description" -g my-resource-group -w my-workspace

必須のパラメーター

--name -n

コンポーネントの名前。

--resource-group -g

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

--workspace-name -w

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

省略可能のパラメーター

--add

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

規定値: []

--force-string

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

規定値: False

--label -l

コンポーネントのラベル。

--registry-name

指定した場合、コマンドはワークスペースではなくレジストリを対象とします。そのため、リソースグループとワークスペースは必要ありません。

--remove

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

規定値: []

--set

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

規定値: []

--version -v

コンポーネントのバージョン。

グローバルパラメーター

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

コマンド

az ml component archive

例

必須のパラメーター

省略可能のパラメーター

az ml component create

例

必須のパラメーター

省略可能のパラメーター

az ml component list

例

省略可能のパラメーター

az ml component prepare-for-sign

例

必須のパラメーター

省略可能のパラメーター

az ml component restore

例

必須のパラメーター

省略可能のパラメーター

az ml component show

例

必須のパラメーター

省略可能のパラメーター

az ml component update

例

必須のパラメーター

省略可能のパラメーター

その他のリソース