Task - List
Lista todas as Tarefas associadas ao Trabalho especificado.
Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à tarefa principal. Use a API de subtarefas de lista para recuperar informações sobre subtarefas.
GET {batchUrl}/jobs/{jobId}/tasks?api-version=2024-07-01.20.0
GET {batchUrl}/jobs/{jobId}/tasks?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
batch
|
path | True |
string |
A URL base para todas as solicitações de serviço do Lote do Azure. |
job
|
path | True |
string |
A ID do trabalho. |
api-version
|
query | True |
string |
Versão da API do cliente. |
$expand
|
query |
string |
Uma cláusula $expand OData. |
|
$filter
|
query |
string |
Uma cláusula $filter OData. Para obter mais informações sobre como construir esse filtro, consulte https://zcusa.951200.xyz/rest/api/batchservice/odata-filters-in-batch#list-tasks. |
|
$select
|
query |
string |
Uma cláusula OData $select. |
|
maxresults
|
query |
integer int32 |
O número máximo de itens a serem retornados na resposta. Um máximo de 1000 tarefas podem ser retornadas. |
|
timeout
|
query |
integer int32 |
O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for maior que 30, o padrão será usado. |
Cabeçalho do Pedido
Media Types: "application/json; odata=minimalmetadata"
Name | Necessário | Tipo | Description |
---|---|---|---|
client-request-id |
string uuid |
A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves encaracoladas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Se o servidor deve retornar o client-request-id na resposta. |
|
ocp-date |
string date-time-rfc1123 |
A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Uma resposta contendo a lista de Tarefas. Cabeçalhos
|
|
Other Status Codes |
O erro do serviço de lote. |
Segurança
azure_auth
Fluxo de código de autenticação do Microsoft Entra OAuth 2.0
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | Personificar a sua conta de utilizador |
Authorization
Tipo:
apiKey
Em:
header
Exemplos
Task list
Pedido de amostra
GET account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.0
Resposta da amostra
{
"value": [
{
"id": "task1",
"url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task1",
"eTag": "0x8D4125FD1A825A4",
"creationTime": "2016-11-21T22:43:31.4733476Z",
"lastModified": "2016-11-21T22:43:31.4733476Z",
"state": "active",
"stateTransitionTime": "2016-11-21T22:43:31.4733476Z",
"commandLine": "cmd /c echo task1",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"constraints": {
"maxWallClockTime": "P10675199DT2H48M5.4775807S",
"retentionTime": "P10675199DT2H48M5.4775807S",
"maxTaskRetryCount": 0
},
"requiredSlots": 2,
"executionInfo": {
"retryCount": 0,
"requeueCount": 0
}
},
{
"id": "task2",
"url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task2",
"eTag": "0x8D4125FD2153345",
"creationTime": "2016-11-21T22:43:31.6736345Z",
"lastModified": "2016-11-21T22:43:32.1880389Z",
"state": "active",
"stateTransitionTime": "2016-11-21T22:43:31.6736345Z",
"commandLine": "cmd /c echo task2",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"constraints": {
"maxWallClockTime": "P10675199DT2H48M5.4775807S",
"retentionTime": "P10675199DT2H48M5.4775807S",
"maxTaskRetryCount": 3
},
"requiredSlots": 2,
"executionInfo": {
"retryCount": 0,
"requeueCount": 0
}
}
]
}
Definições
Name | Description |
---|---|
Access |
Os recursos de lote aos quais o token concede acesso. |
Affinity |
Uma dica de localidade que pode ser usada pelo serviço Batch para selecionar um Nó de Computação no qual iniciar uma Tarefa. |
Application |
Uma referência a um pacote a ser implantado em nós de computação. |
Authentication |
As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço em lote. |
Auto |
O escopo para o usuário automático |
Auto |
Especifica os parâmetros para o usuário automático que executa uma tarefa no serviço em lote. |
Batch |
Uma resposta de erro recebida do serviço Batch do Azure. |
Batch |
Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure. |
Cloud |
Uma tarefa em lote do Azure. |
Cloud |
O resultado da listagem das Tarefas em um Trabalho. |
Compute |
A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará. |
Compute |
Informações sobre o nó de computação no qual uma tarefa foi executada. |
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 do contêiner. |
Container |
Um registro de contêiner privado. |
Container |
O local do diretório de trabalho da tarefa do contêiner. |
Dependency |
Uma ação que o serviço em lote executa em tarefas que dependem dessa tarefa. |
Elevation |
O nível de elevação do usuário. |
Environment |
Uma variável de ambiente a ser definida em um processo Task. |
Error |
A categoria do erro. |
Error |
Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure. |
Exit |
Como o serviço Batch deve responder se uma Tarefa sair com um código de saída específico. |
Exit |
Um intervalo de códigos de saída e como o serviço Batch deve responder aos códigos de saída dentro desse intervalo. |
Exit |
Especifica como o serviço em lote deve responder quando a tarefa for concluída. |
Exit |
Especifica como o serviço Batch responde a uma condição de saída específica. |
Http |
Um par nome-valor de cabeçalho HTTP |
Job |
Uma ação a ser executada no Job que contém a Task, se a Task for concluída com a condição de saída fornecida e a propriedade onTaskFailed do Job for 'performExitOptionsJobAction'. |
Multi |
Configurações que especificam como executar uma tarefa de várias instâncias. |
Name |
Representa um par nome-valor. |
Output |
Uma especificação para carregar arquivos de um Nó de Computação em Lote do Azure para outro local depois que o serviço de Lote concluir a execução do processo de Tarefa. |
Output |
Especifica um destino de carregamento de arquivo em um contêiner de armazenamento de blob do Azure. |
Output |
O destino para o qual um arquivo deve ser carregado. |
Output |
As condições sob as quais um arquivo de saída de tarefa ou conjunto de arquivos deve ser carregado. |
Output |
Detalhes sobre uma operação de upload de arquivo de saída, incluindo em que condições executar o upload. |
Resource |
Um único arquivo ou vários arquivos a serem baixados para um nó de computação. |
Task |
Restrições de execução a serem aplicadas a uma Tarefa. |
Task |
Contém informações sobre o contêiner que uma tarefa está executando. |
Task |
As configurações de contêiner para uma Tarefa. |
Task |
Especifica quaisquer dependências de uma Tarefa. Qualquer Tarefa especificada explicitamente ou dentro de um intervalo de dependência deve ser concluída antes que a Tarefa dependente seja agendada. |
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 |
Um intervalo de IDs de Tarefa do qual uma Tarefa pode depender. Todas as Tarefas com IDs no intervalo devem ser concluídas com êxito antes que a Tarefa dependente possa ser agendada. |
Task |
O estado da Tarefa. |
Task |
Estatísticas de utilização de recursos para uma Tarefa. |
User |
A definição da identidade do usuário sob a qual a Tarefa é executada. |
AccessScope
Os recursos de lote aos quais o token concede acesso.
Name | Tipo | Description |
---|---|---|
job |
string |
Concede acesso para executar todas as operações no Trabalho que contém a Tarefa. |
AffinityInformation
Uma dica de localidade que pode ser usada pelo serviço Batch para selecionar um Nó de Computação no qual iniciar uma Tarefa.
Name | Tipo | Description |
---|---|---|
affinityId |
string |
Uma cadeia de caracteres opaca que representa o local de um Nó de Computação ou de uma Tarefa executada anteriormente. |
ApplicationPackageReference
Uma referência a um pacote a ser implantado em nós de computação.
Name | Tipo | Description |
---|---|---|
applicationId |
string |
A ID do aplicativo a ser implantado. |
version |
string |
A versão do aplicativo a ser implantado. Se omitida, a versão padrão será implantada. |
AuthenticationTokenSettings
As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço em lote.
Name | Tipo | Description |
---|---|---|
access |
Os recursos de lote aos quais o token concede acesso. |
AutoUserScope
O escopo para o usuário automático
Name | Tipo | Description |
---|---|---|
pool |
string |
Especifica que a Tarefa é executada como a Conta de usuário automático comum que é criada em cada Nó de Computação em um Pool. |
task |
string |
Especifica que o serviço deve criar um novo usuário para a Tarefa. |
AutoUserSpecification
Especifica os parâmetros para o usuário automático que executa uma tarefa no serviço em lote.
Name | Tipo | Description |
---|---|---|
elevationLevel |
O nível de elevação do usuário automático. |
|
scope |
O escopo para o usuário automático |
BatchError
Uma resposta de erro recebida do serviço Batch do Azure.
Name | Tipo | Description |
---|---|---|
code |
string |
Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente. |
message |
Uma mensagem descrevendo 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.
Name | Tipo | Description |
---|---|---|
key |
string |
Um identificador que especifica o significado da propriedade Value. |
value |
string |
As informações adicionais incluídas com a resposta de erro. |
CloudTask
Uma tarefa em lote do Azure.
Name | Tipo | Description |
---|---|---|
affinityInfo |
Uma dica de localidade que pode ser usada pelo serviço Batch para selecionar um Nó de Computação no qual iniciar a nova Tarefa. |
|
applicationPackageReferences |
Uma lista de Pacotes que o serviço de Lote implantará no Nó de Computação antes de executar a linha de comando. |
|
authenticationTokenSettings |
As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço em lote. |
|
commandLine |
string |
A linha de comando da Tarefa. |
constraints |
As restrições de execução que se aplicam a esta Tarefa. |
|
containerSettings |
As configurações do contêiner sob o qual a Tarefa é executada. |
|
creationTime |
string |
O tempo de criação da Tarefa. |
dependsOn |
As Tarefas das quais esta Tarefa depende. |
|
displayName |
string |
Um nome para exibição para a Tarefa. |
eTag |
string |
O ETag da Tarefa. |
environmentSettings |
Uma lista de configurações de variáveis de ambiente para a Tarefa. |
|
executionInfo |
Informações sobre a execução da Tarefa. |
|
exitConditions |
Especifica como o serviço em lote deve responder quando a tarefa for concluída. |
|
id |
string |
Uma cadeia de caracteres que identifica exclusivamente a Tarefa dentro do Trabalho. |
lastModified |
string |
A última hora modificada da Tarefa. |
multiInstanceSettings |
Um objeto que indica que a Tarefa é uma Tarefa de várias instâncias e contém informações sobre como executar a Tarefa de várias instâncias. |
|
nodeInfo |
Informações sobre o nó de computação no qual a tarefa foi executada. |
|
outputFiles |
Uma lista de arquivos que o serviço Batch carregará do nó de computação depois de executar a linha de comando. |
|
previousState |
O estado anterior da Tarefa. |
|
previousStateTransitionTime |
string |
A hora em que a Tarefa entrou em seu estado anterior. |
requiredSlots |
integer |
O número de slots de agendamento que a Tarefa requer para ser executada. |
resourceFiles |
Uma lista de arquivos que o serviço em lote baixará para o nó de computação antes de executar a linha de comando. |
|
state |
O estado atual da Tarefa. |
|
stateTransitionTime |
string |
O momento em que a Tarefa entrou em seu estado atual. |
stats |
Estatísticas de utilização de recursos para a Tarefa. |
|
url |
string |
A URL da tarefa. |
userIdentity |
A identidade do usuário sob a qual a Tarefa é executada. |
CloudTaskListResult
O resultado da listagem das Tarefas em um Trabalho.
Name | Tipo | Description |
---|---|---|
odata.nextLink |
string |
O URL para obter o próximo conjunto de resultados. |
value |
A lista de Tarefas. |
ComputeNodeIdentityReference
A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.
Name | Tipo | Description |
---|---|---|
resourceId |
string |
O ID de recurso ARM da identidade atribuída ao usuário. |
ComputeNodeInformation
Informações sobre o nó de computação no qual uma tarefa foi executada.
Name | Tipo | Description |
---|---|---|
affinityId |
string |
Um identificador para o Nó no qual a Tarefa foi executada, que pode ser passado ao adicionar uma Tarefa para solicitar que a Tarefa seja agendada nesse Nó de Computação. |
nodeId |
string |
A ID do Nó de Computação no qual a Tarefa foi executada. |
nodeUrl |
string |
A URL do Nó de Computação no qual a Tarefa foi executada. |
poolId |
string |
A ID do Pool no qual a Tarefa foi executada. |
taskRootDirectory |
string |
O diretório raiz da tarefa no nó de computação. |
taskRootDirectoryUrl |
string |
A URL para o diretório raiz da tarefa no nó de computação. |
ContainerHostBatchBindMountEntry
A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas.
Name | Tipo | Description |
---|---|---|
isReadOnly |
boolean |
Monte esse caminho de origem como modo somente leitura ou não. O valor padrão é false (modo de leitura/gravação). |
source |
O caminho que ser montado para o cliente de contêiner pode selecionar. |
ContainerHostDataPath
Os caminhos que serão montados no contêiner da tarefa do contêiner.
Name | Tipo | Description |
---|---|---|
Applications |
string |
O caminho dos aplicativos. |
JobPrep |
string |
O caminho da tarefa de preparação para o trabalho. |
Shared |
string |
O caminho para a tarefa de várias instâncias compartilhar seus arquivos. |
Startup |
string |
O caminho para iniciar a tarefa. |
Task |
string |
O caminho da tarefa. |
VfsMounts |
string |
O caminho contém todos os sistemas de arquivos virtuais montados neste nó. |
ContainerRegistry
Um registro de contêiner privado.
Name | Tipo | Description |
---|---|---|
identityReference |
A referência à identidade atribuída ao usuário a ser usada para acessar um Registro de Contêiner do Azure em vez de nome de usuário e senha. |
|
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 para iniciar sessão no servidor de registo. |
ContainerWorkingDirectory
O local do diretório de trabalho da tarefa do contêiner.
Name | Tipo | Description |
---|---|---|
containerImageDefault |
string |
Use o diretório de trabalho definido na imagem do contêiner. Tenha cuidado que este diretório não conterá os arquivos de recursos baixados pelo lote. |
taskWorkingDirectory |
string |
Use o diretório de trabalho padrão Tarefa do serviço em lote, que conterá os arquivos de recursos da tarefa preenchidos por lote. |
DependencyAction
Uma ação que o serviço em lote executa em tarefas que dependem dessa tarefa.
Name | Tipo | Description |
---|---|---|
block |
string |
Bloqueia tarefas que aguardam esta tarefa, impedindo que sejam agendadas. |
satisfy |
string |
Satisfazer as tarefas que aguardam esta tarefa; Quando todas as dependências estiverem satisfeitas, a tarefa será agendada para ser executada. |
ElevationLevel
O nível de elevação do usuário.
Name | Tipo | Description |
---|---|---|
admin |
string |
O usuário é um usuário com acesso elevado e opera com permissões completas de administrador. |
nonadmin |
string |
O usuário é um usuário padrão sem acesso elevado. |
EnvironmentSetting
Uma variável de ambiente a ser definida em um processo Task.
Name | Tipo | Description |
---|---|---|
name |
string |
O nome da variável de ambiente. |
value |
string |
O valor da variável de ambiente. |
ErrorCategory
A categoria do erro.
Name | Tipo | Description |
---|---|---|
servererror |
string |
O erro é devido a um problema interno do servidor. |
usererror |
string |
O erro é devido a um problema do usuário, como configuração incorreta. |
ErrorMessage
Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
Name | Tipo | Description |
---|---|---|
lang |
string |
O código de idioma da mensagem de erro |
value |
string |
O texto da mensagem. |
ExitCodeMapping
Como o serviço Batch deve responder se uma Tarefa sair com um código de saída específico.
Name | Tipo | Description |
---|---|---|
code |
integer |
Um código de saída do processo. |
exitOptions |
Como o serviço de lote deve responder se a tarefa sair com esse código de saída. |
ExitCodeRangeMapping
Um intervalo de códigos de saída e como o serviço Batch deve responder aos códigos de saída dentro desse intervalo.
Name | Tipo | Description |
---|---|---|
end |
integer |
O último código de saída no intervalo. |
exitOptions |
Como o serviço Batch deve responder se a Tarefa sair com um código de saída no intervalo do início ao fim (inclusive). |
|
start |
integer |
O primeiro código de saída no intervalo. |
ExitConditions
Especifica como o serviço em lote deve responder quando a tarefa for concluída.
Name | Tipo | Description |
---|---|---|
default |
Como o serviço de lote deve responder se a tarefa falhar com uma condição de saída não coberta por nenhuma das outras propriedades. |
|
exitCodeRanges |
Uma lista de intervalos de códigos de saída de tarefas e como o serviço de lote deve responder a eles. |
|
exitCodes |
Uma lista de códigos de saída de Tarefa individuais e como o serviço Batch deve responder a eles. |
|
fileUploadError |
Como o serviço em lote deve responder se ocorrer um erro de carregamento de arquivo. |
|
preProcessingError |
Como o serviço em lote deve responder se a tarefa falhar ao iniciar devido a um erro. |
ExitOptions
Especifica como o serviço Batch responde a uma condição de saída específica.
Name | Tipo | Description |
---|---|---|
dependencyAction |
Uma ação que o serviço em lote executa em tarefas que dependem dessa tarefa. |
|
jobAction |
Uma ação a ser executada no Job que contém a Task, se a Task for concluída com a condição de saída fornecida e a propriedade onTaskFailed do Job for 'performExitOptionsJobAction'. |
HttpHeader
Um par nome-valor de cabeçalho HTTP
Name | Tipo | Description |
---|---|---|
name |
string |
O nome do cabeçalho que não diferencia maiúsculas de minúsculas a ser usado durante o upload de arquivos de saída |
value |
string |
O valor do cabeçalho a ser usado durante o upload de arquivos de saída |
JobAction
Uma ação a ser executada no Job que contém a Task, se a Task for concluída com a condição de saída fornecida e a propriedade onTaskFailed do Job for 'performExitOptionsJobAction'.
Name | Tipo | Description |
---|---|---|
disable |
string |
Desative o trabalho. Isso equivale a chamar a API de trabalho desabilitada, com um valor disableTasks de requeue. |
none |
string |
Não tome nenhuma medida. |
terminate |
string |
Encerre o trabalho. O terminateReason na executionInfo do trabalho é definido como "TaskFailed". |
MultiInstanceSettings
Configurações que especificam como executar uma tarefa de várias instâncias.
Name | Tipo | Description |
---|---|---|
commonResourceFiles |
Uma lista de arquivos que o serviço Batch baixará antes de executar a linha de comando de coordenação. |
|
coordinationCommandLine |
string |
A linha de comando a ser executada em todos os nós de computação para permitir que eles coordenem quando o primário executa o comando Task principal. |
numberOfInstances |
integer |
O número de nós de computação exigidos pela tarefa. |
NameValuePair
Representa um par nome-valor.
Name | Tipo | Description |
---|---|---|
name |
string |
O nome no par nome-valor. |
value |
string |
O valor no par nome-valor. |
OutputFile
Uma especificação para carregar arquivos de um Nó de Computação em Lote do Azure para outro local depois que o serviço de Lote concluir a execução do processo de Tarefa.
Name | Tipo | Description |
---|---|---|
destination |
O destino do(s) arquivo(s) de saída. |
|
filePattern |
string |
Um padrão que indica o(s) ficheiro(s) a carregar. |
uploadOptions |
Opções adicionais para a operação de carregamento, incluindo em que condições realizar o carregamento. |
OutputFileBlobContainerDestination
Especifica um destino de carregamento de arquivo em um contêiner de armazenamento de blob do Azure.
Name | Tipo | Description |
---|---|---|
containerUrl |
string |
A URL do contêiner no Armazenamento de Blobs do Azure para o qual carregar o(s) arquivo(s). |
identityReference |
A referência à identidade atribuída ao usuário a ser usada para acessar o Armazenamento de Blob do Azure especificado por containerUrl |
|
path |
string |
O blob de destino ou diretório virtual dentro do contêiner de Armazenamento do Azure. |
uploadHeaders |
Uma lista de pares nome-valor para cabeçalhos a serem usados no upload de arquivos de saída |
OutputFileDestination
O destino para o qual um arquivo deve ser carregado.
Name | Tipo | Description |
---|---|---|
container |
Um local no armazenamento de blob do Azure para o qual os arquivos são carregados. |
OutputFileUploadCondition
As condições sob as quais um arquivo de saída de tarefa ou conjunto de arquivos deve ser carregado.
Name | Tipo | Description |
---|---|---|
taskcompletion |
string |
Carregue o(s) arquivo(s) após a saída do processo de Tarefa, independentemente do código de saída. |
taskfailure |
string |
Carregue o(s) arquivo(s) somente depois que o processo de Tarefa for encerrado com um código de saída diferente de zero. |
tasksuccess |
string |
Carregue o(s) arquivo(s) somente depois que o processo de Tarefa sair com um código de saída de 0. |
OutputFileUploadOptions
Detalhes sobre uma operação de upload de arquivo de saída, incluindo em que condições executar o upload.
Name | Tipo | Description |
---|---|---|
uploadCondition |
As condições sob as quais o arquivo de saída da tarefa ou conjunto de arquivos deve ser carregado. |
ResourceFile
Um único arquivo ou vários arquivos a serem baixados para um nó de computação.
Name | Tipo | Description |
---|---|---|
autoStorageContainerName |
string |
O nome do contêiner de armazenamento na conta de armazenamento automático. |
blobPrefix |
string |
O prefixo de blob a ser usado ao baixar blobs de um contêiner de Armazenamento do Azure. Somente os blobs cujos nomes começam com o prefixo especificado serão baixados. |
fileMode |
string |
O atributo file permission mode em formato octal. |
filePath |
string |
O local no nó de computação para o qual baixar o(s) arquivo(s), relativo ao diretório de trabalho da tarefa. |
httpUrl |
string |
O URL do ficheiro a transferir. |
identityReference |
A referência à identidade atribuída ao usuário a ser usada para acessar o Armazenamento de Blob do Azure especificado por storageContainerUrl ou httpUrl |
|
storageContainerUrl |
string |
A URL do contêiner de blob no Armazenamento de Blob do Azure. |
TaskConstraints
Restrições de execução a serem aplicadas a uma Tarefa.
Name | Tipo | Description |
---|---|---|
maxTaskRetryCount |
integer |
O número máximo de vezes que a Tarefa pode ser repetida. O serviço de lote tenta novamente uma tarefa se seu código de saída for diferente de zero. |
maxWallClockTime |
string |
O tempo máximo decorrido que a Tarefa pode executar, medido a partir do momento em que a Tarefa é iniciada. Se a Tarefa não for concluída dentro do prazo, o serviço em lote a encerrará. |
retentionTime |
string |
O tempo mínimo para manter o diretório Task no Nó de Computação onde ele foi executado, a partir do momento em que ele conclui a execução. Após esse tempo, o serviço de lote pode excluir o diretório de tarefas e todo o seu conteúdo. |
TaskContainerExecutionInformation
Contém informações sobre o contêiner que uma tarefa está executando.
Name | Tipo | Description |
---|---|---|
containerId |
string |
A ID do contêiner. |
error |
string |
Informações detalhadas de erro sobre o contêiner. |
state |
string |
O estado do recipiente. |
TaskContainerSettings
As configurações de contêiner para uma Tarefa.
Name | Tipo | Description |
---|---|---|
containerHostBatchBindMounts |
Os caminhos que você deseja montar para a tarefa de contêiner. |
|
containerRunOptions |
string |
Opções adicionais para o comando container create. |
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 do contêiner. |
TaskDependencies
Especifica quaisquer dependências de uma Tarefa. Qualquer Tarefa especificada explicitamente ou dentro de um intervalo de dependência deve ser concluída antes que a Tarefa dependente seja agendada.
Name | Tipo | Description |
---|---|---|
taskIdRanges |
A lista de intervalos de ID de Tarefa dos quais esta Tarefa depende. Todas as Tarefas em todos os intervalos devem ser concluídas com êxito antes que a Tarefa dependente possa ser agendada. |
|
taskIds |
string[] |
A lista de IDs de Tarefa da qual esta Tarefa depende. Todas as Tarefas nesta lista devem ser concluídas com êxito antes que a Tarefa dependente possa ser agendada. |
TaskExecutionInformation
Informações sobre a execução de uma Tarefa.
Name | Tipo | Description |
---|---|---|
containerInfo |
Informações sobre o contêiner sob o 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 colocada novamente na fila pelo serviço em lote como resultado de uma solicitação do usuário. |
lastRetryTime |
string |
O momento mais recente em que uma nova tentativa da Tarefa começou a ser executada. |
requeueCount |
integer |
O número de vezes que a tarefa foi colocada novamente na fila pelo serviço em lote como resultado de uma solicitação do usuário. |
result |
O resultado da execução da tarefa. |
|
retryCount |
integer |
O número de vezes que a tarefa foi repetida pelo serviço de lote. |
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 em execução ou depois de o processo de Tarefa ter sido encerrado. |
success |
string |
A tarefa foi executada com êxito. |
TaskFailureInformation
Informações sobre uma falha de tarefa.
Name | Tipo | Description |
---|---|---|
category |
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 ao erro. |
|
message |
string |
Uma mensagem descrevendo o erro de tarefa, destinado a ser adequado para exibição em uma interface do usuário. |
TaskIdRange
Um intervalo de IDs de Tarefa do qual uma Tarefa pode depender. Todas as Tarefas com IDs no intervalo devem ser concluídas com êxito antes que a Tarefa dependente possa ser agendada.
Name | Tipo | Description |
---|---|---|
end |
integer |
A última ID de Tarefa no intervalo. |
start |
integer |
A primeira ID de Tarefa no intervalo. |
TaskState
O estado da Tarefa.
Name | Tipo | Description |
---|---|---|
active |
string |
A Tarefa está enfileirada e pode ser executada, mas não está atualmente atribuída a um Nó de Computação. Uma Tarefa entra nesse estado quando é criada, quando é habilitada após ser desabilitada ou quando está aguardando uma nova tentativa após uma execução com falha. |
completed |
string |
A Tarefa não está mais qualificada para execução, geralmente porque a Tarefa foi concluída com êxito ou a Tarefa foi concluída sem êxito e esgotou seu limite de novas tentativas. Uma Tarefa também é marcada como concluída se ocorrer um erro ao iniciar a Tarefa ou quando a Tarefa tiver sido encerrada. |
preparing |
string |
A Tarefa foi atribuída a um Nó de Computação, mas está aguardando a conclusão de uma Tarefa de Preparação de Trabalho necessária no Nó de Computação. Se a Tarefa de Preparação de Trabalho for bem-sucedida, a Tarefa passará para execução. Se a Tarefa de Preparação de Trabalho falhar, a Tarefa voltará à ativa e será qualificada para ser atribuída a um Nó de Computação diferente. |
running |
string |
A tarefa está sendo executada em um nó de computação. Isso inclui a preparação no nível da tarefa, como baixar arquivos de recursos ou implantar pacotes especificados na tarefa - isso não significa necessariamente que a linha de comando da tarefa começou a ser executada. |
TaskStatistics
Estatísticas de utilização de recursos para uma Tarefa.
Name | Tipo | Description |
---|---|---|
kernelCPUTime |
string |
O tempo total de CPU do modo kernel (somado em todos os núcleos e todos os nós de computação) consumido pela tarefa. |
lastUpdateTime |
string |
A hora em que as estatísticas foram atualizadas pela última vez. Todas as estatísticas são limitadas ao intervalo entre startTime e lastUpdateTime. |
readIOGiB |
number |
O total de gibibytes lidos do disco pela Tarefa. |
readIOps |
integer |
O número total de operações de leitura de disco feitas pela Tarefa. |
startTime |
string |
A hora de início do intervalo de tempo coberto pelas estatísticas. |
url |
string |
O URL das estatísticas. |
userCPUTime |
string |
O tempo total de CPU do modo de usuário (somado em todos os núcleos e todos os nós de computação) consumido pela tarefa. |
waitTime |
string |
O tempo total de espera da Tarefa. O tempo de espera para uma Tarefa é definido como o tempo decorrido entre a criação da Tarefa e o início da execução da Tarefa. (Se a Tarefa for repetida devido a falhas, o tempo de espera será o tempo para a execução da Tarefa mais recente.) |
wallClockTime |
string |
O tempo total do relógio de parede da Tarefa. |
writeIOGiB |
number |
O total de gibibytes gravados no disco pela tarefa. |
writeIOps |
integer |
O número total de operações de gravação em disco feitas pela Tarefa. |
UserIdentity
A definição da identidade do usuário sob a qual a Tarefa é executada.
Name | Tipo | Description |
---|---|---|
autoUser |
O usuário automático sob o qual a tarefa é executada. |
|
username |
string |
O nome da identidade do usuário sob a qual a Tarefa é executada. |