az ml online-endpoint

Note

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

Azure ML オンライン エンドポイントを管理します。

Azure ML エンドポイントは、モデルデプロイを作成および管理するためのシンプルなインターフェイスを提供します。 各エンドポイントには 1 つ以上のデプロイを含めることができます。これにより、1 つのスコアリング エンドポイントからのトラフィックを必要に応じて複数のデプロイに提供できます。 これは、制御されたロールアウトなどのシナリオに役立ちます。

Azure ML では、オンラインとバッチの 2 種類のエンドポイントがサポートされています。 オンライン エンドポイントはリアルタイム推論をサポートしますが、バッチ エンドポイントはオフライン バッチ スコアリングに使用されます。

コマンド

名前	説明	型	状態
az ml online-endpoint create	エンドポイントを作成します。	拡張子	GA
az ml online-endpoint delete	エンドポイントを削除します。	拡張子	GA
az ml online-endpoint get-credentials	オンライン エンドポイントのトークン/キーを一覧表示します。	拡張子	GA
az ml online-endpoint invoke	エンドポイントを呼び出します。	拡張子	GA
az ml online-endpoint list	ワークスペース内のエンドポイントを一覧表示します。	拡張子	GA
az ml online-endpoint regenerate-keys	オンライン エンドポイントのキーを再生成します。	拡張子	GA
az ml online-endpoint show	エンドポイントの詳細を表示します。	拡張子	GA
az ml online-endpoint update	エンドポイントを更新します。	拡張子	GA

az ml online-endpoint create

エンドポイントを作成します。

エンドポイントを作成するには、オンライン エンドポイント構成を含む YAML ファイルを指定します。 エンドポイントが既に存在する場合は、失敗します。 既存のエンドポイントを更新する場合は、az ml online-endpoint update を使用します。

az ml online-endpoint create --resource-group
                             --workspace-name
                             [--auth-mode]
                             [--file]
                             [--local {false, true}]
                             [--name]
                             [--no-wait]
                             [--set]
                             [--web]

例

YAML 仕様ファイルからエンドポイントを作成する

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

必須のパラメーター

--resource-group -g

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

--workspace-name -w

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

省略可能のパラメーター

--auth-mode

エンドポイントの認証方法。 使用できる値: キー、aml_token。 既定値: キー。

--file -f

Azure ML オンライン エンドポイント仕様を含む YAML ファイルへのローカル パス。 オンライン エンドポイントの YAML リファレンス ドキュメントは次 https://aka.ms/ml-cli-v2-endpoint-online-yaml-referenceの場所にあります。

--local

エンドポイントをローカルに作成します。 注: トラフィックと認証はローカルではサポートされていません。 'az ml online-deployment create --local' を直接使用できます。 存在しない場合は、エンドポイントが作成されます。

指定可能な値: false, true

規定値: False

--name -n

オンライン エンドポイントの名前。

--no-wait

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

規定値: False

--set

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

--web -e

Web ブラウザーで Azure ML Studio にエンドポイントの詳細を表示します。

規定値: 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 online-endpoint delete

エンドポイントを削除します。

az ml online-endpoint delete --name
                             --resource-group
                             --workspace-name
                             [--local {false, true}]
                             [--no-wait]
                             [--yes]

例

オンライン エンドポイント (すべてのデプロイを含む) を削除する

az ml online-endpoint delete --name my-online-endpoint --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

オンライン エンドポイントの名前。

--resource-group -g

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

--workspace-name -w

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

省略可能のパラメーター

--local

ローカル エンドポイントを削除します。

指定可能な値: false, true

規定値: False

--no-wait

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

規定値: 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 online-endpoint get-credentials

オンライン エンドポイントのトークン/キーを一覧表示します。

az ml online-endpoint get-credentials --name
                                      --resource-group
                                      --workspace-name

例

オンライン エンドポイントのキーを一覧表示する

az ml online-endpoint get-credentials --name my-online-endpoint --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

オンライン エンドポイントの名前。

--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 online-endpoint invoke

エンドポイントを呼び出します。

何らかの要求データを使用してオンライン エンドポイントを呼び出すことができます。 これはリアルタイム推論であり、スコア付け結果はすぐに返されます。

az ml online-endpoint invoke --name
                             --resource-group
                             --workspace-name
                             [--deployment-name]
                             [--local {false, true}]
                             [--request-file]

例

何らかの要求データを使用してオンライン エンドポイントを呼び出す

az ml online-endpoint invoke --name my-online-endpoint --request-file sample_request.json --resource-group my-resource-group --workspace-name my-workspace

