Batch Deployments - Get

Referência

Service:: Machine Learning

API Version:: 2024-04-01

Obtém uma implementação de inferência de lotes por ID.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
deploymentName	path	True	string	O identificador das implementações do Batch.
endpointName	path	True	string	Nome do ponto final
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	O ID da subscrição de destino.
workspaceName	path	True	string	Nome da área de trabalho do Azure Machine Learning. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	BatchDeploymentTrackedResource	Com êxito
Other Status Codes	ErrorResponse	Erro

Exemplos

Get Workspace Batch Deployment.

Sample Request

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/testDeploymentName?api-version=2024-04-01

Sample Response

Status code:: 200

{
  "id": "string",
  "name": "string",
  "type": "string",
  "properties": {
    "description": "string",
    "properties": {
      "string": "string"
    },
    "codeConfiguration": {
      "codeId": "string",
      "scoringScript": "string"
    },
    "environmentId": "string",
    "environmentVariables": {
      "string": "string"
    },
    "compute": "string",
    "errorThreshold": 1,
    "retrySettings": {
      "maxRetries": 1,
      "timeout": "PT5M"
    },
    "miniBatchSize": 1,
    "loggingLevel": "Info",
    "model": {
      "referenceType": "Id",
      "assetId": "string"
    },
    "maxConcurrencyPerInstance": 1,
    "outputAction": "SummaryOnly",
    "outputFileName": "string",
    "resources": {
      "instanceCount": 1,
      "instanceType": "string",
      "properties": {
        "string": {
          "843c2bb4-e5f1-4267-98c8-ba22a99dbb00": null
        }
      }
    },
    "provisioningState": "Creating"
  },
  "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
  }
}

Definições

Name	Description
BatchDeployment	Definições de inferência de lotes por implementação.
BatchDeploymentConfigurationType	Os tipos de propriedade enumerados para implementações em lote.
BatchDeploymentTrackedResource
BatchLoggingLevel	Registar verbosidade para inferência de lotes. O aumento da ordem de verbosidade para o registo é: Aviso, Informações e Depuração. O valor predefinido é Informações.
BatchOutputAction	Enum para determinar como a inferência de lotes irá processar a saída
BatchPipelineComponentDeploymentConfiguration	Propriedades de uma Implementação de Componentes do Batch Pipeline.
BatchRetrySettings	Repita as definições para uma operação de inferência de lotes.
CodeConfiguration	Configuração para um recurso de código de classificação.
createdByType	O tipo de identidade que criou o recurso.
DataPathAssetReference	Referência a um recurso através do respetivo caminho num arquivo 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 a erros
IdAssetReference	Referência a um recurso através do respetivo ID de recurso do ARM.
ManagedServiceIdentity	Identidade de serviço gerida (identidades atribuídas pelo sistema e/ou pelo utilizador)
ManagedServiceIdentityType	Tipo de identidade de serviço gerida (onde os tipos SystemAssigned e UserAssigned são permitidos).
OutputPathAssetReference	Referência a um recurso através do respetivo caminho numa saída de tarefa.
ReferenceType	Enumerar para determinar que método de referência utilizar para um recurso.
Sku	A definição do modelo de recurso que representa o SKU
SkuTier	Este campo tem de ser implementado pelo Fornecedor de Recursos se o serviço tiver mais do que um escalão, mas não for necessário num PUT.
systemData	Metadados relativos à criação e última modificação do recurso.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo utilizador

BatchDeployment

Definições de inferência de lotes por implementação.

Name	Tipo	Valor Predefinido	Description
codeConfiguration	CodeConfiguration		Configuração de código para a implementação do ponto final.
compute	string		Destino de computação para a operação de inferência de lotes.
deploymentConfiguration	BatchDeploymentConfiguration: BatchPipelineComponentDeploymentConfiguration		Propriedades relevantes para diferentes tipos de implementação.
description	string		Descrição da implementação do ponto final.
environmentId	string		ID do recurso arm ou AssetId da especificação do ambiente para a implementação do ponto final.
environmentVariables	object		Configuração de variáveis de ambiente para a implementação.
errorThreshold	integer	-1	Limiar de erro, se a contagem de erros para toda a entrada for superior a este valor, a inferência do lote será abortada. O intervalo é [-1, int. MaxValue]. Para FileDataset, este valor é a contagem de falhas de ficheiros. Para TabularDataset, este valor é a contagem de falhas de registo. Se estiver definido como -1 (o limite inferior), todas as falhas durante a inferência do lote serão ignoradas.
loggingLevel	BatchLoggingLevel	Info	Nível de registo da operação de inferência de lotes.
maxConcurrencyPerInstance	integer	1	Indica o número máximo de paralelismo por instância.
miniBatchSize	integer	10	Tamanho do mini-lote transmitido para cada invocação de lote. Para FileDataset, este é o número de ficheiros por mini-lote. Para TabularDataset, este é o tamanho dos registos em bytes, por mini-lote.
model	AssetReferenceBase: DataPathAssetReference IdAssetReference OutputPathAssetReference		Referência ao recurso de modelo para a implementação do ponto final.
outputAction	BatchOutputAction	AppendRow	Indica como a saída será organizada.
outputFileName	string	predictions.csv	Nome de ficheiro 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 aprovisionamento para a implementação do ponto final.
resources	DeploymentResourceConfiguration		Indica a configuração de computação para a tarefa. Se não for fornecido, a predefinição será a predefinição das predefinições definidas em ResourceConfiguration.
retrySettings	BatchRetrySettings		Repita as Definições da operação de inferência de lotes. Se não for fornecido, será predefinido para as predefinições definidas em BatchRetrySettings.

