Compute Node - List

Lista os Nós de Computação no Conjunto especificado.

GET {batchUrl}/pools/{poolId}/nodes?api-version=2023-11-01.18.0
GET {batchUrl}/pools/{poolId}/nodes?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

Parâmetros do URI

Name Em Necessário Tipo Description
batchUrl
path True

string

O URL base para todos os pedidos de serviço Azure Batch.

poolId
path True

string

O ID do Conjunto a partir do qual pretende listar Os Nós de Computação.

api-version
query True

string

Versão da API de Cliente.

$filter
query

string

Uma cláusula OData $filter. Para obter mais informações sobre como construir este filtro, consulte https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.

$select
query

string

Uma cláusula OData $select.

maxresults
query

integer

int32

O número máximo de itens a devolver na resposta. Pode ser devolvido um máximo de 1000 Nós de Computação.

timeout
query

integer

int32

O tempo máximo que o servidor pode gastar a processar o pedido, em segundos. A predefinição é 30 segundos.

Cabeçalho do Pedido

Media Types: "application/json; odata=minimalmetadata"

Name Necessário Tipo Description
client-request-id

string

uuid

A identidade do pedido gerado pelo autor da chamada, sob a forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Se o servidor deve devolver o client-request-id na resposta.

ocp-date

string

date-time-rfc1123

A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-a explicitamente se estiver a chamar a API REST diretamente.

Respostas

Name Tipo Description
200 OK

ComputeNodeListResult

Uma resposta que contém a lista de Nós de Computação.

Cabeçalhos

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
Other Status Codes

BatchError

O erro do serviço Batch.

Segurança

azure_auth

Microsoft Entra fluxo de código de autenticação OAuth 2.0

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

Âmbitos

Name Description
user_impersonation Representar a sua conta de utilizador

Authorization

Tipo: apiKey
Em: header

Exemplos

Node list

Pedido de amostra

GET account.region.batch.azure.com/pools/poolId/nodes?api-version=2023-11-01.18.0


Resposta da amostra

{
  "value": [
    {
      "id": "tvm-1695681911_1-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2016-11-22T22:22:27.2236818Z",
      "lastBootTime": "2016-11-22T22:22:24.4634125Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_1-20161122t193202z",
      "vmSize": "small",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T22:22:27.2236818Z",
        "endTime": "2016-11-22T22:22:27.567189Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
      }
    },
    {
      "id": "tvm-1695681911_2-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2016-11-22T19:37:31.4285526Z",
      "lastBootTime": "2016-11-22T19:37:28.623369Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
      "vmSize": "small",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T19:37:31.4285526Z",
        "endTime": "2016-11-22T19:37:31.838028Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
      }
    },
    {
      "id": "tvm-1695681911_3-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2016-11-22T19:36:51.0013378Z",
      "lastBootTime": "2016-11-22T19:36:48.21721Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_3-20161122t193202z",
      "vmSize": "small",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T19:36:51.0013378Z",
        "endTime": "2016-11-22T19:36:51.2363447Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
      }
    }
  ]
}

Definições

Name Description
AutoUserScope

O âmbito do utilizador automático

AutoUserSpecification

Especifica os parâmetros para o utilizador automático que executa uma Tarefa no serviço Batch.

BatchError

Uma resposta de erro recebida do serviço Azure Batch.

BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.

CertificateReference

Uma referência a um Certificado a ser instalado em Nós de Computação num Conjunto.

CertificateStoreLocation

A localização do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado.

CertificateVisibility

Que contas de utilizador no Nó de Computação devem ter acesso aos dados privados do Certificado.

ComputeNode

Um Nó de Computação no serviço Batch.

ComputeNodeEndpointConfiguration

A configuração do ponto final para o Nó de Computação.

ComputeNodeError

Um erro encontrado por um Nó de Computação.

ComputeNodeIdentityReference

A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.

ComputeNodeListResult

O resultado da listagem dos Nós de Computação num Conjunto.

ComputeNodeState

O estado atual do Nó de Computação.

ContainerRegistry

Um registo de contentor privado.

ContainerWorkingDirectory

A localização do diretório de trabalho tarefa do contentor.

ElevationLevel

O nível de elevação do utilizador.

EnvironmentSetting

Uma variável de ambiente a definir num processo de Tarefa.

ErrorCategory

A categoria do erro.

ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

ImageReference

Uma referência a uma Imagem do Azure Máquinas Virtuais Marketplace ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de Imagem do Azure Marketplace verificadas por Azure Batch, veja a operação "Listar Imagens Suportadas".

InboundEndpoint

Um ponto final de entrada num Nó de Computação.

InboundEndpointProtocol

O protocolo do ponto final.

NameValuePair

Representa um par nome-valor.

NodeAgentInformation

Informações sobre o agente do Nó de Computação.

ResourceFile

Um único ficheiro ou vários ficheiros a transferir para um Nó de Computação.

SchedulingState

Se o Nó de Computação está disponível para Agendamento de tarefas.

StartTask

Uma Tarefa que é executada quando um Nó associa um Conjunto no serviço Azure Batch ou quando o Nó de Computação é reiniciado ou reproduzido.

StartTaskInformation

Informações sobre uma StartTask em execução num Nó de Computação.

StartTaskState

O estado do StartTask no Nó de Computação.

TaskContainerExecutionInformation

