Batch Endpoints - Create Or Update

Serviço:: Machine Learning

Versão API:: 2025-12-01

Crie um endpoint de inferência por lote (assíncrono).
Cria um ponto de extremidade de inferência em lote (assíncrono).

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

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
endpointName	path	True	string	Nome para o ponto de extremidade do lote.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Nome do Espaço de Trabalho do Azure Machine Learning
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Órgão do Pedido

Nome	Necessário	Tipo	Descrição
location	True	string	A geolocalização onde o recurso vive
properties	True	BatchEndpointProperties	[Obrigatório] Atributos adicionais da entidade.
identity		ManagedServiceIdentity	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)
kind		string	Metadados usados pelo portal/ferramenta/etc para renderizar diferentes experiências de UX para recursos do mesmo tipo.
sku		Sku	Detalhes de sku necessários para o contrato ARM para Autoscaling.
tags		object	Tags de recursos.

Respostas

Nome	Tipo	Descrição
200 OK	BatchEndpoint	Operação de atualização do recurso 'BatchEndpoint' bem-sucedida
201 Created	BatchEndpoint	O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso. Cabeçalhos Azure-AsyncOperation: string Retry-After: integer x-ms-async-operation-timeout: string
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Nome

Tipo

Descrição

200 OK

BatchEndpoint

Operação de atualização do recurso 'BatchEndpoint' bem-sucedida

201 Created

BatchEndpoint

O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.

Cabeçalhos

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

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Flow: implicit
URL de autorização: https://login.microsoftonline.com/common/oauth2/authorize

Alcances

Nome	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

CreateOrUpdate Workspace Batch Endpoint.

Pedido de exemplo

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": {}
}

Resposta de exemplo

Código de estado:: 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": {}
}

Código de estado:: 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": {}
}

Definições

Nome	Descrição
BatchEndpoint	Tipos de recursos controlados concretos podem ser criados aliasing esse tipo usando um tipo de propriedade específico.
BatchEndpointDefaults	Valores padrão do ponto de extremidade em lote
BatchEndpointProperties	Configuração de ponto final em lote.
createdByType	O tipo de identidade que criou o recurso.
EndpointAuthKeys	Chaves para autenticação de ponto final.
EndpointAuthMode	Enum para determinar o modo de autenticação do ponto final.
EndpointProvisioningState	Estado de provisionamento de ponto final.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ManagedServiceIdentity	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
Sku	A definição do modelo de recursos que representa a SKU
SkuTier	Este campo deve ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não é obrigatório em um PUT.
systemData	Metadados referentes à criação e última modificação do recurso.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário

BatchEndpoint

Objetivo

Tipos de recursos controlados concretos podem ser criados aliasing esse tipo usando um tipo de propriedade específico.

Nome	Tipo	Descrição
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)
kind	string	Metadados usados pelo portal/ferramenta/etc para renderizar diferentes experiências de UX para recursos do mesmo tipo.
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties	BatchEndpointProperties	[Obrigatório] Atributos adicionais da entidade.
sku	Sku	Detalhes de sku necessários para o contrato ARM para Autoscaling.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BatchEndpointDefaults

Objetivo

Valores padrão do ponto de extremidade em lote

Nome	Tipo	Descrição
deploymentName	string	Nome da implantação que será padrão para o ponto de extremidade. Essa implantação acabará recebendo 100% tráfego quando a URL de pontuação do ponto de extremidade for invocada.

BatchEndpointProperties

Objetivo

Configuração de ponto final em lote.

Nome	Tipo	Descrição
authMode	EndpointAuthMode	[Obrigatório] O método de autenticação para invocar o ponto de extremidade (operação do plano de dados). Use 'Key' para autenticação baseada em chave. Use 'AMLToken' para autenticação baseada em token do Azure Machine Learning. Use 'AADToken' para autenticação baseada em token do Microsoft Entra.
defaults	BatchEndpointDefaults	Valores padrão para Batch Endpoint
description	string	Descrição do parâmetro de avaliação de inferência.
keys	EndpointAuthKeys (password)	EndpointAuthKeys para definir inicialmente em um Endpoint. Esta propriedade será sempre retornada como null. Os valores AuthKey devem ser recuperados usando a API ListKeys.
properties	object	Dicionário de propriedades. As propriedades podem ser adicionadas, mas não removidas ou alteradas.
provisioningState	EndpointProvisioningState	Estado de provisionamento para o ponto de extremidade.
scoringUri	string (uri)	URI do ponto final.
swaggerUri	string (uri)	URI do Endpoint Swagger.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

EndpointAuthKeys

Objetivo

Chaves para autenticação de ponto final.

Nome	Tipo	Descrição
primaryKey	string (password)	A chave primária.
secondaryKey	string (password)	A chave secundária.

EndpointAuthMode

Enumeração

Enum para determinar o modo de autenticação do ponto final.

Valor	Descrição
AMLToken
Key
AADToken

EndpointProvisioningState

Enumeração

Estado de provisionamento de ponto final.

Valor	Descrição
Creating
Deleting
Succeeded
Failed
Updating
Canceled

ErrorAdditionalInfo

Objetivo

O erro de gerenciamento de recursos informações adicionais.

Nome	Tipo	Descrição
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objetivo

O detalhe do erro.

Nome	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objetivo

Resposta de erro

Nome	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

ManagedServiceIdentity

Objetivo

Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)

Nome	Tipo	Descrição
principalId	string (uuid)	O ID da entidade de serviço da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
tenantId	string (uuid)	O ID do locatário da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identidades O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.

ManagedServiceIdentityType

Enumeração

Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos).

Valor	Descrição
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Sku

Objetivo

A definição do modelo de recursos que representa a SKU

Nome	Tipo	Descrição
capacity	integer (int32)	Se a SKU suportar scaleout/in, o inteiro de capacidade deve ser incluído. Se a expansão/entrada não for possível para o recurso, isso poderá ser omitido.
family	string	Se o serviço tiver diferentes gerações de hardware, para o mesmo SKU, isso pode ser capturado aqui.
name	string	O nome do SKU. Ex - P3. Normalmente, é um código de letra + número
size	string	O tamanho do SKU. Quando o campo de nome é a combinação de camada e algum outro valor, este seria o código autônomo.
tier	SkuTier	Este campo deve ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não é obrigatório em um PUT.

SkuTier

Enumeração

Este campo deve ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não é obrigatório em um PUT.

Valor	Descrição
Free
Basic
Standard
Premium

systemData

Objetivo

Metadados referentes à criação e última modificação do recurso.

Nome	Tipo	Descrição
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Objetivo

Propriedades de identidade atribuídas pelo usuário

Nome	Tipo	Descrição
clientId	string (uuid)	O ID do cliente da identidade atribuída.
principalId	string (uuid)	O ID principal da identidade atribuída.

Partilhar via

Batch Endpoints - Create Or Update

Parâmetros URI

Órgão do Pedido

Respostas

Segurança

azure_auth

Alcances

Exemplos

CreateOrUpdate Workspace Batch Endpoint.

Pedido de exemplo

Resposta de exemplo

Definições

BatchEndpoint

BatchEndpointDefaults

BatchEndpointProperties

createdByType

EndpointAuthKeys

EndpointAuthMode

EndpointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

Sku

SkuTier

systemData

UserAssignedIdentity