Delen via


CLI (v2) Foundry Tools-verbinding 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 Typologie Beschrijving Toegestane waarden Standaardwaarde
$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 Voorwerp De woordenlijst voor verbindingstags.
type tekenreeks Vereist. Het verbindingstype. azure_ai_services azure_ai_services
is_shared booleaan 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 Foundry Tools-resource.

Opmerkingen

Er zijn twee manieren om verbindingen met Foundry Tools te maken:

  • Eén verbinding voor alle Foundry Tools behalve Azure AI Search.
  • Eén verbinding voor elk afzonderlijk Foundry Tool.

Het schema dat in dit artikel wordt beschreven, is voor één verbinding voor alle Foundry Tools, met uitzondering van Azure AI Search.

Hoewel de az ml connection opdrachten kunnen worden gebruikt om zowel Azure Machine Learning- als Microsoft Foundry-verbindingen te beheren, is de verbinding met Foundry Tools specifiek voor Foundry.

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/

Volgende stappen