Online Deployments - List

Référence

Service:: Machine Learning

API Version:: 2023-10-01

Répertorier les déploiements de points de terminaison d’inférence.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments?api-version=2023-10-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments?api-version=2023-10-01&$orderBy={$orderBy}&$top={$top}&$skip={$skip}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpointName	path	True	string	Nom du point de terminaison d’inférence.
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
workspaceName	path	True	string	Nom de l’espace de travail Azure Machine Learning. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	Version de l’API à utiliser pour cette opération.
$orderBy	query		string	Classement de la liste.
$skip	query		string	Jeton de continuation pour la pagination.
$top	query		integer int32	En haut de la liste.

Réponses

Nom	Type	Description
200 OK	OnlineDeploymentTrackedResourceArmPaginatedResult	Succès
Other Status Codes	ErrorResponse	Error

Exemples

List Online Deployments.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/onlineEndpoints/testEndpointName/deployments?api-version=2023-10-01&$orderBy=string&$top=1

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "properties": {
        "description": "string",
        "properties": {
          "string": "string"
        },
        "codeConfiguration": {
          "codeId": "string",
          "scoringScript": "string"
        },
        "environmentId": "string",
        "environmentVariables": {
          "string": "string"
        },
        "scaleSettings": {
          "scaleType": "Default"
        },
        "requestSettings": {
          "maxQueueWait": "PT5M",
          "requestTimeout": "PT5M",
          "maxConcurrentRequestsPerInstance": 1
        },
        "modelMountPath": "string",
        "appInsightsEnabled": false,
        "livenessProbe": {
          "failureThreshold": 1,
          "successThreshold": 1,
          "timeout": "PT5M",
          "period": "PT5M",
          "initialDelay": "PT5M"
        },
        "provisioningState": "Creating",
        "instanceType": "string",
        "model": "string",
        "endpointComputeType": "Kubernetes",
        "containerResourceRequirements": {
          "containerResourceRequests": {
            "cpu": "\"1\"",
            "memory": "\"2Gi\"",
            "gpu": "\"1\""
          },
          "containerResourceLimits": {
            "cpu": "\"1\"",
            "memory": "\"2Gi\"",
            "gpu": "\"1\""
          }
        }
      },
      "systemData": {
        "createdAt": "2020-01-01T12:34:56.999Z",
        "createdBy": "string",
        "createdByType": "User",
        "lastModifiedAt": "2020-01-01T12:34:56.999Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User"
      },
      "tags": {},
      "location": "string",
      "kind": "string",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-1111-2222-3333-444444444444",
        "tenantId": "00000000-1111-2222-3333-444444444444",
        "userAssignedIdentities": {
          "string": {
            "principalId": "00000000-1111-2222-3333-444444444444",
            "clientId": "00000000-1111-2222-3333-444444444444"
          }
        }
      },
      "sku": {
        "name": "string",
        "tier": "Free",
        "size": "string",
        "family": "string",
        "capacity": 1
      }
    }
  ],
  "nextLink": "string"
}

Définitions

Nom	Description
CodeConfiguration	Configuration d’une ressource de code de scoring.
ContainerResourceRequirements	Les ressources requises pour chaque conteneur instance au sein d’un déploiement en ligne.
ContainerResourceSettings
createdByType	Type d’identité qui a créé la ressource.
DefaultScaleSettings
DeploymentProvisioningState	Valeurs possibles pour DeploymentProvisioningState.
EgressPublicNetworkAccessType	Énumérez pour déterminer si PublicNetworkAccess est activé ou désactivé pour la sortie d’un déploiement.
EndpointComputeType	Enum pour déterminer le type de calcul du point de terminaison.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
KubernetesOnlineDeployment	Propriétés spécifiques à un KubernetesOnlineDeployment.
ManagedOnlineDeployment	Propriétés spécifiques à un ManagedOnlineDeployment.
ManagedServiceIdentity	Identité de service managée (identités affectées par le système et/ou par l’utilisateur)
ManagedServiceIdentityType	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
OnlineDeploymentTrackedResource
OnlineDeploymentTrackedResourceArmPaginatedResult	Liste paginée des entités OnlineDeployment.
OnlineRequestSettings	Configuration des demandes de scoring de déploiement en ligne.
ProbeSettings	Configuration de la sonde liveness/readiness du conteneur de déploiement.
ScaleType
Sku	Définition du modèle de ressource représentant la référence SKU
SkuTier	Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas obligatoire sur un PUT.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TargetUtilizationScaleSettings
UserAssignedIdentity	Propriétés de l’identité affectée par l’utilisateur

CodeConfiguration

Configuration d’une ressource de code de scoring.

Nom	Type	Description
codeId	string	ID de ressource ARM de la ressource de code.
scoringScript	string	[Obligatoire] Script à exécuter au démarrage. par exemple « score.py »

ContainerResourceRequirements

Les ressources requises pour chaque conteneur instance au sein d’un déploiement en ligne.

Nom	Type	Description
containerResourceLimits	ContainerResourceSettings	Informations sur la limite des ressources de conteneur :
containerResourceRequests	ContainerResourceSettings	Informations sur la demande de ressource de conteneur :

