Partilhar via


Batch Deployments - List

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=2024-04-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments?api-version=2024-04-01&$orderBy={$orderBy}&$top={$top}&$skip={$skip}

Parâmetros do URI

Name Em Necessário Tipo Description
endpointName
path True

string

Nome do ponto final

resourceGroupName
path True

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

A ID da assinatura de destino.

workspaceName
path True

string

Nome do espaço de trabalho do Azure Machine Learning.

Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

api-version
query True

string

A versão da API a ser usada 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 Description
200 OK

BatchDeploymentTrackedResourceArmPaginatedResult

Sucesso

Other Status Codes

ErrorResponse

Erro

Exemplos

List Workspace Batch Deployment.

Pedido de amostra

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

Resposta da amostra

{
  "value": [
    {
      "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": {
              "a3c13e2e-a213-4cac-9f5a-b49966906ad6": 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
      }
    }
  ],
  "nextLink": "string"
}

Definições

Name Description
BatchDeployment

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

BatchDeploymentConfigurationType

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

BatchDeploymentTrackedResource
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 padrão é 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

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

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

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

Name Tipo Default value Description
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

-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

Nível de registro para operação de inferência em lote.

maxConcurrencyPerInstance

integer

1

Indica o número máximo de paralelismo por instância.

miniBatchSize

integer

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:

Referência ao ativo de modelo para a implantação do ponto de extremidade.

outputAction

BatchOutputAction

AppendRow

Indica como a saída será organizada.

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.

BatchDeploymentConfigurationType

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

Name Tipo Description
Model

string

PipelineComponent

string

BatchDeploymentTrackedResource

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

BatchDeployment

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

BatchDeploymentTrackedResourceArmPaginatedResult

Uma lista paginada de entidades BatchDeployment.

Name Tipo Description
nextLink

string

O link para a próxima página de objetos BatchDeployment. Se null, não há páginas adicionais.

value

BatchDeploymentTrackedResource[]

Uma matriz de objetos do tipo 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 padrão é Info.

Name Tipo Description
Debug

string

Info

string

Warning

string

BatchOutputAction

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

Name Tipo Description
AppendRow

string

SummaryOnly

string

BatchPipelineComponentDeploymentConfiguration

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

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

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

Name Tipo Default value Description
maxRetries

integer

3

Contagem máxima de tentativas para um minilote

timeout

string

PT30S

Tempo limite de invocação para um minilote, no formato ISO 8601.

CodeConfiguration

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

Name Tipo Description
codeId

string

ID do recurso ARM do ativo de código.

scoringScript

string

[Obrigatório] O script a ser executado na inicialização. 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 ativo por meio de seu caminho em um armazenamento de dados.

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

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 Default value Description
instanceCount

integer

1

Número opcional de instâncias ou nós usados pelo destino de computação.

instanceType

string

Tipo opcional de VM usado conforme suportado pelo destino de computação.

properties

object

Saco de propriedades adicionais.

ErrorAdditionalInfo

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

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[]

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

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

IdAssetReference

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

Name Tipo Description
assetId

string

[Obrigatório] ID do recurso ARM do ativo.

referenceType string:

Id

[Obrigatório] Especifica o tipo de referência de ativo.

ManagedServiceIdentity

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

Name Tipo Description
principalId

string

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

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

Tipo de identidade de serviço gerenciado (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 ativo através de seu caminho em uma saída de trabalho.

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

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

Name Tipo Description
DataPath

string

Id

string

OutputPath

string

Sku

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

Name Tipo Description
capacity

integer

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

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.

Name Tipo Description
Basic

string

Free

string

Premium

string

Standard

string

systemData

Metadados referentes à 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 usuário

Name Tipo Description
clientId

string

O ID do cliente da identidade atribuída.

principalId

string

O ID principal da identidade atribuída.