Freigeben über


YAML-Schema der Verbindung der Azure KI Services für die CLI (V2)

GILT FÜR: Azure CLI ml Erweiterung v2 (aktuell)

Hinweis

Die in diesem Dokument beschriebene YAML-Syntax basiert auf dem JSON-Schema für die neueste Version der ML CLI v2-Erweiterung. Die Funktion dieser Syntax wird nur mit der neuesten Version der ML CLI v2-Erweiterung garantiert. Die Schemas für ältere Erweiterungsversionen finden Sie unter https://azuremlschemasprod.azureedge.net/.

YAML-Syntax

Schlüssel type BESCHREIBUNG Zulässige Werte Standardwert
$schema Zeichenfolge Das YAML-Schema. Wenn Sie die Visual Studio Code-Erweiterung für Azure Machine Learning zum Erstellen einer YAML-Datei verwenden, können Sie Schema- und Ressourcenvervollständigungen aufrufen, wenn Sie am Anfang Ihrer Datei $schema einschließen.
name Zeichenfolge Erforderlich. Der Verbindungsname.
description Zeichenfolge Die Verbindungsbeschreibung.
tags Objekt Das Verbindungs-Tag-Wörterbuch.
type Zeichenfolge Erforderlich. Der Verbindungstyp. azure_ai_services azure_ai_services
is_shared boolean true, wenn die Verbindung für andere Projekte im Hub freigegeben wird; andernfalls false. true
endpoint Zeichenfolge Erforderlich. Die URL des Endpunkts.
api_key Zeichenfolge Erforderlich. Der API-Schlüssel, der zur Authentifizierung der Verbindung verwendet wird. Wenn nicht angegeben, wird eine Verbindung mit Microsoft Entra ID (Authentifizierung ohne Anmeldeinformationen) hergestellt.
ai_services_resource_id Zeichenfolge Erforderlich. Die vollqualifizierte Azure-Ressourcen-ID der Azure KI Services-Ressource.

Hinweise

Es gibt zwei Möglichkeiten zum Erstellen von Verbindungen mit Azure KI Services:

  • Eine Verbindung für alle Azure KI Services mit Ausnahme von Azure KI-Suche.
  • Eine Verbindung für jeden einzelnen Azure KI Service.

Das in diesem Artikel beschriebene Schema gilt für eine Verbindung für alle Azure KI Services mit Ausnahme von Azure KI-Suche.

Während die az ml connection-Befehle zum Verwalten von Azure Machine Learning- und Azure KI Studio-Verbindungen verwendet werden können, ist die Azure KI Services-Verbindung spezifisch für Azure KI Studio.

Beispiele

Beispiele finden Sie in dieser GitHub-Ressource. Hier sind mehrere aufgeführt. Diese Beispiele haben das Format von YAML-Dateien und werden von der CLI verwendet. Beispiel: az ml connection create -f <file-name>.yaml.

YAML: API-Schlüssel

#AzureAIServiceConnection.yml

name: myazai_ei
type: azure_ai_services
endpoint: https://contoso.cognitiveservices.azure.com/
api_key: XXXXXXXXXXXXXXX

YAML: Ohne Anmeldeinformationen

#AzureAIServiceConnection.yml

name: myazai_apk
type: azure_ai_services
endpoint: https://contoso.cognitiveservices.azure.com/

Nächste Schritte