Batch Endpoints - Create Or Update

Servizio:: Machine Learning

Versione API:: 2025-12-01

Crea un endpoint di inferenza batch (asincrono).
Crea un endpoint di inferenza batch (asincrono).

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpointName	path	True	string	Nome per l'endpoint batch.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Nome dell'area di lavoro di Azure Machine Learning
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Posizione geografica in cui risiede la risorsa
properties	True	BatchEndpointProperties	[Obbligatorio] Attributi aggiuntivi dell'entità.
identity		ManagedServiceIdentity	Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente)
kind		string	Metadati usati dal portale, dagli strumenti e così via per eseguire il rendering di esperienze utente diverse per le risorse dello stesso tipo.
sku		Sku	Dettagli sku necessari per il contratto ARM per la scalabilità automatica.
tags		object	Tag di risorsa.

Risposte

Nome	Tipo	Descrizione
200 OK	BatchEndpoint	Operazione di aggiornamento 'BatchEndpoint' della risorsa riuscita
201 Created	BatchEndpoint	La richiesta ha avuto esito positivo e di conseguenza è stata creata una nuova risorsa. Intestazioni Azure-AsyncOperation: string Retry-After: integer x-ms-async-operation-timeout: string
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Nome

Tipo

Descrizione

200 OK

BatchEndpoint

Operazione di aggiornamento 'BatchEndpoint' della risorsa riuscita

201 Created

BatchEndpoint

La richiesta ha avuto esito positivo e di conseguenza è stata creata una nuova risorsa.

Intestazioni

Azure-AsyncOperation: string
Retry-After: integer
x-ms-async-operation-timeout: string

Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

CreateOrUpdate Workspace Batch Endpoint.

Esempio di richiesta

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-12-01

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

Risposta di esempio

Codice di stato:: 200

{
  "name": "string",
  "type": "string",
  "id": "string",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444",
    "userAssignedIdentities": {
      "string": {
        "clientId": "00000000-1111-2222-3333-444444444444",
        "principalId": "00000000-1111-2222-3333-444444444444"
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "description": "string",
    "authMode": "AMLToken",
    "defaults": {
      "deploymentName": "string"
    },
    "properties": {
      "string": "string"
    },
    "provisioningState": "Succeeded",
    "scoringUri": "https://www.contoso.com/example",
    "swaggerUri": "https://www.contoso.com/example"
  },
  "sku": {
    "name": "string",
    "capacity": 1,
    "family": "string",
    "size": "string",
    "tier": "Free"
  },
  "systemData": {
    "createdAt": "2020-01-01T12:34:56.999Z",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2020-01-01T12:34:56.999Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  },
  "tags": {}
}

Codice di stato:: 201

{
  "name": "string",
  "type": "string",
  "id": "string",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444",
    "userAssignedIdentities": {
      "string": {
        "clientId": "00000000-1111-2222-3333-444444444444",
        "principalId": "00000000-1111-2222-3333-444444444444"
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "description": "string",
    "authMode": "AMLToken",
    "defaults": {
      "deploymentName": "string"
    },
    "properties": {
      "string": "string"
    },
    "provisioningState": "Updating",
    "scoringUri": "https://www.contoso.com/example",
    "swaggerUri": "https://www.contoso.com/example"
  },
  "sku": {
    "name": "string",
    "capacity": 1,
    "family": "string",
    "size": "string",
    "tier": "Free"
  },
  "systemData": {
    "createdAt": "2020-01-01T12:34:56.999Z",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2020-01-01T12:34:56.999Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  },
  "tags": {}
}

Definizioni

Nome	Descrizione
BatchEndpoint	I tipi di risorse rilevati concreti possono essere creati eseguendo l'aliasing di questo tipo usando un tipo di proprietà specifico.
BatchEndpointDefaults	Valori predefiniti dell'endpoint batch
BatchEndpointProperties	Configurazione dell'endpoint batch.
createdByType	Tipo di identità che ha creato la risorsa.
EndpointAuthKeys	Chiavi per l'autenticazione degli endpoint.
EndpointAuthMode	Enumerazione per determinare la modalità di autenticazione dell'endpoint.
EndpointProvisioningState	Stato del provisioning degli endpoint.
ErrorAdditionalInfo	L'errore di gestione delle risorse informazioni aggiuntive.
ErrorDetail	I dettagli dell'errore.
ErrorResponse	Risposta di errore
ManagedServiceIdentity	Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente)
ManagedServiceIdentityType	Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).
Sku	Definizione del modello di risorse che rappresenta lo SKU
SkuTier	Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
UserAssignedIdentity	Proprietà di identità assegnate dall'utente

BatchEndpoint

Oggetto

