Batch Deployments - List

Serviço:: Machine Learning

Versão da API:: 2025-12-01

Lista implantações de inferência em lote no workspace.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpointName	path	True	string	Nome do 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 workspace do Azure Machine Learning
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$orderBy	query		string	Ordenação de lista.
$skip	query		string	Token de continuação para paginação.
$top	query		integer (int32)	No topo da lista.

Respostas

Nome	Tipo	Description
200 OK	BatchDeploymentTrackedResourceArmPaginatedResult	A operação do Azure foi concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	Personificar sua conta de usuário

Exemplos

List Workspace Batch Deployment.

Solicitação de exemplo

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=2025-12-01&$orderBy=string&$top=1

Resposta de exemplo

Código de status:: 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

Nome	Description
BatchDeployment	Tipos concretos de recursos rastreados podem ser criados com o alias desse 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 de log para inferência em lote. A ordem crescente de detalhamento para o registro é: Aviso, Informações e Depuração. O valor padrão é Info.
BatchOutputAction	Enumeração para determinar como a inferência em lote manipulará 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 repositório de dados.
DeploymentProvisioningState	Valores possíveis para DeploymentProvisioningState.
DeploymentResourceConfiguration
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
IdAssetReference	Referência a um ativo por meio de sua ID de recurso do ARM.
ManagedServiceIdentity	Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
OutputPathAssetReference	Referência a um ativo por meio de seu caminho em uma saída de trabalho.
ReferenceType	Enumeração para determinar qual método de referência usar para um ativo.
Sku	A definição do modelo de recurso que representa o SKU
SkuTier	Esse campo deverá ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT.
systemData	Metadados relativos à criação e última modificação do recurso.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário

BatchDeployment

Objeto

Tipos concretos de recursos rastreados podem ser criados com o alias desse tipo usando um tipo de propriedade específico.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)
kind	string	Metadados usados pelo portal/ferramentas/etc para renderizar diferentes experiências de experiência de experiência de usuário para recursos do mesmo tipo.
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties	BatchDeploymentProperties	[Obrigatório] Atributos adicionais da entidade.
sku	Sku	Detalhes de SKU necessários para o contrato do ARM para dimensionamento automático.
systemData	systemData	Metadados do Azure Resource Manager que contêm 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	Description
Model
PipelineComponent

BatchDeploymentProperties

Objeto

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

Nome	Tipo	Valor padrão	Description
codeConfiguration	CodeConfiguration		Configuração de código para a implantação do ponto de extremidade.
compute	string		Destino de computação para a 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 do 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. MaxValue]. 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 do lote serão ignoradas.
loggingLevel	BatchLoggingLevel	Info	Detalhamento de log para inferência em lote. A ordem crescente de detalhamento para o registro é: Aviso, Informações e Depuração. O valor padrão é 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 invocação em lote. Para FileDataset, esse é o número de arquivos por mini-lote. Para TabularDataset, esse é o tamanho dos registros em bytes, por mini-lote.
model	AssetReferenceBase: DataPathAssetReference IdAssetReference OutputPathAssetReference		Referência ao ativo de modelo para a implantação do ponto de extremidade.
outputAction	BatchOutputAction	AppendRow	Enumeração para determinar como a inferência em lote manipulará 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á 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á os padrões definidos em BatchRetrySettings.

BatchDeploymentTrackedResourceArmPaginatedResult

Objeto

Uma lista paginada de entidades BatchDeployment.

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	BatchDeployment[]	Os itens do BatchDeployment nesta página

BatchLoggingLevel

Enumeração

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

Valor	Description
Info
Warning
Debug

BatchOutputAction

Enumeração

Enumeração para determinar como a inferência em lote manipulará a saída

Valor	Description
SummaryOnly
AppendRow

BatchPipelineComponentDeploymentConfiguration

Objeto

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

Nome	Tipo	Description
componentId	IdAssetReference	A ID do ARM do componente a ser executado.
deploymentConfigurationType	string: PipelineComponent	[Obrigatório] O tipo da 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 marcas que serão aplicadas ao trabalho.

BatchRetrySettings

Objeto

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

Nome	Tipo	Valor padrão	Description
maxRetries	integer (int32)	3	Contagem máxima de repetição para um mini-lote
timeout	string (duration)	PT30S	Tempo limite de invocação para um mini-lote, no formato ISO 8601.

CodeConfiguration

Objeto

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

Nome	Tipo	Description
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	Description
User
Application
ManagedIdentity
Key

DataPathAssetReference

Objeto

Referência a um ativo por meio de seu caminho em um repositório de dados.

Nome	Tipo	Description
datastoreId	string	ID do recurso ARM do armazenamento de dados em que 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	Description
Creating
Deleting
Scaling
Updating
Succeeded
Failed
Canceled

DeploymentResourceConfiguration

Objeto

Nome	Tipo	Valor padrão	Description
instanceCount	integer (int32)	1	Número opcional de instâncias ou nós usados pelo destino de computação.
instanceType	string		Tipo opcional de VM usado como suporte pelo destino de computação.
properties			Recipiente de propriedades adicionais.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
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 destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

IdAssetReference

Objeto

Referência a um ativo por meio de sua ID de recurso do ARM.

Nome	Tipo	Description
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

Objeto

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

Nome	Tipo	Description
principalId	string (uuid)	A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
tenantId	string (uuid)	A ID do locatário da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
userAssignedIdentities	<string, UserAssignedIdentity>	Identidades de User-Assigned O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/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 (em que os tipos SystemAssigned e UserAssigned são permitidos).

Valor	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

OutputPathAssetReference

Objeto

Referência a um ativo por meio de seu caminho em uma saída de trabalho.

Nome	Tipo	Description
jobId	string	ID de recurso do 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

Enumeração para determinar qual método de referência usar para um ativo.

Valor	Description
Id
DataPath
OutputPath

Sku

Objeto

A definição do modelo de recurso que representa o SKU

Nome	Tipo	Description
capacity	integer (int32)	Se o SKU der suporte a expansão/entrada, o inteiro de capacidade deverá ser incluído. Se a escala horizontal/in 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 a mesma SKU, isso poderá ser capturado aqui.
name	string	O nome da SKU. Ex - P3. Normalmente, é um código letter+number
size	string	O tamanho da SKU. Quando o campo de nome é a combinação de camada e algum outro valor, esse seria o código autônomo.
tier	SkuTier	Esse campo deverá ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT.

SkuTier

Enumeração

Esse campo deverá ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT.

Valor	Description
Free
Basic
Standard
Premium

systemData

Objeto

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

Nome	Tipo	Description
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

Objeto

Propriedades de identidade atribuídas pelo usuário

Nome	Tipo	Description
clientId	string (uuid)	A ID do cliente da identidade atribuída.
principalId	string (uuid)	A ID da entidade de segurança da identidade atribuída.

Compartilhar via

Batch Deployments - List

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

List Workspace Batch Deployment.

Solicitação de exemplo

Resposta de exemplo

Definições

BatchDeployment

BatchDeploymentConfigurationType

BatchDeploymentProperties

BatchDeploymentTrackedResourceArmPaginatedResult

BatchLoggingLevel

BatchOutputAction

BatchPipelineComponentDeploymentConfiguration

BatchRetrySettings

CodeConfiguration

createdByType

DataPathAssetReference

DeploymentProvisioningState

DeploymentResourceConfiguration

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdAssetReference

ManagedServiceIdentity

ManagedServiceIdentityType

OutputPathAssetReference

ReferenceType

Sku

SkuTier

systemData

UserAssignedIdentity