Compartilhar via

Task - Update

  • Referência
Serviço:
Batch Service
Versão da API:
2024-07-01.20.0

Atualiza as propriedades da Tarefa especificada.

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2024-07-01.20.0
Com parâmetros opcionais: 
PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?timeout={timeout}&api-version=2024-07-01.20.0

Parâmetros de URI

Nome Em Obrigatório Tipo Description
batchUrl
 path True

string

A URL base para todas as solicitações de serviço 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 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.
If-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 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 horário 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 horário especificado.

Corpo da solicitação

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

Nome Tipo Description
constraints

TaskConstraints

Restrições que se aplicam a esta Tarefa.
Se omitida, a Tarefa recebe as restrições padrão. Para tarefas de várias instâncias, atualizar o tempo de retenção aplica-se somente à Tarefa primária e não às subtarefas.

Respostas

Nome Tipo Description
200 OK

A solicitação para o serviço do 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 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

Task update

Solicitação de exemplo

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 de exemplo

Código de status:
200

Definições

Nome Description
BatchError

Uma resposta de erro recebida do serviço do Lote 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 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

ErrorMessage

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

BatchErrorDetail[]

Uma coleção de pares chave-valor 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.

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.

TaskConstraints

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

Nome Tipo Description
maxTaskRetryCount

integer

O número máximo de vezes que a Tarefa pode ser repetida. O serviço do Lote tentará novamente uma Tarefa se o código de saída não for zero.
Observe que esse valor controla especificamente o número de repetições para o executável da Tarefa devido a um código de saída diferente de zero. O serviço lote tentará a Tarefa uma vez e poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de repetição for 3, o Lote tentará a Tarefa até 4 vezes (uma tentativa inicial e três tentativas). Se a contagem máxima de repetição for 0, o serviço do Lote não tentará novamente a Tarefa após a primeira tentativa. Se a contagem máxima de repetição for -1, o serviço do 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 novas 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 limite de tempo, o serviço do Lote a encerrará.
Se isso não for especificado, não haverá limite de tempo para a execução da Tarefa.
retentionTime

string

O tempo mínimo para manter o diretório Tarefa no Nó de Computação em que ele foi executado, a partir do momento em que ele conclui a execução. Após esse tempo, o serviço do Lote poderá excluir o diretório tarefa e todo o seu conteúdo.
O padrão é 7 dias, ou seja, o diretório tarefa 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.

Nome Tipo Description
constraints

TaskConstraints

Restrições que se aplicam a esta Tarefa.
Se omitida, a Tarefa recebe as restrições padrão. Para tarefas de várias instâncias, atualizar o tempo de retenção aplica-se somente à Tarefa primária e não às subtarefas.