Compute Node - Disable Scheduling

Service:

Batch Service

API Version:

2023-11-01.18.0

Hiermee wordt taakplanning uitgeschakeld op het opgegeven rekenknooppunt.
U kunt Taakplanning op een rekenknooppunt alleen uitschakelen als de huidige planningsstatus is ingeschakeld.

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

URI-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch serviceaanvragen.
nodeId	path	True	string	De id van het rekenknooppunt waarop u Taakplanning wilt uitschakelen.
poolId	path	True	string	De id van de pool die het rekenknooppunt bevat.
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 door 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 deze expliciet in als u de REST API rechtstreeks aanroept.

Aanvraagbody

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

Name	Type	Description
nodeDisableSchedulingOption	DisableComputeNodeSchedulingOption	Wat u moet doen met taken die momenteel worden uitgevoerd bij het uitschakelen van taakplanning op het rekenknooppunt. De standaardwaarde is opnieuw in de wachtrij plaatsen.

Antwoorden

Name	Type	Description
200 OK		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

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

Definities

Name	Description
BatchError	Een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
DisableComputeNodeSchedulingOption	Wat u moet doen met taken die momenteel worden uitgevoerd bij het uitschakelen van taakplanning op het rekenknooppunt.
ErrorMessage	Een foutbericht ontvangen in een Azure Batch foutbericht.
NodeDisableSchedulingParameter	Opties voor het uitschakelen van planning op een rekenknooppunt.

BatchError

Een foutbericht 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 informatie 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.

DisableComputeNodeSchedulingOption

Wat u moet doen met taken die momenteel worden uitgevoerd bij het uitschakelen van taakplanning op het rekenknooppunt.

Name	Type	Description
requeue	string	Beëindig actieve taakprocessen en plaats de taken opnieuw. De taken kunnen opnieuw worden uitgevoerd op andere rekenknooppunten of wanneer taakplanning opnieuw is ingeschakeld op dit rekenknooppunt. Voer de offlinestatus in zodra taken zijn beëindigd.
taskcompletion	string	Sta taken die momenteel worden uitgevoerd toe om te voltooien. Geen nieuwe taken plannen tijdens het wachten. Voer de offlinestatus in wanneer alle taken zijn voltooid.
terminate	string	Actieve taken beëindigen. De taken worden voltooid met failureInfo die aangeeft dat ze zijn beëindigd en niet opnieuw worden uitgevoerd. Voer de offlinestatus in zodra taken zijn beëindigd.

ErrorMessage

Een foutbericht ontvangen in een Azure Batch foutbericht.

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

NodeDisableSchedulingParameter

Opties voor het uitschakelen van planning op een rekenknooppunt.

Name	Type	Description
nodeDisableSchedulingOption	DisableComputeNodeSchedulingOption	Wat u moet doen met taken die momenteel worden uitgevoerd bij het uitschakelen van taakplanning op het rekenknooppunt. De standaardwaarde is opnieuw in de wachtrij plaatsen.