Job - Disable

Služba:

Batch Service

Verze rozhraní API:

2023-11-01.18.0

Zakáže zadanou úlohu a zabrání spuštění nových úloh.
Služba Batch okamžitě přesune úlohu do stavu zakázání. Služba Batch pak pomocí parametru disableTasks určí, co dělat s aktuálně spuštěnými úkoly úlohy. Úloha zůstává ve stavu zakázání, dokud se operace zakázání nedokončí a všechny úkoly byly vyřešeny podle možnosti disableTasks; Úloha se pak přesune do zakázaného stavu. V rámci úlohy nejsou spuštěny žádné nové úkoly, dokud se nepřesunou zpět do aktivního stavu. Pokud se pokusíte zakázat úlohu, která je v jiném stavu než aktivní, zakázaná nebo zakázaná, požadavek selže se stavovým kódem 409.

POST {batchUrl}/jobs/{jobId}/disable?api-version=2023-11-01.18.0

S volitelnými parametry:

POST {batchUrl}/jobs/{jobId}/disable?timeout={timeout}&api-version=2023-11-01.18.0

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
batchUrl	path	True	string	Základní adresa URL pro všechny požadavky Azure Batch služby.
jobId	path	True	string	ID úlohy, která se má zakázat.
api-version	query	True	string	Verze rozhraní API klienta.
timeout	query		integer int32	Maximální doba, kterou může server strávit zpracováním požadavku( v sekundách). Výchozí hodnota je 30 sekund.

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
client-request-id		string uuid	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Určuje, jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vydána. Klientské knihovny obvykle nastavit na aktuální systémový čas hodin; pokud voláte rozhraní REST API přímo, explicitně ho nastavte.
If-Match		string	Hodnota ETag přidružená k verzi prostředku, kterou klient zná. Operace se provede pouze v případě, že aktuální značka ETag prostředku ve službě přesně odpovídá hodnotě zadané klientem.
If-None-Match		string	Hodnota ETag přidružená k verzi prostředku, kterou klient zná. Operace se provede pouze v případě, že aktuální značka ETag prostředku ve službě neodpovídá hodnotě zadané klientem.
If-Modified-Since		string date-time-rfc1123	Časové razítko označující čas poslední změny prostředku známého klientovi. Operace se provede pouze v případě, že se prostředek ve službě od zadaného času změnil.
If-Unmodified-Since		string date-time-rfc1123	Časové razítko označující čas poslední změny prostředku známého klientovi. Operace se provede pouze v případě, že prostředek ve službě nebyl od zadaného času změněn.

Text požadavku

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

Name	Vyžadováno	Typ	Description
disableTasks	True	DisableJobOption	Co dělat s aktivními úkoly přidruženými k úloze.

Odpovědi

Name	Typ	Description
202 Accepted		Požadavek na službu Batch byl úspěšný. Hlavičky client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Chyba ze služby Batch.

Zabezpečení

azure_auth

Microsoft Entra tok ověřovacího kódu OAuth 2.0

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Authorization

Typ: apiKey
V: header

Příklady

Job disable

Ukázkový požadavek

HTTP

POST account.region.batch.azure.com/jobs/jobId/disable?api-version=2023-11-01.18.0



{
  "disableTasks": "terminate"
}

Ukázková odpověď

Stavový kód:

202

Definice

Name	Description
BatchError	Služba Azure Batch obdržela chybovou odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.
DisableJobOption	Co dělat s aktivními úkoly přidruženými k úloze.
ErrorMessage	Chybová zpráva přijatá v Azure Batch chybovou odpověď.
JobDisableParameter	Možnosti při zakázání úlohy

BatchError

Služba Azure Batch obdržela chybovou odpověď.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou neutrální a mají být využívány programově.
message	ErrorMessage	Zpráva popisující chybu, která má být vhodná k zobrazení v uživatelském rozhraní.
values	BatchErrorDetail[]	Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.

Name	Typ	Description
key	string	Identifikátor určující význam value vlastnost.
value	string	Další informace zahrnuté v chybové odpovědi.

DisableJobOption

Co dělat s aktivními úkoly přidruženými k úloze.

Name	Typ	Description
requeue	string	Ukončete spuštěné úlohy a znovu je zasaďte do fronty. Úkoly se po povolení úlohy spustí znovu.
terminate	string	Ukončete spuštěné úlohy. Úkoly budou dokončeny s informací o selhání, které indikují, že byly ukončeny, a nebudou znovu spuštěny.
wait	string	Povolit dokončení aktuálně spuštěných úloh

ErrorMessage

Chybová zpráva přijatá v Azure Batch chybovou odpověď.

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy

JobDisableParameter

Možnosti při zakázání úlohy

Name	Typ	Description
disableTasks	DisableJobOption	Co dělat s aktivními úkoly přidruženými k úloze.