Contém informações sobre o contentor que uma Tarefa está a executar.

TaskContainerSettings

As definições de contentor para uma Tarefa.

TaskExecutionInformation

Informações sobre a execução de uma Tarefa.

TaskExecutionResult

O resultado da execução da tarefa.

TaskFailureInformation

Informações sobre uma Falha de tarefa.

TaskInformation

Informações sobre uma Tarefa em execução num Nó de Computação.

TaskState

O estado da Tarefa.

UserIdentity

A definição da identidade de utilizador na qual a Tarefa é executada.

VirtualMachineInfo

Informações sobre o estado atual da máquina virtual.

AutoUserScope

O âmbito do utilizador automático

Name Tipo Description
pool

string

Especifica que a Tarefa é executada como a Conta de utilizador automático comum que é criada em todos os Nós de Computação num Conjunto.

task

string

Especifica que o serviço deve criar um novo utilizador para a Tarefa.

AutoUserSpecification

Especifica os parâmetros para o utilizador automático que executa uma Tarefa no serviço Batch.

Name Tipo Description
elevationLevel

ElevationLevel

O nível de elevação do utilizador automático.
O valor predefinido é nonAdmin.

scope

AutoUserScope

O âmbito do utilizador automático
O valor predefinido é conjunto. Se o conjunto estiver a executar o Windows, deve ser especificado um valor de Tarefa se for necessário um isolamento mais rigoroso entre as tarefas. Por exemplo, se a tarefa sofrer uma mutação do registo de uma forma que possa afetar outras tarefas ou se tiverem sido especificados certificados no conjunto que não devem ser acessíveis por tarefas normais, mas que devem ser acessíveis por StartTasks.

BatchError

Uma resposta de erro recebida do serviço Azure Batch.

Name Tipo Description
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

message

ErrorMessage

Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador.

values

BatchErrorDetail[]

Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.

Name Tipo Description
key

string

Um identificador que especifica o significado da propriedade Valor.

value

string

As informações adicionais incluídas na resposta de erro.

CertificateReference

Uma referência a um Certificado a ser instalado em Nós de Computação num Conjunto.

Name Tipo Description
storeLocation

CertificateStoreLocation

A localização do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado.
O valor predefinido é currentuser. Esta propriedade é aplicável apenas a Conjuntos configurados com Nós de Computação do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration com uma referência de Imagem do Windows). Para Nós de Computação do Linux, os Certificados são armazenados num diretório dentro do diretório de trabalho de tarefas e é fornecida uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR à Tarefa para consultar esta localização. Para Certificados com visibilidade de "remoteUser", é criado um diretório "certificados" no diretório principal do utilizador (por exemplo, /home/{user-name}/certs) e os Certificados são colocados nesse diretório.

storeName

string

O nome do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado.
Esta propriedade é aplicável apenas a Conjuntos configurados com Nós de Computação do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration com uma referência de Imagem do Windows). Os nomes de arquivo comuns incluem: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, mas também pode ser utilizado qualquer nome de arquivo personalizado. O valor predefinido é O Meu.

thumbprint

string

O thumbprint do Certificado.

thumbprintAlgorithm

string

O algoritmo com o qual o thumbprint está associado. Tem de ser sha1.

visibility

CertificateVisibility[]

Que contas de utilizador no Nó de Computação devem ter acesso aos dados privados do Certificado.
Pode especificar mais do que uma visibilidade nesta coleção. A predefinição é todas as Contas.

CertificateStoreLocation

A localização do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado.

Name Tipo Description
currentuser

string

Os certificados devem ser instalados no arquivo de Certificados CurrentUser.

localmachine

string

Os certificados devem ser instalados no arquivo de Certificados LocalMachine.

CertificateVisibility

Que contas de utilizador no Nó de Computação devem ter acesso aos dados privados do Certificado.

Name Tipo Description
remoteuser

string

O Certificado deve estar visível para as contas de utilizador nas quais os utilizadores acedem remotamente ao Nó de Computação.

starttask

string

O Certificado deve estar visível para a conta de utilizador na qual o StartTask é executado. Tenha em atenção que se o Âmbito do AutoUser for Conjunto para StartTask e uma Tarefa, este certificado também estará visível para a Tarefa.

task

string

O Certificado deve estar visível para as contas de utilizador nas quais as Tarefas de Trabalho são executadas.

ComputeNode

Um Nó de Computação no serviço Batch.

Name Tipo Description
affinityId

string

Um identificador que pode ser transmitido ao adicionar uma Tarefa para pedir que a Tarefa seja agendada neste Nó de Computação.
Tenha em atenção que se trata apenas de uma afinidade suave. Se o Nó de Computação de destino estiver ocupado ou indisponível no momento em que a Tarefa estiver agendada, a Tarefa será agendada noutro local.

allocationTime

string

O momento em que este Nó de Computação foi alocado ao Conjunto.
Esta é a altura em que o Nó de Computação foi inicialmente alocado e não é alterado uma vez definido. Não é atualizado quando o Nó de Computação é reparado ou preempido.

certificateReferences

CertificateReference[]

A lista de Certificados instalados no Nó de Computação.
Para Os Nós do Windows, o serviço Batch instala os Certificados no arquivo e localização de Certificados especificados. Para Nós de Computação do Linux, os Certificados são armazenados num diretório dentro do diretório de trabalho de tarefas e é fornecida uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR à Tarefa para consultar esta localização. Para Certificados com visibilidade de "remoteUser", é criado um diretório "certificados" no diretório principal do utilizador (por exemplo, /home/{user-name}/certs) e os Certificados são colocados nesse diretório.

