CLI (v2): YAML-Schema für Onlineendpunkt

Artikel
11/28/2023

GILT FÜRAzure CLI-ML-Erweiterung v2 (aktuell)

Das JSON-Quellschema finden Sie für https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json verwalteten Onlineendpunkt und für https://azuremlschemas.azureedge.net/latest/kubernetesOnlineEndpoint.schema.json Kubernetes-Onlineendpunkt. Die Unterschiede zwischen verwaltetem Onlineendpunkt und Kubernetes-Onlineendpunkt werden in der Tabelle der Eigenschaften in diesem Artikel beschrieben. Das Beispiel in diesem Artikel konzentriert sich auf verwalteten Onlineendpunkt.

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/.

Hinweis

Ein vollständig angegebener YAML-Beispielcode für verwaltete Onlineendpunkte steht als Referenz zur Verfügung.

YAML-Syntax

Schlüssel	type	BESCHREIBUNG	Zulässige Werte	Standardwert
`$schema`	Zeichenfolge	Das YAML-Schema. Wenn Sie die VS Code-Erweiterung für Azure Machine Learning zum Erstellen einer YAML-Datei verwenden, können Sie durch das Einfügen von `$schema` am Anfang der Datei Schema- und Ressourcenvervollständigungen aufrufen.
`name`	Zeichenfolge	Erforderlich. Name des Endpunkts. Muss auf Azure-Regionsebene eindeutig sein. Benennungsregeln werden unter Endpunktgrenzwerte definiert.
`description`	Zeichenfolge	Eine Beschreibung des Endpunkts
`tags`	Objekt	Wörterbuch der Tags für den Endpunkt
`auth_mode`	Zeichenfolge	Die Authentifizierungsmethode zum Aufrufen des Endpunkts (Vorgang auf Datenebene). Verwenden Sie `key` für schlüsselbasierte Authentifizierung. Verwenden Sie `aml_token` für die tokenbasierte Azure Machine Learning-Authentifizierung. Verwenden von `aad_token` für die tokenbasierte Microsoft Entra-Authentifizierung (Vorschau).	`key`, `aml_token`, `aad_token`	`key`
`compute`	Zeichenfolge	Name des Computeziels, auf dem die Endpunktbereitstellungen ausgeführt werden sollen. Dieses Feld gilt nur für Endpunktbereitstellungen für Kubernetes-Cluster mit Azure Arc-Unterstützung (das in diesem Feld angegebene Computeziel muss `type: kubernetes` enthalten). Geben Sie dieses Feld nicht an, wenn Sie einen verwalteten Onlinerückschluss verwenden.
`identity`	Objekt (object)	Die Konfiguration der verwalteten Identität für den Zugriff auf Azure-Ressourcen für die Endpunktbereitstellung und den Rückschluss.
`identity.type`	Zeichenfolge	Der Typ der verwalteten Identität. Wenn der Typ `user_assigned` ist, muss auch die Eigenschaft `identity.user_assigned_identities` angegeben werden.	`system_assigned`, `user_assigned`
`identity.user_assigned_identities`	array	Liste der vollqualifizierten Ressourcen-IDs der vom Benutzer zugewiesenen Identitäten.
`traffic`	Objekt (object)	Der Datenverkehr stellt den Prozentsatz der Anforderungen dar, die von verschiedenen Bereitstellungen verarbeitet werden sollen. Er wird durch ein Wörterbuch von Schlüssel-Wert-Paaren dargestellt, bei denen der Schlüssel den Bereitstellungsnamen und der Wert den Prozentsatz des Datenverkehrs für diese Bereitstellung darstellt. `blue: 90 green: 10` bedeutet beispielsweise, dass 90 % der Anforderungen an die Bereitstellung mit dem Namen `blue` und 10 % an die Bereitstellung `green` gesendet werden. Der gesamte Datenverkehr muss entweder 0 sein oder addiert 100 ergeben. Unter Sicherer Rollout für Onlineendpunkte wird die Datenverkehrskonfiguration in Aktion gezeigt. Hinweis: Sie können dieses Feld während der Erstellung von Onlineendpunkten nicht festlegen, da die Bereitstellungen unter diesem Endpunkt erstellt werden müssen, bevor Datenverkehr festgelegt werden kann. Sie können den Datenverkehr für einen Onlineendpunkt aktualisieren, nachdem die Bereitstellungen mit `az ml online-endpoint update` erstellt wurden, z. B. `az ml online-endpoint update --name <endpoint_name> --traffic "blue=90 green=10"`.
`public_network_access`	Zeichenfolge	Dieses Flag steuert die Sichtbarkeit des verwalteten Endpunkts. Bei `disabled` werden eingehende Bewertungsanforderungen über den privaten Endpunkt des Azure Machine Learning-Arbeitsbereichs empfangen und der Endpunkt ist von öffentlichen Netzwerken aus nicht erreichbar. Dieses Flag gilt nur für verwaltete Endpunkte.	`enabled`, `disabled`	`enabled`
`mirror_traffic`	Zeichenfolge	Prozentsatz des Livedatenverkehrs, der in eine Bereitstellung gespiegelt werden soll. Die Spiegelung des Datenverkehrs ändert nichts an den Ergebnissen, die an die Kunden zurückgegeben werden. Der gespiegelte Prozentsatz des Datenverkehrs wird kopiert und an die angegebene Bereitstellung übermittelt, damit Sie Metriken und Protokolle erfassen können, ohne die Clients zu beeinträchtigen. Beispielsweise zum Überprüfen, ob die Wartezeit innerhalb akzeptabler Grenzen liegt und ob keine HTTP-Fehler vorliegen. Es wird durch ein Wörterbuch mit einem einzelnen Schlüssel-Wert-Paar dargestellt, wobei der Schlüssel den Namen der Bereitstellung und der Wert den Prozentsatz des Datenverkehrs darstellt, der in die Bereitstellung gespiegelt werden soll. Weitere Informationen finden Sie unter Testen einer Bereitstellung mit gespiegelten Datenverkehr.

Bemerkungen

Mit dem Befehl az ml online-endpoint können Sie Azure Machine Learning-Onlineendpunkte verwalten.

Beispiele

Beispiele finden Sie im GitHub-Beispielrepository. Im Folgenden sind mehrere aufgeführt.

YAML: Grundlagen

$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-endpoint
auth_mode: key

YAML: Systemseitig zugewiesene Identität

$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-sai-endpoint
auth_mode: key

YAML: Benutzerseitig zugewiesene Identität

$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-uai-endpoint
auth_mode: key
identity:
  type: user_assigned
  user_assigned_identities:
    - resource_id: user_identity_ARM_id_place_holder

Share via