I tipi di risorse rilevati concreti possono essere creati eseguendo l'aliasing di questo tipo usando un tipo di proprietà specifico.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente)
kind	string	Metadati usati dal portale, dagli strumenti e così via per eseguire il rendering di esperienze utente diverse per le risorse dello stesso tipo.
location	string	Posizione geografica in cui risiede la risorsa
name	string	nome della risorsa.
properties	BatchEndpointProperties	[Obbligatorio] Attributi aggiuntivi dell'entità.
sku	Sku	Dettagli sku necessari per il contratto ARM per la scalabilità automatica.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
tags	object	Tag di risorsa.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

BatchEndpointDefaults

Oggetto

Valori predefiniti dell'endpoint batch

Nome	Tipo	Descrizione
deploymentName	string	Nome della distribuzione che sarà predefinita per l'endpoint. Questa distribuzione finisce per ottenere 100% traffico quando viene richiamato l'URL di assegnazione dei punteggi dell'endpoint.

BatchEndpointProperties

Oggetto

Configurazione dell'endpoint batch.

Nome	Tipo	Descrizione
authMode	EndpointAuthMode	[Obbligatorio] Metodo di autenticazione per richiamare l'endpoint (operazione del piano dati). Usare 'Key' per l'autenticazione basata su chiave. Usare "AMLToken" per l'autenticazione basata su token di Azure Machine Learning. Usare "AADToken" per l'autenticazione basata su token di Microsoft Entra.
defaults	BatchEndpointDefaults	Valori predefiniti per l'endpoint batch
description	string	Descrizione dell'endpoint di inferenza.
keys	EndpointAuthKeys (password)	EndpointAuthKeys da impostare inizialmente su un endpoint. Questa proprietà verrà sempre restituita come null. I valori AuthKey devono essere recuperati usando l'API ListKeys.
properties	object	Dizionario delle proprietà. Le proprietà possono essere aggiunte, ma non rimosse o modificate.
provisioningState	EndpointProvisioningState	Stato di provisioning per l'endpoint.
scoringUri	string (uri)	URI dell'endpoint.
swaggerUri	string (uri)	URI Swagger endpoint.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

EndpointAuthKeys

Oggetto

Chiavi per l'autenticazione degli endpoint.

Nome	Tipo	Descrizione
primaryKey	string (password)	Chiave primaria.
secondaryKey	string (password)	Chiave secondaria.

EndpointAuthMode

Enumerazione

Enumerazione per determinare la modalità di autenticazione dell'endpoint.

Valore	Descrizione
AMLToken
Key
AADToken

EndpointProvisioningState

Enumerazione

Stato del provisioning degli endpoint.

Valore	Descrizione
Creating
Deleting
Succeeded
Failed
Updating
Canceled

ErrorAdditionalInfo

Oggetto

L'errore di gestione delle risorse informazioni aggiuntive.

Nome	Tipo	Descrizione
info	object	Le informazioni aggiuntive.
type	string	Il tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

I dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	L'errore informazioni aggiuntive.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Obiettivo dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

ManagedServiceIdentity

Oggetto

Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente)

Nome	Tipo	Descrizione
principalId	string (uuid)	ID entità servizio dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.
tenantId	string (uuid)	ID tenant dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.
type	ManagedServiceIdentityType	Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	identità User-Assigned Set di identità assegnate dall'utente associate alla risorsa. Le chiavi del dizionario userAssignedIdentities saranno ID risorsa ARM nel formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. I valori del dizionario possono essere oggetti vuoti ({}) nelle richieste.

ManagedServiceIdentityType

Enumerazione

Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).

Valore	Descrizione
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Sku

Oggetto

Definizione del modello di risorse che rappresenta lo SKU

Nome	Tipo	Descrizione
capacity	integer (int32)	Se lo SKU supporta l'aumento o l'aumento del numero di istanze, è necessario includere l'intero della capacità. Se non è possibile aumentare o ridurre il numero di istanze per la risorsa, potrebbe essere omesso.
family	string	Se il servizio ha generazioni diverse di hardware, per lo stesso SKU, è possibile acquisire qui.
name	string	Nome dello SKU. Ad esempio - P3. Si tratta in genere di un codice lettera+numero
size	string	Dimensioni dello SKU. Quando il campo nome è la combinazione di livello e un altro valore, si tratta del codice autonomo.
tier	SkuTier	Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.

SkuTier

Enumerazione

Questo campo deve essere implementato dal provider di risorse se il servizio ha più di un livello, ma non è necessario in un PUT.

Valore	Descrizione
Free
Basic
Standard
Premium

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

UserAssignedIdentity

Oggetto

Proprietà di identità assegnate dall'utente

Nome	Tipo	Descrizione
clientId	string (uuid)	ID client dell'identità assegnata.
principalId	string (uuid)	ID entità dell'identità assegnata.

Condividi tramite

Batch Endpoints - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

CreateOrUpdate Workspace Batch Endpoint.

Esempio di richiesta

Risposta di esempio

Definizioni

BatchEndpoint

BatchEndpointDefaults

BatchEndpointProperties

createdByType

EndpointAuthKeys

EndpointAuthMode

EndpointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

Sku

SkuTier

systemData

UserAssignedIdentity