Aviso: esta propriedade foi preterida e será removida após fevereiro de 2024. Em alternativa, utilize a Extensão Azure KeyVault .

endpointConfiguration

ComputeNodeEndpointConfiguration

A configuração do ponto final para o Nó de Computação.

errors

ComputeNodeError[]

A lista de erros que estão atualmente a ser encontrados pelo Nó de Computação.

id

string

O ID do Nó de Computação.
A cada Nó de Computação que é adicionado a um Conjunto é atribuído um ID exclusivo. Sempre que um Nó de Computação é removido de um Conjunto, todos os respetivos ficheiros locais são eliminados e o ID é recuperado e pode ser reutilizado para novos Nós de Computação.

ipAddress

string

O endereço IP que outros Nós podem utilizar para comunicar com este Nó de Computação.
A cada Nó de Computação adicionado a um Conjunto é atribuído um endereço IP exclusivo. Sempre que um Nó de Computação é removido de um Conjunto, todos os respetivos ficheiros locais são eliminados e o endereço IP é recuperado e pode ser reutilizado para novos Nós de Computação.

isDedicated

boolean

Se este Nó de Computação é um Nó de Computação dedicado. Se for falso, o Nó de Computação é um Nó de Computação Spot/De baixa prioridade.

lastBootTime

string

A última vez em que o Nó de Computação foi iniciado.
Esta propriedade poderá não estar presente se o estado do Nó de Computação for inutilizável.

nodeAgentInfo

NodeAgentInformation

Informações sobre a versão do agente do Nó de Computação e a hora em que o Nó de Computação foi atualizado para uma nova versão.
O agente do Nó de Computação do Batch é um programa que é executado em cada Nó de Computação no Conjunto e fornece a capacidade do Batch no Nó de Computação.

recentTasks

TaskInformation[]

Uma lista de Tarefas cujo estado foi alterado recentemente.
Esta propriedade só está presente se, pelo menos, uma Tarefa tiver sido executada neste Nó de Computação desde que foi atribuída ao Conjunto.

runningTaskSlotsCount

integer

O número total de blocos de agendamento utilizados pela execução atualmente de Tarefas de Trabalho no Nó de Computação. Isto inclui Tarefas do Gestor de Tarefas e Tarefas normais, mas não Preparação de Trabalhos, Lançamento de Tarefas ou Iniciar Tarefas.

runningTasksCount

integer

O número total de Tarefas atualmente em execução no Nó de Computação. Isto inclui Tarefas do Gestor de Tarefas e Tarefas normais, mas não Preparação de Trabalhos, Lançamento de Tarefas ou Iniciar Tarefas.

schedulingState

SchedulingState

Se o Nó de Computação está disponível para Agendamento de tarefas.

startTask

StartTask

A Tarefa especificada para ser executada no Nó de Computação à medida que se junta ao Conjunto.
O Batch repetirá Tarefas quando uma operação de recuperação for acionada num Nó. Os exemplos de operações de recuperação incluem (mas não estão limitados a) quando um Nó em mau estado de funcionamento é reiniciado ou um Nó de Computação desapareceu devido a uma falha do anfitrião. As repetições devido a operações de recuperação são independentes e não são contabilizadas em relação ao maxTaskRetryCount. Mesmo que maxTaskRetryCount seja 0, pode ocorrer uma repetição interna devido a uma operação de recuperação. Por este motivo, todas as Tarefas devem ser idempotentes. Isto significa que as Tarefas têm de tolerar que sejam interrompidas e reiniciadas sem causar danos ou dados duplicados. A melhor prática para tarefas de execução prolongada é utilizar alguma forma de ponto de verificação. Em alguns casos, o StartTask pode ser novamente executado, apesar de o Nó de Computação não ter sido reiniciado. Deve ter especial cuidado para evitar StartTasks que criam processos separatistas ou instalam/iniciam serviços a partir do diretório de trabalho StartTask, uma vez que isto impedirá o Batch de voltar a executar o StartTask.

startTaskInfo

StartTaskInformation

Informações de runtime sobre a execução do StartTask no Nó de Computação.

state

ComputeNodeState

O estado atual do Nó de Computação.
O Nó de Computação Spot/Low-priority foi preempido. As tarefas que estavam em execução no Nó de Computação quando foi preempida serão reagendadas quando outro Nó de Computação ficar disponível.

stateTransitionTime

string

O momento em que o Nó de Computação entrou no estado atual.

totalTasksRun

integer

O número total de Tarefas de Trabalho concluídas no Nó de Computação. Isto inclui Tarefas do Gestor de Tarefas e Tarefas normais, mas não Preparação de Trabalhos, Lançamento de Tarefas ou Iniciar Tarefas.

totalTasksSucceeded

integer

O número total de Tarefas de Tarefas concluídas com êxito (com exitCode 0) no Nó de Computação. Isto inclui Tarefas do Gestor de Tarefas e Tarefas normais, mas não Preparação de Trabalhos, Lançamento de Tarefas ou Iniciar Tarefas.

url

string

O URL do Nó de Computação.

virtualMachineInfo

VirtualMachineInfo

