Batch Deployments - List

Referência

Service:: Machine Learning

API Version:: 2023-10-01

Lista implantações de inferência do Lote no workspace.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments?api-version=2023-10-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
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
workspaceName	path	True	string	Nome do workspace 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 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	Êxito
Other Status Codes	ErrorResponse	Erro

Exemplos

List 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?api-version=2023-10-01&$orderBy=string&$top=1

Sample Response

Status code:: 200

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

Nome	Description
BatchDeployment	Configurações de inferência do lote por implantação.
BatchDeploymentTrackedResource
BatchDeploymentTrackedResourceArmPaginatedResult	Uma lista paginada de entidades BatchDeployment.
BatchLoggingLevel	Detalhamento de log para inferência em lote. Aumentar a ordem de detalhamento para registro em log é : Aviso, Informações e Depuração. O valor padrão é Info.
BatchOutputAction	Enumeração para determinar como a inferência em lote tratará a saída
BatchRetrySettings	Tente novamente as configurações de uma operação de inferência em lote.
CodeConfiguration	Configuração de 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	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 atribuídas pelo usuário)
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciada (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	Enumerar 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

Configurações de inferência do 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.
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	-1	Limite de erro, se a contagem de erros de toda a entrada for superior a esse valor, a inferência do 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 em lote serão ignoradas.
loggingLevel	BatchLoggingLevel	Info	Nível de registro em log para a 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 invocação em lote. Para FileDataset, esse é 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	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á os padrões definidos em ResourceConfiguration.
retrySettings	BatchRetrySettings		Repetir configurações para a operação de inferência em lote. Se não for fornecido, o padrão será os padrões definidos em BatchRetrySettings.

BatchDeploymentTrackedResource

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 atribuídas 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 em que o recurso reside
name	string	O nome do recurso
properties	BatchDeployment	[Obrigatório] Atributos adicionais da entidade.
sku	Sku	Detalhes de SKU necessários para o contrato do ARM para Dimensionamento Automático.
systemData	systemData	Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
tags	object	Marcas de recurso.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BatchDeploymentTrackedResourceArmPaginatedResult

Uma lista paginada de entidades BatchDeployment.

Nome	Tipo	Description
nextLink	string	O link para a próxima página de objetos BatchDeployment. Se for nulo, não haverá páginas adicionais.
value	BatchDeploymentTrackedResource[]	Uma matriz de objetos do tipo BatchDeployment.

BatchLoggingLevel

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

Nome	Tipo	Description
Debug	string
Info	string
Warning	string

BatchOutputAction

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

Nome	Tipo	Description
AppendRow	string
SummaryOnly	string

BatchRetrySettings

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

Nome	Tipo	Valor padrão	Description
maxRetries	integer	3	Contagem máxima de repetição para um minilote
timeout	string	PT30S	Tempo limite de invocação para um minilote, no formato ISO 8601.

CodeConfiguration

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

Nome	Tipo	Description
codeId	string	ID de recurso do ARM do ativo de código.
scoringScript	string	[Obrigatório] O script a ser executado na inicialização. ex. "score.py"

createdByType

O tipo de identidade que criou o recurso.

Nome	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.

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

Valores possíveis para DeploymentProvisioningState.

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

DeploymentResourceConfiguration

Nome	Tipo	Valor padrão	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 usada como suporte pelo destino de computação.
properties	object		Recipiente de propriedades adicionais.

ErrorAdditionalInfo

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

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

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

IdAssetReference

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

Nome	Tipo	Description
assetId	string	[Obrigatório] ID de recurso do ARM do ativo.
referenceType	string: Id	[Obrigatório] Especifica o tipo de referência de ativo.

ManagedServiceIdentity

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

Nome	Tipo	Description
principalId	string	A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.
tenantId	string	A ID do locatário da identidade atribuída pelo sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciada (em que os tipos SystemAssigned e UserAssigned são permitidos).
userAssignedIdentities	<string, UserAssignedIdentity>	identidades 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 de dicionário podem ser objetos vazios ({}) em solicitações.

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciada (em que os tipos SystemAssigned e UserAssigned são permitidos).

Nome	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

OutputPathAssetReference

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

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

Nome	Tipo	Description
DataPath	string
Id	string
OutputPath	string

Sku

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

Nome	Tipo	Description
capacity	integer	Se o SKU der suporte a expansão/entrada, o inteiro de capacidade deverá ser incluído. Se o scale out/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 de letra+número
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

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.

Nome	Tipo	Description
Basic	string
Free	string
Premium	string
Standard	string

systemData

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

Nome	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

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