Compute Node - Disable Scheduling

Service:

Batch Service

API Version:

2023-11-01.18.0

Desativa o Agendamento de tarefas no Nó de Computação especificado.
Só pode desativar o Agendamento de tarefas num Nó de Computação se o respetivo estado de agendamento atual estiver ativado.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/disablescheduling?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/disablescheduling?timeout={timeout}&api-version=2023-11-01.18.0

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	O URL base para todos os pedidos de serviço Azure Batch.
nodeId	path	True	string	O ID do Nó de Computação no qual pretende desativar o Agendamento de tarefas.
poolId	path	True	string	O ID do Conjunto que contém o Nó de Computação.
api-version	query	True	string	Versão da API de Cliente.
timeout	query		integer int32	O tempo máximo que o servidor pode passar a processar o pedido, em segundos. A predefinição é 30 segundos.

Cabeçalho do Pedido

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

Name	Necessário	Tipo	Description
client-request-id		string uuid	A identidade do pedido gerado pelo autor da chamada, na forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve devolver o client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-o explicitamente se estiver a chamar a API REST diretamente.

Corpo do Pedido

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

Name	Tipo	Description
nodeDisableSchedulingOption	DisableComputeNodeSchedulingOption	O que fazer com a execução atualmente de Tarefas ao desativar o Agendamento de tarefas no Nó de Computação. O valor predefinido é voltar a colocar em fila.

Respostas

Name	Tipo	Description
200 OK		O pedido ao serviço Batch foi efetuado com êxito. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	O erro do serviço Batch.

Segurança

azure_auth

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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Representar a sua conta de utilizador

Authorization

Type: apiKey
In: header

Exemplos

Node disable scheduling

Sample Request

HTTP

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/disablescheduling?api-version=2023-11-01.18.0



{
  "nodeDisableSchedulingOption": "terminate"
}

Sample Response

Status code:

200

Definições

Name	Description
BatchError	Uma resposta de erro recebida do serviço Azure Batch.
BatchErrorDetail	Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
DisableComputeNodeSchedulingOption	O que fazer com a execução atualmente de Tarefas ao desativar o Agendamento de tarefas no Nó de Computação.
ErrorMessage	Uma mensagem de erro recebida numa resposta de erro Azure Batch.
NodeDisableSchedulingParameter	Opções para desativar o agendamento num Nó de Computação.

BatchError

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

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 que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.

Name	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Valor.
value	string	As informações adicionais incluídas na resposta de erro.

DisableComputeNodeSchedulingOption

O que fazer com a execução atualmente de Tarefas ao desativar o Agendamento de tarefas no Nó de Computação.

Name	Tipo	Description
requeue	string	Termine os processos de tarefas em execução e volte a colocar em fila as Tarefas. As Tarefas podem ser executadas novamente noutros Nós de Computação ou quando o Agendamento de tarefas é reativado neste Nó de Computação. Introduza o estado offline assim que as Tarefas tiverem sido terminadas.
taskcompletion	string	Permitir a conclusão das Tarefas atualmente em execução. Não agende tarefas novas enquanto aguarda. Introduza o estado offline quando todas as Tarefas estiverem concluídas.
terminate	string	Termine a execução de Tarefas. As Tarefas serão concluídas com failureInfo a indicar que foram terminadas e que não serão executadas novamente. Introduza o estado offline assim que as Tarefas tiverem sido terminadas.

ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

Name	Tipo	Description
lang	string	O código de idioma da mensagem de erro
value	string	O texto da mensagem.

NodeDisableSchedulingParameter

Opções para desativar o agendamento num Nó de Computação.

Name	Tipo	Description
nodeDisableSchedulingOption	DisableComputeNodeSchedulingOption	O que fazer com a execução atualmente de Tarefas ao desativar o Agendamento de tarefas no Nó de Computação. O valor predefinido é voltar a colocar em fila.