CLI (v2) Azure AI Services-verbindings-YAML-schema
VAN TOEPASSING OP:
Azure CLI ml-extensie v2 (huidige)
Notitie
De YAML-syntaxis die in dit document wordt beschreven, is gebaseerd op het JSON-schema voor de nieuwste versie van de ML CLI v2-extensie. Deze syntaxis werkt gegarandeerd alleen met de nieuwste versie van de ML CLI v2-extensie. U vindt de schema's voor oudere extensieversies op https://azuremlschemasprod.azureedge.net/.
YAML-syntaxis
| Sleutel | Type | Description | Toegestane waarden | Default value |
|---|---|---|---|---|
$schema |
tekenreeks | Het YAML-schema. Als u de Azure Machine Learning Visual Studio Code-extensie gebruikt om het YAML-bestand te ontwerpen, neemt $schema u deze boven aan het bestand op om schema- en resourcevoltooiingen aan te roepen. |
||
name |
tekenreeks | Vereist. De verbindingsnaam. | ||
description |
tekenreeks | De beschrijving van de verbinding. | ||
tags |
object | De woordenlijst voor verbindingstags. | ||
type |
tekenreeks | Vereist. Het verbindingstype. | azure_ai_services |
azure_ai_services |
is_shared |
boolean | true als de verbinding wordt gedeeld tussen andere projecten in de hub; anders, false. |
true |
|
endpoint |
tekenreeks | Vereist. De URL van het eindpunt. | ||
api_key |
tekenreeks | De API-sleutel die wordt gebruikt om de verbinding te verifiëren. Als deze niet is opgegeven, wordt de verbinding geverifieerd via Microsoft Entra-id (verificatie zonder referenties). | ||
ai_services_resource_id |
tekenreeks | Vereist. De volledig gekwalificeerde Azure-resource-id van de Azure AI Services-resource. |
Opmerkingen
Er zijn twee manieren om verbindingen met Azure AI Services te maken:
- Eén verbinding voor alle Azure AI Services, met uitzondering van Azure AI Search.
- Eén verbinding voor elke afzonderlijke Azure AI-service.
Het schema dat in dit artikel wordt beschreven, is voor één verbinding voor alle Azure AI Services, met uitzondering van Azure AI Search.
Hoewel de az ml connection opdrachten kunnen worden gebruikt om zowel Azure Machine Learning- als Azure AI Studio-verbindingen te beheren, is de Azure AI Services-verbinding specifiek voor Azure AI Studio.
Voorbeelden
Deze voorbeelden zijn in de vorm van YAML-bestanden en worden gebruikt vanuit de CLI. Bijvoorbeeld: az ml connection create -f <file-name>.yaml.
YAML: API-sleutel
#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/