Compute Node - Get

Serviço:

Batch Service

Versão da API:

2024-07-01.20.0

Obtém informações sobre o nó de computação especificado.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?api-version=2024-07-01.20.0

Com parâmetros opcionais:

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?$select={$select}&timeout={timeout}&api-version=2024-07-01.20.0

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço do Lote do Azure.
nodeId	path	True	string	A ID do nó de computação sobre o qual você deseja obter informações.
poolId	path	True	string	A ID do Pool que contém o Nó de Computação.
api-version	query	True	string	Versão da API do cliente.
$select	query		string	Uma cláusula OData $select.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for maior que 30, o padrão será usado.

Cabeçalho do Pedido

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

Name	Necessário	Tipo	Description
client-request-id		string uuid	A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves encaracoladas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve retornar o client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Name	Tipo	Description
200 OK	ComputeNode	Uma resposta que contém o nó 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 de lote.

Segurança

azure_auth

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

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

Âmbitos

Name	Description
user_impersonation	Personificar a sua conta de utilizador

Authorization

Tipo: apiKey
Em: header

Exemplos

Node get

Pedido de amostra

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z?api-version=2024-07-01.20.0

Resposta da amostra

Código de estado:

200

{
  "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,
  "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-22T19:37:28.623369Z"
  }
}

Definições

Name	Description
AutoUserScope	O escopo para o usuário automático
AutoUserSpecification	Especifica os parâmetros para o usuário automático que executa uma tarefa no serviço em lote.
BatchError	Uma resposta de erro recebida do serviço Batch do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
CertificateReference	Uma referência a um certificado a ser instalado em nós de computação em um pool.
CertificateStoreLocation	O local do armazenamento de certificados no nó de computação no qual instalar o certificado.
CertificateVisibility	Quais Contas de usuário no Nó de Computação devem ter acesso aos dados privados do Certificado.
ComputeNode	Um nó de computação no serviço de lote.
ComputeNodeEndpointConfiguration	A configuração do ponto de extremidade 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 ao usuário associada ao pool de lotes que um nó de computação usará.
ComputeNodeState	O estado atual do nó de computação.
ContainerHostBatchBindMountEntry	A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas.
ContainerHostDataPath	Os caminhos que serão montados no contêiner da tarefa do contêiner.
ContainerRegistry	Um registro de contêiner privado.
ContainerWorkingDirectory	O local do diretório de trabalho da tarefa do contêiner.
ElevationLevel	O nível de elevação do usuário.
EnvironmentSetting	Uma variável de ambiente a ser definida em um processo Task.
ErrorCategory	A categoria do erro.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
ImageReference	Uma referência a uma Imagem do Azure Virtual Machines 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 pelo Lote do Azure, consulte a operação 'Listar imagens suportadas'.
InboundEndpoint	Um ponto de extremidade de entrada em um nó de computação.
InboundEndpointProtocol	O protocolo do ponto de extremidade.
NameValuePair	Representa um par nome-valor.
NodeAgentInformation	Informações sobre o agente Compute Node.
ResourceFile	Um único arquivo ou vários arquivos a serem baixados 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ó ingressa em um Pool no serviço Lote do Azure ou quando o Nó de Computação é reinicializado ou recriado.
StartTaskInformation	Informações sobre um StartTask em execução em um nó de computação.
StartTaskState	O estado do StartTask no nó de computação.
TaskContainerExecutionInformation	Contém informações sobre o contêiner que uma tarefa está executando.
TaskContainerSettings	As configurações de contêiner 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 em um nó de computação.
TaskState	O estado da Tarefa.
UserIdentity	A definição da identidade do usuário sob a qual a Tarefa é executada.
VirtualMachineInfo	Informações sobre o estado atual da máquina virtual.

AutoUserScope

O escopo para o usuário automático

Name	Tipo	Description
pool	string	Especifica que a Tarefa é executada como a Conta de usuário automático comum que é criada em cada Nó de Computação em um Pool.
task	string	Especifica que o serviço deve criar um novo usuário para a Tarefa.

AutoUserSpecification

Especifica os parâmetros para o usuário automático que executa uma tarefa no serviço em lote.

Name	Tipo	Description
elevationLevel	ElevationLevel	O nível de elevação do usuário automático. O valor padrão é nonAdmin.
scope	AutoUserScope	O escopo para o usuário automático O valor padrão é pool. Se o pool estiver executando o Windows, um valor de Task deverá ser especificado se for necessário um isolamento mais rigoroso entre as tarefas. Por exemplo, se a tarefa muta o registro de uma forma que pode afetar outras tarefas, ou se certificados foram especificados no pool que não deve ser acessível por tarefas normais, mas deve ser acessível por StartTasks.

