Partilhar via


Task - Update

Atualiza as propriedades da Tarefa especificada.

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2024-07-01.20.0
PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?timeout={timeout}&api-version=2024-07-01.20.0

Parâmetros do URI

Name Em Necessário Tipo Description
batchUrl
path True

string

A URL base para todas as solicitações de serviço do Lote do Azure.

jobId
path True

string

A ID do Trabalho que contém a Tarefa.

taskId
path True

string

A ID da Tarefa a ser atualizada.

api-version
query True

string

Versão da API do cliente.

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.

If-Match

string

Um valor ETag associado à versão do recurso conhecida pelo cliente. A operação será executada somente se o ETag atual do recurso no serviço corresponder exatamente ao valor especificado pelo cliente.

If-None-Match

string

Um valor ETag associado à versão do recurso conhecida pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço não corresponder ao valor especificado pelo cliente.

If-Modified-Since

string

date-time-rfc1123

Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço tiver sido modificado desde o tempo especificado.

If-Unmodified-Since

string

date-time-rfc1123

Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço não tiver sido modificado desde o tempo especificado.

Corpo do Pedido

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

Name Tipo Description
constraints

TaskConstraints

Restrições que se aplicam a esta Tarefa.
Se omitida, a Tarefa receberá as restrições padrão. Para Tarefas de várias instâncias, a atualização do tempo de retenção aplica-se apenas à Tarefa principal e não às subtarefas.

Respostas

Name Tipo Description
200 OK

A solicitação para o serviço de lote foi bem-sucedida.

Cabeçalhos

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

O erro do serviço de lote.

Segurança

azure_auth

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

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

Âmbitos

Name Description
user_impersonation Personificar a sua conta de utilizador

Authorization

Tipo: apiKey
Em: header

Exemplos

Task update

Pedido de amostra

PUT account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2024-07-01.20.0



{
  "constraints": {
    "maxWallClockTime": "PT1H",
    "maxTaskRetryCount": 3,
    "retentionTime": "PT1H"
  }
}

Resposta da amostra

Definições

Name Description
BatchError

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

BatchErrorDetail

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

ErrorMessage

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

TaskConstraints

Restrições de execução a serem aplicadas a uma Tarefa.

TaskUpdateParameter

O conjunto de alterações a serem feitas em uma Tarefa.

BatchError

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

Name Tipo Description
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

message

ErrorMessage

Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.

values

BatchErrorDetail[]

Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

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

Name Tipo Description
key

string

Um identificador que especifica o significado da propriedade Value.

value

string

As informações adicionais incluídas com a resposta de erro.

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.

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.
Observe que esse valor controla especificamente o número de novas tentativas para o executável Task devido a um código de saída diferente de zero. O serviço de lote tentará a tarefa uma vez e, em seguida, poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de tentativas for 3, o Batch tentará a Tarefa até 4 vezes (uma tentativa inicial e 3 tentativas). Se a contagem máxima de tentativas for 0, o serviço em lote não repetirá a tarefa após a primeira tentativa. Se a contagem máxima de tentativas for -1, o serviço em lote repetirá a tarefa sem limite, no entanto, isso não é recomendado para uma tarefa inicial ou qualquer tarefa. O valor padrão é 0 (sem tentativas).

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á.
Se isso não for especificado, não há limite de tempo para a execução da Tarefa.

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.
O padrão é 7 dias, ou seja, o diretório de tarefas será mantido por 7 dias, a menos que o nó de computação seja removido ou o trabalho seja excluído.

TaskUpdateParameter

O conjunto de alterações a serem feitas em uma Tarefa.

Name Tipo Description
constraints

TaskConstraints

Restrições que se aplicam a esta Tarefa.
Se omitida, a Tarefa receberá as restrições padrão. Para Tarefas de várias instâncias, a atualização do tempo de retenção aplica-se apenas à Tarefa principal e não às subtarefas.