BatchDeploymentConfigurationType

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

Name	Tipo	Description
Model	string
PipelineComponent	string

BatchDeploymentTrackedResource

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identidade de serviço gerida (identidades atribuídas pelo sistema e/ou pelo utilizador)
kind	string	Metadados utilizados pelo portal/ferramentas/etc. para compor diferentes experiências de UX para recursos do mesmo tipo.
location	string	A localização geográfica onde o recurso se encontra
name	string	O nome do recurso
properties	BatchDeployment	[Obrigatório] Atributos adicionais da entidade.
sku	Sku	Detalhes do SKU necessários para o contrato arm para dimensionamento automático.
systemData	systemData	O Azure Resource Manager metadados que contêm informações createdBy e modifiedBy.
tags	object	Etiquetas de recursos.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BatchLoggingLevel

Registar verbosidade para inferência de lotes. O aumento da ordem de verbosidade para o registo é: Aviso, Informações e Depuração. O valor predefinido é Informações.

Name	Tipo	Description
Debug	string
Info	string
Warning	string

BatchOutputAction

Enum para determinar como a inferência de lotes irá processar a saída

Name	Tipo	Description
AppendRow	string
SummaryOnly	string

BatchPipelineComponentDeploymentConfiguration

Propriedades de uma Implementação de Componentes do Batch Pipeline.

Name	Tipo	Description
componentId	IdAssetReference	O ID arm do componente a ser executado.
deploymentConfigurationType	string: PipelineComponent	[Obrigatório] O tipo de implementação
description	string	A descrição que será aplicada à tarefa.
settings	object	Definições de tempo de execução para a tarefa de pipeline.
tags	object	As etiquetas que serão aplicadas à tarefa.

BatchRetrySettings

Repita as definições para uma operação de inferência de lotes.

Name	Tipo	Valor Predefinido	Description
maxRetries	integer	3	Contagem máxima de repetições para um mini-lote
timeout	string	PT30S	Tempo limite de invocação para um mini-lote, no formato ISO 8601.

CodeConfiguration

Configuração para um recurso de código de classificação.

Name	Tipo	Description
codeId	string	ID do recurso arm do recurso de código.
scoringScript	string	[Obrigatório] O script a executar no arranque. Por exemplo, "score.py"

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataPathAssetReference

Referência a um recurso através do respetivo caminho num arquivo de dados.

Name	Tipo	Description
datastoreId	string	ID de recurso arm do arquivo de dados onde o recurso está localizado.
path	string	O caminho do ficheiro/diretório no arquivo de dados.
referenceType	string: DataPath	[Obrigatório] Especifica o tipo de referência de recursos.

DeploymentProvisioningState

Valores possíveis para DeploymentProvisioningState.

Name	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Scaling	string
Succeeded	string
Updating	string

DeploymentResourceConfiguration

Name	Tipo	Valor Predefinido	Description
instanceCount	integer	1	Número opcional de instâncias ou nós utilizados pelo destino de computação.
instanceType	string		Tipo opcional de VM utilizado como suportado pelo destino de computação.
properties	object		Saco de propriedades adicionais.

ErrorAdditionalInfo

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

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

ErrorDetail

O detalhe do erro.

Name	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

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

IdAssetReference

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

Name	Tipo	Description
assetId	string	[Obrigatório] ID do recurso arm do recurso.
referenceType	string: Id	[Obrigatório] Especifica o tipo de referência de recursos.

ManagedServiceIdentity

Identidade de serviço gerida (identidades atribuídas pelo sistema e/ou pelo utilizador)

Name	Tipo	Description
principalId	string	O ID do principal de serviço da identidade atribuída pelo sistema. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema.
tenantId	string	O ID de inquilino da identidade atribuída pelo sistema. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerida (onde os tipos SystemAssigned e UserAssigned são permitidos).
userAssignedIdentities	<string, UserAssignedIdentity>	Identidades de User-Assigned O conjunto de identidades atribuídas pelo utilizador associadas ao recurso. As chaves de dicionário userAssignedIdentities serão IDs de recursos do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) nos pedidos.

ManagedServiceIdentityType

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

Name	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

OutputPathAssetReference

Referência a um recurso através do respetivo caminho numa saída de tarefa.

Name	Tipo	Description
jobId	string	ID do recurso arm da tarefa.
path	string	O caminho do ficheiro/diretório na saída da tarefa.
referenceType	string: OutputPath	[Obrigatório] Especifica o tipo de referência de recursos.

ReferenceType

Enumerar para determinar que método de referência utilizar para um recurso.

Name	Tipo	Description
DataPath	string
Id	string
OutputPath	string

Sku

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

Name	Tipo	Description
capacity	integer	Se o SKU suportar o aumento horizontal/in, o número inteiro de capacidade deve ser incluído. Se não for possível aumentar/reduzir horizontalmente o recurso, tal 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 letter+number
size	string	O tamanho do SKU. Quando o campo de nome é a combinação de camada e outro valor, este seria o código autónomo.
tier	SkuTier	Este campo tem de ser implementado pelo Fornecedor de Recursos se o serviço tiver mais do que um escalão, mas não for necessário num PUT.

SkuTier

Este campo tem de ser implementado pelo Fornecedor de Recursos se o serviço tiver mais do que um escalão, mas não for necessário num PUT.

Name	Tipo	Description
Basic	string
Free	string
Premium	string
Standard	string

systemData

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

Name	Tipo	Description
createdAt	string	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	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

Propriedades de identidade atribuídas pelo utilizador

Name	Tipo	Description
clientId	string	O ID de cliente da identidade atribuída.
principalId	string	O ID principal da identidade atribuída.