Compute Node - Get

Service:

Batch Service

API Version:

2023-11-01.18.0

Obtém informações sobre o Nó de Computação especificado.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?api-version=2023-11-01.18.0

With optional parameters:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço Lote do Azure.
nodeId	path	True	string	A ID do Nó de Computação sobre a 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.

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
client-request-id		string uuid	A identidade da solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, 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 a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Nome	Tipo	Description
200 OK	ComputeNode	Uma resposta que contém o Nó de Computação. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	O erro do serviço do Lote.

Segurança

azure_auth

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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	Representar sua conta de usuário

Authorization

Type: apiKey
In: header

Exemplos

Node get

Sample Request

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z?api-version=2023-11-01.18.0

Sample Response

Status code:

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

Nome	Description
AutoUserScope	O escopo do usuário automático
AutoUserSpecification	Especifica os parâmetros para o usuário automático que executa uma Tarefa no serviço do Lote.
BatchError	Uma resposta de erro recebida do serviço Lote do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro 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 repositório 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 do 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 pelo usuário associada ao pool do Lote que um nó de computação usará.
ComputeNodeState	O estado atual do Nó de Computação.
ContainerRegistry	Um registro de contêiner privado.
ContainerWorkingDirectory	O local do diretório de trabalho da Tarefa de contêiner.
ElevationLevel	O nível de elevação do usuário.
EnvironmentSetting	Uma variável de ambiente a ser definida em um processo de Tarefa.
ErrorCategory	A categoria do erro.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro Lote do Azure.
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 Azure Marketplace verificadas por Lote do Azure, consulte a operação 'Listar Imagens Com Suporte'.
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 de Nó de Computação.
ResourceFile	Um único arquivo ou vários arquivos a serem baixados em 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 de 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 do usuário automático

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

Nome	Tipo	Description
elevationLevel	ElevationLevel	O nível de elevação do usuário automático. O valor padrão é nonAdmin.
scope	AutoUserScope	O escopo do 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 alterar o registro de uma maneira que possa afetar outras tarefas ou se os certificados tiverem sido especificados no pool, que não devem ser acessíveis por tarefas normais, mas devem ser acessíveis pelo StartTasks.

BatchError

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

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
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ído em uma resposta de erro Lote do Azure.

Nome	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Value.
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 em um pool.

Nome	Tipo	Description
storeLocation	CertificateStoreLocation	O local do repositório de certificados no Nó de Computação no qual instalar o Certificado. O valor padrão é currentuser. Essa propriedade é aplicável somente a Pools configurados com nós de computação do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration usando uma referência de Imagem do Windows). Para nós de computação do 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 Certificados são colocados nesse diretório.
storeName	string	O nome do repositório de certificados no Nó de Computação no qual instalar o Certificado. Essa propriedade é aplicável somente a Pools configurados com nós de computação do Windows (ou seja, criados com cloudServiceConfiguration ou com virtualMachineConfiguration usando uma referência de Imagem do Windows). Os nomes comuns do repositório incluem: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, mas qualquer nome de repositório personalizado também pode ser usado. O valor padrão é 65536.
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 repositório de certificados no Nó de Computação no qual instalar o Certificado.

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

CertificateVisibility

Quais contas de usuário no Nó de Computação devem ter acesso aos dados privados do Certificado.

Nome	Tipo	Description
remoteuser	string	O Certificado deve estar visível para as contas de usuário nas 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 na qual o StartTask é executado. Observe que, se o Escopo do AutoUser 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 nas quais as Tarefas de Trabalho são executadas.

ComputeNode

Um Nó de Computação no serviço do Lote.

