CLI (v2) オンライン エンドポイント YAML スキーマ

適用対象: Azure CLI ML 拡張機能 v2 (現行)

ソース JSON スキーマは、マネージド オンライン エンドポイントの https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json と Kubernetes オンライン エンドポイントの https://azuremlschemas.azureedge.net/latest/kubernetesOnlineEndpoint.schema.json にあります。 マネージド オンライン エンドポイントと Kubernetes オンライン エンドポイントの違いについては、この記事のプロパティの表で説明します。 この記事のサンプルでは、マネージド オンライン エンドポイントに焦点を当てています。

Note

このドキュメントで詳しく説明されている YAML 構文は、最新バージョンの ML CLI v2 拡張機能の JSON スキーマに基づいています。 この構文は、ML CLI v2 拡張機能の最新バージョンでのみ動作することが保証されています。 以前のバージョンの拡張機能のスキーマについては、https://azuremlschemasprod.azureedge.net/ でご確認いただけます。

Note

マネージド オンライン エンドポイント用に詳細に指定されたサンプル YAML があるので、ご参考ください

YAML 構文

キー Type 説明 使用できる値 既定値
$schema string YAML スキーマ。 Azure Machine Learning 用 VS Code 拡張機能を使用して YAML ファイルを作成する場合は、ファイルの先頭に $schema を含めることで、スキーマとリソースの入力候補を呼び出すことができます。
name string 必須。 エンドポイントの名前。 Azure リージョン レベルで一意である必要があります。

名前付け規則は、エンドポイントの制限で定義されています。
description string エンドポイントの説明。
tags object エンドポイントのタグのディクショナリ。
auth_mode string エンドポイントの認証方法。 キーベースの認証と Azure Machine Learning トークンベースの認証がサポートされています。 キーベースの認証の有効期限が切れることはありませんが、Azure Machine Learning トークンベースの認証は期限切れになります。 keyaml_token key
compute string エンドポイントのデプロイを実行するコンピューティング先の名前。 このフィールドは、Azure Arc 対応 Kubernetes クラスターへのエンドポイント デプロイにのみ適用されます (このフィールドに指定するコンピューティング先には type: kubernetes が必要です)。 マネージド オンライン推論を実行している場合は、このフィールドを指定しないでください。
identity object エンドポイントのプロビジョニングと推論のために Azure リソースにアクセスするマネージド ID 構成。
identity.type string マネージド ID の種類。 型が user_assigned の場合は、identity.user_assigned_identities プロパティも指定する必要があります。 system_assigneduser_assigned
identity.user_assigned_identities array ユーザー割り当て ID の完全修飾リソース ID の一覧。
traffic object トラフィックは、異なるデプロイによって処理される要求の割合を表します。 これは、キーと値のペアのディクショナリによって表されます。キーはデプロイ名を表し、値はデプロイへのトラフィックの割合を表します。 たとえば、blue: 90 green: 10 は 90% の要求が blue という名前のデプロイに送信され、10% がデプロイ green に送信されるということです。 トラフィックの合計は 0 または 100 である必要があります。 トラフィック構成を確認するには、オンライン エンドポイントの安全なロールアウトに関するページを参照してください。

注: トラフィックを設定する前に、そのエンドポイントの下にデプロイを作成する必要があるため、オンライン エンドポイントの作成中にこのフィールドを設定することはできません。 デプロイが作成された後は、az ml online-endpoint update を使用してオンライン エンドポイントのトラフィックを更新できます (例: az ml online-endpoint update --name <endpoint_name> --traffic "blue=90 green=10")。
public_network_access string このフラグにより、マネージド エンドポイントの可視性が制御されます。 disabled に設定されていると、インバウンド スコアリング要求は Azure Machine Learning ワークスペースのプライベート エンドポイントを使って受信され、パブリック ネットワークからエンドポイントに到達することはできません。 このフラグは、マネージド エンドポイントにのみ適用されます。 enableddisabled enabled
mirror_traffic string デプロイにミラーリングするライブ トラフィックの割合。 トラフィックをミラーリングしても、クライアントに返される結果は変わりません。 ミラーリングされたトラフィックの一部がコピーされ、指定されたデプロイに送信されるため、クライアントに影響を与えずにメトリックとログを収集することができます。 たとえば、待機時間が許容範囲内かどうか、HTTP エラーが発生していないかどうかを確認する場合です。 これは、 1 つのキーと値のペアを持つ辞書によって表されます。キーはデプロイ名を表し、値はデプロイにミラーリングするトラフィックの割合を表します。 詳細については、「ミラーリングされたトラフィックを使用してデプロイをテストする」を参照してください。

注釈

az ml online-endpoint コマンドは、Azure Machine Learning オンライン エンドポイントを管理するために使用できます。

例は、GitHub リポジトリの例にあります。 以下にいくつか示します。

YAML: basic

$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-endpoint
auth_mode: key

YAML: システム割り当て ID

$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-sai-endpoint
auth_mode: key

YAML: ユーザー割り当て ID

$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-uai-endpoint
auth_mode: key
identity:
  type: user_assigned
  user_assigned_identities:
    - resource_id: user_identity_ARM_id_place_holder

次のステップ