BatchError

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

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 descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Name	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Value.
value	string	As informações adicionais incluídas com a resposta de erro.

CertificateReference

Uma referência a um certificado a ser instalado em nós de computação em um pool.

Name	Tipo	Description
storeLocation	CertificateStoreLocation	O local do armazenamento de certificados no nó de computação no qual instalar o certificado. O valor padrão é currentuser. Esta propriedade é aplicável somente para pools configurados com nós de computação do Windows. Para nós de computação Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho Tarefa e uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR é fornecida à tarefa para consultar esse local. Para Certificados com visibilidade de 'remoteUser', um diretório 'certs' é criado no diretório base do usuário (por exemplo, /home/{user-name}/certs) e os Certificados são colocados nesse diretório.
storeName	string	O nome do armazenamento de certificados no nó de computação no qual instalar o certificado. Esta propriedade é aplicável somente para pools configurados com nós de computação do Windows. Os nomes de armazenamento comuns incluem: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, mas qualquer nome de loja personalizado também pode ser usado. O valor padrão é My.
thumbprint	string	A impressão digital do Certificado.
thumbprintAlgorithm	string	O algoritmo ao qual a impressão digital está associada. Isso deve ser sha1.
visibility	CertificateVisibility[]	Quais Contas de usuário no Nó de Computação devem ter acesso aos dados privados do Certificado. Você pode especificar mais de uma visibilidade nesta coleção. O padrão é todas as contas.

CertificateStoreLocation

O local do armazenamento de certificados no nó de computação no qual instalar o certificado.

Name	Tipo	Description
currentuser	string	Os certificados devem ser instalados no repositório de certificados CurrentUser.
localmachine	string	Os certificados devem ser instalados no armazenamento de certificados LocalMachine.

CertificateVisibility

Quais Contas de usuário 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 usuário sob as quais os usuários acessam remotamente o Nó de Computação.
starttask	string	O certificado deve estar visível para a conta de usuário sob a qual o StartTask é executado. Observe que, se o Escopo do Usuário Automático for Pool para StartTask e uma Tarefa, esse certificado também ficará visível para a Tarefa.
task	string	O Certificado deve estar visível para as contas de usuário sob as quais as Tarefas de Trabalho são executadas.

ComputeNode

Um nó de computação no serviço de lote.

