Compute Node - List
Lista os nós de computação no pool especificado.
GET {batchUrl}/pools/{poolId}/nodes?api-version=2024-07-01.20.0
GET {batchUrl}/pools/{poolId}/nodes?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
batch
|
path | True |
string |
A URL base para todas as solicitações de serviço do Lote do Azure. |
pool
|
path | True |
string |
A ID do pool do qual você deseja listar nós de computação. |
api-version
|
query | True |
string |
Versão da API do cliente. |
$filter
|
query |
string |
Uma cláusula $filter OData. Para obter mais informações sobre como construir esse filtro, consulte https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. |
|
$select
|
query |
string |
Uma cláusula $select OData. |
|
maxresults
|
query |
integer int32 |
O número máximo de itens a serem retornados na resposta. Um máximo de 1000 Nós de Computação pode ser retornado. |
|
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 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 a ID de solicitação do cliente 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 |
Uma resposta que contém a lista de Nós de Computação. Cabeçalhos
|
|
Other Status Codes |
O erro do serviço do Lote. |
Segurança
azure_auth
Fluxo de código de autenticação do Microsoft Entra OAuth 2.0
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
user_impersonation | Representar sua conta de usuário |
Authorization
Tipo:
apiKey
Em:
header
Exemplos
Node list
Solicitação de exemplo
GET account.region.batch.azure.com/pools/poolId/nodes?api-version=2024-07-01.20.0
Resposta de exemplo
{
"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
Nome | Description |
---|---|
Auto |
O escopo do usuário automático |
Auto |
Especifica os parâmetros para o usuário automático que executa uma Tarefa no serviço do Lote. |
Batch |
Uma resposta de erro recebida do serviço do Lote do Azure. |
Batch |
Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure. |
Certificate |
Uma referência a um certificado a ser instalado em nós de computação em um pool. |
Certificate |
O local do repositório de certificados no Nó de Computação no qual instalar o Certificado. |
Certificate |
Quais contas de usuário no Nó de Computação devem ter acesso aos dados privados do Certificado. |
Compute |
Um nó de computação no serviço do Lote. |
Compute |
A configuração do ponto de extremidade 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 usuário associada ao pool do Lote que um nó de computação usará. |
Compute |
O resultado da listagem dos nós de computação em um pool. |
Compute |
O estado atual do Nó de Computação. |
Container |
A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas. |
Container |
Os caminhos que serão montados no contêiner da tarefa de contêiner. |
Container |
Um registro de contêiner privado. |
Container |
O local do diretório de trabalho da Tarefa de contêiner. |
Elevation |
O nível de elevação do usuário. |
Environment |
Uma variável de ambiente a ser definida em um processo de tarefa. |
Error |
A categoria do erro. |
Error |
Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure. |
Image |
Uma referência a uma imagem do Marketplace de Máquinas Virtuais do Azure 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 Com Suporte'. |
Inbound |
Um ponto de extremidade de entrada em um Nó de Computação. |
Inbound |
O protocolo do ponto de extremidade. |
Name |
Representa um par nome-valor. |
Node |
Informações sobre o agente do Nó de Computação. |
Resource |
Um único arquivo ou vários arquivos a serem baixados em 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ó ingressa em um pool no serviço do Lote do Azure ou quando o Nó de Computação é reinicializado ou reimageado. |
Start |
Informações sobre um StartTask em execução em um Nó de Computação. |
Start |
O estado do StartTask no Nó de Computação. |
Task |
Contém informações sobre o contêiner que uma Tarefa está executando. |
Task |
As configurações de contêiner de 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 em um Nó de Computação. |
Task |
O estado da Tarefa. |
User |
A definição da identidade do usuário na qual a Tarefa é executada. |
Virtual |
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 |
O nível de elevação do usuário automático. |
|
scope |
O escopo do usuário automático |
BatchError
Uma resposta de erro recebida do serviço do 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 |
Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário. |
|
values |
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.
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 |
O local do repositório de certificados no Nó de Computação no qual instalar o Certificado. |
|
storeName |
string |
O nome do repositório de certificados no Nó de Computação no qual instalar o Certificado. |
thumbprint |
string |
A impressão digital do Certificado. |
thumbprintAlgorithm |
string |
O algoritmo com o qual a impressão digital está associada. Isso deve ser sha1. |
visibility |
Quais contas de usuário no Nó de Computação devem ter acesso aos dados privados do Certificado. |
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 o 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. |
allocationTime |
string |
O momento em que esse Nó de Computação foi alocado para o pool. |
certificateReferences |
A lista de Certificados instalados no Nó de Computação. Aviso: essa propriedade foi preterida e será removida após fevereiro de 2024. Em vez disso, use o de Extensão do Azure KeyVault |
|
endpointConfiguration |
A configuração do ponto de extremidade para o Nó de Computação. |
|
errors |
A lista de erros que estão sendo encontrados no momento pelo Nó de Computação. |
|
id |
string |
A ID do Nó de Computação. |
ipAddress |
string |
O endereço IP que outros nós podem usar para se comunicar com esse Nó de Computação. |
isDedicated |
boolean |
Se esse Nó de Computação é um nó de computação dedicado. Se for falso, 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. |
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 slots de agendamento usados pela execução atual de Tarefas de Trabalho no Nó de Computação. Isso inclui tarefas do Gerenciador de Trabalho 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 em execução no momento no Nó de Computação. Isso inclui tarefas do Gerenciador de Trabalho e tarefas normais, mas não preparação de trabalho, liberação de trabalho ou tarefas de início. |
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 ele ingressa no Pool. |
|
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 |
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 Trabalho 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 que foram concluídas com êxito (com exitCode 0) no Nó de Computação. Isso inclui tarefas do Gerenciador de Trabalho 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 |
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. |
ComputeNodeEndpointConfiguration
A configuração do ponto de extremidade para o Nó de Computação.
Nome | Tipo | Description |
---|---|---|
inboundEndpoints |
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 do Nó de Computação. Os códigos são invariáveis e devem ser consumidos programaticamente. |
errorDetails |
A lista de detalhes de erro adicionais relacionados ao erro do 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. |
ComputeNodeListResult
O resultado da listagem dos nós de computação em um pool.
Nome | Tipo | Description |
---|---|---|
odata.nextLink |
string |
A 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.
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. |
deallocated |
string |
O Nó de Computação é desalocado. |
deallocating |
string |
O Nó de Computação está desalocando. |
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 |
No momento, o Nó de Computação não está executando uma Tarefa 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 preemptado. 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 estiver 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 (exceto 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 novas tentativas) e waitForSuccess está definido. O Nó de Computação não é utilizável 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 a execução da tarefa 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.
Nome | Tipo | Description |
---|---|---|
isReadOnly |
boolean |
Monte esse caminho de origem como modo somente leitura ou não. O valor padrão é falso (modo de leitura/gravação). |
source |
O caminho que será montado no cliente do contêiner pode ser selecionado. |
ContainerHostDataPath
Os caminhos que serão montados no contêiner da tarefa de contêiner.
Nome | Tipo | Description |
---|---|---|
Applications |
string |
O caminho dos aplicativos. |
JobPrep |
string |
O caminho da tarefa de preparação do 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.
Nome | Tipo | Description |
---|---|---|
identityReference |
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. |
|
password |
string |
A senha para fazer logon no servidor do Registro. |
registryServer |
string |
A URL do Registro. |
username |
string |
O nome de usuário a ser conectado ao 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 do 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 Marketplace de Máquinas Virtuais do Azure 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 Com Suporte'.
Nome | Tipo | Description |
---|---|---|
communityGalleryImageId |
string |
O identificador exclusivo da imagem da galeria da comunidade |
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 Marketplace de Máquinas Virtuais do Azure. |
publisher |
string |
O editor da Imagem do Marketplace de Máquinas Virtuais do Azure. |
sharedGalleryImageId |
string |
O identificador exclusivo da imagem da galeria compartilhada |
sku |
string |
A SKU da imagem do Marketplace de Máquinas Virtuais do Azure. |
version |
string |
A versão da Imagem do Marketplace de Máquinas Virtuais do Azure. |
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. |
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 |
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 do Nó de Computação.
Nome | 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 em Lote em execução no Nó de Computação. |
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. |
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. |
fileMode |
string |
O atributo de modo de permissão de arquivo no formato octal. |
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. |
httpUrl |
string |
A URL do arquivo a ser baixado. |
identityReference |
A referência à identidade atribuída pelo usuário a ser usada para acessar o Armazenamento de Blobs do Azure especificado por storageContainerUrl ou httpUrl |
|
storageContainerUrl |
string |
A URL do contêiner de blob no Armazenamento de Blobs do Azure. |
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 do Lote do Azure ou quando o Nó de Computação é reinicializado ou reimageado.
Nome | Tipo | Description |
---|---|---|
commandLine |
string |
A linha de comando do StartTask. |
containerSettings |
As configurações do contêiner no qual o StartTask é executado. |
|
environmentSettings |
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. |
resourceFiles |
Uma lista de arquivos que o serviço do Lote baixará no 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 feito usando arquivos .zip, pacotes de aplicativos ou contêineres do Docker. |
|
userIdentity |
A identidade do usuário na qual o StartTask é executado. |
|
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. |
StartTaskInformation
Informações sobre um StartTask em execução em um Nó de Computação.
Nome | Tipo | Description |
---|---|---|
containerInfo |
Informações sobre o contêiner no qual a Tarefa está sendo executada. |
|
endTime |
string |
A hora em que o StartTask parou de ser executado. |
exitCode |
integer |
O código de saída do programa especificado na linha de comando StartTask. |
failureInfo |
Informações que descrevem a falha da tarefa, se houver. |
|
lastRetryTime |
string |
O momento 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 do Lote. |
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.
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 |
A ID do contêiner. |
error |
string |
Informações detalhadas de erro sobre o contêiner. |
state |
string |
O estado do contêiner. |
TaskContainerSettings
As configurações de contêiner de uma Tarefa.
Nome | Tipo | Description |
---|---|---|
containerHostBatchBindMounts |
Os caminhos que você deseja montar na tarefa de contêiner. |
|
containerRunOptions |
string |
Opções adicionais para o comando de criação de contêiner. |
imageName |
string |
A imagem a ser usada para criar o contêiner no qual a Tarefa será executada. |
registry |
O registro privado que contém a imagem do contêiner. |
|
workingDirectory |
O local do diretório de trabalho da Tarefa de contêiner. |
TaskExecutionInformation
Informações sobre a execução de uma Tarefa.
Nome | Tipo | Description |
---|---|---|
containerInfo |
Informações sobre o contêiner no qual a Tarefa está sendo executada. |
|
endTime |
string |
A hora em que a Tarefa foi concluída. |
exitCode |
integer |
O código de saída do programa especificado na linha de comando Tarefa. |
failureInfo |
Informações que descrevem a falha da tarefa, se houver. |
|
lastRequeueTime |
string |
O momento mais recente em que a Tarefa foi requeutada pelo serviço lote como resultado de uma solicitação de usuário. |
lastRetryTime |
string |
O momento 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 requeutada pelo serviço lote como resultado de uma solicitação de usuário. |
result |
O resultado da execução da tarefa. |
|
retryCount |
integer |
O número de vezes que a Tarefa foi repetida pelo serviço do Lote. |
startTime |
string |
A hora em que a Tarefa começou a ser executada. |
TaskExecutionResult
O resultado da execução da tarefa.
Nome | Tipo | Description |
---|---|---|
failure |
string |
Houve um erro durante o processamento da Tarefa. A falha pode ter ocorrido antes do processo de tarefa ser iniciado, enquanto o processo de tarefa estava em execução 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.
Nome | Tipo | Description |
---|---|---|
category |
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 |
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 |
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 |
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 repetição 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 êxito e esgotou seu limite de repetição. Uma tarefa também será marcada como concluída se ocorreu um erro ao iniciar a Tarefa ou quando a Tarefa foi 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 recursos ou implantar pacotes especificados na Tarefa , isso não significa necessariamente que a linha de comando Task começou a ser executada. |
UserIdentity
A definição da identidade do usuário na qual a Tarefa é executada.
Nome | Tipo | Description |
---|---|---|
autoUser |
O usuário automático no qual a Tarefa é executada. |
|
username |
string |
O nome da identidade do usuário na qual a Tarefa é executada. |
VirtualMachineInfo
Informações sobre o estado atual da máquina virtual.
Nome | Tipo | Description |
---|---|---|
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'. |