az ml index

  • プレビュー

Note

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

このコマンド グループはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Azure ML インデックスを管理します。

コマンド

名前 説明 型 状態
az ml index create

インデックスを作成します。

 Extension Preview
az ml index list

ワークスペース内のインデックスを一覧表示します。

 Extension Preview
az ml index show

ワークスペース内のインデックスの詳細を表示します。

 Extension Preview

az ml index create

プレビュー

コマンド グループ 'ml index' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

インデックスを作成します。

インデックスは、ローカル ファイル、ローカル ディレクトリ、データストア、またはリモート URI から作成できます。 作成されたインデックスは、指定された名前とバージョンでワークスペース内で追跡されます。

az ml index create [--acquire-policy-token]
                   [--change-reference]
                   [--datastore]
                   [--description]
                   [--file]
                   [--name]
                   [--path]
                   [--registry-name]
                   [--resource-group]
                   [--set]
                   [--stage]
                   [--tags]
                   [--version]
                   [--workspace-name]

例

YAML 仕様ファイルからインデックスを作成する

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

ローカル フォルダーへのパスからインデックスを作成する

az ml index create --name my-index --version 1 --path ./my-index --resource-group my-resource-group --workspace-name my-workspace

データストアへのパスからインデックスを作成する

az ml index create --name my-index --version 1 --path azureml://datastores/myblobstore/paths/indexes/MLIndex --resource-group my-resource-group --workspace-name my-workspace

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--datastore

ローカル成果物をアップロードするデータストア。

--description

インデックスの説明。

--file -f

Azure ML インデックス仕様を含む YAML ファイルへのローカル パス。 インデックスの YAML リファレンス ドキュメントは次の場所にあります。

--name -n

インデックスの名前。

--path -p

インデックス ファイルへのパス。 ローカルまたはリモートの場所を指定できます。 指定する場合は、--name/-n も指定する必要があります。

--registry-name

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

--resource-group -g

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

--set

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

--stage -s

インデックスのステージ。

--tags

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

--version -v

インデックスのバージョン。

--workspace-name -w

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

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az ml index list

プレビュー

コマンド グループ 'ml index' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

ワークスペース内のインデックスを一覧表示します。

az ml index list [--max-results]
                 [--name]
                 [--registry-name]
                 [--resource-group]
                 [--workspace-name]

例

ワークスペース内のすべてのインデックスを一覧表示する

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

ワークスペース内の指定した名前のすべてのインデックス バージョンを一覧表示する

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

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

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az ml index show

プレビュー

コマンド グループ 'ml index' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

ワークスペース内のインデックスの詳細を表示します。

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

例

指定した名前とバージョンを持つインデックスの詳細を表示する

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

必須のパラメーター

--name -n

インデックスの名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False