ContainerResourceSettings

Nom	Type	Description
cpu	string	Nombre de demandes/limite de processeurs virtuels pour le conteneur. Plus d’informations : https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
gpu	string	Nombre de cartes GPU Nvidia demande/limite pour le conteneur. Plus d’informations : https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
memory	string	Demande/limite de taille de mémoire pour le conteneur. Plus d’informations : https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultScaleSettings

Nom	Type	Description
scaleType	string: Default	[Obligatoire] Type d’algorithme de mise à l’échelle de déploiement

DeploymentProvisioningState

Valeurs possibles pour DeploymentProvisioningState.

Nom	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Scaling	string
Succeeded	string
Updating	string

EgressPublicNetworkAccessType

Énumérez pour déterminer si PublicNetworkAccess est activé ou désactivé pour la sortie d’un déploiement.

Nom	Type	Description
Disabled	string
Enabled	string

EndpointComputeType

Enum pour déterminer le type de calcul du point de terminaison.

Nom	Type	Description
AzureMLCompute	string
Kubernetes	string
Managed	string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet error.

KubernetesOnlineDeployment

Propriétés spécifiques à un KubernetesOnlineDeployment.

Nom	Type	Valeur par défaut	Description
appInsightsEnabled	boolean	False	Si la valeur est true, active la journalisation Application Insights.
codeConfiguration	CodeConfiguration		Configuration du code pour le déploiement du point de terminaison.
containerResourceRequirements	ContainerResourceRequirements		Exigences en ressources pour le conteneur (processeur et mémoire).
description	string		Description du déploiement du point de terminaison.
egressPublicNetworkAccess	EgressPublicNetworkAccessType	Enabled	Si activé, autorisez l’accès au réseau public de sortie. Si cette option est désactivée, cela crée une sortie sécurisée. Par défaut : Activé.
endpointComputeType	string: Kubernetes		[Obligatoire] Type de calcul du point de terminaison.
environmentId	string		ID de ressource ARM ou AssetId de la spécification de l’environnement pour le déploiement du point de terminaison.
environmentVariables	object		Configuration des variables d’environnement pour le déploiement.
instanceType	string		Type de instance de calcul.
livenessProbe	ProbeSettings		La probe liveness supervise régulièrement l’intégrité du conteneur.
model	string		Chemin d’uri du modèle.
modelMountPath	string		Chemin d’accès pour monter le modèle dans un conteneur personnalisé.
properties	object		Dictionnaire de propriétés. Les propriétés peuvent être ajoutées, mais pas supprimées ou modifiées.
provisioningState	DeploymentProvisioningState		État d’approvisionnement pour le déploiement du point de terminaison.
readinessProbe	ProbeSettings		La probe readiness valide si le conteneur est prêt à traiter le trafic. Les propriétés et les valeurs par défaut sont identiques à celles de la probe liveness.
requestSettings	OnlineRequestSettings		Paramètres de demande pour le déploiement.
scaleSettings	OnlineScaleSettings: DefaultScaleSettings TargetUtilizationScaleSettings		Paramètres de mise à l’échelle pour le déploiement. S’il est null ou non fourni, il est défini par défaut sur TargetUtilizationScaleSettings pour KubernetesOnlineDeployment et sur DefaultScaleSettings pour ManagedOnlineDeployment.

ManagedOnlineDeployment

Propriétés spécifiques à un ManagedOnlineDeployment.

Nom	Type	Valeur par défaut	Description
appInsightsEnabled	boolean	False	Si la valeur est true, active la journalisation Application Insights.
codeConfiguration	CodeConfiguration		Configuration du code pour le déploiement du point de terminaison.
description	string		Description du déploiement du point de terminaison.
egressPublicNetworkAccess	EgressPublicNetworkAccessType	Enabled	Si activé, autorisez l’accès au réseau public de sortie. Si cette option est désactivée, cela crée une sortie sécurisée. Par défaut : Activé.
endpointComputeType	string: Managed		[Obligatoire] Type de calcul du point de terminaison.
environmentId	string		ID de ressource ARM ou AssetId de la spécification d’environnement pour le déploiement du point de terminaison.
environmentVariables	object		Configuration des variables d’environnement pour le déploiement.
instanceType	string		Type de instance de calcul.
livenessProbe	ProbeSettings		La probe liveness supervise régulièrement l’intégrité du conteneur.
model	string		Chemin d’uri du modèle.
modelMountPath	string		Chemin d’accès pour monter le modèle dans un conteneur personnalisé.
properties	object		Dictionnaire de propriétés. Les propriétés peuvent être ajoutées, mais pas supprimées ou modifiées.
provisioningState	DeploymentProvisioningState		État d’approvisionnement pour le déploiement du point de terminaison.
readinessProbe	ProbeSettings		La probe readiness valide si le conteneur est prêt à traiter le trafic. Les propriétés et les valeurs par défaut sont identiques à celles de la probe liveness.
requestSettings	OnlineRequestSettings		Paramètres de demande pour le déploiement.
scaleSettings	OnlineScaleSettings: DefaultScaleSettings TargetUtilizationScaleSettings		Paramètres de mise à l’échelle pour le déploiement. S’il est null ou non fourni, il est défini par défaut sur TargetUtilizationScaleSettings pour KubernetesOnlineDeployment et sur DefaultScaleSettings pour ManagedOnlineDeployment.

