Job - Disable

Serviço:

Batch Service

Versão da API:

2024-07-01.20.0

Desabilita o Trabalho especificado, impedindo a execução de novas Tarefas.
O Serviço de Lote move imediatamente o Trabalho para o estado de desativação. Em seguida, Batch usa o parâmetro disableTasks para determinar o que fazer com as Tarefas do Trabalho em execução no momento. O Job permanece no estado de desativação até que a operação de desativação seja concluída e todas as Tarefas tenham sido tratadas de acordo com a opção disableTasks; em seguida, o Job passa para o estado desativado. Nenhuma nova Tarefa é iniciada sob o Trabalho até que ele volte ao estado ativo. Se você tentar desabilitar um trabalho que esteja em qualquer estado diferente de ativo, desabilitado ou desabilitado, a solicitação falhará com o código de status 409.

POST {batchUrl}/jobs/{jobId}/disable?api-version=2024-07-01.20.0

Com parâmetros opcionais:

POST {batchUrl}/jobs/{jobId}/disable?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 a ser desabilitado.
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	Necessário	Tipo	Description
disableTasks	True	DisableJobOption	O que fazer com as Tarefas ativas associadas ao Trabalho.

Respostas

Name	Tipo	Description
202 Accepted		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

Job disable

Pedido de amostra

HTTP

POST account.region.batch.azure.com/jobs/jobId/disable?api-version=2024-07-01.20.0



{
  "disableTasks": "terminate"
}

Resposta da amostra

Código de estado:

202

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.
DisableJobOption	O que fazer com as Tarefas ativas associadas ao Trabalho.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
JobDisableParameter	Opções ao desativar um trabalho.

BatchError

Object

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

Object

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.

DisableJobOption

Enumeração

O que fazer com as Tarefas ativas associadas ao Trabalho.

Valor	Description
requeue	Encerre as tarefas em execução e coloque-as novamente na fila. As Tarefas serão executadas novamente quando o Trabalho estiver habilitado.
terminate	Encerrar tarefas em execução. As Tarefas serão concluídas com failureInfo indicando que foram encerradas e não serão executadas novamente.
wait	Permitir que as Tarefas atualmente em execução sejam concluídas.

ErrorMessage

Object

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.

JobDisableParameter

Object

Opções ao desativar um trabalho.

Name	Tipo	Description
disableTasks	DisableJobOption	O que fazer com as Tarefas ativas associadas ao Trabalho.