Job Schedule - Terminate
Termina uma Agenda de Tarefas.
POST {batchUrl}/jobschedules/{jobScheduleId}/terminate?api-version=2023-11-01.18.0
POST {batchUrl}/jobschedules/{jobScheduleId}/terminate?timeout={timeout}&api-version=2023-11-01.18.0
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
batch
|
path | True |
string |
O URL base para todos os pedidos de serviço Azure Batch. |
job
|
path | True |
string |
O ID da Agenda de Tarefas a terminar. |
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. |
|
If-Match |
string |
Um valor ETag associado à versão do recurso conhecido pelo cliente. A operação só será efetuada 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 conhecido pelo cliente. A operação só será efetuada se o 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 última hora modificada do recurso conhecido pelo cliente. A operação só será efetuada se o recurso no serviço tiver sido modificado desde a hora especificada. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
Um carimbo de data/hora que indica a última hora modificada do recurso conhecido pelo cliente. A operação só será efetuada se o recurso no serviço não tiver sido modificado desde a hora especificada. |
Respostas
Name | Tipo | Description |
---|---|---|
202 Accepted |
O pedido ao serviço Batch foi efetuado com êxito. Headers
|
|
Other Status Codes |
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
JobSchedule terminate
Sample Request
POST account.region.batch.azure.com/jobschedules/jobScheduleId/terminate?api-version=2023-11-01.18.0
Sample Response
Definições
Name | Description |
---|---|
Batch |
Uma resposta de erro recebida do serviço Azure Batch. |
Batch |
Um item de informações adicionais incluídas numa resposta de erro Azure Batch. |
Error |
Uma mensagem de erro recebida numa resposta de erro Azure Batch. |
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 |
Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador. |
|
values |
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. |
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. |