Informações sobre o estado atual da máquina virtual.

vmSize

string

O tamanho da máquina virtual que aloja o Nó de Computação.
Para obter informações sobre os tamanhos disponíveis de máquinas virtuais em Conjuntos, veja Escolher um tamanho de VM para Nós de Computação num Conjunto de Azure Batch (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

ComputeNodeEndpointConfiguration

A configuração do ponto final para o Nó de Computação.

Name Tipo Description
inboundEndpoints

InboundEndpoint[]

A lista de pontos finais de entrada que estão acessíveis no Nó de Computação.

ComputeNodeError

Um erro encontrado por um Nó de Computação.

Name Tipo Description
code

string

Um identificador para o erro Node de Computação. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

errorDetails

NameValuePair[]

A lista de detalhes de erro adicionais relacionados com o erro Nó de Computação.

message

string

Uma mensagem que descreve o erro Node de Computação, que se destina a ser adequado para ser apresentado numa interface de utilizador.

ComputeNodeIdentityReference

A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.

Name Tipo Description
resourceId

string

O ID de recurso do ARM da identidade atribuída pelo utilizador.

ComputeNodeListResult

O resultado da listagem dos Nós de Computação num Conjunto.

Name Tipo Description
odata.nextLink

string

O URL para obter o próximo conjunto de resultados.

value

ComputeNode[]

A lista de Nós de Computação.

ComputeNodeState

O estado atual do Nó de Computação.

Name Tipo Description
creating

string

O serviço Batch obteve a máquina virtual subjacente a partir da Computação do Azure, mas ainda não começou a aderir ao Conjunto.

idle

string

O Nó de Computação não está atualmente a executar uma Tarefa.

leavingpool

string

O Nó de Computação está a sair do Conjunto porque o utilizador o removeu explicitamente ou porque o Conjunto está a redimensionar ou a reduzir automaticamente.

offline

string

O Nó de Computação não está atualmente a executar uma Tarefa e o agendamento de novas Tarefas para o Nó de Computação está desativado.

preempted

string

O Nó de Computação Spot/Low-priority foi preempido. As tarefas que estavam em execução no Nó de Computação quando foi preempida serão reagendadas quando outro Nó de Computação ficar disponível.

rebooting

string

O Nó de Computação está a ser reiniciado.

reimaging

string

O Nó de Computação é reimaginado.

running

string

O Nó de Computação está a executar uma ou mais Tarefas (além de uma StartTask).

starting

string

O serviço Batch está a começar na máquina virtual subjacente.

starttaskfailed

string

O StartTask falhou no Nó de Computação (e esgotou todas as repetições) e waitForSuccess está definido. O Nó de Computação não é utilizável para executar Tarefas.

unknown

string

O serviço Batch perdeu o contacto com o Nó de Computação e não sabe o seu estado verdadeiro.

unusable

string

Não é possível utilizar o Nó de Computação para a execução de tarefas devido a erros.

waitingforstarttask

string

O StartTask começou a ser executado no Nó de Computação, mas waitForSuccess está definido e o StartTask ainda não foi concluído.

ContainerRegistry

Um registo de contentor privado.

Name Tipo Description
identityReference

ComputeNodeIdentityReference

A referência à identidade atribuída pelo utilizador a utilizar para aceder a um Azure Container Registry em vez de nome de utilizador e palavra-passe.
A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.

password

string

A palavra-passe para iniciar sessão no servidor de registo.

registryServer

string

O URL do registo.
Se for omitido, a predefinição é "docker.io".

username

string

O nome de utilizador a iniciar sessão no servidor de registo.

ContainerWorkingDirectory

A localização do diretório de trabalho tarefa do contentor.

Name Tipo Description
containerImageDefault

string

Utilize o diretório de trabalho definido no contentor Imagem. Tenha em atenção que este diretório não conterá os Ficheiros de Recursos transferidos pelo Batch.

taskWorkingDirectory

string

Utilize o diretório de trabalho tarefas do serviço Batch padrão, que irá conter os Ficheiros de Recurso de Tarefa preenchidos pelo Batch.

ElevationLevel

O nível de elevação do utilizador.

Name Tipo Description
admin

string

O utilizador é um utilizador com acesso elevado e funciona com permissões de Administrador completas.

nonadmin

string

O utilizador é um utilizador padrão sem acesso elevado.

EnvironmentSetting

Uma variável de ambiente a definir num processo de Tarefa.

Name Tipo Description
name

string

O nome da variável de ambiente.

value

string

O valor da variável de ambiente.

ErrorCategory

A categoria do erro.

Name Tipo Description
servererror

string

O erro deve-se a um problema interno do servidor.

usererror

string

O erro deve-se a um problema do utilizador, como configuração incorreta.

ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

Name Tipo Description
lang

string

O código de idioma da mensagem de erro

value

string

O texto da mensagem.

ImageReference

Uma referência a uma Imagem do Azure Máquinas Virtuais Marketplace ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de Imagem do Azure Marketplace verificadas por Azure Batch, veja a operação "Listar Imagens Suportadas".

Name Tipo Description
exactVersion

string

A versão específica da imagem da plataforma ou imagem do marketplace utilizada para criar o nó. Este campo só de leitura só difere de "versão" apenas se o valor especificado para "versão" quando o conjunto foi criado for "mais recente".

offer

string

O tipo de oferta da Imagem do Azure Máquinas Virtuais Marketplace.
Por exemplo, UbuntuServer ou WindowsServer.

publisher

string

O publicador do Azure Máquinas Virtuais Imagem do Marketplace.
Por exemplo, Canonical ou MicrosoftWindowsServer.

sku

string

O SKU da Imagem do Azure Máquinas Virtuais Marketplace.
Por exemplo, 18.04-LTS ou 2019-Datacenter.

version

string

A versão do Azure Máquinas Virtuais Imagem do Marketplace.
Pode especificar um valor "mais recente" para selecionar a versão mais recente de uma Imagem. Se for omitido, a predefinição é "mais recente".

virtualMachineImageId

string

O identificador do recurso ARM da Imagem da Galeria de Computação do Azure. Os Nós de Computação no Conjunto serão criados com este ID de Imagem. Este é do formulário /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para obter sempre a predefinição da versão mais recente da imagem.
Esta propriedade é mutuamente exclusiva com outras propriedades ImageReference. A Imagem da Galeria de Computação do Azure tem de ter réplicas na mesma região e tem de estar na mesma subscrição que a conta Azure Batch. Se a versão da imagem não for especificada no imageId, será utilizada a versão mais recente. Para obter informações sobre as definições da firewall para o agente do Nó de Computação do Batch comunicar com o serviço Batch, consulte https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpoint

Um ponto final de entrada num Nó de Computação.

Name Tipo Description
backendPort

integer

O número da porta de back-end do ponto final.

frontendPort

integer

O número de porta pública do ponto final.

name

string

O nome do ponto final.

protocol

InboundEndpointProtocol

O protocolo do ponto final.

publicFQDN

string

O nome de domínio completamente qualificado público para o Nó de Computação.

publicIPAddress

string

O endereço IP público do Nó de Computação.

InboundEndpointProtocol

O protocolo do ponto final.

Name Tipo Description
tcp

string

Utilize o TCP para o ponto final.

udp

string

Utilize uDP para o ponto final.

NameValuePair

Representa um par nome-valor.

Name Tipo Description
name

string

O nome no par name-value.

value

string

O valor no par name-value.

NodeAgentInformation

Informações sobre o agente do Nó de Computação.

Name Tipo Description
lastUpdateTime

string

A hora em que o agente do Nó de Computação foi atualizado no Nó de Computação.
Esta é a hora mais recente em que o agente do Nó de Computação foi atualizado para uma nova versão.

version

string

A versão do agente do Nó de Computação do Batch em execução no Nó de Computação.
Este número de versão pode ser verificado em relação às notas de versão do agente do Nó de Computação localizadas em https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.

ResourceFile

Um único ficheiro ou vários ficheiros a transferir para um Nó de Computação.

Name Tipo Description
autoStorageContainerName

string

O nome do contentor de armazenamento na Conta de armazenamento automático.
As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas tem de ser especificada.

blobPrefix

string

O prefixo de blobs a utilizar ao transferir blobs a partir de um contentor do Armazenamento do Azure. Apenas os blobs cujos nomes começam com o prefixo especificado serão transferidos.
A propriedade só é válida quando autoStorageContainerName ou storageContainerUrl é utilizado. Este prefixo pode ser um nome de ficheiro parcial ou um subdiretório. Se não for especificado um prefixo, todos os ficheiros no contentor serão transferidos.

fileMode

string

O atributo do modo de permissão de ficheiro no formato octal.
Esta propriedade aplica-se apenas aos ficheiros que estão a ser transferidos para Nós de Computação do Linux. Será ignorado se for especificado para um resourceFile que será transferido para um Nó de Computação do Windows. Se esta propriedade não for especificada para um Nó de Computação do Linux, é aplicado um valor predefinido de 0770 ao ficheiro.

filePath

string

A localização no Nó de Computação para o qual transferir os ficheiros, relativamente ao diretório de trabalho da Tarefa.
Se a propriedade httpUrl for especificada, o filePath é necessário e descreve o caminho para o qual o ficheiro será transferido, incluindo o nome do ficheiro. Caso contrário, se a propriedade autoStorageContainerName ou storageContainerUrl for especificada, filePath é opcional e é o diretório para o qual transferir os ficheiros. No caso em que filePath é utilizado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será mantida na totalidade e anexada ao diretório filePath especificado. O caminho relativo especificado não consegue sair do diretório de trabalho da Tarefa (por exemplo, utilizando '.').

httpUrl

string

O URL do ficheiro a transferir.
As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas tem de ser especificada. Se o URL apontar para Armazenamento de Blobs do Azure, tem de ser legível a partir de nós de computação. Existem três formas de obter esse URL para um blob no armazenamento do Azure: incluir uma Assinatura de Acesso Partilhado (SAS) que concede permissões de leitura no blob, utilizar uma identidade gerida com permissão de leitura ou definir a ACL para o blob ou o respetivo contentor para permitir o acesso público.

identityReference

ComputeNodeIdentityReference

A referência à identidade atribuída pelo utilizador a utilizar para aceder a Armazenamento de Blobs do Azure especificada por storageContainerUrl ou httpUrl
A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.

storageContainerUrl

string

O URL do contentor de blobs no Armazenamento de Blobs do Azure.
As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas tem de ser especificada. Este URL tem de ser legível e listável a partir de nós de computação. Existem três formas de obter esse URL para um contentor no armazenamento do Azure: incluir uma Assinatura de Acesso Partilhado (SAS) que concede permissões de leitura e lista no contentor, utilizar uma identidade gerida com permissões de leitura e lista ou definir a ACL para o contentor para permitir o acesso público.

SchedulingState

Se o Nó de Computação está disponível para Agendamento de tarefas.

Name Tipo Description
disabled

string

Não serão agendadas novas Tarefas no Nó de Computação. As tarefas já em execução no Nó de Computação ainda podem ser executadas até à conclusão. Todos os Nós de Computação começam com o agendamento ativado.

enabled

string

As tarefas podem ser agendadas no Nó de Computação.

StartTask

Uma Tarefa que é executada quando um Nó associa um Conjunto no serviço Azure Batch ou quando o Nó de Computação é reiniciado ou reproduzido.

Name Tipo Description
commandLine

string

A linha de comandos do StartTask.
A linha de comandos não é executada sob uma shell e, por conseguinte, não pode tirar partido das funcionalidades da shell, como a expansão da variável de ambiente. Se quiser tirar partido destas funcionalidades, deve invocar a shell na linha de comandos, por exemplo, utilizando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comandos se referir a caminhos de ficheiro, deve utilizar um caminho relativo (relativamente ao diretório de trabalho da tarefa) ou utilizar a variável de ambiente fornecido pelo Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

containerSettings

TaskContainerSettings

As definições do contentor no qual o StartTask é executado.
Quando for especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios Azure Batch no nó) são mapeados para o contentor, todas as variáveis de ambiente de tarefas são mapeadas para o contentor e a linha de comandos Tarefa é executada no contentor. Os ficheiros produzidos no contentor fora do AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco anfitrião, o que significa que as APIs de ficheiro do Batch não poderão aceder a esses ficheiros.