Nome	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. Observe que isso é 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	A hora em que esse Nó de Computação foi alocado para o pool. Esse é o momento em que o Nó de Computação foi alocado inicialmente e não é alterado uma vez definido. Ele não é atualizado quando o Nó de Computação é reparado ou preempcionado pelo serviço.
certificateReferences	CertificateReference[]	A lista de Certificados instalados no Nó de Computação. Para nós do Windows, o serviço lote instala os Certificados no repositório de certificados e no local especificados. Para nós de computação do 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: essa propriedade foi preterida e será removida após fevereiro de 2024. Em vez disso, use a Extensão do Azure KeyVault .
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 a ID é recuperada 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. Cada nó de computação adicionado a um pool recebe 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 esse nó de computação é um nó de computação dedicado. Se for false, o Nó de Computação será 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 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 em Lote é um programa que é executado em cada Nó de Computação no Pool e fornece a funcionalidade do Lote 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 pela execução atual de Tarefas de Trabalho no Nó de Computação. Isso inclui Tarefas do Gerenciador de Trabalhos e Tarefas normais, mas não Preparação do Trabalho, Liberação do Trabalho ou Tarefas de Início.
runningTasksCount	integer	O número total de tarefas de trabalho em execução no momento no nó de computação. Isso inclui Tarefas do Gerenciador de Trabalhos e Tarefas normais, mas não Preparação do Trabalho, Liberação do 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 ele ingressa no pool. O Lote repetirá Tarefas quando uma operação de recuperação for disparada em um Nó. Exemplos de operações de recuperação incluem (mas não se limitam a) quando um nó não íntegro é reinicializado ou um Nó de Computação desapareceu devido a uma falha no host. As novas tentativas devido a operações de recuperação são independentes de e não são contadas em relação a maxTaskRetryCount. Mesmo que maxTaskRetryCount seja 0, poderá ocorrer uma repetição interna devido a uma operação de recuperação. Por isso, todas as Tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar que sejam interrompidas e reiniciadas sem causar dados corrompidos ou duplicados. A melhor prática para tarefas de execução prolongada é 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. Deve-se tomar cuidado especial para evitar StartTasks que criam processos de separação ou serviços de instalação/inicialização do diretório de trabalho StartTask, pois isso impedirá que o Lote seja capaz de executar novamente 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/de baixa prioridade foi preempto. As tarefas que estavam em execução no Nó de Computação quando ele foi preempcionado serão reagendadas quando outro Nó de Computação ficar disponível.
stateTransitionTime	string	A hora em que o Nó de Computação inseriu 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 Trabalhos e Tarefas normais, mas não Preparação do Trabalho, Liberação do Trabalho ou Tarefas de Início.
totalTasksSucceeded	integer	O número total de Tarefas de Trabalho que foram concluídas com êxito (com exitCode 0) no Nó de Computação. Isso inclui Tarefas do Gerenciador de Trabalhos e Tarefas normais, mas não Preparação do Trabalho, Liberação do 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 os tamanhos disponíveis de máquinas virtuais em Pools, consulte Escolher um tamanho de VM para nós de computação em um pool de Lote do Azure (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

ComputeNodeEndpointConfiguration

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

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

Nome	Tipo	Description
code	string	Um identificador para o erro nó de computação. Os códigos são invariáveis e devem ser consumidos programaticamente.
errorDetails	NameValuePair[]	A lista de detalhes de erro adicionais relacionados ao erro Nó de Computação.
message	string	Uma mensagem que descreve o erro Nó de Computação, destinada a ser adequada para exibição em uma interface do usuário.

ComputeNodeIdentityReference

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

Nome	Tipo	Description
resourceId	string	A ID de recurso do ARM da identidade atribuída pelo usuário.

ComputeNodeState

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

Nome	Tipo	Description
creating	string	O serviço lote obteve a máquina virtual subjacente da Computação do Azure, mas ainda não começou a ingressar no pool.
idle	string	O Nó de Computação não está executando uma Tarefa no momento.
leavingpool	string	O Nó de Computação está deixando o Pool, porque o usuário o removeu explicitamente ou porque o Pool está redimensionando ou dimensionando 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/de baixa prioridade foi preempto. As tarefas que estavam em execução no Nó de Computação quando ele foi preempcionado serão reagendadas quando outro Nó de Computação ficar disponível.
rebooting	string	O Nó de Computação está sendo reinicializado.
reimaging	string	O Nó de Computação é reimaginado.
running	string	O Nó de Computação está executando uma ou mais Tarefas (diferente de uma StartTask).
starting	string	O serviço lote está começando 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 pode ser usado para executar Tarefas.
unknown	string	O serviço lote perdeu contato com o Nó de Computação e não sabe seu estado verdadeiro.
unusable	string	O Nó de Computação não pode ser usado para execução de tarefa 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 registro de contêiner privado.

Nome	Tipo	Description
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída pelo 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 pelo usuário associada ao pool do Lote que um nó de computação usará.
password	string	A senha para fazer logon no servidor do Registro.
registryServer	string	A URL do registro. Se omitido, o padrão será "docker.io".
username	string	O nome de usuário para fazer logon no servidor do Registro.

ContainerWorkingDirectory

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

Nome	Tipo	Description
containerImageDefault	string	Use o diretório de trabalho definido na Imagem do contêiner. Cuidado para que esse diretório não contenha os Arquivos de Recursos baixados pelo Lote.
taskWorkingDirectory	string	Use o diretório de trabalho da Tarefa de Serviço do Lote padrão, que conterá os Arquivos de Recurso de Tarefa preenchidos pelo Lote.

ElevationLevel

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

Nome	Tipo	Description
admin	string	O usuário é um usuário com acesso elevado e opera com permissões de Administrador completas.
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 de Tarefa.

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

Nome	Tipo	Description
servererror	string	O erro ocorre devido a um problema interno do servidor.
usererror	string	O erro ocorre devido a um problema de usuário, como configuração incorreta.

ErrorMessage

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

Nome	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 Azure Marketplace verificadas por Lote do Azure, consulte a operação 'Listar Imagens Com Suporte'.

Nome	Tipo	Description
exactVersion	string	A versão específica da imagem da plataforma ou da imagem do marketplace usada para criar o nó. Esse campo somente leitura será diferente de "version" somente se o valor especificado para 'version' quando o pool foi criado for 'latest'.
offer	string	O tipo de oferta da Imagem do Azure Máquinas Virtuais Marketplace. Por exemplo, UbuntuServer ou WindowsServer.
publisher	string	O editor da imagem do Azure Máquinas Virtuais 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 da imagem do Azure Máquinas Virtuais Marketplace. Um valor "mais recente" pode ser especificado para selecionar a versão mais recente de uma Imagem. Se omitido, o padrão será 'latest'.
virtualMachineImageId	string	O identificador de recurso do ARM da Imagem da Galeria de Computação do Azure. Nós de computação no pool serão criados usando essa ID de imagem. Isso é 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 sempre usar a versão mais recente da imagem. Essa 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 Lote do Azure. Se a versão da imagem não for especificada na imageId, a versão mais recente será usada. Para obter informações sobre as configurações de firewall do agente do Nó de Computação em Lote para se comunicar com o serviço do Lote, consulte https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpoint

Um ponto de extremidade de entrada em um Nó de Computação.

Nome	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 totalmente 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 de extremidade.

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

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

NodeAgentInformation

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

Nome	Tipo	Description
lastUpdateTime	string	A hora em que o agente de 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 em Lote em execução no Nó de Computação. 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 em um Nó de Computação.

Nome	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 do 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 de modo de permissão de arquivo no formato octal. Essa propriedade se aplica somente aos 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 os arquivos em relação 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 baixar os arquivos. 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 acrescentada 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	A URL do arquivo para download. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Se a URL apontar para Armazenamento de Blobs do Azure, ela deverá ser legível de nós de computação. Há três maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma SAS (Assinatura de Acesso Compartilhado) 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 pelo usuário a ser usada para acessar Armazenamento de Blobs do Azure especificada por storageContainerUrl ou httpUrl A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.
storageContainerUrl	string	A URL do contêiner de blob no Armazenamento de Blobs do Azure. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Essa URL deve ser legível e listável 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 para o contêiner para permitir acesso público.

SchedulingState

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

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

Nome	Tipo	Description
commandLine	string	A linha de comando do StartTask. A linha de comando não é executada em um shell e, portanto, não pode aproveitar os recursos do shell, como expansão de variável de ambiente. Se você quiser aproveitar esses recursos, invoque 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 (em relação ao diretório de trabalho Tarefa) ou usar a variável de ambiente fornecida pelo Lote (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	As configurações para o contêiner no qual o StartTask é executado. Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz de Lote do Azure diretórios no nó) são mapeados para o contêiner, todas as variáveis de ambiente task são mapeadas para o contêiner e a linha de comando Task é executada no contêiner. Os arquivos produzidos no contêiner fora do AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco host, o que significa que as APIs de arquivo do Lote não poderão acessar esses arquivos.
environmentSettings	EnvironmentSetting[]	Uma lista de configurações de variável de ambiente para o StartTask.
maxTaskRetryCount	integer	O número máximo de vezes que a Tarefa pode ser repetida. O serviço do Lote tentará novamente uma Tarefa se o código de saída não for zero. Observe que esse valor controla especificamente o número de tentativas. O serviço do Lote tentará a Tarefa uma vez e poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de repetições for 3, o Lote tentará a Tarefa até 4 vezes (uma tentativa inicial e três tentativas). Se a contagem máxima de repetição for 0, o serviço do Lote não repetirá a Tarefa. Se a contagem máxima de repetição for -1, o serviço do Lote tentará novamente a Tarefa sem limite, no entanto, isso não é recomendado para uma tarefa inicial ou qualquer tarefa. O valor padrão é 0 (sem novas tentativas).
resourceFiles	ResourceFile[]	Uma lista de arquivos que o serviço do 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 recurso. 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 deverá ser reduzida em tamanho. Isso pode ser obtido usando arquivos .zip, Pacotes de Aplicativos ou Contêineres do Docker. Os arquivos listados sob esse 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 será executada como um usuário não administrativo exclusivo para a Tarefa.
waitForSuccess	boolean	Se o serviço do Lote deve aguardar a conclusão do StartTask com êxito (ou seja, sair com o código de saída 0) antes de agendar tarefas no Nó de Computação. Se true e o StartTask falharem em um Nó, o serviço do Lote tentará novamente o StartTask até sua contagem máxima de repetição (maxTaskRetryCount). Se a Tarefa ainda não tiver sido concluída com êxito após todas as tentativas, o serviço do Lote marcará o Nó inutilizável e não agendará Tarefas para ele. Essa condição pode ser detectada por meio do estado do Nó de Computação e dos detalhes das informações de falha. Se for falso, o serviço do Lote 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 estiver 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.

Nome	Tipo	Description
containerInfo	TaskContainerExecutionInformation	Informações sobre o contêiner no qual a Tarefa está sendo executada. Essa propriedade será 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. Essa é 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 falhe e uma nova tentativa esteja pendente). Esse 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 será definida somente 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 desenvolvedor de aplicativos 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 do aplicativo. No entanto, se o serviço do Lote encerrar o StartTask (devido ao tempo limite ou ao término 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. Essa propriedade será definida somente se a Tarefa estiver no estado concluído e encontrar uma falha.
lastRetryTime	string	O momento mais recente em que uma nova tentativa da Tarefa começou a ser executada. Esse elemento só estará presente se a Tarefa tiver sido repetida (ou seja, retryCount não é zero). Se estiver presente, isso normalmente será o mesmo que startTime, mas poderá ser diferente se a Tarefa tiver sido reiniciada por motivos diferentes da repetição; por exemplo, se o Nó de Computação tiver sido reinicializado durante uma repetição, o startTime será atualizado, mas o lastRetryTime não será.
result	TaskExecutionResult	O resultado da execução da tarefa. Se o valor for 'failed', os detalhes da falha poderão ser encontrados na propriedade failureInfo.
retryCount	integer	O número de vezes que a Tarefa foi repetida pelo serviço do Lote. As falhas do 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 os erros de carregamento de arquivo não são repetidos. O serviço lote 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.

Nome	Tipo	Description
completed	string	O StartTask foi encerrado 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 da tarefa (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.

Nome	Tipo	Description
containerId	string	O ID do contêiner.
error	string	Informações detalhadas de erro sobre o contêiner. Essa é a cadeia de caracteres de erro detalhada do serviço docker, se disponível. É equivalente ao campo de erro retornado por "docker inspect".
state	string	O estado do contêiner. Esse é o estado do contêiner de acordo com o serviço docker. É equivalente ao campo status retornado por "inspeção do docker".

TaskContainerSettings

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

Nome	Tipo	Description
containerRunOptions	string	Opções adicionais para o comando de criação de contêiner. Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além daquelas controladas pelo Serviço de Lote.
imageName	string	A Imagem a ser usada para criar o contêiner no qual a Tarefa será executada. Essa é a referência de imagem completa, como seria especificado para "docker pull". Se nenhuma marca for fornecida como parte do nome da imagem, a marca ":latest" será usada como padrão.
registry	ContainerRegistry	O registro privado que contém a Imagem do contêiner. Essa configuração poderá ser omitida se já tiver sido fornecida na criação do pool.
workingDirectory	ContainerWorkingDirectory	O local do diretório de trabalho da Tarefa de contêiner. O padrão é 'taskWorkingDirectory'.

TaskExecutionInformation

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

Nome	Tipo	Description
containerInfo	TaskContainerExecutionInformation	Informações sobre o contêiner no qual a Tarefa está sendo executada. Essa propriedade será definida somente se a Tarefa for executada em um contexto de contêiner.
endTime	string	A hora em que a Tarefa foi concluída. Essa propriedade será 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. Essa propriedade será 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 de aplicativos 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 do aplicativo. No entanto, se o serviço lote encerrar a Tarefa (devido ao tempo limite ou ao término 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. Essa propriedade será definida somente se a Tarefa estiver no estado concluído e encontrar uma falha.
lastRequeueTime	string	O momento mais recente em que a Tarefa foi requeutada pelo serviço do Lote como resultado de uma solicitação de usuário. Essa propriedade será definida somente se requeueCount não for zero.
lastRetryTime	string	O momento mais recente em que uma nova tentativa da Tarefa começou a ser executada. Esse elemento só estará presente se a Tarefa tiver sido repetida (ou seja, retryCount não é zero). Se estiver presente, isso normalmente será o mesmo que startTime, mas poderá ser diferente se a Tarefa tiver sido reiniciada por motivos diferentes da repetição; por exemplo, se o Nó de Computação tiver sido reinicializado durante uma repetição, o startTime será atualizado, mas o lastRetryTime não será.
requeueCount	integer	O número de vezes que a Tarefa foi requeutada pelo serviço do Lote como resultado de uma solicitação de usuário. Quando o usuário remove 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 tarefas em execução nos nós de computação sejam requeuídas para execução. Essa contagem rastreia quantas vezes a Tarefa foi requeutada por esses motivos.
result	TaskExecutionResult	O resultado da execução da tarefa. Se o valor for 'failed', os detalhes da falha poderão ser encontrados na propriedade failureInfo.
retryCount	integer	O número de vezes que a Tarefa foi repetida pelo serviço do Lote. As falhas do 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 os erros de carregamento de arquivo não são repetidos. O serviço lote tentará novamente a Tarefa até o limite especificado pelas restrições.
startTime	string	A hora em que a Tarefa começou a ser executada. 'Running' corresponde ao estado em execução; portanto, se a Tarefa especificar arquivos de recurso 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 será a hora mais recente em que a Tarefa começou a ser executada. Essa 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.

Nome	Tipo	Description
failure	string	Ocorreu um erro durante o processamento da Tarefa. A falha pode ter ocorrido antes da inicialização do processo da Tarefa, enquanto o processo da Tarefa estava em execução ou após a saída do processo da Tarefa.
success	string	A Tarefa foi executada com êxito.

TaskFailureInformation

Informações sobre uma falha de tarefa.

Nome	Tipo	Description
category	ErrorCategory	A categoria do erro Tarefa.
code	string	Um identificador para o erro Tarefa. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	NameValuePair[]	Uma lista de detalhes adicionais relacionados ao erro.
message	string	Uma mensagem que descreve o erro Tarefa, destinada a ser adequada para exibição em uma interface do usuário.

TaskInformation

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

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

Nome	Tipo	Description
active	string	A Tarefa está na fila e pode ser executada, mas não está atribuída atualmente a um Nó de Computação. Uma Tarefa entra nesse estado quando é criada, quando está habilitada após ser desabilitada ou quando aguarda uma nova tentativa após uma execução com falha.
completed	string	A Tarefa não está mais qualificada para ser executada, geralmente porque a Tarefa foi concluída com êxito ou a Tarefa foi concluída sem sucesso e esgotou o limite de repetição. Uma Tarefa também será 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 do Trabalho for bem-sucedida, a Tarefa passará para a execução. Se a Tarefa de Preparação do Trabalho falhar, a Tarefa retornará à ativa e será qualificada para ser atribuída a um nó de computação diferente.
running	string	A Tarefa está em execução em um Nó de Computação. Isso inclui a preparação no nível da tarefa, como baixar arquivos de recurso ou implantar pacotes especificados na Tarefa , isso não significa necessariamente que a linha de comando Task tenha começado a ser executada.

UserIdentity

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

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

Nome	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 Dimensionamento de Máquinas Virtuais do Nó de Computação. Definido somente se a Conta do Lote foi criada com sua propriedade poolAllocationMode definida como 'UserSubscription'.