CLI (v2) YAML-schema för Azure AI Search-anslutning
GÄLLER FÖR:
Azure CLI ml-tillägget v2 (aktuellt)
Kommentar
YAML-syntaxen som beskrivs i det här dokumentet baseras på JSON-schemat för den senaste versionen av ML CLI v2-tillägget. Den här syntaxen är garanterad att endast fungera med den senaste versionen av ML CLI v2-tillägget. Du hittar scheman för äldre tilläggsversioner på https://azuremlschemasprod.azureedge.net/.
YAML-syntax
| Nyckel | Typ | Beskrivning | Tillåtna värden | Standardvärde |
|---|---|---|---|---|
$schema |
sträng | YAML-schemat. Om du använder Azure Machine Learning Visual Studio Code-tillägget för att skapa YAML-filen ska du ta med $schema längst upp i filen för att anropa schema- och resursavslutningar. |
||
name |
sträng | Obligatoriskt. Anslutningsnamnet. | ||
description |
sträng | Anslutningsbeskrivningen. | ||
tags |
objekt | Ordlistan för anslutningstaggen. | ||
type |
sträng | Obligatoriskt. Anslutningstypen. | azure_ai_search |
azure_ai_search |
is_shared |
boolean | trueom anslutningen delas mellan andra projekt i hubben; annars . false |
true |
|
endpoint |
sträng | Obligatoriskt. Slutpunktens URL. | ||
api_key |
sträng | API-nyckeln som används för att autentisera anslutningen. Om den inte tillhandahålls autentiseras anslutningen via Microsoft Entra-ID (autentisering utan autentisering). |
Kommentarer
Kommandona az ml connection kan användas för att hantera både Azure Machine Learning- och Azure AI Studio-anslutningar, men Azure AI Search-anslutningen är specifik för Azure AI Studio.
Exempel
De här exemplen är i form av YAML-filer och används från CLI. Exempel: az ml connection create -f <file-name>.yaml
YAML: API-nyckel
#AzureContentSafetyConnection.yml
name: myazaics_apk
type: azure_ai_search
endpoint: https://contoso.search.windows.net/
api_key: XXXXXXXXXXXXXXX
YAML: Microsoft Entra ID (förhandsversion)
#AzureContentSafetyConnection.yml
name: myazaics_ei
type: azure_ai_search
endpoint: https://contoso.search.windows.net/