Compute Node - Disable Scheduling

  • Referenz
Service:
Batch Service
API Version:
2023-11-01.18.0

Deaktiviert die Aufgabenplanung auf dem angegebenen Computeknoten.
Sie können die Aufgabenplanung auf einem Computeknoten nur deaktivieren, wenn der aktuelle Planungsstatus aktiviert ist.

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-Parameter

Name In Erforderlich Typ Beschreibung
batchUrl
 path True

string

Die Basis-URL für alle Azure Batch-Dienstanforderungen.
nodeId
 path True

string

Die ID des Computeknotens, auf dem Sie die Aufgabenplanung deaktivieren möchten.
poolId
 path True

string

Die ID des Pools, der den Computeknoten enthält.
api-version
 query True

string

Client-API-Version.
timeout
 query

integer

int32

Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden aufwenden kann. Der Standardwert ist 30 Sekunden.

Anforderungsheader

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

Name Erforderlich Typ Beschreibung
client-request-id

string

uuid

Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Gibt an, ob der Server die client-request-ID in der Antwort zurückgeben soll.
ocp-date

string

date-time-rfc1123

Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.

Anforderungstext

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

Name Typ Beschreibung
nodeDisableSchedulingOption

DisableComputeNodeSchedulingOption

Vorgehensweise bei derzeit ausgeführten Tasks beim Deaktivieren der Aufgabenplanung auf dem Computeknoten.
Der Standardwert ist „requeue“.

Antworten

Name Typ Beschreibung
200 OK

Die Anforderung an den Batch-Dienst war erfolgreich.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

Der Fehler vom Batch-Dienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodeflow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Authorization

Type: apiKey
In: header

Beispiele

Node disable scheduling

Sample Request

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

Definitionen

Name Beschreibung
BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.
DisableComputeNodeSchedulingOption

Vorgehensweise bei derzeit ausgeführten Tasks beim Deaktivieren der Aufgabenplanung auf dem Computeknoten.
ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde.
NodeDisableSchedulingParameter

Optionen zum Deaktivieren der Planung auf einem Computeknoten.

BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
message

ErrorMessage

Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
values

BatchErrorDetail[]

Eine Auflistung von Schlüssel-Wert-Paaren mit zusätzlichen Details zum Fehler.

BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.

Name Typ Beschreibung
key

string

Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt.
value

string

Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind.

DisableComputeNodeSchedulingOption

Vorgehensweise bei derzeit ausgeführten Tasks beim Deaktivieren der Aufgabenplanung auf dem Computeknoten.

Name Typ Beschreibung
requeue

string

Beenden Sie ausgeführte Aufgabenprozesse, und stellen Sie die Tasks erneut in die Warteschlange. Die Tasks können auf anderen Computeknoten erneut ausgeführt werden, oder wenn die Aufgabenplanung auf diesem Computeknoten wieder aktiviert ist. Geben Sie den Offlinezustand ein, sobald Aufgaben beendet wurden.
taskcompletion

string

Das Abschließen aktuell ausgeführter Tasks zulassen. Planen Sie während des Wartens keine neuen Aufgaben. Geben Sie den Offlinezustand ein, wenn alle Aufgaben abgeschlossen sind.
terminate

string

Beenden Sie ausgeführte Tasks. Die Tasks werden mit failureInfo abgeschlossen, was angibt, dass sie beendet wurden, und wird nicht erneut ausgeführt. Geben Sie den Offlinezustand ein, sobald Aufgaben beendet wurden.

ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde.

Name Typ Beschreibung
lang

string

Der Sprachcode der Fehlermeldung
value

string

Der Text der Meldung.

NodeDisableSchedulingParameter

Optionen zum Deaktivieren der Planung auf einem Computeknoten.

Name Typ Beschreibung
nodeDisableSchedulingOption

DisableComputeNodeSchedulingOption

Vorgehensweise bei derzeit ausgeführten Tasks beim Deaktivieren der Aufgabenplanung auf dem Computeknoten.
Der Standardwert ist „requeue“.