environmentSettings

EnvironmentSetting[]

Uma lista de definições de variáveis de ambiente para o StartTask.

maxTaskRetryCount

integer

O número máximo de vezes que a Tarefa pode ser repetida.
O serviço Batch repetirá uma Tarefa se o código de saída não forzero. Tenha em atenção que este valor controla especificamente o número de tentativas. O serviço Batch tentará a Tarefa uma vez e, em seguida, poderá repetir até este limite. Por exemplo, se a contagem máxima de repetições for 3, o Batch tentará a Tarefa até 4 vezes (uma tentativa inicial e três repetições). Se a contagem máxima de repetições for 0, o serviço Batch não repetirá a Tarefa. Se a contagem máxima de repetições for -1, o serviço Batch repetirá a Tarefa sem limite, no entanto não é recomendado para uma tarefa de início ou qualquer tarefa. O valor predefinido é 0 (sem repetições).

resourceFiles

ResourceFile[]

Uma lista de ficheiros que o serviço Batch irá transferir para o Nó de Computação antes de executar a linha de comandos. Existe um tamanho máximo para a lista de ficheiros de recursos. Quando o tamanho máximo for excedido, o pedido falhará e o código de erro de resposta será RequestEntityTooLarge. Se isto ocorrer, a coleção de ResourceFiles tem de ser reduzida em tamanho. Isto pode ser conseguido com .zip ficheiros, Pacotes de Aplicações ou Contentores do Docker.
Os ficheiros listados neste elemento estão localizados no diretório de trabalho da Tarefa.