Name	Tipo	Description
affinityId	string	Um identificador que pode ser passado ao adicionar uma Tarefa para solicitar que a Tarefa seja agendada neste Nó de Computação. Note que esta é apenas uma afinidade suave. Se o Nó de Computação de destino estiver ocupado ou indisponível no momento em que a Tarefa for agendada, a Tarefa será agendada em outro lugar.
allocationTime	string	O momento em que esse nó de computação foi alocado para o pool. Este é o momento em que o nó de computação foi inicialmente alocado e não muda uma vez definido. Ele não é atualizado quando o Nó de Computação é recuperado ou antecipado.
certificateReferences	CertificateReference[]	A lista de certificados instalados no nó de computação. Para nós do Windows, o serviço em lote instala os certificados no armazenamento de certificados e no local especificados. Para nós de computação Linux, os certificados são armazenados em um diretório dentro do diretório de trabalho Tarefa e uma variável de ambiente AZ_BATCH_CERTIFICATES_DIR é fornecida à tarefa para consultar esse local. Para Certificados com visibilidade de 'remoteUser', um diretório 'certs' é criado no diretório base do usuário (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 vez disso, use o Azure KeyVault Extension.
endpointConfiguration	ComputeNodeEndpointConfiguration	A configuração do ponto de extremidade para o nó de computação.
errors	ComputeNodeError[]	A lista de erros que estão sendo encontrados atualmente pelo nó de computação.
id	string	A ID do nó de computação. Cada nó de computação adicionado a um pool recebe uma ID exclusiva. Sempre que um nó de computação é removido de um pool, todos os seus arquivos locais são excluídos 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 usar para se comunicar com esse nó de computação. A cada nó de computação adicionado a um pool é atribuído um endereço IP exclusivo. Sempre que um nó de computação é removido de um pool, todos os seus arquivos locais são excluídos 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 false, 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. Essa propriedade pode não estar presente se o estado do nó de computação estiver 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 Batch Compute Node é um programa que é executado em cada Nó de Computação no Pool e fornece capacidade de Batch no Nó de Computação.
recentTasks	TaskInformation[]	Uma lista de Tarefas cujo estado foi alterado recentemente. Essa propriedade estará presente somente se pelo menos uma Tarefa tiver sido executada neste Nó de Computação desde que foi atribuída ao Pool.
runningTaskSlotsCount	integer	O número total de slots de agendamento usados atualmente executando Tarefas de Trabalho no Nó de Computação. Isso inclui Tarefas do Gerenciador de Tarefas e Tarefas normais, mas não Preparação de Trabalho, Liberação de Trabalho ou Tarefas de Início.
runningTasksCount	integer	O número total de tarefas de trabalho atualmente em execução no nó de computação. Isso inclui Tarefas do Gerenciador de Tarefas e Tarefas normais, mas não Preparação de Trabalho, Liberação de Trabalho ou Tarefas de Início.
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 Pool. O lote tentará novamente Tarefas quando uma operação de recuperação for acionada em um nó. Exemplos de operações de recuperação incluem (mas não estão limitados a) quando um nó não íntegro é reinicializado ou um nó de computação desaparece devido a falha do host. As novas tentativas devido a operações de recuperação são independentes e não são contabilizadas em relação ao maxTaskRetryCount. Mesmo se maxTaskRetryCount for 0, pode ocorrer uma nova tentativa interna devido a uma operação de recuperação. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar corrupção ou dados duplicados. A prática recomendada para tarefas de longa duração é usar alguma forma de ponto de verificação. Em alguns casos, o StartTask pode ser executado novamente mesmo que o nó de computação não tenha sido reinicializado. Cuidado especial deve ser tomado para evitar StartTasks que criam processos separatistas ou instalam/iniciam serviços a partir do diretório de trabalho StartTask, pois isso impedirá que o Batch possa executar novamente o StartTask.
startTaskInfo	StartTaskInformation	Informações de tempo de execução 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 antecipado. As tarefas que estavam sendo executadas no Nó de Computação quando ele foi antecipado serão reagendadas quando outro Nó de Computação estiver disponível.
stateTransitionTime	string	O momento em que o nó de computação entrou em seu estado atual.
totalTasksRun	integer	O número total de tarefas de trabalho concluídas no nó de computação. Isso inclui Tarefas do Gerenciador de Tarefas e Tarefas normais, mas não Preparação de Trabalho, Liberação de Trabalho ou Tarefas de Início.
totalTasksSucceeded	integer	O número total de tarefas de trabalho concluídas com êxito (com exitCode 0) no nó de computação. Isso inclui Tarefas do Gerenciador de Tarefas e Tarefas normais, mas não Preparação de Trabalho, Liberação de Trabalho ou Tarefas de Início.
url	string	A 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 hospeda o nó de computação. Para obter informações sobre tamanhos disponíveis de máquinas virtuais em Pools, consulte Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

ComputeNodeEndpointConfiguration

A configuração do ponto de extremidade para o nó de computação.

Name	Tipo	Description
inboundEndpoints	InboundEndpoint[]	A lista de pontos de extremidade de entrada 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 de nó 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 ao erro do nó de computação.
message	string	Uma mensagem descrevendo o erro do nó de computação, destinado a ser adequado para exibição em uma interface do usuário.

ComputeNodeIdentityReference

A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.

Name	Tipo	Description
resourceId	string	O ID de recurso ARM da identidade atribuída ao usuário.

ComputeNodeState

O estado atual do nó de computação.

Name	Tipo	Description
creating	string	O serviço Batch obteve a máquina virtual subjacente do Azure Compute, mas ainda não começou a ingressar no Pool.
deallocated	string	O nó de computação é deslocalizado.
deallocating	string	O nó de computação está deslocalizando.
idle	string	O nó de computação não está executando uma tarefa no momento.
leavingpool	string	O Nó de Computação está saindo do Pool, seja porque o usuário o removeu explicitamente ou porque o Pool está redimensionando ou reduzindo automaticamente.
offline	string	O Nó de Computação não está executando uma Tarefa no momento e o agendamento de novas Tarefas para o Nó de Computação está desabilitado.
preempted	string	O nó de computação spot/low-priority foi antecipado. As tarefas que estavam sendo executadas no Nó de Computação quando ele foi antecipado serão reagendadas quando outro Nó de Computação estiver disponível.
rebooting	string	O nó de computação está reinicializando.
reimaging	string	O nó de computação está recriando imagens.
running	string	O nó de computação está executando uma ou mais tarefas (diferente de uma StartTask).
starting	string	O serviço Batch está iniciando na máquina virtual subjacente.
starttaskfailed	string	O StartTask falhou no nó de computação (e esgotou todas as tentativas) e waitForSuccess está definido. O nó de computação não é utilizável para executar tarefas.
unknown	string	O serviço de lote perdeu contato com o nó de computação e não sabe seu verdadeiro estado.
unusable	string	O nó de computação não pode ser usado para a execução de tarefas devido a erros.
upgradingos	string	O nó de computação está passando por uma operação de atualização do sistema operacional.
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.

ContainerHostBatchBindMountEntry

A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas.

Name	Tipo	Description
isReadOnly	boolean	Monte esse caminho de origem como modo somente leitura ou não. O valor padrão é false (modo de leitura/gravação). Para Linux, se você montar esse caminho como um modo de leitura/gravação, isso não significa que todos os usuários no contêiner tenham o acesso de leitura/gravação para o caminho, depende do acesso na VM do host. Se esse caminho for montado somente leitura, todos os usuários dentro do contêiner não poderão modificá-lo.
source	ContainerHostDataPath	O caminho que ser montado para o cliente de contêiner pode selecionar.

ContainerHostDataPath

Os caminhos que serão montados no contêiner da tarefa do contêiner.

Name	Tipo	Description
Applications	string	O caminho dos aplicativos.
JobPrep	string	O caminho da tarefa de preparação para o trabalho.
Shared	string	O caminho para a tarefa de várias instâncias compartilhar seus arquivos.
Startup	string	O caminho para iniciar a tarefa.
Task	string	O caminho da tarefa.
VfsMounts	string	O caminho contém todos os sistemas de arquivos virtuais montados neste nó.

ContainerRegistry

Um registro de contêiner privado.

Name	Tipo	Description
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída ao usuário a ser usada para acessar um Registro de Contêiner do Azure em vez de nome de usuário e senha. A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.
password	string	A palavra-passe para iniciar sessão no servidor de registo.
registryServer	string	O URL do registo. Se omitido, o padrão é "docker.io".
username	string	O nome de utilizador para iniciar sessão no servidor de registo.

ContainerWorkingDirectory

O local do diretório de trabalho da tarefa do contêiner.

Name	Tipo	Description
containerImageDefault	string	Use o diretório de trabalho definido na imagem do contêiner. Tenha cuidado que este diretório não conterá os arquivos de recursos baixados pelo lote.
taskWorkingDirectory	string	Use o diretório de trabalho padrão Tarefa do serviço em lote, que conterá os arquivos de recursos da tarefa preenchidos por lote.

ElevationLevel

O nível de elevação do usuário.

Name	Tipo	Description
admin	string	O usuário é um usuário com acesso elevado e opera com permissões completas de administrador.
nonadmin	string	O usuário é um usuário padrão sem acesso elevado.

EnvironmentSetting

Uma variável de ambiente a ser definida em um processo Task.

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 é devido a um problema interno do servidor.
usererror	string	O erro é devido a um problema do usuário, como configuração incorreta.

ErrorMessage

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

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 Virtual Machines 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 pelo Lote do Azure, consulte a operação 'Listar imagens suportadas'.

Name	Tipo	Description
communityGalleryImageId	string	O identificador exclusivo da imagem da galeria da comunidade Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida na chamada GET da galeria da comunidade.
exactVersion	string	A versão específica da imagem da plataforma ou imagem do mercado usada para criar o nó. Este campo somente leitura difere de 'version' somente se o valor especificado para 'version' quando o pool foi criado era 'mais recente'.
offer	string	O tipo de oferta da Imagem do Azure Virtual Machines Marketplace. Por exemplo, UbuntuServer ou WindowsServer.
publisher	string	O editor da Imagem do Azure Virtual Machines Marketplace. Por exemplo, Canonical ou MicrosoftWindowsServer.
sharedGalleryImageId	string	O identificador exclusivo da imagem da galeria compartilhada Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida a partir da chamada GET da imagem da galeria partilhada.
sku	string	A SKU da imagem do Azure Virtual Machines Marketplace. Por exemplo, 18.04-LTS ou 2019-Datacenter.
version	string	A versão da Imagem do Azure Virtual Machines Marketplace. Um valor de 'mais recente' pode ser especificado para selecionar a versão mais recente de uma imagem. Se omitido, o padrão é 'mais recente'.
virtualMachineImageId	string	O identificador de recurso ARM da Imagem da Galeria de Computação do Azure. Os nós de computação no pool serão criados usando essa ID de imagem. Este é o formato /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 sempre padronizar a versão de imagem mais recente. Esta propriedade é mutuamente exclusiva com outras propriedades ImageReference. A Imagem da Galeria de Computação do Azure deve ter réplicas na mesma região e deve estar na mesma assinatura que a conta do Lote do Azure. Se a versão da imagem não for especificada no imageId, a versão mais recente será usada. Para obter informações sobre as configurações de firewall para o agente Batch Compute Node se comunicar com o serviço Batch, consulte https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

InboundEndpoint

Um ponto de extremidade de entrada em um nó de computação.

Name	Tipo	Description
backendPort	integer	O número da porta de back-end do ponto de extremidade.
frontendPort	integer	O número da porta pública do ponto de extremidade.
name	string	O nome do ponto de extremidade.
protocol	InboundEndpointProtocol	O protocolo do ponto de extremidade.
publicFQDN	string	O nome de domínio público totalmente qualificado para o nó de computação.
publicIPAddress	string	O endereço IP público do nó de computação.

InboundEndpointProtocol

O protocolo do ponto de extremidade.

Name	Tipo	Description
tcp	string	Use TCP para o ponto de extremidade.
udp	string	Use UDP para o ponto de extremidade.

NameValuePair

Representa um par nome-valor.

Name	Tipo	Description
name	string	O nome no par nome-valor.
value	string	O valor no par nome-valor.

NodeAgentInformation

Informações sobre o agente Compute Node.

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 vez mais recente que o agente Compute Node foi atualizado para uma nova versão.
version	string	A versão do agente Batch Compute Node em execução no Compute Node. Esse 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 arquivo ou vários arquivos a serem baixados para um nó de computação.

Name	Tipo	Description
autoStorageContainerName	string	O nome do contêiner de armazenamento na conta de armazenamento automático. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada.
blobPrefix	string	O prefixo de blob a ser usado ao baixar blobs de um contêiner de Armazenamento do Azure. Somente os blobs cujos nomes começam com o prefixo especificado serão baixados. A propriedade é válida somente quando autoStorageContainerName ou storageContainerUrl é usado. Esse prefixo pode ser um nome de arquivo parcial ou um subdiretório. Se um prefixo não for especificado, todos os arquivos no contêiner serão baixados.
fileMode	string	O atributo file permission mode em formato octal. Esta propriedade aplica-se apenas a arquivos que estão sendo baixados para nós de computação do Linux. Ele será ignorado se for especificado para um resourceFile que será baixado para um nó de computação do Windows. Se essa propriedade não for especificada para um nó de computação do Linux, um valor padrão de 0770 será aplicado ao arquivo.
filePath	string	O local no nó de computação para o qual baixar o(s) arquivo(s), relativo ao diretório de trabalho da tarefa. Se a propriedade httpUrl for especificada, o filePath será necessário e descreverá o caminho para o qual o arquivo será baixado, incluindo o nome do arquivo. Caso contrário, se a propriedade autoStorageContainerName ou storageContainerUrl for especificada, filePath será opcional e será o diretório para o qual os arquivos serão baixados. No caso em que filePath é usado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será mantida na íntegra e anexada ao diretório filePath especificado. O caminho relativo especificado não pode sair do diretório de trabalho da Tarefa (por exemplo, usando '..').
httpUrl	string	O URL do ficheiro a transferir. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Se a URL apontar para o Armazenamento de Blobs do Azure, ela deverá ser legível a partir dos nós de computação. Há três maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma Assinatura de Acesso Compartilhado (SAS) concedendo permissões de leitura no blob, usar uma identidade gerenciada com permissão de leitura ou definir a ACL para o blob ou seu contêiner para permitir acesso público.
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída ao usuário a ser usada para acessar o Armazenamento de Blob do Azure especificado por storageContainerUrl ou httpUrl A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.
storageContainerUrl	string	A URL do contêiner de blob no Armazenamento de Blob do Azure. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Este URL deve ser legível e listável a partir de nós de computação. Há três maneiras de obter essa URL para um contêiner no armazenamento do Azure: incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de leitura e lista no contêiner, usar uma identidade gerenciada com permissões de leitura e lista ou definir a ACL do contêiner para permitir acesso público.

SchedulingState

Se o nó de computação está disponível para agendamento de tarefas.

Name	Tipo	Description
disabled	string	Nenhuma nova tarefa será agendada no nó de computação. As tarefas já em execução no Nó de Computação ainda podem ser executadas até a conclusão. Todos os nós de computação começam com o agendamento habilitado.
enabled	string	As tarefas podem ser agendadas no nó de computação.

StartTask

Uma Tarefa que é executada quando um Nó ingressa em um Pool no serviço Lote do Azure ou quando o Nó de Computação é reinicializado ou recriado.

Name	Tipo	Description
commandLine	string	A linha de comando do StartTask. A linha de comando não é executada sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se você quiser aproveitar esses recursos, você deve invocar o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comando se referir a caminhos de arquivo, ela deverá usar um caminho relativo (relativo ao diretório de trabalho Tarefa) ou usar a variável de ambiente Batch provided (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	As configurações para o contêiner sob o qual o StartTask é executado. Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios do Lote do Azure no nó) são mapeados no contêiner, todas as variáveis de ambiente de Tarefa são mapeadas no contêiner e a linha de comando Tarefa é executada no contêiner. Os arquivos produzidos no contêiner fora de AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco host, o que significa que as APIs de arquivo em lote não poderão acessar esses arquivos.
environmentSettings	EnvironmentSetting[]	Uma lista de configuraçõ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 de lote tenta novamente uma tarefa se seu código de saída for diferente de zero. Observe que esse valor controla especificamente o número de tentativas. O serviço de lote tentará a tarefa uma vez e, em seguida, poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de tentativas for 3, o Batch tentará a Tarefa até 4 vezes (uma tentativa inicial e 3 tentativas). Se a contagem máxima de tentativas for 0, o serviço Batch não repetirá a Tarefa. Se a contagem máxima de tentativas for -1, o serviço em lote repetirá a tarefa sem limite, no entanto, isso não é recomendado para uma tarefa inicial ou qualquer tarefa. O valor padrão é 0 (sem tentativas).
resourceFiles	ResourceFile[]	Uma lista de arquivos que o serviço em lote baixará para o nó de computação antes de executar a linha de comando. Há um tamanho máximo para a lista de arquivos de recursos. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deve ser reduzida em tamanho. Isso pode ser feito usando arquivos .zip, pacotes de aplicativos ou contêineres do Docker. Os arquivos listados sob este elemento estão localizados no diretório de trabalho da tarefa.
userIdentity	UserIdentity	A identidade do usuário sob a qual o StartTask é executado. Se omitida, a Tarefa é executada como um usuário não administrativo exclusivo para a Tarefa.
waitForSuccess	boolean	Se o serviço em lote deve aguardar a conclusão bem-sucedida do StartTask (ou seja, sair com o código de saída 0) antes de agendar quaisquer tarefas no nó de computação. Se true e o StartTask falhar em um nó, o serviço Batch tentará novamente o StartTask até sua contagem máxima de tentativas (maxTaskRetryCount). Se a Tarefa ainda não tiver sido concluída com êxito após todas as tentativas, o serviço Lote marcará o Nó como inutilizável e não agendará Tarefas para ele. Esta condição pode ser detetada através do estado do nó de computação e detalhes de informações de falha. Se false, o serviço Batch não aguardará a conclusão do StartTask. Nesse 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, novas tarefas continuarão a ser agendadas no nó de computação. O padrão é true.

StartTaskInformation

Informações sobre um StartTask em execução em um nó de computação.

Name	Tipo	Description
containerInfo	TaskContainerExecutionInformation	Informações sobre o contêiner sob o qual a Tarefa está sendo executada. Essa propriedade é definida somente se a Tarefa for executada em um contexto de contêiner.
endTime	string	A hora em que o StartTask parou de ser executado. Esta é a hora de término da execução mais recente do StartTask, se essa execução tiver sido concluída (mesmo que essa execução tenha falhado e uma nova tentativa esteja pendente). Este elemento não estará presente se o StartTask estiver em execução no momento.
exitCode	integer	O código de saída do programa especificado na linha de comando StartTask. Essa propriedade é definida somente se 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 desenvolvedor do aplicativo para esse processo. Se você usar o valor do código de saída para tomar decisões em seu código, certifique-se de conhecer a convenção de código de saída usada pelo processo de aplicativo. No entanto, se o serviço Batch encerrar o StartTask (devido ao tempo limite ou ao encerramento do usuário por meio da API), você poderá ver um código de saída definido pelo sistema operacional.
failureInfo	TaskFailureInformation	Informações que descrevem a falha da tarefa, se houver. Esta propriedade é definida somente se a tarefa estiver no estado concluído e encontrou uma falha.
lastRetryTime	string	O momento mais recente em que uma nova tentativa da Tarefa começou a ser executada. Este elemento estará presente somente se a Task tiver sido repetida (ou seja, retryCount for diferente de zero). Se presente, normalmente é o mesmo que startTime, mas pode ser diferente se a Tarefa tiver sido reiniciada por motivos diferentes de repetir; por exemplo, se o nó de computação foi reinicializado durante uma nova tentativa, então o startTime é atualizado, mas o lastRetryTime não.
result	TaskExecutionResult	O resultado da execução da tarefa. Se o valor for 'failed', 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 de lote. Falhas de aplicativo de tarefa (código de saída diferente de zero) são repetidas, erros de pré-processamento (a tarefa não pôde ser executada) e erros de upload de arquivo não são repetidos. O serviço Batch tentará novamente a Tarefa até o limite especificado pelas restrições.
startTime	string	A hora em que o StartTask começou a ser executado. Esse valor é redefinido 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 novas tentativas foi atingido, ou o processo StartTask não foi executado devido a erros de preparação de tarefas (como falhas de download de arquivo de recurso).
running	string	O StartTask está em execução no momento.

TaskContainerExecutionInformation

Contém informações sobre o contêiner que uma tarefa está executando.

Name	Tipo	Description
containerId	string	A ID do contêiner.
error	string	Informações detalhadas de erro sobre o contêiner. Esta é a cadeia de erro detalhada do serviço Docker, se disponível. É equivalente ao campo de erro retornado por "docker inspect".
state	string	O estado do recipiente. Este é o estado do contêiner de acordo com o serviço Docker. É equivalente ao campo de status retornado por "docker inspect".

TaskContainerSettings

As configurações de contêiner para uma Tarefa.

Name	Tipo	Description
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	Os caminhos que você deseja montar para a tarefa de contêiner. Se essa matriz for nula ou não estiver presente, a tarefa de contêiner montará toda a unidade de disco temporária no Windows (ou AZ_BATCH_NODE_ROOT_DIR no Linux). Ele não montará nenhum caminho de dados no contêiner se essa matriz estiver definida como vazia.
containerRunOptions	string	Opções adicionais para o comando container create. Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além daquelas controladas pelo Batch Service.
imageName	string	A Imagem a ser usada para criar o contêiner no qual a Tarefa será executada. Esta é a referência completa da imagem, como seria especificado para "docker pull". Se nenhuma tag for fornecida como parte do nome da imagem, a tag ":latest" será usada como padrão.
registry	ContainerRegistry	O registro privado que contém a imagem do contêiner. Essa configuração pode ser omitida se já tiver sido fornecida na criação do pool.
workingDirectory	ContainerWorkingDirectory	O local do diretório de trabalho da tarefa do contêiner. O padrão é 'taskWorkingDirectory'.

TaskExecutionInformation

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

Name	Tipo	Description
containerInfo	TaskContainerExecutionInformation	Informações sobre o contêiner sob o qual a Tarefa está sendo executada. Essa propriedade é definida somente se a Tarefa for executada em um contexto de contêiner.
endTime	string	A hora em que a Tarefa foi concluída. Esta propriedade é definida somente se a tarefa estiver no estado concluído.
exitCode	integer	O código de saída do programa especificado na linha de comando Tarefa. Esta propriedade é definida somente 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 desenvolvedor do aplicativo para esse processo. Se você usar o valor do código de saída para tomar decisões em seu código, certifique-se de conhecer a convenção de código de saída usada pelo processo de aplicativo. No entanto, se o serviço em lote encerrar a tarefa (devido ao tempo limite ou ao encerramento do usuário por meio da API), você poderá ver um código de saída definido pelo sistema operacional.
failureInfo	TaskFailureInformation	Informações que descrevem a falha da tarefa, se houver. Esta propriedade é definida somente se a tarefa estiver no estado concluído e encontrou uma falha.
lastRequeueTime	string	O momento mais recente em que a tarefa foi colocada novamente na fila pelo serviço em lote como resultado de uma solicitação do usuário. Esta propriedade é definida somente se o requeueCount for diferente de zero.
lastRetryTime	string	O momento mais recente em que uma nova tentativa da Tarefa começou a ser executada. Este elemento estará presente somente se a Task tiver sido repetida (ou seja, retryCount for diferente de zero). Se presente, normalmente é o mesmo que startTime, mas pode ser diferente se a Tarefa tiver sido reiniciada por motivos diferentes de repetir; por exemplo, se o nó de computação foi reinicializado durante uma nova tentativa, então o startTime é atualizado, mas o lastRetryTime não.
requeueCount	integer	O número de vezes que a tarefa foi colocada novamente na fila pelo serviço em lote como resultado de uma solicitação do usuário. Quando o usuário remove os Nós de Computação de um Pool (redimensionando/reduzindo o pool) ou quando o Trabalho está sendo desabilitado, o usuário pode especificar que as Tarefas em execução nos Nós de Computação sejam novamente enfileiradas para execução. Essa contagem controla quantas vezes a Tarefa foi colocada novamente na fila por esses motivos.
result	TaskExecutionResult	O resultado da execução da tarefa. Se o valor for 'failed', 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 de lote. Falhas de aplicativo de tarefa (código de saída diferente de zero) são repetidas, erros de pré-processamento (a tarefa não pôde ser executada) e erros de upload de arquivo não são repetidos. O serviço Batch tentará novamente a Tarefa até o limite especificado pelas restrições.
startTime	string	A hora em que a Tarefa começou a ser executada. 'Em execução' corresponde ao estado de execução, portanto, se a Tarefa especificar arquivos de recursos ou Pacotes, a hora de início refletirá a hora em que a Tarefa começou a baixá-los ou implantá-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ídas.

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 em execução ou depois de o processo de Tarefa ter sido encerrado.
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 ao erro.
message	string	Uma mensagem descrevendo o erro de tarefa, destinado a ser adequado para exibição em uma interface do usuário.

TaskInformation

Informações sobre uma tarefa em execução em um nó de computação.

Name	Tipo	Description
executionInfo	TaskExecutionInformation	Informações sobre a execução da Tarefa.
jobId	string	A ID do Trabalho ao qual a Tarefa pertence.
subtaskId	integer	A ID da subtarefa se a Tarefa for uma Tarefa de várias instâncias.
taskId	string	A ID da tarefa.
taskState	TaskState	O estado atual da Tarefa.
taskUrl	string	A URL da tarefa.

TaskState

O estado da Tarefa.

Name	Tipo	Description
active	string	A Tarefa está enfileirada e pode ser executada, mas não está atualmente atribuída a um Nó de Computação. Uma Tarefa entra nesse estado quando é criada, quando é habilitada após ser desabilitada ou quando está aguardando uma nova tentativa após uma execução com falha.
completed	string	A Tarefa não está mais qualificada para execução, geralmente porque a Tarefa foi concluída com êxito ou a Tarefa foi concluída sem êxito e esgotou seu limite de novas tentativas. Uma Tarefa também é marcada como concluída se ocorrer um erro ao iniciar a Tarefa ou quando a Tarefa tiver sido encerrada.
preparing	string	A Tarefa foi atribuída a um Nó de Computação, mas está aguardando a conclusão de uma Tarefa de Preparação de Trabalho necessária no Nó de Computação. Se a Tarefa de Preparação de Trabalho for bem-sucedida, a Tarefa passará para execução. Se a Tarefa de Preparação de Trabalho falhar, a Tarefa voltará à ativa e será qualificada para ser atribuída a um Nó de Computação diferente.
running	string	A tarefa está sendo executada em um nó de computação. Isso inclui a preparação no nível da tarefa, como baixar arquivos de recursos ou implantar pacotes especificados na tarefa - isso não significa necessariamente que a linha de comando da tarefa começou a ser executada.

UserIdentity

A definição da identidade do usuário sob a qual a Tarefa é executada.

Name	Tipo	Description
autoUser	AutoUserSpecification	O usuário automático sob o qual a tarefa é executada. As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos.
username	string	O nome da identidade do usuário sob a qual a Tarefa é executada. As propriedades userName e autoUser são mutuamente exclusivas; você deve 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	A ID do recurso da VM atual do Conjunto de Escala de Máquina Virtual do Nó de Computação. Definido somente se a Conta em Lote tiver sido criada com sua propriedade poolAllocationMode definida como 'UserSubscription'.