Compute Node - List
Lista os Nós de Computação no Conjunto especificado.
GET {batchUrl}/pools/{poolId}/nodes?api-version=2023-11-01.18.0
GET {batchUrl}/pools/{poolId}/nodes?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
batch
|
path | True |
string |
O URL base para todos os pedidos de serviço Azure Batch. |
pool
|
path | True |
string |
O ID do Conjunto a partir do qual pretende listar Os Nós de Computação. |
api-version
|
query | True |
string |
Versão da API de Cliente. |
$filter
|
query |
string |
Uma cláusula OData $filter. Para obter mais informações sobre como construir este filtro, consulte https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. |
|
$select
|
query |
string |
Uma cláusula OData $select. |
|
maxresults
|
query |
integer int32 |
O número máximo de itens a devolver na resposta. Pode ser devolvido um máximo de 1000 Nós de Computação. |
|
timeout
|
query |
integer int32 |
O tempo máximo que o servidor pode gastar a processar o pedido, em segundos. A predefinição é 30 segundos. |
Cabeçalho do Pedido
Media Types: "application/json; odata=minimalmetadata"
Name | Necessário | Tipo | Description |
---|---|---|---|
client-request-id |
string uuid |
A identidade do pedido gerado pelo autor da chamada, sob a forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Se o servidor deve devolver o client-request-id na resposta. |
|
ocp-date |
string date-time-rfc1123 |
A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-a explicitamente se estiver a chamar a API REST diretamente. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Uma resposta que contém a lista de Nós de Computação. Cabeçalhos
|
|
Other Status Codes |
O erro do serviço Batch. |
Segurança
azure_auth
Microsoft Entra fluxo de código de autenticação OAuth 2.0
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | Representar a sua conta de utilizador |
Authorization
Tipo:
apiKey
Em:
header
Exemplos
Node list
Pedido de amostra
GET account.region.batch.azure.com/pools/poolId/nodes?api-version=2023-11-01.18.0
Resposta da amostra
{
"value": [
{
"id": "tvm-1695681911_1-20161122t193202z",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z",
"state": "idle",
"schedulingState": "enabled",
"stateTransitionTime": "2016-11-22T22:22:27.2236818Z",
"lastBootTime": "2016-11-22T22:22:24.4634125Z",
"allocationTime": "2016-11-22T19:32:02.8155319Z",
"ipAddress": "1.1.1.1",
"affinityId": "TVM:tvm-1695681911_1-20161122t193202z",
"vmSize": "small",
"totalTasksRun": 0,
"totalTasksSucceeded": 0,
"runningTasksCount": 0,
"runningTaskSlotsCount": 0,
"isDedicated": true,
"startTask": {
"commandLine": "cmd /c echo hello",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"startTaskInfo": {
"state": "completed",
"startTime": "2016-11-22T22:22:27.2236818Z",
"endTime": "2016-11-22T22:22:27.567189Z",
"exitCode": 0,
"retryCount": 0
},
"nodeAgentInfo": {
"version": "1.2.0.0",
"lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
}
},
{
"id": "tvm-1695681911_2-20161122t193202z",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z",
"state": "idle",
"schedulingState": "enabled",
"stateTransitionTime": "2016-11-22T19:37:31.4285526Z",
"lastBootTime": "2016-11-22T19:37:28.623369Z",
"allocationTime": "2016-11-22T19:32:02.8155319Z",
"ipAddress": "1.1.1.1",
"affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
"vmSize": "small",
"totalTasksRun": 0,
"totalTasksSucceeded": 0,
"runningTasksCount": 0,
"runningTaskSlotsCount": 0,
"isDedicated": true,
"startTask": {
"commandLine": "cmd /c echo hello",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"startTaskInfo": {
"state": "completed",
"startTime": "2016-11-22T19:37:31.4285526Z",
"endTime": "2016-11-22T19:37:31.838028Z",
"exitCode": 0,
"retryCount": 0
},
"nodeAgentInfo": {
"version": "1.2.0.0",
"lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
}
},
{
"id": "tvm-1695681911_3-20161122t193202z",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z",
"state": "idle",
"schedulingState": "enabled",
"stateTransitionTime": "2016-11-22T19:36:51.0013378Z",
"lastBootTime": "2016-11-22T19:36:48.21721Z",
"allocationTime": "2016-11-22T19:32:02.8155319Z",
"ipAddress": "1.1.1.1",
"affinityId": "TVM:tvm-1695681911_3-20161122t193202z",
"vmSize": "small",
"totalTasksRun": 0,
"totalTasksSucceeded": 0,
"runningTasksCount": 0,
"runningTaskSlotsCount": 0,
"isDedicated": true,
"startTask": {
"commandLine": "cmd /c echo hello",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"startTaskInfo": {
"state": "completed",
"startTime": "2016-11-22T19:36:51.0013378Z",
"endTime": "2016-11-22T19:36:51.2363447Z",
"exitCode": 0,
"retryCount": 0
},
"nodeAgentInfo": {
"version": "1.2.0.0",
"lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
}
}
]
}
Definições
Name | Description |
---|---|
Auto |
O âmbito do utilizador automático |
Auto |
Especifica os parâmetros para o utilizador automático que executa uma Tarefa no serviço Batch. |
Batch |
Uma resposta de erro recebida do serviço Azure Batch. |
Batch |
Um item de informações adicionais incluídas numa resposta de erro Azure Batch. |
Certificate |
Uma referência a um Certificado a ser instalado em Nós de Computação num Conjunto. |
Certificate |
A localização do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado. |
Certificate |
Que contas de utilizador no Nó de Computação devem ter acesso aos dados privados do Certificado. |
Compute |
Um Nó de Computação no serviço Batch. |
Compute |
A configuração do ponto final para o Nó de Computação. |
Compute |
Um erro encontrado por um Nó de Computação. |
Compute |
A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar. |
Compute |
O resultado da listagem dos Nós de Computação num Conjunto. |
Compute |
O estado atual do Nó de Computação. |
Container |
Um registo de contentor privado. |
Container |
A localização do diretório de trabalho tarefa do contentor. |
Elevation |
O nível de elevação do utilizador. |
Environment |
Uma variável de ambiente a definir num processo de Tarefa. |
Error |
A categoria do erro. |
Error |
Uma mensagem de erro recebida numa resposta de erro Azure Batch. |
Image |
Uma referência a uma Imagem do Azure Máquinas Virtuais Marketplace ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de Imagem do Azure Marketplace verificadas por Azure Batch, veja a operação "Listar Imagens Suportadas". |
Inbound |
Um ponto final de entrada num Nó de Computação. |
Inbound |
O protocolo do ponto final. |
Name |
Representa um par nome-valor. |
Node |
Informações sobre o agente do Nó de Computação. |
Resource |
Um único ficheiro ou vários ficheiros a transferir para um Nó de Computação. |
Scheduling |
Se o Nó de Computação está disponível para Agendamento de tarefas. |
Start |
Uma Tarefa que é executada quando um Nó associa um Conjunto no serviço Azure Batch ou quando o Nó de Computação é reiniciado ou reproduzido. |
Start |
Informações sobre uma StartTask em execução num Nó de Computação. |
Start |
O estado do StartTask no Nó de Computação. |
Task |
Contém informações sobre o contentor que uma Tarefa está a executar. |
Task |
As definições de contentor para uma Tarefa. |
Task |
Informações sobre a execução de uma Tarefa. |
Task |
O resultado da execução da tarefa. |
Task |
Informações sobre uma Falha de tarefa. |
Task |
Informações sobre uma Tarefa em execução num Nó de Computação. |
Task |
O estado da Tarefa. |
User |
A definição da identidade de utilizador na qual a Tarefa é executada. |
Virtual |
Informações sobre o estado atual da máquina virtual. |
AutoUserScope
O âmbito do utilizador automático
Name | Tipo | Description |
---|---|---|
pool |
string |
Especifica que a Tarefa é executada como a Conta de utilizador automático comum que é criada em todos os Nós de Computação num Conjunto. |
task |
string |
Especifica que o serviço deve criar um novo utilizador para a Tarefa. |
AutoUserSpecification
Especifica os parâmetros para o utilizador automático que executa uma Tarefa no serviço Batch.
Name | Tipo | Description |
---|---|---|
elevationLevel |
O nível de elevação do utilizador automático. |
|
scope |
O âmbito do utilizador automático |
BatchError
Uma resposta de erro recebida do serviço Azure Batch.
Name | Tipo | Description |
---|---|---|
code |
string |
Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente. |
message |
Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador. |
|
values |
Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro. |
BatchErrorDetail
Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
Name | Tipo | Description |
---|---|---|
key |
string |
Um identificador que especifica o significado da propriedade Valor. |
value |
string |
As informações adicionais incluídas na resposta de erro. |
CertificateReference
Uma referência a um Certificado a ser instalado em Nós de Computação num Conjunto.
Name | Tipo | Description |
---|---|---|
storeLocation |
A localização do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado. |
|
storeName |
string |
O nome do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado. |
thumbprint |
string |
O thumbprint do Certificado. |
thumbprintAlgorithm |
string |
O algoritmo com o qual o thumbprint está associado. Tem de ser sha1. |
visibility |
Que contas de utilizador no Nó de Computação devem ter acesso aos dados privados do Certificado. |
CertificateStoreLocation
A localização do Arquivo de certificados no Nó de Computação no qual pretende instalar o Certificado.
Name | Tipo | Description |
---|---|---|
currentuser |
string |
Os certificados devem ser instalados no arquivo de Certificados CurrentUser. |
localmachine |
string |
Os certificados devem ser instalados no arquivo de Certificados LocalMachine. |
CertificateVisibility
Que contas de utilizador no Nó de Computação devem ter acesso aos dados privados do Certificado.
Name | Tipo | Description |
---|---|---|
remoteuser |
string |
O Certificado deve estar visível para as contas de utilizador nas quais os utilizadores acedem remotamente ao Nó de Computação. |
starttask |
string |
O Certificado deve estar visível para a conta de utilizador na qual o StartTask é executado. Tenha em atenção que se o Âmbito do AutoUser for Conjunto para StartTask e uma Tarefa, este certificado também estará visível para a Tarefa. |
task |
string |
O Certificado deve estar visível para as contas de utilizador nas quais as Tarefas de Trabalho são executadas. |
ComputeNode
Um Nó de Computação no serviço Batch.
Name | Tipo | Description |
---|---|---|
affinityId |
string |
Um identificador que pode ser transmitido ao adicionar uma Tarefa para pedir que a Tarefa seja agendada neste Nó de Computação. |
allocationTime |
string |
O momento em que este Nó de Computação foi alocado ao Conjunto. |
certificateReferences |
A lista de Certificados instalados no Nó de Computação. Aviso: esta propriedade foi preterida e será removida após fevereiro de 2024. Em alternativa, utilize a Extensão Azure KeyVault . |
|
endpointConfiguration |
A configuração do ponto final para o Nó de Computação. |
|
errors |
A lista de erros que estão atualmente a ser encontrados pelo Nó de Computação. |
|
id |
string |
O ID do Nó de Computação. |
ipAddress |
string |
O endereço IP que outros Nós podem utilizar para comunicar com este Nó de Computação. |
isDedicated |
boolean |
Se este Nó de Computação é um Nó de Computação dedicado. Se for falso, o Nó de Computação é um Nó de Computação Spot/De baixa prioridade. |
lastBootTime |
string |
A última vez em que o Nó de Computação foi iniciado. |
nodeAgentInfo |
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. |
|
recentTasks |
Uma lista de Tarefas cujo estado foi alterado recentemente. |
|
runningTaskSlotsCount |
integer |
O número total de blocos de agendamento utilizados pela execução atualmente de Tarefas de Trabalho no Nó de Computação. Isto inclui Tarefas do Gestor de Tarefas e Tarefas normais, mas não Preparação de Trabalhos, Lançamento de Tarefas ou Iniciar Tarefas. |
runningTasksCount |
integer |
O número total de Tarefas atualmente em execução no Nó de Computação. Isto inclui Tarefas do Gestor de Tarefas e Tarefas normais, mas não Preparação de Trabalhos, Lançamento de Tarefas ou Iniciar Tarefas. |
schedulingState |
Se o Nó de Computação está disponível para Agendamento de tarefas. |
|
startTask |
A Tarefa especificada para ser executada no Nó de Computação à medida que se junta ao Conjunto. |
|
startTaskInfo |
Informações de runtime sobre a execução do StartTask no Nó de Computação. |
|
state |
O estado atual do Nó de Computação. |
|
stateTransitionTime |
string |
O momento em que o Nó de Computação entrou no estado atual. |
totalTasksRun |
integer |
O número total de Tarefas de Trabalho concluídas no Nó de Computação. Isto inclui Tarefas do Gestor de Tarefas e Tarefas normais, mas não Preparação de Trabalhos, Lançamento de Tarefas ou Iniciar Tarefas. |
totalTasksSucceeded |
integer |
O número total de Tarefas de Tarefas concluídas com êxito (com exitCode 0) no Nó de Computação. Isto inclui Tarefas do Gestor de Tarefas e Tarefas normais, mas não Preparação de Trabalhos, Lançamento de Tarefas ou Iniciar Tarefas. |
url |
string |
O URL do Nó de Computação. |
virtualMachineInfo |
Informações sobre o estado atual da máquina virtual. |
|
vmSize |
string |
O tamanho da máquina virtual que aloja o Nó de Computação. |
ComputeNodeEndpointConfiguration
A configuração do ponto final para o Nó de Computação.
Name | Tipo | Description |
---|---|---|
inboundEndpoints |
A lista de pontos finais de entrada que estão acessíveis no Nó de Computação. |
ComputeNodeError
Um erro encontrado por um Nó de Computação.
Name | Tipo | Description |
---|---|---|
code |
string |
Um identificador para o erro Node de Computação. Os códigos são invariantes e destinam-se a ser consumidos programaticamente. |
errorDetails |
A lista de detalhes de erro adicionais relacionados com o erro Nó de Computação. |
|
message |
string |
Uma mensagem que descreve o erro Node de Computação, que se destina a ser adequado para ser apresentado numa interface de utilizador. |
ComputeNodeIdentityReference
A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.
Name | Tipo | Description |
---|---|---|
resourceId |
string |
O ID de recurso do ARM da identidade atribuída pelo utilizador. |
ComputeNodeListResult
O resultado da listagem dos Nós de Computação num Conjunto.
Name | Tipo | Description |
---|---|---|
odata.nextLink |
string |
O URL para obter o próximo conjunto de resultados. |
value |
A lista de Nós de Computação. |
ComputeNodeState
O estado atual do Nó de Computação.
Name | Tipo | Description |
---|---|---|
creating |
string |
O serviço Batch obteve a máquina virtual subjacente a partir da Computação do Azure, mas ainda não começou a aderir ao Conjunto. |
idle |
string |
O Nó de Computação não está atualmente a executar uma Tarefa. |
leavingpool |
string |
O Nó de Computação está a sair do Conjunto porque o utilizador o removeu explicitamente ou porque o Conjunto está a redimensionar ou a reduzir automaticamente. |
offline |
string |
O Nó de Computação não está atualmente a executar uma Tarefa e o agendamento de novas Tarefas para o Nó de Computação está desativado. |
preempted |
string |
O Nó de Computação Spot/Low-priority foi preempido. As tarefas que estavam em execução no Nó de Computação quando foi preempida serão reagendadas quando outro Nó de Computação ficar disponível. |
rebooting |
string |
O Nó de Computação está a ser reiniciado. |
reimaging |
string |
O Nó de Computação é reimaginado. |
running |
string |
O Nó de Computação está a executar uma ou mais Tarefas (além de uma StartTask). |
starting |
string |
O serviço Batch está a começar na máquina virtual subjacente. |
starttaskfailed |
string |
O StartTask falhou no Nó de Computação (e esgotou todas as repetições) e waitForSuccess está definido. O Nó de Computação não é utilizável para executar Tarefas. |
unknown |
string |
O serviço Batch perdeu o contacto com o Nó de Computação e não sabe o seu estado verdadeiro. |
unusable |
string |
Não é possível utilizar o Nó de Computação para a execução de tarefas devido a erros. |
waitingforstarttask |
string |
O StartTask começou a ser executado no Nó de Computação, mas waitForSuccess está definido e o StartTask ainda não foi concluído. |
ContainerRegistry
Um registo de contentor privado.
Name | Tipo | Description |
---|---|---|
identityReference |
A referência à identidade atribuída pelo utilizador a utilizar para aceder a um Azure Container Registry em vez de nome de utilizador e palavra-passe. |
|
password |
string |
A palavra-passe para iniciar sessão no servidor de registo. |
registryServer |
string |
O URL do registo. |
username |
string |
O nome de utilizador a iniciar sessão no servidor de registo. |
ContainerWorkingDirectory
A localização do diretório de trabalho tarefa do contentor.
Name | Tipo | Description |
---|---|---|
containerImageDefault |
string |
Utilize o diretório de trabalho definido no contentor Imagem. Tenha em atenção que este diretório não conterá os Ficheiros de Recursos transferidos pelo Batch. |
taskWorkingDirectory |
string |
Utilize o diretório de trabalho tarefas do serviço Batch padrão, que irá conter os Ficheiros de Recurso de Tarefa preenchidos pelo Batch. |
ElevationLevel
O nível de elevação do utilizador.
Name | Tipo | Description |
---|---|---|
admin |
string |
O utilizador é um utilizador com acesso elevado e funciona com permissões de Administrador completas. |
nonadmin |
string |
O utilizador é um utilizador padrão sem acesso elevado. |
EnvironmentSetting
Uma variável de ambiente a definir num processo de Tarefa.
Name | Tipo | Description |
---|---|---|
name |
string |
O nome da variável de ambiente. |
value |
string |
O valor da variável de ambiente. |
ErrorCategory
A categoria do erro.
Name | Tipo | Description |
---|---|---|
servererror |
string |
O erro deve-se a um problema interno do servidor. |
usererror |
string |
O erro deve-se a um problema do utilizador, como configuração incorreta. |
ErrorMessage
Uma mensagem de erro recebida numa resposta de erro Azure Batch.
Name | Tipo | Description |
---|---|---|
lang |
string |
O código de idioma da mensagem de erro |
value |
string |
O texto da mensagem. |
ImageReference
Uma referência a uma Imagem do Azure Máquinas Virtuais Marketplace ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de Imagem do Azure Marketplace verificadas por Azure Batch, veja a operação "Listar Imagens Suportadas".
Name | Tipo | Description |
---|---|---|
exactVersion |
string |
A versão específica da imagem da plataforma ou imagem do marketplace utilizada para criar o nó. Este campo só de leitura só difere de "versão" apenas se o valor especificado para "versão" quando o conjunto foi criado for "mais recente". |
offer |
string |
O tipo de oferta da Imagem do Azure Máquinas Virtuais Marketplace. |
publisher |
string |
O publicador do Azure Máquinas Virtuais Imagem do Marketplace. |
sku |
string |
O SKU da Imagem do Azure Máquinas Virtuais Marketplace. |
version |
string |
A versão do Azure Máquinas Virtuais Imagem do Marketplace. |
virtualMachineImageId |
string |
O identificador do recurso ARM da Imagem da Galeria de Computação do Azure. Os Nós de Computação no Conjunto serão criados com este ID de Imagem. Este é do formulário /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para obter sempre a predefinição da versão mais recente da imagem. |
InboundEndpoint
Um ponto final de entrada num Nó de Computação.
Name | Tipo | Description |
---|---|---|
backendPort |
integer |
O número da porta de back-end do ponto final. |
frontendPort |
integer |
O número de porta pública do ponto final. |
name |
string |
O nome do ponto final. |
protocol |
O protocolo do ponto final. |
|
publicFQDN |
string |
O nome de domínio completamente qualificado público para o Nó de Computação. |
publicIPAddress |
string |
O endereço IP público do Nó de Computação. |
InboundEndpointProtocol
O protocolo do ponto final.
Name | Tipo | Description |
---|---|---|
tcp |
string |
Utilize o TCP para o ponto final. |
udp |
string |
Utilize uDP para o ponto final. |
NameValuePair
Representa um par nome-valor.
Name | Tipo | Description |
---|---|---|
name |
string |
O nome no par name-value. |
value |
string |
O valor no par name-value. |
NodeAgentInformation
Informações sobre o agente do Nó de Computação.
Name | Tipo | Description |
---|---|---|
lastUpdateTime |
string |
A hora em que o agente do Nó de Computação foi atualizado no Nó de Computação. |
version |
string |
A versão do agente do Nó de Computação do Batch em execução no Nó de Computação. |
ResourceFile
Um único ficheiro ou vários ficheiros a transferir para um Nó de Computação.
Name | Tipo | Description |
---|---|---|
autoStorageContainerName |
string |
O nome do contentor de armazenamento na Conta de armazenamento automático. |
blobPrefix |
string |
O prefixo de blobs a utilizar ao transferir blobs a partir de um contentor do Armazenamento do Azure. Apenas os blobs cujos nomes começam com o prefixo especificado serão transferidos. |
fileMode |
string |
O atributo do modo de permissão de ficheiro no formato octal. |
filePath |
string |
A localização no Nó de Computação para o qual transferir os ficheiros, relativamente ao diretório de trabalho da Tarefa. |
httpUrl |
string |
O URL do ficheiro a transferir. |
identityReference |
A referência à identidade atribuída pelo utilizador a utilizar para aceder a Armazenamento de Blobs do Azure especificada por storageContainerUrl ou httpUrl |
|
storageContainerUrl |
string |
O URL do contentor de blobs no Armazenamento de Blobs do Azure. |
SchedulingState
Se o Nó de Computação está disponível para Agendamento de tarefas.
Name | Tipo | Description |
---|---|---|
disabled |
string |
Não serão agendadas novas Tarefas no Nó de Computação. As tarefas já em execução no Nó de Computação ainda podem ser executadas até à conclusão. Todos os Nós de Computação começam com o agendamento ativado. |
enabled |
string |
As tarefas podem ser agendadas no Nó de Computação. |
StartTask
Uma Tarefa que é executada quando um Nó associa um Conjunto no serviço Azure Batch ou quando o Nó de Computação é reiniciado ou reproduzido.
Name | Tipo | Description |
---|---|---|
commandLine |
string |
A linha de comandos do StartTask. |
containerSettings |
As definições do contentor no qual o StartTask é executado. |
|
environmentSettings |
Uma lista de definições de variáveis de ambiente para o StartTask. |
|
maxTaskRetryCount |
integer |
O número máximo de vezes que a Tarefa pode ser repetida. |
resourceFiles |
Uma lista de ficheiros que o serviço Batch irá transferir para o Nó de Computação antes de executar a linha de comandos. Existe um tamanho máximo para a lista de ficheiros de recursos. Quando o tamanho máximo for excedido, o pedido falhará e o código de erro de resposta será RequestEntityTooLarge. Se isto ocorrer, a coleção de ResourceFiles tem de ser reduzida em tamanho. Isto pode ser conseguido com .zip ficheiros, Pacotes de Aplicações ou Contentores do Docker. |
|
userIdentity |
A identidade de utilizador na qual o StartTask é executado. |
|
waitForSuccess |
boolean |
Se o serviço Batch deve aguardar que o StartTask seja concluído com êxito (ou seja, sair com o código de saída 0) antes de agendar quaisquer Tarefas no Nó de Computação. |
StartTaskInformation
Informações sobre uma StartTask em execução num Nó de Computação.
Name | Tipo | Description |
---|---|---|
containerInfo |
Informações sobre o contentor no qual a Tarefa está a ser executada. |
|
endTime |
string |
A hora em que o StartTask deixou de ser executado. |
exitCode |
integer |
O código de saída do programa especificado na linha de comandos StartTask. |
failureInfo |
Informações que descrevem a falha da Tarefa, se existirem. |
|
lastRetryTime |
string |
A hora mais recente em que uma repetição da Tarefa começou a ser executada. |
result |
O resultado da execução da Tarefa. |
|
retryCount |
integer |
O número de vezes que a Tarefa foi repetida pelo serviço Batch. |
startTime |
string |
A hora em que o StartTask começou a ser executado. |
state |
O estado do StartTask no Nó de Computação. |
StartTaskState
O estado do StartTask no Nó de Computação.
Name | Tipo | Description |
---|---|---|
completed |
string |
O StartTask saiu com o código de saída 0 ou o StartTask falhou e o limite de repetição foi atingido ou o processo StartTask não foi executado devido a erros de preparação de tarefas (como falhas na transferência de ficheiros de recursos). |
running |
string |
O StartTask está atualmente em execução. |
TaskContainerExecutionInformation
Contém informações sobre o contentor que uma Tarefa está a executar.
Name | Tipo | Description |
---|---|---|
containerId |
string |
O ID do contentor. |
error |
string |
Informações de erro detalhadas sobre o contentor. |
state |
string |
O estado do contentor. |
TaskContainerSettings
As definições de contentor para uma Tarefa.
Name | Tipo | Description |
---|---|---|
containerRunOptions |
string |
Opções adicionais para o comando de criação de contentor. |
imageName |
string |
A Imagem a utilizar para criar o contentor no qual a Tarefa será executada. |
registry |
O registo privado que contém o contentor Imagem. |
|
workingDirectory |
A localização do diretório de trabalho da Tarefa de contentor. |
TaskExecutionInformation
Informações sobre a execução de uma Tarefa.
Name | Tipo | Description |
---|---|---|
containerInfo |
Informações sobre o contentor no qual a Tarefa está a ser executada. |
|
endTime |
string |
O momento em que a Tarefa foi concluída. |
exitCode |
integer |
O código de saída do programa especificado na linha de comandos Tarefa. |
failureInfo |
Informações que descrevem a falha da Tarefa, se existirem. |
|
lastRequeueTime |
string |
A hora mais recente em que a Tarefa foi recoduída pelo serviço Batch como resultado de um pedido de utilizador. |
lastRetryTime |
string |
A hora mais recente em que uma repetição da Tarefa começou a ser executada. |
requeueCount |
integer |
O número de vezes que a Tarefa foi recoduída pelo serviço Batch como resultado de um pedido de utilizador. |
result |
O resultado da execução da Tarefa. |
|
retryCount |
integer |
O número de vezes que a Tarefa foi repetida pelo serviço Batch. |
startTime |
string |
A hora em que a Tarefa começou a ser executada. |
TaskExecutionResult
O resultado da execução da tarefa.
Name | Tipo | Description |
---|---|---|
failure |
string |
Ocorreu um erro durante o processamento da Tarefa. A falha pode ter ocorrido antes do processo de Tarefa ter sido iniciado, enquanto o processo de Tarefa estava a ser executado ou após a saída do processo de Tarefa. |
success |
string |
A Tarefa foi executada com êxito. |
TaskFailureInformation
Informações sobre uma Falha de tarefa.
Name | Tipo | Description |
---|---|---|
category |
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 |
Uma lista de detalhes adicionais relacionados com o erro. |
|
message |
string |
Uma mensagem que descreve o erro Tarefa, que se destina a ser adequado para ser apresentado numa interface de utilizador. |
TaskInformation
Informações sobre uma Tarefa em execução num Nó de Computação.
Name | Tipo | Description |
---|---|---|
executionInfo |
Informações sobre a execução da Tarefa. |
|
jobId |
string |
O ID da Tarefa à qual a Tarefa pertence. |
subtaskId |
integer |
O ID da subtarefa se a Tarefa for uma Tarefa de várias instâncias. |
taskId |
string |
O ID da Tarefa. |
taskState |
O estado atual da Tarefa. |
|
taskUrl |
string |
O URL da Tarefa. |
TaskState
O estado da Tarefa.
Name | Tipo | Description |
---|---|---|
active |
string |
A Tarefa está em fila de espera e pode ser executada, mas não está atualmente atribuída a um Nó de Computação. Uma Tarefa entra neste estado quando é criada, quando é ativada após ser desativada ou quando aguarda uma nova tentativa após uma execução falhada. |
completed |
string |
A Tarefa já não é elegível para ser executada, normalmente porque a Tarefa foi concluída com êxito ou a Tarefa foi concluída sem êxito e esgotou o limite de repetições. Uma Tarefa também é marcada como concluída se ocorreu um erro ao iniciar a Tarefa ou quando a Tarefa foi terminada. |
preparing |
string |
A Tarefa foi atribuída a um Nó de Computação, mas aguarda a conclusão de uma Tarefa de Preparação de Tarefas necessária no Nó de Computação. Se a Tarefa de Preparação da Tarefa for bem-sucedida, a Tarefa passará a ser executada. Se a Tarefa de Preparação da Tarefa falhar, a Tarefa voltará a estar ativa e será elegível para ser atribuída a um Nó de Computação diferente. |
running |
string |
A Tarefa está em execução num Nó de Computação. Isto inclui a preparação ao nível da tarefa, como transferir ficheiros de recursos ou implementar Pacotes especificados na Tarefa. Não significa necessariamente que a linha de comandos Tarefa tenha começado a ser executada. |
UserIdentity
A definição da identidade de utilizador na qual a Tarefa é executada.
Name | Tipo | Description |
---|---|---|
autoUser |
O utilizador automático no qual a Tarefa é executada. |
|
username |
string |
O nome da identidade de utilizador na qual a Tarefa é executada. |
VirtualMachineInfo
Informações sobre o estado atual da máquina virtual.
Name | Tipo | Description |
---|---|---|
imageReference |
A referência à Imagem do Marketplace da Máquina Virtual do Azure. |
|
scaleSetVmResourceId |
string |
O ID de recurso da VM atual do Conjunto de Dimensionamento de Máquinas Virtuais do Nó de Computação. Apenas definido se a Conta do Batch tiver sido criada com a respetiva propriedade poolAllocationMode definida como "UserSubscription". |