userIdentity

UserIdentity

A identidade de utilizador na qual o StartTask é executado.
Se omitido, a Tarefa é executada como um utilizador não administrativo exclusivo da Tarefa.

waitForSuccess

boolean

Se o serviço Batch deve aguardar que o StartTask seja concluído com êxito (ou seja, sair com o código de saída 0) antes de agendar quaisquer Tarefas no Nó de Computação.
Se for verdadeiro e o StartTask falhar num Nó, o serviço Batch repete o StartTask até à contagem máxima de repetições (maxTaskRetryCount). Se a Tarefa ainda não tiver sido concluída com êxito após todas as repetições, o serviço Batch marca o Nó inutilizável e não agendará Tarefas para o mesmo. Esta condição pode ser detetada através do estado do Nó de Computação e dos detalhes das informações de falha. Se for falso, o serviço Batch não aguardará pela conclusão do StartTask. Neste caso, outras Tarefas podem começar a ser executadas no Nó de Computação enquanto o StartTask ainda está em execução; e mesmo que o StartTask falhe, as novas Tarefas continuarão a ser agendadas no Nó de Computação. A predefinição é verdadeira.

StartTaskInformation

Informações sobre uma StartTask em execução num Nó de Computação.

Name Tipo Description
containerInfo

TaskContainerExecutionInformation

Informações sobre o contentor no qual a Tarefa está a ser executada.
Esta propriedade só é definida se a Tarefa for executada num contexto de contentor.

endTime

string

A hora em que o StartTask deixou de ser executado.
Esta é a hora de fim da execução mais recente do StartTask, se essa execução tiver sido concluída (mesmo que essa execução tenha falhado e uma repetição esteja pendente). Este elemento não está presente se o StartTask estiver atualmente em execução.

exitCode

integer