ManagedServiceIdentity

Identité de service managée (identités affectées par le système et/ou par l’utilisateur)

Nom	Type	Description
principalId	string	ID de principal de service de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
tenantId	string	ID de locataire de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
type	ManagedServiceIdentityType	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
userAssignedIdentities	<string, UserAssignedIdentity>	identités User-Assigned Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities sont des ID de ressource ARM au format : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs du dictionnaire peuvent être des objets vides ({}) dans les requêtes.

ManagedServiceIdentityType

Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).

Nom	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

OnlineDeploymentTrackedResource

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identité de service managée (identités affectées par le système et/ou par l’utilisateur)
kind	string	Métadonnées utilisées par le portail/les outils/etc pour afficher différentes expériences d’expérience utilisateur pour des ressources du même type.
location	string	Emplacement géographique où réside la ressource
name	string	nom de la ressource.
properties	OnlineDeployment: KubernetesOnlineDeployment ManagedOnlineDeployment	[Obligatoire] Attributs supplémentaires de l’entité.
sku	Sku	Détails de la référence SKU requis pour le contrat ARM pour la mise à l’échelle automatique.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

OnlineDeploymentTrackedResourceArmPaginatedResult

Liste paginée des entités OnlineDeployment.

Nom	Type	Description
nextLink	string	Lien vers la page suivante des objets OnlineDeployment. Si la valeur est null, il n’y a pas de pages supplémentaires.
value	OnlineDeploymentTrackedResource[]	Tableau d’objets de type OnlineDeployment.

OnlineRequestSettings

Configuration des demandes de scoring de déploiement en ligne.

Nom	Type	Valeur par défaut	Description
maxConcurrentRequestsPerInstance	integer	1	Nombre maximal de requêtes simultanées par nœud autorisées par déploiement. La valeur par défaut est de 1.
maxQueueWait	string	PT0.5S	(Déconseillé pour les points de terminaison managés en ligne) Durée maximale pendant laquelle une demande reste dans la file d’attente au format ISO 8601. Par défaut, 500 ms. (Augmentez maintenant pour prendre `request_timeout_ms` en compte tous les retards de mise en réseau/de file d’attente)
requestTimeout	string	PT5S	Délai d’expiration du score au format ISO 8601. Par défaut, 5 000 ms.

ProbeSettings

Configuration de la sonde liveness/readiness du conteneur de déploiement.

Nom	Type	Valeur par défaut	Description
failureThreshold	integer	30	Nombre d’échecs à autoriser avant de retourner un status défectueux.
initialDelay	string		Délai avant la première sonde au format ISO 8601.
period	string	PT10S	Durée entre les sondes au format ISO 8601.
successThreshold	integer	1	Nombre de sondes réussies avant de retourner un status sain.
timeout	string	PT2S	Délai d’expiration de la sonde au format ISO 8601.

ScaleType

Nom	Type	Description
Default	string
TargetUtilization	string

Sku

Définition du modèle de ressource représentant la référence SKU

Nom	Type	Description
capacity	integer	Si la référence SKU prend en charge le scale-out/in, l’entier de capacité doit être inclus. Si un scale-out/scale-in n’est pas possible pour la ressource, cela peut être omis.
family	string	Si le service a différentes générations de matériel, pour la même référence SKU, cela peut être capturé ici.
name	string	Nom de la référence SKU. Ex - P3. Il s’agit généralement d’un code lettre+nombre
size	string	Taille de la référence SKU. Lorsque le champ name est la combinaison du niveau et d’une autre valeur, il s’agit du code autonome.
tier	SkuTier	Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas requis sur un PUT.

SkuTier

Ce champ doit être implémenté par le fournisseur de ressources si le service a plusieurs niveaux, mais n’est pas obligatoire sur un PUT.

Nom	Type	Description
Basic	string
Free	string
Premium	string
Standard	string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

TargetUtilizationScaleSettings

Nom	Type	Valeur par défaut	Description
maxInstances	integer	1	Nombre maximal d’instances possibles pour la mise à l’échelle du déploiement. Le quota sera réservé à max_instances.
minInstances	integer	1	Nombre minimal d’instances devant toujours être présentes.
pollingInterval	string	PT1S	Intervalle d’interrogation au format ISO 8691. Prend uniquement en charge la durée avec une précision aussi faible que secondes.
scaleType	string: TargetUtilization		[Obligatoire] Type d’algorithme de mise à l’échelle de déploiement
targetUtilizationPercentage	integer	70	Utilisation du processeur cible pour le générateur de mise à l’échelle automatique.

UserAssignedIdentity

Propriétés de l’identité affectée par l’utilisateur

Nom	Type	Description
clientId	string	ID client de l’identité affectée.
principalId	string	ID principal de l’identité affectée.