Job - Disable

Service:

Batch Service

API Version:

2023-11-01.18.0

Hiermee schakelt u de opgegeven taak uit, waardoor nieuwe taken niet kunnen worden uitgevoerd.
De Batch-service verplaatst de taak onmiddellijk naar de uitgeschakelde status. Batch gebruikt vervolgens de parameter disableTasks om te bepalen wat er moet worden gedaan met de taken die momenteel worden uitgevoerd van de taak. De taak blijft in de uitgeschakelde status totdat de bewerking uitschakelen is voltooid en alle taken zijn afgehandeld volgens de optie disableTasks; de taak wordt vervolgens verplaatst naar de uitgeschakelde status. Er worden geen nieuwe taken gestart onder de taak totdat deze weer actief is. Als u een taak probeert uit te schakelen die een andere status heeft dan actief, uitschakelen of uitgeschakeld, mislukt de aanvraag met statuscode 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-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch serviceaanvragen.
jobId	path	True	string	De id van de taak die moet worden uitgeschakeld.
api-version	query	True	string	Client-API-versie.
timeout	query		integer int32	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string uuid	De aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Of de server de client-request-id in het antwoord moet retourneren.
ocp-date		string date-time-rfc1123	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige systeemkloktijd; stel dit expliciet in als u de REST API rechtstreeks aanroept.
If-Match		string	Een ETag-waarde die is gekoppeld aan de versie van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de huidige ETag van de resource op de service exact overeenkomt met de waarde die is opgegeven door de client.
If-None-Match		string	Een ETag-waarde die is gekoppeld aan de versie van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de huidige ETag van de resource op de service niet overeenkomt met de waarde die is opgegeven door de client.
If-Modified-Since		string date-time-rfc1123	Een tijdstempel die de laatste wijzigingstijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource op de service sinds de opgegeven tijd is gewijzigd.
If-Unmodified-Since		string date-time-rfc1123	Een tijdstempel die de laatste wijzigingstijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource op de service sinds de opgegeven tijd niet is gewijzigd.

Aanvraagbody

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

Name	Vereist	Type	Description
disableTasks	True	DisableJobOption	Wat u moet doen met actieve taken die zijn gekoppeld aan de taak.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag voor de Batch-service is geslaagd. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

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

Definities

Name	Description
BatchError	Een foutbericht dat is ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
DisableJobOption	Wat u moet doen met actieve taken die zijn gekoppeld aan de taak.
ErrorMessage	Een foutbericht ontvangen in een Azure Batch antwoord.
JobDisableParameter	Opties bij het uitschakelen van een taak.

BatchError

Een foutbericht dat is ontvangen van de Azure Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	ErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	Een verzameling sleutel-waardeparen met aanvullende details over de fout.

BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name	Type	Description
key	string	Een id die de betekenis van de eigenschap Value aangeeft.
value	string	De aanvullende informatie die is opgenomen in de foutreactie.

DisableJobOption

Wat u moet doen met actieve taken die zijn gekoppeld aan de taak.

Name	Type	Description
requeue	string	Actieve taken beëindigen en opnieuw in de wachtrij plaatsen. De taken worden opnieuw uitgevoerd wanneer de taak is ingeschakeld.
terminate	string	Actieve taken beëindigen. De taken worden voltooid met failureInfo die aangeeft dat ze zijn beëindigd en niet opnieuw worden uitgevoerd.
wait	string	Hiermee staat u toe dat taken die momenteel worden uitgevoerd, worden voltooid.

ErrorMessage

Een foutbericht ontvangen in een Azure Batch antwoord.

Name	Type	Description
lang	string	De taalcode van het foutbericht
value	string	De tekst van het bericht.

JobDisableParameter

Opties bij het uitschakelen van een taak.

Name	Type	Description
disableTasks	DisableJobOption	Wat u moet doen met actieve taken die zijn gekoppeld aan de taak.