特定のデプロイを対象とするオンライン エンドポイントを呼び出す

az ml online-endpoint invoke --name my-online-endpoint --deployment my-deployment --request-file sample_request.json --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

オンライン エンドポイントの名前。

--resource-group -g

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

--workspace-name -w

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

省略可能のパラメーター

--deployment-name -d

ターゲットとするデプロイの名前。

--local

ローカル エンドポイントを呼び出します。 これは、このエンドポイントに対してローカル デプロイが作成されている場合にのみ機能します。

指定可能な値: false, true

規定値: False

--request-file -r

要求データを含む JSON ファイルへのローカル パス。

グローバル パラメーター

--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 online-endpoint list

ワークスペース内のエンドポイントを一覧表示します。

az ml online-endpoint list --resource-group
                           --workspace-name
                           [--local {false, true}]

例

ワークスペース内のすべてのオンライン エンドポイントを一覧表示する

az ml online-endpoint list --resource-group my-resource-group --workspace-name my-workspace

ワークスペース内のすべてのバッチ エンドポイントを一覧表示する

az ml online-endpoint list  --resource-group my-resource-group --workspace-name my-workspace

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

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

必須のパラメーター

--resource-group -g

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

--workspace-name -w

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

省略可能のパラメーター

--local

すべてのローカル エンドポイントを一覧表示します。

指定可能な値: false, true

規定値: 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 online-endpoint regenerate-keys

オンライン エンドポイントのキーを再生成します。

az ml online-endpoint regenerate-keys --name
                                      --resource-group
                                      --workspace-name
                                      [--key-type]
                                      [--no-wait]

例

オンライン エンドポイントのキーを再生成する

az ml online-endpoint regenerate-keys --name my-online-endpoint --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

オンライン エンドポイントの名前。

--resource-group -g

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

--workspace-name -w

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

省略可能のパラメーター

--key-type

再生成するキーの種類。 使用できる値: プライマリ、セカンダリ。

規定値: primary

--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 online-endpoint show

エンドポイントの詳細を表示します。

az ml online-endpoint show --name
                           --resource-group
                           --workspace-name
                           [--local {false, true}]
                           [--web]

例

バッチ エンドポイントの詳細を表示する

az ml online-endpoint show --name my-online-endpoint  --resource-group my-resource-group --workspace-name my-workspace

--query 引数を使用して、コマンドの結果に対して JMESPath クエリを実行するエンドポイントのプロビジョニング状態を表示します。

az ml online-endpoint show -n my-endpoint --query "{Name:name,State:provisioning_state}"  --output table --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

--name -n

オンライン エンドポイントの名前。

--resource-group -g

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

--workspace-name -w

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

省略可能のパラメーター

--local

ローカル エンドポイントを表示します。

指定可能な値: false, true

規定値: False

--web -e

Web ブラウザーで Azure ML Studio にエンドポイントの詳細を表示します。

規定値: 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 online-endpoint update

エンドポイントを更新します。

エンドポイントの 'description'、'tags'、および 'traffic' プロパティを更新できます。 さらに、新しいデプロイをエンドポイントに追加したり、既存のデプロイを更新したりできます。

az ml online-endpoint update --resource-group
                             --workspace-name
                             [--add]
                             [--file]
                             [--force-string]
                             [--local {false, true}]
                             [--mirror-traffic]
                             [--name]
                             [--no-wait]
                             [--remove]
                             [--set]
                             [--traffic]
                             [--web]

例

YAML 仕様ファイルからエンドポイントを更新する

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

エンドポイントのトラフィック設定を更新する

az ml online-endpoint update --name my-online-endpoint  --traffic "my-new-deployment=100" --resource-group my-resource-group --workspace-name my-workspace

必須のパラメーター

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

規定値: []

--file -f

Azure ML オンライン エンドポイント仕様を含む YAML ファイルへのローカル パス。 オンライン エンドポイントの YAML リファレンス ドキュメントは次 https://aka.ms/ml-cli-v2-endpoint-online-yaml-referenceの場所にあります。

--force-string

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

規定値: False

--local

ローカル エンドポイントを更新します。

指定可能な値: false, true

規定値: False

--mirror-traffic

ライブ トラフィックの重複する割合を、デプロイのトレーニングに転送します。

--name -n

オンライン エンドポイントの名前。

--no-wait

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

規定値: False

--remove

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

規定値: []

--set

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

規定値: []

--traffic -r

エンドポイントのトラフィック設定のスペース区切りのキーと値のペア (引用符)。

--web -e

Web ブラウザーで Azure ML Studio にエンドポイントの詳細を表示します。

規定値: 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 を使います。