CLI (v2) Azure AI Services 接続 YAML スキーマ
適用対象: 
Azure CLI ml 拡張機能 v2 (現行)
Note
このドキュメントで詳しく説明されている YAML 構文は、最新バージョンの ML CLI v2 拡張機能の JSON スキーマに基づいています。 この構文は、ML CLI v2 拡張機能の最新バージョンでのみ動作することが保証されています。 以前のバージョンの拡張機能のスキーマについては、https://azuremlschemasprod.azureedge.net/ でご確認いただけます。
YAML 構文
| キー | Type | 説明 | 使用できる値 | 既定値 |
|---|---|---|---|---|
$schema |
string | YAML スキーマ。 Azure Machine Learning 用 Visual Studio Code 拡張機能を使用して YAML ファイルを作成する場合、ファイルの先頭に $schema を含めて、スキーマとリソースの入力候補を呼び出します。 |
||
name |
string | 必須。 接続名。 | ||
description |
string | 接続の説明。 | ||
tags |
オブジェクト | 接続タグの辞書。 | ||
type |
string | 必須。 接続の種類。 | azure_ai_services |
azure_ai_services |
is_shared |
boolean | 接続がハブ内の他のプロジェクトとの間で共有されている場合は true、それ以外の場合は false となります。 |
true |
|
endpoint |
string | 必須。 エンドポイントの URL です。 | ||
api_key |
string | 接続の認証に使用される API キー。 指定しない場合、接続は Microsoft Entra ID (資格情報のない認証) を介して認証されます。 | ||
ai_services_resource_id |
string | 必須。 Azure AI Services リソースの完全修飾 Azure リソース ID。 |
解説
Azure AI Services への接続を作成するには、次の 2 つの方法があります。
- Azure AI Search を除く、すべての Azure AI サービスに対する 1 つの接続。
- 個々の Azure AI サービスごとに 1 つの接続。
この記事で説明するスキーマは、Azure AI Search を除くすべての Azure AI サービスに対する 1 つの接続を対象としています。
az ml connection コマンドを使用すると Azure Machine Learning と Azure AI Studio の両方の接続を管理できますが、Azure AI サービス接続は Azure AI Studio に固有のものです。
例
これらの例は YAML ファイルの形式であり、CLI から使用します。 たとえば、az ml connection create -f <file-name>.yaml のようにします。
YAML: API キー
#AzureAIServiceConnection.yml
name: myazai_ei
type: azure_ai_services
endpoint: https://contoso.cognitiveservices.azure.com/
api_key: XXXXXXXXXXXXXXX
YAML: Microsoft Entra ID
#AzureAIServiceConnection.yml
name: myazai_apk
type: azure_ai_services
endpoint: https://contoso.cognitiveservices.azure.com/