Job - Disable

Service:

Batch Service

API Version:

2023-11-01.18.0

Inaktiverar det angivna jobbet, vilket förhindrar att nya aktiviteter körs.
Batch-tjänsten flyttar omedelbart jobbet till inaktiveringstillståndet. Batch använder sedan parametern disableTasks för att avgöra vad du ska göra med de uppgifter som körs för jobbet. Jobbet förblir i inaktiveringstillståndet tills inaktiveringsåtgärden har slutförts och alla aktiviteter har hanterats enligt alternativet disableTasks. Jobbet flyttas sedan till inaktiverat tillstånd. Inga nya aktiviteter startas under jobbet förrän det återgår till aktivt tillstånd. Om du försöker inaktivera ett jobb som är i något annat tillstånd än aktivt, inaktiverat eller inaktiverat misslyckas begäran med statuskod 409.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch tjänstbegäranden.
jobId	path	True	string	ID:t för jobbet som ska inaktiveras.
api-version	query	True	string	Klient-API-version.
timeout	query		integer int32	Den maximala tid som servern kan ägna åt att bearbeta begäran, i sekunder. Standardvärdet är 30 sekunder.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
client-request-id		string uuid	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Om servern ska returnera client-request-id i svaret.
ocp-date		string date-time-rfc1123	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till systemets aktuella klocktid. ange det uttryckligen om du anropar REST-API:et direkt.
If-Match		string	Ett ETag-värde som är associerat med den version av resursen som klienten känner till. Åtgärden utförs endast om resursens aktuella ETag i tjänsten exakt matchar det värde som anges av klienten.
If-None-Match		string	Ett ETag-värde som är associerat med den version av resursen som klienten känner till. Åtgärden utförs endast om resursens aktuella ETag i tjänsten inte matchar det värde som anges av klienten.
If-Modified-Since		string date-time-rfc1123	En tidsstämpel som anger den senaste ändringstiden för resursen som klienten känner till. Åtgärden utförs endast om resursen i tjänsten har ändrats sedan den angivna tiden.
If-Unmodified-Since		string date-time-rfc1123	En tidsstämpel som anger den senaste ändringstiden för resursen som klienten känner till. Åtgärden utförs endast om resursen i tjänsten inte har ändrats sedan den angivna tiden.

Begärandetext

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

Name	Obligatorisk	Typ	Description
disableTasks	True	DisableJobOption	Vad du ska göra med aktiva aktiviteter som är associerade med jobbet.

Svar

Name	Typ	Description
202 Accepted		Begäran till Batch-tjänsten lyckades. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Felet från Batch-tjänsten.

Säkerhet

azure_auth

Microsoft Entra OAuth 2.0-autentiseringskodflöde

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

Scopes

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Type: apiKey
In: header

Exempel

Job disable

Sample Request

HTTP

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



{
  "disableTasks": "terminate"
}

Sample Response

Status code:

202

Definitioner

Name	Description
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
DisableJobOption	Vad du ska göra med aktiva aktiviteter som är associerade med jobbet.
ErrorMessage	Ett felmeddelande som tas emot i ett Azure Batch felsvar.
JobDisableParameter	Alternativ när du inaktiverar ett jobb.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

DisableJobOption

Vad du ska göra med aktiva aktiviteter som är associerade med jobbet.

Name	Typ	Description
requeue	string	Avsluta aktiviteter som körs och skicka dem på nytt. Aktiviteterna körs igen när jobbet är aktiverat.
terminate	string	Avsluta aktiviteter som körs. Aktiviteterna slutförs med failureInfo som anger att de har avslutats och inte körs igen.
wait	string	Tillåt att aktiviteter som körs för närvarande slutförs.

ErrorMessage

Ett felmeddelande som tas emot i ett Azure Batch felsvar.

Name	Typ	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.

JobDisableParameter

Alternativ när du inaktiverar ett jobb.

Name	Typ	Description
disableTasks	DisableJobOption	Vad du ska göra med aktiva aktiviteter som är associerade med jobbet.