Batch Deployments - List

Serviço:

Machine Learning

Versão da API:

2026-05-01

Lista implantações de inferência em lote no espaço de trabalho.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Obrigató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	O 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.
$orderBy	query		string	Ordenação da lista.
$skip	query		string	Token de continuação para paginação.
$top	query		integer (int32)	Topo da lista.

Respostas

Name	Tipo	Descrição
200 OK	BatchDeploymentTrackedResourceArmPaginatedResult	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Descrição
user_impersonation	assumir a identidade da sua conta de utilizador

Exemplos

List Workspace Batch Deployment.

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

200

{
  "nextLink": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName/deployments?api-version=2025-07-01-preview&$skip=2",
  "value": [
    {
      "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",
        "codeConfiguration": {
          "codeId": "string",
          "scoringScript": "string"
        },
        "compute": "string",
        "environmentId": "string",
        "environmentVariables": {
          "string": "string"
        },
        "errorThreshold": 1,
        "loggingLevel": "Info",
        "maxConcurrencyPerInstance": 1,
        "miniBatchSize": 1,
        "model": {
          "assetId": "string",
          "referenceType": "Id"
        },
        "outputAction": "SummaryOnly",
        "outputFileName": "string",
        "properties": {
          "string": "string"
        },
        "provisioningState": "Creating",
        "resources": {
          "instanceCount": 1,
          "instanceType": "string",
          "properties": {
            "string": {
              "a3c13e2e-a213-4cac-9f5a-b49966906ad6": null
            }
          }
        },
        "retrySettings": {
          "maxRetries": 1,
          "timeout": "PT5M"
        }
      },
      "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

Name	Descrição
BatchDeployment	Tipos de recursos controlados concretos podem ser criados aliasing esse tipo usando um tipo de propriedade específico.
BatchDeploymentConfigurationType	Os tipos de propriedade enumerados para implantações em lote.
BatchDeploymentProperties	Configurações de inferência em lote por implantação.
BatchDeploymentTrackedResourceArmPaginatedResult	Uma lista paginada de entidades BatchDeployment.
BatchLoggingLevel	Detalhamento do log para inferência em lote. Aumentar a ordem de detalhamento para registro é: Aviso, Informações e Depuração. O valor predefinido é Info.
BatchOutputAction	Enum para determinar como a inferência em lote lidará com a saída
BatchPipelineComponentDeploymentConfiguration	Propriedades para uma implantação de componente de pipeline em lote.
BatchRetrySettings	Repita as configurações para uma operação de inferência em lote.
CodeConfiguration	Configuração para um ativo de código de pontuação.
createdByType	O tipo de identidade que criou o recurso.
DataPathAssetReference	Referência a um ativo por meio de seu caminho em um armazenamento de dados.
DeploymentProvisioningState	Valores possíveis para DeploymentProvisioningState.
DeploymentResourceConfiguration
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
IdAssetReference	Referência a um ativo através do seu ID de recurso ARM.
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).
OutputPathAssetReference	Referência a um ativo através de seu caminho em uma saída de trabalho.
ReferenceType	Enum para determinar qual método de referência usar para um ativo.
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

BatchDeployment

Object

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

Name	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	BatchDeploymentProperties	[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"

BatchDeploymentConfigurationType

Enumeração

Os tipos de propriedade enumerados para implantações em lote.

Valor	Descrição
Model
PipelineComponent

BatchDeploymentProperties

Object

Configurações de inferência em lote por implantação.

Name	Tipo	Valor predefinido	Descrição
codeConfiguration	CodeConfiguration		Configuração de código para a implantação do ponto de extremidade.
compute	string		Destino de computação para operação de inferência em lote.
deploymentConfiguration	BatchDeploymentConfiguration: BatchPipelineComponentDeploymentConfiguration		Propriedades relevantes para diferentes tipos de implantação.
description	string		Descrição da implantação do ponto de extremidade.
environmentId	string		ID de recurso ARM ou AssetId da especificação de ambiente para a implantação do ponto de extremidade.
environmentVariables	object		Configuração de variáveis de ambiente para a implantação.
errorThreshold	integer (int32)	-1	Limite de erro, se a contagem de erros para toda a entrada ultrapassar esse valor, a inferência em lote será anulada. O intervalo é [-1, int. ValorMáximo]. Para FileDataset, esse valor é a contagem de falhas de arquivo. Para TabularDataset, esse valor é a contagem de falhas de registro. Se definido como -1 (o limite inferior), todas as falhas durante a inferência em lote serão ignoradas.
loggingLevel	BatchLoggingLevel	Info	Detalhamento do log para inferência em lote. Aumentar a ordem de detalhamento para registro é: Aviso, Informações e Depuração. O valor predefinido é Info.
maxConcurrencyPerInstance	integer (int32)	1	Indica o número máximo de paralelismo por instância.
miniBatchSize	integer (int64)	10	Tamanho do minilote passado para cada chamada de lote. Para FileDataset, este é o número de arquivos por minilote. Para TabularDataset, esse é o tamanho dos registros em bytes, por minilote.
model	AssetReferenceBase: DataPathAssetReference IdAssetReference OutputPathAssetReference		Referência ao ativo de modelo para a implantação do ponto de extremidade.
outputAction	BatchOutputAction	AppendRow	Enum para determinar como a inferência em lote lidará com a saída
outputFileName	string	predictions.csv	Nome do arquivo de saída personalizado para append_row ação de saída.
properties	object		Dicionário de propriedades. As propriedades podem ser adicionadas, mas não removidas ou alteradas.
provisioningState	DeploymentProvisioningState		Estado de provisionamento para a implantação do ponto de extremidade.
resources	DeploymentResourceConfiguration		Indica a configuração de computação para o trabalho. Se não for fornecido, o padrão será definido como padrão para os padrões definidos em ResourceConfiguration.
retrySettings	BatchRetrySettings		Configurações de repetição para a operação de inferência em lote. Se não for fornecido, o padrão será definido como padrão em BatchRetrySettings.

BatchDeploymentTrackedResourceArmPaginatedResult

Object

Uma lista paginada de entidades BatchDeployment.

Name	Tipo	Descrição
nextLink	string (uri)	A ligação para a próxima página de itens
value	BatchDeployment[]	Os itens do BatchDeployment nesta página

BatchLoggingLevel

Enumeração

Detalhamento do log para inferência em lote. Aumentar a ordem de detalhamento para registro é: Aviso, Informações e Depuração. O valor predefinido é Info.

Valor	Descrição
Info
Warning
Debug

BatchOutputAction

Enumeração

Enum para determinar como a inferência em lote lidará com a saída

Valor	Descrição
SummaryOnly
AppendRow

BatchPipelineComponentDeploymentConfiguration

Object

Propriedades para uma implantação de componente de pipeline em lote.

Name	Tipo	Descrição
componentId	IdAssetReference	A ID ARM do componente a ser executado.
deploymentConfigurationType	string: PipelineComponent	[Obrigatório] O tipo de implantação
description	string	A descrição que será aplicada ao trabalho.
settings	object	Configurações de tempo de execução para o trabalho de pipeline.
tags	object	As tags que serão aplicadas ao trabalho.

BatchRetrySettings

Object

Repita as configurações para uma operação de inferência em lote.

Name	Tipo	Valor predefinido	Descrição
maxRetries	integer (int32)	3	Contagem máxima de tentativas para um minilote
timeout	string (duration)	PT30S	Tempo limite de invocação para um minilote, no formato ISO 8601.

CodeConfiguration

Object

Configuração para um ativo de código de pontuação.

Name	Tipo	Descrição
codeId	string	ID do recurso ARM do ativo de código.
scoringScript	string minLength: 1 pattern: [a-zA-Z0-9_]	[Obrigatório] O script a ser executado na inicialização. eg. "score.py"

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

DataPathAssetReference

Object

Referência a um ativo por meio de seu caminho em um armazenamento de dados.

Name	Tipo	Descrição
datastoreId	string	ID do recurso ARM do armazenamento de dados onde o ativo está localizado.
path	string	O caminho do arquivo/diretório no armazenamento de dados.
referenceType	string: DataPath	[Obrigatório] Especifica o tipo de referência de ativo.

DeploymentProvisioningState

Enumeração

Valores possíveis para DeploymentProvisioningState.

Valor	Descrição
Creating
Deleting
Scaling
Updating
Succeeded
Failed
Canceled

DeploymentResourceConfiguration

Object

Name	Tipo	Valor predefinido	Descrição
instanceCount	integer (int32)	1	Número opcional de instâncias ou nós usados pelo alvo de cálculo.
instanceType	string		Tipo opcional de VM usado conforme suportado pelo destino de computação.
properties			Saco de propriedades adicionais.

ErrorAdditionalInfo

Object

Informações adicionais sobre o erro de gestão de recursos.

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

ErrorDetail

Object

O detalhe do erro.

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

ErrorResponse

Object

Resposta de erro

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

IdAssetReference

Object

Referência a um ativo através do seu ID de recurso ARM.

Name	Tipo	Descrição
assetId	string minLength: 1 pattern: [a-zA-Z0-9_]	[Obrigatório] ID do recurso ARM do ativo.
referenceType	string: Id	[Obrigatório] Especifica o tipo de referência de ativo.

ManagedServiceIdentity

Object

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

Name	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 de 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

OutputPathAssetReference

Object

Referência a um ativo através de seu caminho em uma saída de trabalho.

Name	Tipo	Descrição
jobId	string	ID do recurso ARM do trabalho.
path	string	O caminho do arquivo/diretório na saída do trabalho.
referenceType	string: OutputPath	[Obrigatório] Especifica o tipo de referência de ativo.

ReferenceType

Enumeração

Enum para determinar qual método de referência usar para um ativo.

Valor	Descrição
Id
DataPath
OutputPath

Sku

Object

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

Name	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

Object

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

Name	Tipo	Descrição
createdAt	string (date-time)	A marca temporal da criação do recurso (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	A data e 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

Object

Propriedades de identidade atribuídas pelo usuário

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