Schéma YAML d’un point de terminaison en ligne avec l’interface CLI (v2)

  • Article

S’APPLIQUE À :Extension Azure ML CLI v2 (actuelle)

Le schéma JSON source se trouve surhttps://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json pour le point de terminaison en ligne managé et sur https://azuremlschemas.azureedge.net/latest/kubernetesOnlineEndpoint.schema.json pour le point de terminaison en ligne Kubernetes. Les différences entre le point de terminaison en ligne managé et le point de terminaison en ligne Kubernetes sont décrites dans la table des propriétés de cet article. L’échantillon dans cet article se concentre sur le point de terminaison en ligne managé.

Remarque

La syntaxe YAML détaillée dans ce document est basée sur le schéma JSON pour la dernière version de l’extension ML CLI v2. Le fonctionnement de cette syntaxe est garanti uniquement avec la dernière version de l’extension ML CLI v2. Vous trouverez les schémas des versions d’extension plus anciennes sur https://azuremlschemasprod.azureedge.net/.

Remarque

Un exemple YAML complet pour les points de terminaison en ligne managés est disponible à des fins de référence

Syntaxe YAML

Clé Type Description Valeurs autorisées Valeur par défaut
$schema string Schéma YAML. Si vous utilisez l’extension VS Code d’Azure Machine Learning pour créer le fichier YAML, en incluant $schema en haut de votre fichier, vous pouvez appeler des complétions de schémas et de ressources.
name string Obligatoire. Nom du point de terminaison, Doit être unique au niveau de la région Azure.

Les règles de nommage sont définies sous limites du point de terminaison.
description string Description du point de terminaison.
tags object Dictionnaire d’étiquettes du point de terminaison.
auth_mode string Méthode d’authentification du point de terminaison. L’authentification basée sur une clé et l’authentification basée sur un jeton Azure Machine Learning sont prises en charge. L’authentification basée sur une clé n’expire pas, contrairement à l’authentification basée sur un jeton Azure Machine Learning. key, aml_token key
compute string Nom de la cible de calcul sur laquelle exécuter les déploiements de point de terminaison. Ce champ s’applique uniquement aux déploiements de point de terminaison sur les clusters Kubernetes avec Azure Arc (la cible de calcul spécifiée dans ce champ doit avoir type: kubernetes). Ne spécifiez pas ce champ si vous effectuez une inférence en ligne managée.
identity object Configuration de l’identité managée afin d’accéder aux ressources Azure pour le provisionnement et l’inférence des points de terminaison.
identity.type string Type d’identité managée. Si le type est user_assigned, la propriété identity.user_assigned_identities doit également être spécifiée. system_assigned, user_assigned
identity.user_assigned_identities tableau Liste des ID de ressource complets des identités affectées par l’utilisateur.
traffic object Le trafic représente le pourcentage de requêtes qui doivent être traitées par différents déploiements. Il est représenté par un dictionnaire de paires clé-valeur, où les clés représentent le nom du déploiement et la valeur le pourcentage de trafic vers ce déploiement. Par exemple, blue: 90 green: 10 signifie que 90 % des requêtes sont envoyées au déploiement nommé blue et 10 % sont envoyées au déploiement green. Le trafic total doit être égal à 0 ou s’additionner jusqu’à 100. Consultez Déploiement sécurisé pour les points de terminaison en ligne pour voir la configuration du trafic en action.

Remarque : vous ne pouvez pas définir ce champ lors de la création du point de terminaison en ligne, car les déploiements sous ce point de terminaison doivent être créés avant que le trafic puisse être défini. Vous pouvez mettre à jour le trafic d’un point de terminaison en ligne après avoir créé les déploiements à l’aide de az ml online-endpoint update ; par exemple az ml online-endpoint update --name <endpoint_name> --traffic "blue=90 green=10".
public_network_access string Cet indicateur contrôle la visibilité du point de terminaison managé. Si disabled, les requêtes de scoring entrantes sont reçues sur le point de terminaison privé de l’espace de travail Azure Machine Learning, mais le point de terminaison n’est pas accessible à partir d’un réseau public. Cet indicateur s’applique uniquement aux points de terminaison managés enabled, disabled enabled
mirror_traffic string Pourcentage de trafic en direct vers un déploiement. Le trafic en miroir ne change pas les résultats retournés aux clients. Le pourcentage en miroir du trafic est copié et envoyé au déploiement spécifié pour pouvoir collecter des métriques et une journalisation sans impacter les clients. Par exemple, pour vérifier si la latence est dans des limites acceptables et qu’il n’y a pas d’erreur HTTP. Il est représenté par un dictionnaire avec une paire clé-valeur unique, où la clé représente le nom du déploiement et la valeur représente le pourcentage de trafic à mettre en miroir vers le déploiement. Pour plus d’informations, consultez Tester un déploiement avec le trafic mis en miroir.

Remarques

La commande az ml online-endpoint peut être utilisée pour gérer les points de terminaison en ligne Azure Machine Learning.

Exemples

Des exemples sont disponibles dans le référentiel d’exemples GitHub. Vous en trouverez plusieurs ci-dessous.

YAML : de base

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

YAML : identité affectée par le système

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

YAML : identité affectée par l’utilisateur

$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

Étapes suivantes