Batch Endpoints - Create Or Update

Service:: Machine Learning

Version d'API:: 2025-06-01

Crée un point de terminaison d’inférence par lots (asynchrone).

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}?api-version=2025-06-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpointName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$	Nom du point de terminaison d’inférence Batch.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Nom de l’espace de travail Azure Machine Learning.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
location	True	string	Emplacement géographique où réside la ressource
properties	True	BatchEndpoint	[Obligatoire] Attributs supplémentaires de l’entité.
identity		ManagedServiceIdentity	Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)
kind		string	Métadonnées utilisées par le portail/l’outil/etc pour afficher différentes expériences d’expérience utilisateur pour les ressources du même type.
sku		Sku	Détails de la référence SKU requis pour le contrat ARM pour la mise à l’échelle automatique.
tags		object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	BatchEndpointTrackedResource	La demande de création ou de mise à jour réussit.
201 Created	BatchEndpointTrackedResource	Date de création En-têtes x-ms-async-operation-timeout: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Erreur

Nom

Type

Description

200 OK

BatchEndpointTrackedResource

La demande de création ou de mise à jour réussit.

201 Created

BatchEndpointTrackedResource

Date de création

En-têtes

x-ms-async-operation-timeout: string
Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Erreur

Exemples

CreateOrUpdate Workspace Batch Endpoint.

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName?api-version=2025-06-01

{
  "properties": {
    "description": "string",
    "properties": {
      "string": "string"
    },
    "authMode": "AMLToken",
    "defaults": {
      "deploymentName": "string"
    }
  },
  "tags": {},
  "location": "string",
  "kind": "string",
  "identity": {
    "type": "SystemAssigned",
    "userAssignedIdentities": {
      "string": {}
    }
  },
  "sku": {
    "name": "string",
    "tier": "Free",
    "size": "string",
    "family": "string",
    "capacity": 1
  }
}

Exemple de réponse

Code d’état:: 200

{
  "id": "string",
  "name": "string",
  "type": "string",
  "properties": {
    "description": "string",
    "properties": {
      "string": "string"
    },
    "scoringUri": "https://www.contoso.com/example",
    "swaggerUri": "https://www.contoso.com/example",
    "authMode": "AMLToken",
    "defaults": {
      "deploymentName": "string"
    },
    "provisioningState": "Succeeded"
  },
  "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
  }
}

Code d’état:: 201

{
  "id": "string",
  "name": "string",
  "type": "string",
  "properties": {
    "description": "string",
    "properties": {
      "string": "string"
    },
    "scoringUri": "https://www.contoso.com/example",
    "swaggerUri": "https://www.contoso.com/example",
    "authMode": "AMLToken",
    "defaults": {
      "deploymentName": "string"
    },
    "provisioningState": "Updating"
  },
  "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
  }
}

Définitions

Nom	Description
BatchEndpoint	Configuration du point de terminaison Batch.
BatchEndpointDefaults	Valeurs par défaut du point de terminaison Batch
BatchEndpointTrackedResource
createdByType	Type d’identité qui a créé la ressource.
EndpointAuthKeys	Clés pour l’authentification de point de terminaison.
EndpointAuthMode	Énumération pour déterminer le mode d’authentification du point de terminaison.
EndpointProvisioningState	État de l’approvisionnement de 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
ManagedServiceIdentity	Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)
ManagedServiceIdentityType	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
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.
UserAssignedIdentity	Propriétés d’identité attribuées par l’utilisateur

BatchEndpoint

Object

Configuration du point de terminaison Batch.

Nom	Type	Description
authMode	EndpointAuthMode	[Obligatoire] Méthode d’authentification pour appeler le point de terminaison (opération de plan de données). Utilisez « Key » pour l’authentification basée sur des clés. Utilisez « AMLToken » pour l’authentification basée sur des jetons Azure Machine Learning. Utilisez « AADToken » pour l’authentification basée sur des jetons Microsoft Entra.
defaults	BatchEndpointDefaults	Valeurs par défaut pour le point de terminaison Batch
description	string	Description du point de terminaison d’inférence.
keys	EndpointAuthKeys	EndpointAuthKeys à définir initialement sur un point de terminaison. Cette propriété est toujours retournée sous la forme null. Les valeurs AuthKey doivent être récupérées à l’aide de l’API ListKeys.
properties	object	Dictionnaire de propriétés. Les propriétés peuvent être ajoutées, mais pas supprimées ou modifiées.
provisioningState	EndpointProvisioningState	État d’approvisionnement du point de terminaison.
scoringUri	string (uri)	URI du point de terminaison.
swaggerUri	string (uri)	URI Swagger du point de terminaison.

BatchEndpointDefaults

Object

Valeurs par défaut du point de terminaison Batch

Nom	Type	Description
deploymentName	string	Nom du déploiement qui sera par défaut pour le point de terminaison. Ce déploiement obtient 100% trafic lorsque l’URL de scoring du point de terminaison est appelée.

BatchEndpointTrackedResource

Object

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 identités affectées par l’utilisateur)
kind	string	Métadonnées utilisées par le portail/l’outil/etc pour afficher différentes expériences d’expérience utilisateur pour les ressources du même type.
location	string	Emplacement géographique où réside la ressource
name	string	nom de la ressource.
properties	BatchEndpoint	[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 »

createdByType

Énumération

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

Valeur	Description
Application
Key
ManagedIdentity
User

EndpointAuthKeys

Object

Clés pour l’authentification de point de terminaison.

Nom	Type	Description
primaryKey	string	Clé primaire.
secondaryKey	string	Clé secondaire.

EndpointAuthMode

Énumération

Énumération pour déterminer le mode d’authentification du point de terminaison.

Valeur	Description
AADToken
AMLToken
Key

EndpointProvisioningState

Énumération

État de l’approvisionnement de point de terminaison.

Valeur	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ManagedServiceIdentity

Object

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

Nom	Type	Description
principalId	string (uuid)	ID du 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 (uuid)	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 seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes.

ManagedServiceIdentityType

Énumération

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

Valeur	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

Sku

Object

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

Nom	Type	Description
capacity	integer (int32)	Si la référence SKU prend en charge le scale-out/in, l’entier de capacité doit être inclus. Si le scale-out/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, vous pouvez le capturer ici.
name	string	Nom de la référence SKU. Pièce P3. Il s’agit généralement d’une lettre+code numérique
size	string	Taille de la référence SKU. Lorsque le champ de nom est la combinaison de 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 obligatoire sur un PUT.

SkuTier

Énumération

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.

Valeur	Description
Basic
Free
Premium
Standard

systemData

Object

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

Nom	Type	Description
createdAt	string (date-time)	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 (date-time)	Horodatage de la dernière modification de 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.

UserAssignedIdentity

Object

Propriétés d’identité attribuées par l’utilisateur

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

Partager via

Batch Endpoints - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Exemples

CreateOrUpdate Workspace Batch Endpoint.

Exemple de requête

Exemple de réponse

Définitions

BatchEndpoint

BatchEndpointDefaults

BatchEndpointTrackedResource

createdByType

EndpointAuthKeys

EndpointAuthMode

EndpointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

Sku

SkuTier

systemData

UserAssignedIdentity