Freigeben über

YAML-Schema der Verbindung der Azure KI-Suche für die CLI (v2)

GILT FÜRAzure 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_search azure_ai_search
is_shared Boolescher Wert 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 Der API-Schlüssel, der zur Authentifizierung der Verbindung verwendet wird. Falls nicht angegeben, wird die Verbindung über die Microsoft Entra-ID (anmeldeinformationenlose Authentifizierung) authentifiziert.

Hinweise

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

Beispiele

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

#AzureContentSafetyConnection.yml

name: myazaics_apk
type: azure_ai_search

endpoint: https://contoso.search.windows.net/
api_key: XXXXXXXXXXXXXXX

YAML: Microsoft Entra ID (Vorschau)

#AzureContentSafetyConnection.yml

name: myazaics_ei
type: azure_ai_search

endpoint: https://contoso.search.windows.net/

Nächste Schritte