O código de saída do programa especificado na linha de comandos StartTask.
Esta propriedade só é definida se o StartTask estiver no estado concluído. Em geral, o código de saída de um processo reflete a convenção específica implementada pelo programador de aplicações para esse processo. Se utilizar o valor de código de saída para tomar decisões no seu código, certifique-se de que conhece a convenção de código de saída utilizada pelo processo da aplicação. No entanto, se o serviço Batch terminar o StartTask (devido ao tempo limite ou à terminação do utilizador através da API), poderá ver um código de saída definido pelo sistema operativo.

failureInfo

TaskFailureInformation

Informações que descrevem a falha da Tarefa, se existirem.
Esta propriedade só é definida se a Tarefa estiver no estado concluído e tiver encontrado uma falha.

lastRetryTime

string

A hora mais recente em que uma repetição da Tarefa começou a ser executada.
Este elemento só está presente se a Tarefa tiver sido repetida (ou seja, retryCount is nonzero). Se estiver presente, este é normalmente o mesmo que startTime, mas pode ser diferente se a Tarefa tiver sido reiniciada por motivos que não a repetição; por exemplo, se o Nó de Computação tiver sido reiniciado durante uma repetição, a startTime é atualizada, mas lastRetryTime não.

result

TaskExecutionResult

O resultado da execução da Tarefa.
Se o valor for "falha", os detalhes da falha podem ser encontrados na propriedade failureInfo.

retryCount

integer

O número de vezes que a Tarefa foi repetida pelo serviço Batch.
As falhas da aplicação de tarefas (código de saída não zero) são repetidas, erros de pré-processamento (não foi possível executar a Tarefa) e os erros de carregamento de ficheiros não são repetidos. O serviço Batch repetirá a Tarefa até ao limite especificado pelas restrições.

startTime

string

A hora em que o StartTask começou a ser executado.
Este valor é reposto sempre que a Tarefa é reiniciada ou repetida (ou seja, esta é a hora mais recente em que o StartTask começou a ser executado).

state

StartTaskState

O estado do StartTask no Nó de Computação.

StartTaskState

O estado do StartTask no Nó de Computação.

Name Tipo Description
completed

string

O StartTask saiu com o código de saída 0 ou o StartTask falhou e o limite de repetição foi atingido ou o processo StartTask não foi executado devido a erros de preparação de tarefas (como falhas na transferência de ficheiros de recursos).

running

string

O StartTask está atualmente em execução.

TaskContainerExecutionInformation

Contém informações sobre o contentor que uma Tarefa está a executar.

Name Tipo Description
containerId

string

O ID do contentor.

error

string

Informações de erro detalhadas sobre o contentor.
Esta é a cadeia de erros detalhada do serviço Docker, se disponível. É equivalente ao campo de erro devolvido pelo "docker inspect".

state

string

O estado do contentor.
Este é o estado do contentor de acordo com o serviço Docker. É equivalente ao campo de estado devolvido pelo "docker inspect".

TaskContainerSettings

As definições de contentor para uma Tarefa.

Name Tipo Description
containerRunOptions

string

Opções adicionais para o comando de criação de contentor.
Estas opções adicionais são fornecidas como argumentos para o comando "docker create", além das que são controladas pelo Serviço Batch.

imageName

string

A Imagem a utilizar para criar o contentor no qual a Tarefa será executada.
Esta é a referência de Imagem completa, tal como seria especificada para "docker pull". Se não for fornecida nenhuma etiqueta como parte do Nome da imagem, a etiqueta ":latest" é utilizada como predefinição.

registry

ContainerRegistry

O registo privado que contém o contentor Imagem.
Esta definição pode ser omitida se já tiver sido fornecida na criação do Conjunto.

workingDirectory

ContainerWorkingDirectory

A localização do diretório de trabalho da Tarefa de contentor.
A predefinição é "taskWorkingDirectory".

TaskExecutionInformation

Informações sobre a execução de uma Tarefa.

Name Tipo Description
containerInfo

TaskContainerExecutionInformation

Informações sobre o contentor no qual a Tarefa está a ser executada.
Esta propriedade só é definida se a Tarefa for executada num contexto de contentor.

endTime

string

O momento em que a Tarefa foi concluída.
Esta propriedade só é definida se a Tarefa estiver no estado Concluído.

exitCode

integer

O código de saída do programa especificado na linha de comandos Tarefa.
Esta propriedade só é definida se a Tarefa estiver no estado concluído. Em geral, o código de saída de um processo reflete a convenção específica implementada pelo programador de aplicações para esse processo. Se utilizar o valor de código de saída para tomar decisões no seu código, certifique-se de que conhece a convenção de código de saída utilizada pelo processo da aplicação. No entanto, se o serviço Batch terminar a Tarefa (devido ao tempo limite ou à terminação do utilizador através da API), poderá ver um código de saída definido pelo sistema operativo.

failureInfo

TaskFailureInformation

Informações que descrevem a falha da Tarefa, se existirem.
Esta propriedade só é definida se a Tarefa estiver no estado concluído e tiver encontrado uma falha.

lastRequeueTime

string

A hora mais recente em que a Tarefa foi recoduída pelo serviço Batch como resultado de um pedido de utilizador.
Esta propriedade só é definida se a requeueCount não forzero.

lastRetryTime

string

A hora mais recente em que uma repetição da Tarefa começou a ser executada.
Este elemento só está presente se a Tarefa tiver sido repetida (ou seja, retryCount is nonzero). Se estiver presente, este é normalmente o mesmo que startTime, mas pode ser diferente se a Tarefa tiver sido reiniciada por motivos que não a repetição; por exemplo, se o Nó de Computação tiver sido reiniciado durante uma repetição, a startTime é atualizada, mas lastRetryTime não.

requeueCount

integer

O número de vezes que a Tarefa foi recoduída pelo serviço Batch como resultado de um pedido de utilizador.
Quando o utilizador remove Os Nós de Computação de um Conjunto (ao redimensionar/reduzir o conjunto) ou quando a Tarefa está a ser desativada, o utilizador pode especificar que a execução de Tarefas nos Nós de Computação é recodada para execução. Esta contagem regista o número de vezes que a Tarefa foi recoduída por estes motivos.

result

TaskExecutionResult

O resultado da execução da Tarefa.
Se o valor for "falha", os detalhes da falha podem ser encontrados na propriedade failureInfo.

retryCount

integer

O número de vezes que a Tarefa foi repetida pelo serviço Batch.
As falhas da aplicação de tarefas (código de saída não zero) são repetidas, erros de pré-processamento (não foi possível executar a Tarefa) e os erros de carregamento de ficheiros não são repetidos. O serviço Batch repetirá a Tarefa até ao limite especificado pelas restrições.

startTime

string

A hora em que a Tarefa começou a ser executada.
"Em execução" corresponde ao estado em execução, por isso, se a Tarefa especificar ficheiros de recursos ou Pacotes, a hora de início reflete o momento em que a Tarefa começou a transferi-los ou a implementá-los. Se a Tarefa tiver sido reiniciada ou repetida, esta é a hora mais recente em que a Tarefa começou a ser executada. Esta propriedade está presente apenas para Tarefas que estão no estado em execução ou concluído.

TaskExecutionResult

O resultado da execução da tarefa.

Name Tipo Description
failure

string

Ocorreu um erro durante o processamento da Tarefa. A falha pode ter ocorrido antes do processo de Tarefa ter sido iniciado, enquanto o processo de Tarefa estava a ser executado ou após a saída do processo de Tarefa.

success

string

A Tarefa foi executada com êxito.

TaskFailureInformation

Informações sobre uma Falha de tarefa.

Name Tipo Description
category

ErrorCategory

A categoria do erro Tarefa.

code

string

Um identificador para o erro Tarefa. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

details

NameValuePair[]

Uma lista de detalhes adicionais relacionados com o erro.

message

string

Uma mensagem que descreve o erro Tarefa, que se destina a ser adequado para ser apresentado numa interface de utilizador.

TaskInformation

Informações sobre uma Tarefa em execução num Nó de Computação.

Name Tipo Description
executionInfo

TaskExecutionInformation

Informações sobre a execução da Tarefa.

jobId

string

O ID da Tarefa à qual a Tarefa pertence.

subtaskId

integer

O ID da subtarefa se a Tarefa for uma Tarefa de várias instâncias.

taskId

string

O ID da Tarefa.

taskState

TaskState

O estado atual da Tarefa.

taskUrl

string

O URL da Tarefa.

TaskState

O estado da Tarefa.

Name Tipo Description
active

string

A Tarefa está em fila de espera e pode ser executada, mas não está atualmente atribuída a um Nó de Computação. Uma Tarefa entra neste estado quando é criada, quando é ativada após ser desativada ou quando aguarda uma nova tentativa após uma execução falhada.

completed

string

A Tarefa já não é elegível para ser executada, normalmente porque a Tarefa foi concluída com êxito ou a Tarefa foi concluída sem êxito e esgotou o limite de repetições. Uma Tarefa também é marcada como concluída se ocorreu um erro ao iniciar a Tarefa ou quando a Tarefa foi terminada.

preparing

string

A Tarefa foi atribuída a um Nó de Computação, mas aguarda a conclusão de uma Tarefa de Preparação de Tarefas necessária no Nó de Computação. Se a Tarefa de Preparação da Tarefa for bem-sucedida, a Tarefa passará a ser executada. Se a Tarefa de Preparação da Tarefa falhar, a Tarefa voltará a estar ativa e será elegível para ser atribuída a um Nó de Computação diferente.

running

string

A Tarefa está em execução num Nó de Computação. Isto inclui a preparação ao nível da tarefa, como transferir ficheiros de recursos ou implementar Pacotes especificados na Tarefa. Não significa necessariamente que a linha de comandos Tarefa tenha começado a ser executada.

UserIdentity

A definição da identidade de utilizador na qual a Tarefa é executada.

Name Tipo Description
autoUser

AutoUserSpecification

O utilizador automático no qual a Tarefa é executada.
As propriedades userName e autoUser são mutuamente exclusivas; tem de especificar um, mas não ambos.

username

string

O nome da identidade de utilizador na qual a Tarefa é executada.
As propriedades userName e autoUser são mutuamente exclusivas; tem de especificar um, mas não ambos.

VirtualMachineInfo

Informações sobre o estado atual da máquina virtual.

Name Tipo Description
imageReference

ImageReference

A referência à Imagem do Marketplace da Máquina Virtual do Azure.

scaleSetVmResourceId

string

O ID de recurso da VM atual do Conjunto de Dimensionamento de Máquinas Virtuais do Nó de Computação. Apenas definido se a Conta do Batch tiver sido criada com a respetiva propriedade poolAllocationMode definida como "UserSubscription".