Nodes - List Nodes
Listet die Rechenknoten im angegebenen Pool auf.
GET {endpoint}/pools/{poolId}/nodes?api-version=2025-06-01
GET {endpoint}/pools/{poolId}/nodes?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$filter={$filter}&$select={$select}
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Batchkontoendpunkt (z. B. https://batchaccount.eastus2.batch.azure.com). |
|
pool
|
path | True |
string |
Die ID des Pools, aus dem Sie Compute Nodes auflisten möchten. |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
|
$filter
|
query |
string |
Eine OData-$filter-Klausel. Weitere Informationen zur Konstruktion dieses Filters finden Sie unter https://v4.hkg1.meaqua.org/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. |
|
|
$select
|
query |
string[] |
Eine OData-$select-Klausel. |
|
|
maxresults
|
query |
integer (int32) minimum: 1maximum: 1000 |
Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Maximal 1000 Anträge können zurückgeschickt werden. |
|
|
time
|
query |
integer (int32) |
Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Ist der Wert größer als 30, wird stattdessen der Standard verwendet." |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| client-request-id |
string |
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 Clientanforderungs-ID in der Antwort zurückgeben soll. |
|
| ocp-date |
string (date-time-rfc7231) |
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. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Die Anforderung ist erfolgreich. Header
|
|
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
OAuth2Auth
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| https://batch.core.windows.net//.default |
Beispiele
Node list
Beispielanforderung
GET {endpoint}/pools/poolId/nodes?api-version=2025-06-01
Beispiel für eine Antwort
{
"value": [
{
"id": "tvm-1695681911_1-20161122t193202z",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z",
"state": "idle",
"schedulingState": "enabled",
"stateTransitionTime": "2025-11-22T22:22:27.2236818Z",
"lastBootTime": "2025-11-22T22:22:24.4634125Z",
"allocationTime": "2025-11-22T19:32:02.8155319Z",
"ipAddress": "1.1.1.1",
"ipv6Address": "1.1.1.1",
"affinityId": "TVM:tvm-1695681911_1-20161122t193202z",
"vmSize": "Standard_D2_v5",
"totalTasksRun": 0,
"totalTasksSucceeded": 0,
"runningTasksCount": 0,
"runningTaskSlotsCount": 0,
"isDedicated": true,
"startTask": {
"commandLine": "cmd /c echo hello",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"virtualMachineInfo": {
"imageReference": {
"publisher": "Canonical",
"offer": "ubuntu-24_04-lts",
"sku": "server",
"version": "latest",
"exactVersion": "latest"
}
},
"startTaskInfo": {
"state": "completed",
"startTime": "2025-11-22T22:22:27.2236818Z",
"endTime": "2025-11-22T22:22:27.567189Z",
"exitCode": 0,
"retryCount": 0
},
"nodeAgentInfo": {
"version": "1.2.0.0",
"lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
}
},
{
"id": "tvm-1695681911_2-20161122t193202z",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z",
"state": "idle",
"schedulingState": "enabled",
"stateTransitionTime": "2025-11-22T19:37:31.4285526Z",
"lastBootTime": "2025-11-22T19:37:28.623369Z",
"allocationTime": "2025-11-22T19:32:02.8155319Z",
"ipAddress": "1.1.1.1",
"ipv6Address": "1.1.1.1",
"affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
"vmSize": "Standard_D2_v5",
"totalTasksRun": 0,
"totalTasksSucceeded": 0,
"runningTasksCount": 0,
"runningTaskSlotsCount": 0,
"isDedicated": true,
"startTask": {
"commandLine": "cmd /c echo hello",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"virtualMachineInfo": {
"imageReference": {
"publisher": "Canonical",
"offer": "ubuntu-24_04-lts",
"sku": "server",
"version": "latest",
"exactVersion": "latest"
}
},
"startTaskInfo": {
"state": "completed",
"startTime": "2025-11-22T19:37:31.4285526Z",
"endTime": "2025-11-22T19:37:31.838028Z",
"exitCode": 0,
"retryCount": 0
},
"nodeAgentInfo": {
"version": "1.2.0.0",
"lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
}
},
{
"id": "tvm-1695681911_3-20161122t193202z",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z",
"state": "idle",
"schedulingState": "enabled",
"stateTransitionTime": "2025-11-22T19:36:51.0013378Z",
"lastBootTime": "2025-11-22T19:36:48.21721Z",
"allocationTime": "2025-11-22T19:32:02.8155319Z",
"ipAddress": "1.1.1.1",
"ipv6Address": "1.1.1.1",
"affinityId": "TVM:tvm-1695681911_3-20161122t193202z",
"vmSize": "Standard_D2_v5",
"totalTasksRun": 0,
"totalTasksSucceeded": 0,
"runningTasksCount": 0,
"runningTaskSlotsCount": 0,
"isDedicated": true,
"startTask": {
"commandLine": "cmd /c echo hello",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"virtualMachineInfo": {
"imageReference": {
"publisher": "Canonical",
"offer": "ubuntu-24_04-lts",
"sku": "server",
"version": "latest",
"exactVersion": "latest"
}
},
"startTaskInfo": {
"state": "completed",
"startTime": "2025-11-22T19:36:51.0013378Z",
"endTime": "2025-11-22T19:36:51.2363447Z",
"exitCode": 0,
"retryCount": 0
},
"nodeAgentInfo": {
"version": "1.2.0.0",
"lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
}
}
]
}
Definitionen
| Name | Beschreibung |
|---|---|
|
Auto |
AutoUserScope-Enums |
|
Auto |
Gibt die Optionen für den automatischen Benutzer an, der eine Azure-Batchaufgabe ausführt. |
|
Batch |
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort. |
|
Batch |
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind. |
|
Batch |
Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde. |
|
Batch |
BatchErrorSourceCategory-Enume |
|
Batch |
Ein Computeknoten im Batchdienst. |
|
Batch |
Der Batch-Computeknoten-Agent ist ein Programm, das auf jedem Computeknoten im Pool ausgeführt wird und Batchfunktionen auf dem Computeknoten bereitstellt. |
|
Batch |
Die Endpunktkonfiguration für den Computeknoten. |
|
Batch |
Fehler eines Computeknotens. |
|
Batch |
Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet. |
|
Batch |
Das Ergebnis der Auflistung der Computeknoten in einem Pool. |
|
Batch |
BatchNodeState-Enums |
|
Batch |
Batch wiederholt Aufgaben, wenn ein Wiederherstellungsvorgang auf einem Knoten ausgelöst wird. Beispiele für Wiederherstellungsvorgänge sind (aber nicht beschränkt darauf), wenn ein fehlerhafter Knoten neu gestartet wird oder ein Computeknoten aufgrund eines Hostfehlers verschwunden ist. Wiederholungen aufgrund von Wiederherstellungsvorgängen sind unabhängig von und werden nicht für das maxTaskRetryCount gezählt. Auch wenn das maxTaskRetryCount 0 ist, kann ein interner Wiederholungsversuch aufgrund eines Wiederherstellungsvorgangs auftreten. Aus diesem Gründen sollten alle Aufgaben idempotent sein. Dies bedeutet, dass Aufgaben unterbrochen und neu gestartet werden müssen, ohne dass Beschädigte oder doppelte Daten verursacht werden. Die bewährte Methode für lange ausgeführte Aufgaben besteht darin, eine Form der Prüfpunkterstellung zu verwenden. In einigen Fällen kann der StartTask erneut ausgeführt werden, obwohl der Computeknoten nicht neu gestartet wurde. Es sollte besonders darauf geachtet werden, startTasks zu vermeiden, die Unterbrechungsvorgang erstellen oder Dienste aus dem StartTask-Arbeitsverzeichnis installieren/starten, da dadurch verhindert wird, dass Batch die StartTask erneut ausführen kann. |
|
Batch |
Informationen zu einem StartTask, der auf einem Computeknoten ausgeführt wird. |
|
Batch |
BatchStartTaskState-Enums |
|
Batch |
Enthält Informationen zum Container, den eine Aufgabe ausführt. |
|
Batch |
Die Containereinstellungen für eine Aufgabe. |
|
Batch |
Informationen zur Ausführung einer Aufgabe. |
|
Batch |
BatchTaskExecutionResult-Enume |
|
Batch |
Informationen zu einem Vorgangsfehler. |
|
Batch |
Informationen zu einer Aufgabe, die auf einem Computeknoten ausgeführt wird. |
|
Batch |
BatchTaskState-Enums |
|
Batch |
Ein Verweis auf ein Azure Virtual Machines Marketplace Image oder ein Azure Compute Gallery Image. Informationen zum Abrufen der Liste aller azure Marketplace-Imageverweise, die von Azure Batch überprüft wurden, finden Sie im Vorgang "Unterstützte Bilder auflisten". |
|
Container |
Der Eintrag des Pfad- und Bereitstellungsmodus, den Sie in Aufgabencontainer bereitstellen möchten. |
|
Container |
Die Pfade, die im Container der Containeraufgabe bereitgestellt werden. |
|
Container |
Eine private Containerregistrierung. |
|
Container |
ContainerWorkingDirectory-Enums |
|
Elevation |
ElevationLevel-Enums |
|
Environment |
Eine Umgebungsvariable, die für einen Vorgangsprozess festgelegt werden soll. |
|
Inbound |
Ein eingehender Endpunkt auf einem Computeknoten. |
|
Inbound |
InboundEndpointProtocol enums |
|
Name |
Stellt ein Name-Wert-Paar dar. |
|
Resource |
Eine einzelne Datei oder mehrere Dateien, die in einen Computeknoten heruntergeladen werden sollen. |
|
Scheduling |
SchedulingState-Enums |
|
User |
Die Definition der Benutzeridentität, unter der die Aufgabe ausgeführt wird. Geben Sie entweder die Eigenschaft "userName" oder "autoUser" an, aber nicht beide. |
|
Virtual |
Informationen zum aktuellen Status des virtuellen Computers. |
AutoUserScope
AutoUserScope-Enums
| Wert | Beschreibung |
|---|---|
| task |
Spezifiziert, dass der Dienst einen neuen Benutzer für die Aufgabe anlegen soll. |
| pool |
Spezifiziert, dass die Aufgabe als gemeinsames automatisches Benutzerkonto ausgeführt wird, das auf jedem Rechenknoten in einem Pool erstellt wird. |
AutoUserSpecification
Gibt die Optionen für den automatischen Benutzer an, der eine Azure-Batchaufgabe ausführt.
| Name | Typ | Beschreibung |
|---|---|---|
| elevationLevel |
Die Höhenstufe des automatischen Benutzers. Der Standardwert ist "nonAdmin". |
|
| scope |
Der Bereich für den automatischen Benutzer. Der Standardwert ist Pool. Wenn der Pool Windows ausführt, sollte ein Wert der Aufgabe angegeben werden, wenn eine strengere Isolierung zwischen Vorgängen erforderlich ist. Dies ist beispielsweise der Fall, wenn die Aufgabe die Registrierung in einer Weise ändert, die sich auf andere Aufgaben auswirken kann. |
BatchError
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
| Name | Typ | Beschreibung |
|---|---|---|
| code |
string |
Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden. |
| message |
Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist. |
|
| values |
Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten. |
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. |
BatchErrorMessage
Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| lang |
string |
Der Sprachcode der Fehlermeldung. |
| value |
string |
Der Text der Nachricht. |
BatchErrorSourceCategory
BatchErrorSourceCategory-Enume
| Wert | Beschreibung |
|---|---|
| usererror |
Der Fehler liegt an einem Benutzerproblem, wie etwa einer Fehlkonfiguration. |
| servererror |
Der Fehler liegt an einem internen Serverproblem. |
BatchNode
Ein Computeknoten im Batchdienst.
| Name | Typ | Beschreibung |
|---|---|---|
| affinityId |
string |
Ein Bezeichner, der beim Hinzufügen einer Aufgabe übergeben werden kann, um anzufordern, dass die Aufgabe auf diesem Computeknoten geplant wird. Beachten Sie, dass dies nur eine weiche Affinität ist. Wenn der Ziel-Computeknoten zum Zeitpunkt der Planung des Vorgangs ausgelastet oder nicht verfügbar ist, wird der Vorgang an anderer Stelle geplant. |
| allocationTime |
string (date-time) |
Die Zeit, zu der dieser Computeknoten dem Pool zugeordnet wurde. Dies ist die Zeit, zu der der Computeknoten anfangs zugewiesen wurde und sich nicht einmal geändert hat. Es wird nicht aktualisiert, wenn der Computeknoten geheilt oder vorgedrängt wird. |
| endpointConfiguration |
Die Endpunktkonfiguration für den Computeknoten. |
|
| errors |
Die Liste der Fehler, die derzeit vom Computeknoten erkannt werden. |
|
| id |
string |
Die ID des Computeknotens. Jedem Computeknoten, der einem Pool hinzugefügt wird, wird eine eindeutige ID zugewiesen. Wenn ein Computeknoten aus einem Pool entfernt wird, werden alle lokalen Dateien gelöscht, und die ID wird zurückgefordert und kann für neue Computeknoten wiederverwendet werden. |
| ipAddress |
string |
Die IP-Adresse, die andere Knoten für die Kommunikation mit diesem Computeknoten verwenden können. Jedem Computeknoten, der einem Pool hinzugefügt wird, wird eine eindeutige IP-Adresse zugewiesen. Wenn ein Computeknoten aus einem Pool entfernt wird, werden alle lokalen Dateien gelöscht, und die IP-Adresse wird zurückgefordert und kann für neue Computeknoten wiederverwendet werden. |
| ipv6Address |
string |
Die IPv6-Adresse, die andere Knoten für die Kommunikation mit diesem Compute Node verwenden können. Jedem Computeknoten, der einem Pool hinzugefügt wird, wird eine eindeutige IP-Adresse zugewiesen. Wenn ein Computeknoten aus einem Pool entfernt wird, werden alle lokalen Dateien gelöscht, und die IP-Adresse wird zurückgefordert und kann für neue Computeknoten wiederverwendet werden. Diese Eigenschaft ist nicht vorhanden, wenn der Pool nicht für IPv6 konfiguriert ist. |
| isDedicated |
boolean |
Gibt an, ob dieser Computeknoten ein dedizierter Computeknoten ist. Bei "false" ist der Computeknoten ein Computeknoten mit spot/niedriger Priorität. |
| lastBootTime |
string (date-time) |
Das letzte Mal, zu dem der Computeknoten gestartet wurde. Diese Eigenschaft ist möglicherweise nicht vorhanden, wenn der Computeknotenstatus nicht verwendet werden kann. |
| nodeAgentInfo |
Informationen zur Computeknoten-Agent-Version und zum Zeitpunkt, zu dem der Computeknoten auf eine neue Version aktualisiert wurde. |
|
| recentTasks |
Eine Liste der Aufgaben, deren Status kürzlich geändert wurde. Diese Eigenschaft ist nur vorhanden, wenn mindestens eine Aufgabe auf diesem Computeknoten ausgeführt wurde, da sie dem Pool zugewiesen wurde. |
|
| runningTaskSlotsCount |
integer (int32) |
Die Gesamtanzahl der Planungsplätze, die derzeit von derzeit ausgeführten Auftragsaufgaben auf dem Computeknoten verwendet werden. Dazu gehören Job-Manager-Aufgaben und normale Aufgaben, aber keine Auftragsvorbereitung, Auftragsfreigabe oder Startaufgaben. |
| runningTasksCount |
integer (int32) |
Die Gesamtzahl der derzeit ausgeführten Auftragsaufgaben auf dem Computeknoten. Dazu gehören Job-Manager-Aufgaben und normale Aufgaben, aber keine Auftragsvorbereitung, Auftragsfreigabe oder Startaufgaben. |
| schedulingState |
Gibt an, ob der Computeknoten für die Vorgangsplanung verfügbar ist. |
|
| startTask |
Die aufgabe, die für die Ausführung auf dem Computeknoten angegeben ist, während sie dem Pool beitritt. |
|
| startTaskInfo |
Laufzeitinformationen zur Ausführung des StartTask auf dem Computeknoten. |
|
| state |
Der aktuelle Zustand des Computeknotens. |
|
| stateTransitionTime |
string (date-time) |
Die Uhrzeit, zu der der Computeknoten seinen aktuellen Zustand eingegeben hat. |
| totalTasksRun |
integer (int32) |
Die Gesamtzahl der abgeschlossenen Auftragsaufgaben auf dem Computeknoten. Dazu gehören Job-Manager-Aufgaben und normale Aufgaben, aber keine Auftragsvorbereitung, Auftragsfreigabe oder Startaufgaben. |
| totalTasksSucceeded |
integer (int32) |
Die Gesamtzahl der Auftragsaufgaben, die erfolgreich (mit exitCode 0) auf dem Computeknoten abgeschlossen wurden. Dazu gehören Job-Manager-Aufgaben und normale Aufgaben, aber keine Auftragsvorbereitung, Auftragsfreigabe oder Startaufgaben. |
| url |
string (uri) |
Die URL des Computeknotens. |
| virtualMachineInfo |
Informationen zum aktuellen Status des virtuellen Computers. |
|
| vmSize |
string |
Die Größe des virtuellen Computers, auf dem der Computeknoten gehostet wird. Informationen zu verfügbaren Größen virtueller Computer in Pools finden Sie unter Auswählen einer VM-Größe für Computeknoten in einem Azure-Batchpool (https://v4.hkg1.meaqua.org/azure/batch/batch-pool-vm-sizes). |
BatchNodeAgentInfo
Der Batch-Computeknoten-Agent ist ein Programm, das auf jedem Computeknoten im Pool ausgeführt wird und Batchfunktionen auf dem Computeknoten bereitstellt.
| Name | Typ | Beschreibung |
|---|---|---|
| lastUpdateTime |
string (date-time) |
Die Zeit, zu der der Compute Node-Agent auf dem Compute Node aktualisiert wurde. Dies ist das letzte Mal, dass der Compute Node-Agent auf eine neue Version aktualisiert wurde. |
| version |
string |
Die Version des Batch Compute Node-Agenten, die auf dem Compute Node läuft. Diese Versionsnummer kann mit den Release Notes des Compute Node-Agenten abgeglichen werden, die sich bei https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md. |
BatchNodeEndpointConfiguration
Die Endpunktkonfiguration für den Computeknoten.
| Name | Typ | Beschreibung |
|---|---|---|
| inboundEndpoints |
Die Liste der eingehenden Endpunkte, die auf dem Compute-Node zugänglich sind. |
BatchNodeError
Fehler eines Computeknotens.
| Name | Typ | Beschreibung |
|---|---|---|
| code |
string |
Ein Identifikator für den Compute Node-Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden. |
| errorDetails |
Die Liste zusätzlicher Fehlerdetails im Zusammenhang mit dem Compute Node-Fehler. |
|
| message |
string |
Eine Nachricht, die den Compute Node-Fehler beschreibt und für die Darstellung in einer Benutzeroberfläche geeignet sein soll. |
BatchNodeIdentityReference
Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.
| Name | Typ | Beschreibung |
|---|---|---|
| resourceId |
string (arm-id) |
Die ARM-Ressourcen-ID der vom Benutzer zugewiesenen Identität. |
BatchNodeListResult
Das Ergebnis der Auflistung der Computeknoten in einem Pool.
| Name | Typ | Beschreibung |
|---|---|---|
| odata.nextLink |
string (uri) |
Die URL zum Abrufen der nächsten Ergebnisse. |
| value |
Die Liste der Rechenknoten. |
BatchNodeState
BatchNodeState-Enums
| Wert | Beschreibung |
|---|---|
| idle |
Der Rechenknoten führt derzeit keine Aufgabe aus. |
| rebooting |
Der Compute Node startet neu. |
| reimaging |
Der Compute-Node ist eine Neubildbildung. |
| running |
Der Compute-Knoten führt eine oder mehrere Aufgaben aus (außer einem StartTask). |
| unusable |
Der Compute-Knoten kann aufgrund von Fehlern nicht für die Aufgabenausführung verwendet werden. |
| creating |
Der Batch-Dienst hat die zugrundeliegende virtuelle Maschine von Azure Compute erhalten, aber er hat noch nicht begonnen, dem Pool beizutreten. |
| starting |
Der Batch-Service startet auf der zugrunde liegenden virtuellen Maschine. |
| waitingforstarttask |
Der StartTask hat begonnen, auf dem Compute-Node zu laufen, aber waitForSuccess ist gesetzt und der StartTask ist noch nicht abgeschlossen. |
| starttaskfailed |
Der StartTask ist am Compute-Knoten fehlgeschlagen (und hat alle Wiederholungsversuche ausgeschöpft), und waitForSuccess ist gesetzt. Der Compute-Knoten ist nicht zum Ausführen von Aufgaben nutzbar. |
| unknown |
Der Batch-Dienst hat den Kontakt zum Compute-Node verloren und kennt dessen tatsächlichen Zustand nicht. |
| leavingpool |
Der Compute-Node verlässt den Pool, entweder weil der Benutzer ihn explizit entfernt hat oder weil der Pool die Größe anpasst oder automatisch verkleinert. |
| offline |
Der Compute-Knoten führt derzeit keine Aufgabe aus, und die Planung neuer Aufgaben für den Rechenknoten ist deaktiviert. |
| preempted |
Der Computeknoten "Spot/Low-Priority" wurde vorgedrängt. Aufgaben, die beim Vorabstart auf dem Computeknoten ausgeführt wurden, werden neu geplant, wenn ein anderer Computeknoten verfügbar wird. |
| upgradingos |
Der Compute Node wird derzeit auf ein Betriebssystem aktualisiert. |
| deallocated |
Der Compute-Knoten wird freigegeben. |
| deallocating |
Der Compute-Knoten wird ausgetauscht. |
BatchStartTask
Batch wiederholt Aufgaben, wenn ein Wiederherstellungsvorgang auf einem Knoten ausgelöst wird. Beispiele für Wiederherstellungsvorgänge sind (aber nicht beschränkt darauf), wenn ein fehlerhafter Knoten neu gestartet wird oder ein Computeknoten aufgrund eines Hostfehlers verschwunden ist. Wiederholungen aufgrund von Wiederherstellungsvorgängen sind unabhängig von und werden nicht für das maxTaskRetryCount gezählt. Auch wenn das maxTaskRetryCount 0 ist, kann ein interner Wiederholungsversuch aufgrund eines Wiederherstellungsvorgangs auftreten. Aus diesem Gründen sollten alle Aufgaben idempotent sein. Dies bedeutet, dass Aufgaben unterbrochen und neu gestartet werden müssen, ohne dass Beschädigte oder doppelte Daten verursacht werden. Die bewährte Methode für lange ausgeführte Aufgaben besteht darin, eine Form der Prüfpunkterstellung zu verwenden. In einigen Fällen kann der StartTask erneut ausgeführt werden, obwohl der Computeknoten nicht neu gestartet wurde. Es sollte besonders darauf geachtet werden, startTasks zu vermeiden, die Unterbrechungsvorgang erstellen oder Dienste aus dem StartTask-Arbeitsverzeichnis installieren/starten, da dadurch verhindert wird, dass Batch die StartTask erneut ausführen kann.
| Name | Typ | Beschreibung |
|---|---|---|
| commandLine |
string |
Die Befehlszeile des StartTask. Die Befehlszeile wird nicht unter einer Shell ausgeführt und kann daher nicht von Shellfeatures wie der Erweiterung der Umgebungsvariablen profitieren. Wenn Sie diese Features nutzen möchten, sollten Sie die Shell in der Befehlszeile aufrufen, z. B. mit "cmd /c MyCommand" in Windows oder "/bin/sh -c MyCommand" in Linux. Wenn sich die Befehlszeile auf Dateipfade bezieht, sollte sie einen relativen Pfad (relativ zum Arbeitsverzeichnis "Aufgabe") verwenden oder die vom Batch bereitgestellte Umgebungsvariable (https://v4.hkg1.meaqua.org/azure/batch/batch-compute-node-environment-variables) verwenden. |
| containerSettings |
Die Einstellungen für den Container, unter dem der StartTask ausgeführt wird. Wenn dies angegeben ist, werden alle Verzeichnisse rekursiv unterhalb der AZ_BATCH_NODE_ROOT_DIR (der Wurzel der Azure Batch-Verzeichnisse auf dem Knoten) in den Container abgebildet, alle Task-Umgebungsvariablen werden in den Container abgebildet und die Task-Befehlszeile wird im Container ausgeführt. Dateien, die außerhalb AZ_BATCH_NODE_ROOT_DIR im Container erzeugt werden, werden möglicherweise nicht auf die Host-Festplatte zurückgewiesen, was bedeutet, dass Batch-Datei-APIs nicht auf diese Dateien zugreifen können. |
|
| environmentSettings |
Eine Liste der Umgebungsvariableneinstellungen für den StartTask. |
|
| maxTaskRetryCount |
integer (int32) |
Die maximale Anzahl der Wiederholungsversuche des Vorgangs. Der Batchdienst ruft eine Aufgabe erneut auf, wenn der Beendigungscode nicht null ist. Beachten Sie, dass dieser Wert speziell die Anzahl der Wiederholungen steuert. Der Batchdienst versucht die Aufgabe einmal, und kann dann bis zu diesem Grenzwert erneut versuchen. Wenn die maximale Wiederholungsanzahl beispielsweise 3 ist, versucht Batch die Aufgabe bis zu 4 Mal (ein erster Versuch und 3 Wiederholungsversuche). Wenn die maximale Wiederholungsanzahl 0 ist, wird der Batchdienst den Vorgang nicht wiederholen. Wenn die maximale Wiederholungsanzahl -1 ist, wiederholt der Batchdienst den Vorgang ohne Beschränkung, dies wird jedoch nicht für einen Startvorgang oder einen Vorgang empfohlen. Der Standardwert ist 0 (keine Wiederholungen). |
| resourceFiles |
Eine Liste der Dateien, die der Batchdienst vor dem Ausführen der Befehlszeile auf den Computeknoten herunterladen wird. Es gibt eine maximale Größe für die Liste der Ressourcendateien. Wenn die maximale Größe überschritten wird, schlägt die Anforderung fehl, und der Antwortfehlercode lautet "RequestEntityTooLarge". Wenn dies der Fall ist, muss die Sammlung von ResourceFiles in der Größe reduziert werden. Dies kann mithilfe von .zip Dateien, Anwendungspaketen oder Docker-Containern erreicht werden. Unter diesem Element aufgelistete Dateien befinden sich im Arbeitsverzeichnis der Aufgabe. |
|
| userIdentity |
Die Benutzeridentität, unter der die StartTask ausgeführt wird. Wenn sie weggelassen wird, läuft die Aufgabe als nicht-administrativer Benutzer, der einzigartig für die Aufgabe ist. |
|
| waitForSuccess |
boolean |
Gibt an, ob der Batchdienst warten soll, bis der StartTask erfolgreich abgeschlossen wurde (d. h. zum Beenden mit Beendigungscode 0), bevor Aufgaben auf dem Computeknoten geplant werden. Wenn "true" und "StartTask" auf einem Knoten fehlschlägt, wiederholt der Batchdienst die StartTask bis zur maximalen Wiederholungsanzahl (maxTaskRetryCount). Wenn die Aufgabe nach allen Wiederholungen noch nicht erfolgreich abgeschlossen wurde, markiert der Batchdienst den Knoten nicht verwendbar und plant keine Vorgänge. Diese Bedingung kann über den Computerknotenstatus und Fehlerinformationen erkannt werden. Wenn "false" lautet, wartet der Batchdienst nicht, bis der StartTask abgeschlossen ist. In diesem Fall können andere Aufgaben mit der Ausführung auf dem Computeknoten beginnen, während der StartTask noch ausgeführt wird. und auch wenn der StartTask fehlschlägt, werden neue Aufgaben weiterhin auf dem Computeknoten geplant. Der Standardwert ist "true". |
BatchStartTaskInfo
Informationen zu einem StartTask, der auf einem Computeknoten ausgeführt wird.
| Name | Typ | Beschreibung |
|---|---|---|
| containerInfo |
Informationen über den Container, unter dem die Aufgabe ausgeführt wird. Diese Eigenschaft wird nur gesetzt, wenn die Aufgabe in einem Containerkontext ausgeführt wird. |
|
| endTime |
string (date-time) |
Der Zeitpunkt, zu dem der StartTask aufgehört hat zu laufen. Dies ist die Endzeit des letzten StartTask-Durchlaufs, falls dieser Lauf abgeschlossen ist (auch wenn der Durchlauf fehlschlug und ein erneuter Versuch aussteht). Dieses Element ist nicht vorhanden, wenn der StartTask gerade ausgeführt wird. |
| exitCode |
integer (int32) |
Der Exit-Code des Programms, der in der StartTask-Kommandozeile angegeben ist. Diese Eigenschaft wird nur gesetzt, wenn sich StartTask im abgeschlossenen Zustand befindet. Im Allgemeinen spiegelt der Ausgangscode eines Prozesses die spezifische Konvention wider, die vom Anwendungsentwickler für diesen Prozess implementiert wurde. Wenn Sie den Exit-Code-Wert verwenden, um Entscheidungen in Ihrem Code zu treffen, stellen Sie sicher, dass Sie die Exit-Code-Konvention kennen, die vom Anwendungsprozess verwendet wird. Wenn der Batch-Service jedoch die StartTask beendet (aufgrund von Timeout oder Benutzerbeendigung über die API), kann es sein, dass ein vom Betriebssystem definierter Exit-Code angezeigt wird. |
| failureInfo |
Informationen, die das Misserfolg der Aufgabe beschreiben, falls vorhanden. Diese Eigenschaft wird nur gesetzt, wenn sich die Aufgabe im abgeschlossenen Zustand befindet und auf einen Fehler stößt. |
|
| lastRetryTime |
string (date-time) |
Das letzte Mal, als ein erneuter Versuch der Aufgabe begann. Dieses Element ist nur vorhanden, wenn die Aufgabe erneut versucht wurde (d. h. retryCount ist nicht null). Wenn vorhanden, ist dies typischerweise dasselbe wie startTime, kann aber anders sein, wenn die Aufgabe aus anderen Gründen als dem erneuten Versuch neu gestartet wurde; zum Beispiel, wenn der Compute-Knoten während eines erneuten Versuchs neu gestartet wurde, wird startTime aktualisiert, aber der lastRetryTime nicht. |
| result |
Das Ergebnis der Ausführung der Aufgabe. Wenn der Wert 'fehlgeschlagen' ist, können die Details des Scheiterns in der Eigenschaft failureInfo gefunden werden. |
|
| retryCount |
integer (int32) |
Die Anzahl der Male, in denen die Aufgabe vom Batch-Service erneut versucht wurde. Task-Anwendungsfehler (nicht-null-Exit-Code) werden erneut versucht, Vorverarbeitungsfehler (die Aufgabe konnte nicht ausgeführt werden) und Datei-Upload-Fehler werden nicht erneut versucht. Der Batch-Service versucht die Aufgabe bis zum durch die Einschränkungen festgelegten Limit erneut. |
| startTime |
string (date-time) |
Die Zeit, zu der der StartTask zu laufen begann. Dieser Wert wird jedes Mal zurückgesetzt, wenn die Aufgabe neu gestartet oder erneut versucht wird (das heißt, dies ist der letzte Zeitpunkt, an dem der StartTask ausgeführt wurde). |
| state |
Der Zustand der StartTask auf dem Rechenknoten. |
BatchStartTaskState
BatchStartTaskState-Enums
| Wert | Beschreibung |
|---|---|
| running |
Der StartTask läuft derzeit. |
| completed |
Der StartTask wurde mit Exitcode 0 beendet, oder der StartTask ist fehlgeschlagen und die Wiederholungsgrenze ist erreicht, oder der StartTask-Prozess wurde aufgrund von Fehlern bei der Task-Vorbereitung (wie z. B. Fehler beim Herunterladen von Ressourcendateien) nicht ausgeführt. |
BatchTaskContainerExecutionInfo
Enthält Informationen zum Container, den eine Aufgabe ausführt.
| Name | Typ | Beschreibung |
|---|---|---|
| containerId |
string |
ID des Containers. |
| error |
string |
Detaillierte Fehlerinformationen zum Container. Dies ist die detaillierte Fehlerfolge des Docker-Dienstes, falls verfügbar. Es entspricht dem Fehlerfeld, das von "docker inspect" zurückgegeben wird. |
| state |
string |
Der Zustand des Behälters. Dies ist der Zustand des Containers laut dem Docker-Service. Es entspricht dem Statusfeld, das von "docker inspect" zurückgegeben wird. |
BatchTaskContainerSettings
Die Containereinstellungen für eine Aufgabe.
| Name | Typ | Beschreibung |
|---|---|---|
| containerHostBatchBindMounts |
Die Pfade, die Sie an containeraufgaben bereitstellen möchten. Wenn dieses Array null ist oder nicht vorhanden ist, stellt die Containeraufgabe das gesamte temporäre Laufwerk in Windows (oder AZ_BATCH_NODE_ROOT_DIR in Linux) ein. Es werden keine Datenpfade in Container bereitgestellt, wenn dieses Array als leer festgelegt ist. |
|
| containerRunOptions |
string |
Zusätzliche Optionen für den Befehl "Container erstellen". Diese zusätzlichen Optionen werden zusätzlich zu den vom Batchdienst gesteuerten Befehlen als Argumente für den Befehl "docker create" bereitgestellt. |
| imageName |
string |
Das Image, das verwendet wird, um den Container zu erstellen, in dem die Aufgabe ausgeführt wird. Dies ist die vollständige Image-Referenz, wie sie bei "docker pull" angegeben wäre. Wenn kein Tag im Bildnamen angegeben ist, wird standardmäßig das Tag ":latest" verwendet. |
| registry |
Das private Register, das das Container-Image enthält. Diese Einstellung kann weggelassen werden, wenn sie bereits bei der Poolerstellung bereitgestellt wurde. |
|
| workingDirectory |
Der Standort des Arbeitsverzeichnisses Container Task. Der Standardwert ist "taskWorkingDirectory". |
BatchTaskExecutionInfo
Informationen zur Ausführung einer Aufgabe.
| Name | Typ | Beschreibung |
|---|---|---|
| containerInfo |
Informationen über den Container, unter dem die Aufgabe ausgeführt wird. Diese Eigenschaft wird nur gesetzt, wenn die Aufgabe in einem Containerkontext ausgeführt wird. |
|
| endTime |
string (date-time) |
Der Zeitpunkt, zu dem die Aufgabe abgeschlossen wurde. Diese Eigenschaft wird nur gesetzt, wenn sich die Aufgabe im Zustand "abgeschlossen" befindet. |
| exitCode |
integer (int32) |
Der Exit-Code des Programms ist in der Task-Befehlszeile angegeben. Diese Eigenschaft wird nur gesetzt, wenn sich die Aufgabe im abgeschlossenen Zustand befindet. Im Allgemeinen spiegelt der Ausgangscode eines Prozesses die spezifische Konvention wider, die vom Anwendungsentwickler für diesen Prozess implementiert wurde. Wenn Sie den Exit-Code-Wert verwenden, um Entscheidungen in Ihrem Code zu treffen, stellen Sie sicher, dass Sie die Exit-Code-Konvention kennen, die vom Anwendungsprozess verwendet wird. Wenn der Batch-Service jedoch die Aufgabe beendet (aufgrund von Timeout oder Benutzerbeendigung über die API), könnten Sie einen vom Betriebssystem definierten Exit-Code sehen. |
| failureInfo |
Informationen, die das Misserfolg der Aufgabe beschreiben, falls vorhanden. Diese Eigenschaft wird nur gesetzt, wenn sich die Aufgabe im abgeschlossenen Zustand befindet und auf einen Fehler stößt. |
|
| lastRequeueTime |
string (date-time) |
Der letzte Zeitpunkt, zu dem die Aufgabe vom Batch-Service infolge einer Benutzeranforderung wieder in die Warteschlange gestellt wurde. Diese Eigenschaft wird nur gesetzt, wenn die requeueCount nicht null ist. |
| lastRetryTime |
string (date-time) |
Das letzte Mal, als ein erneuter Versuch der Aufgabe begann. Dieses Element ist nur vorhanden, wenn die Aufgabe erneut versucht wurde (d. h. retryCount ist nicht null). Wenn vorhanden, ist dies typischerweise dasselbe wie startTime, kann aber anders sein, wenn die Aufgabe aus anderen Gründen als dem erneuten Versuch neu gestartet wurde; zum Beispiel, wenn der Compute-Knoten während eines erneuten Versuchs neu gestartet wurde, wird startTime aktualisiert, aber der lastRetryTime nicht. |
| requeueCount |
integer (int32) |
Die Anzahl der Male, in denen die Aufgabe vom Batch-Service infolge einer Benutzeranforderung erneut in die Warteschlange gestellt wurde. Wenn der Benutzer Compute-Knoten aus einem Pool entfernt (indem er den Pool verkleinert/verkleinert) oder wenn der Job deaktiviert wird, kann er festlegen, dass ausführende Aufgaben auf den Compute-Knoten zur Ausführung erneut in die Warteschlange gestellt werden. Diese Zählung zeigt, wie oft die Aufgabe aus diesen Gründen neu in die Warteschlange gestellt wurde. |
| result |
Das Ergebnis der Ausführung der Aufgabe. Wenn der Wert 'fehlgeschlagen' ist, können die Details des Scheiterns in der Eigenschaft failureInfo gefunden werden. |
|
| retryCount |
integer (int32) |
Die Anzahl der Male, in denen die Aufgabe vom Batch-Service erneut versucht wurde. Task-Anwendungsfehler (nicht-null-Exit-Code) werden erneut versucht, Vorverarbeitungsfehler (die Aufgabe konnte nicht ausgeführt werden) und Datei-Upload-Fehler werden nicht erneut versucht. Der Batch-Service versucht die Aufgabe bis zum durch die Einschränkungen festgelegten Limit erneut. |
| startTime |
string (date-time) |
Die Zeit, zu der die Aufgabe zu laufen begann. 'Laufend' entspricht dem laufenden Zustand, sodass wenn die Aufgabe Ressourcendateien oder Pakete angibt, die Startzeit den Zeitpunkt widerspiegelt, zu dem die Aufgabe mit dem Herunterladen oder Bereitstellen begonnen hat. Wenn die Aufgabe neu gestartet oder erneut versucht wurde, ist dies der letzte Zeitpunkt, in dem die Aufgabe ausgeführt wurde. Diese Eigenschaft ist nur für Aufgaben vorhanden, die sich im laufenden oder abgeschlossenen Zustand befinden. |
BatchTaskExecutionResult
BatchTaskExecutionResult-Enume
| Wert | Beschreibung |
|---|---|
| success |
Die Aufgabe wurde erfolgreich durchgeführt. |
| failure |
Es gab einen Fehler während der Bearbeitung der Aufgabe. Der Ausfall kann vor dem Start des Task-Prozesses, während der Task-Prozess ausgeführt wurde oder nachdem der Task-Prozess beendet war, aufgetreten sein. |
BatchTaskFailureInfo
Informationen zu einem Vorgangsfehler.
| Name | Typ | Beschreibung |
|---|---|---|
| category |
Die Kategorie des Aufgabenfehlers. |
|
| code |
string |
Ein Kennzeichen für den Task-Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden. |
| details |
Eine Liste zusätzlicher Details zu dem Fehler. |
|
| message |
string |
Eine Meldung, die den Aufgabenfehler beschreibt und für die Darstellung in einer Benutzeroberfläche geeignet sein soll. |
BatchTaskInfo
Informationen zu einer Aufgabe, die auf einem Computeknoten ausgeführt wird.
| Name | Typ | Beschreibung |
|---|---|---|
| executionInfo |
Informationen über die Ausführung der Aufgabe. |
|
| jobId |
string |
Die ID des Jobs, zu dem die Aufgabe gehört. |
| subtaskId |
integer (int32) |
Die ID der Unteraufgabe, wenn die Aufgabe eine Multi-Instanz-Aufgabe ist. |
| taskId |
string |
Die ID der Aufgabe. |
| taskState |
Der aktuelle Stand der Aufgabe. |
|
| taskUrl |
string (uri) |
Die URL der Aufgabe. |
BatchTaskState
BatchTaskState-Enums
| Wert | Beschreibung |
|---|---|
| active |
Die Aufgabe ist in der Warteschlange und kann ausgeführt werden, ist aber derzeit nicht einem Rechenknoten zugewiesen. Eine Aufgabe tritt in diesen Zustand ein, wenn sie erstellt wird, wenn sie nach der Deaktivierung aktiviert wird oder wenn sie nach einem fehlgeschlagenen Durchlauf auf einen erneuten Versuch wartet. |
| preparing |
Die Aufgabe wurde einem Rechenknoten zugewiesen, wartet jedoch auf die Abschluss einer erforderlichen Jobvorbereitungsaufgabe auf dem Rechenknoten. Wenn die Aufgabe zur Jobvorbereitung erfolgreich ist, wird die Aufgabe zum Laufen übergegangen. Wenn die Aufgabe zur Jobvorbereitung fehlschlägt, wird sie wieder aktiv und kann einem anderen Rechenknoten zugewiesen werden. |
| running |
Die Aufgabe läuft auf einem Compute-Knoten. Dazu gehört auch die Vorbereitung auf Aufgabenebene, wie das Herunterladen von Ressourcendateien oder das Bereitstellen von auf der Aufgabe angegebenen Paketen – das bedeutet nicht zwangsläufig, dass die Task-Befehlszeile bereits ausgeführt wurde. |
| completed |
Die Aufgabe ist nicht mehr ausführbar, meist weil die Aufgabe erfolgreich abgeschlossen wurde oder die Aufgabe erfolglos abgeschlossen wurde und ihr Wiederholungslimit aufgebraucht ist. Eine Aufgabe wird ebenfalls als abgeschlossen markiert, wenn beim Starten der Aufgabe ein Fehler aufgetreten ist oder wenn die Aufgabe beendet wurde. |
BatchVmImageReference
Ein Verweis auf ein Azure Virtual Machines Marketplace Image oder ein Azure Compute Gallery Image. Informationen zum Abrufen der Liste aller azure Marketplace-Imageverweise, die von Azure Batch überprüft wurden, finden Sie im Vorgang "Unterstützte Bilder auflisten".
| Name | Typ | Beschreibung |
|---|---|---|
| communityGalleryImageId |
string |
Die eindeutige Kennung des Bildes in der Community-Galerie. Diese Eigenschaft schließt sich gegenseitig mit anderen Eigenschaften aus und kann aus dem Get-Aufruf der Communitygalerie abgerufen werden. |
| exactVersion |
string |
Die spezifische Version des Plattform- oder Marktplatzimages, die zur Erstellung des Knotens verwendet wurde. Dieses Nur-Lese-Feld unterscheidet sich von 'version' nur, wenn der für 'version' angegebene Wert bei der Erstellung des Pools 'neueste' war. |
| offer |
string |
Der Angebotstyp des Azure Virtual Machines Marketplace Images. Beispiel: UbuntuServer oder WindowsServer. |
| publisher |
string |
Der Herausgeberin des Azure Virtual Machines Marketplace Image. Beispiel: Canonical oder MicrosoftWindowsServer. |
| sharedGalleryImageId |
string |
Die einzigartige Identifikatorin des gemeinsamen Galeriebilds. Diese Eigenschaft schließt sich gegenseitig mit anderen Eigenschaften aus und kann aus dem GET-Aufruf des freigegebenen Katalogbilds abgerufen werden. |
| sku |
string |
Die SKU des Azure Virtual Machines Marketplace Images. Beispiel: 18.04-LTS oder 2019-Datacenter. |
| version |
string |
Die Version des Azure Virtual Machines Marketplace Images. Ein Wert 'neueste' kann angegeben werden, um die neueste Version eines Images auszuwählen. Wenn dieser Wert nicht angegeben wird, lautet der Standardwert "latest". |
| virtualMachineImageId |
string (arm-id) |
Der ARM-Ressourcenbezeichner des Azure Compute Gallery Image. Compute-Knoten im Pool werden mit dieser Bild-ID erstellt. Dies ist in der Form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} oder /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}, um immer auf die neueste Image-Version zu setzen. Diese Eigenschaft schließt sich gegenseitig mit anderen ImageReference-Eigenschaften aus. Das Azure Compute Gallery Image muss Replikate in derselben Region haben und im selben Abonnement wie das Azure Batch-Konto sein. Wenn die Image-Version nicht in der imageID angegeben ist, wird die neueste Version verwendet. Informationen zu den Firewall-Einstellungen für den Batch Compute Node-Agenten zur Kommunikation mit dem Batch-Service finden https://v4.hkg1.meaqua.org/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configurationSie unter . |
ContainerHostBatchBindMountEntry
Der Eintrag des Pfad- und Bereitstellungsmodus, den Sie in Aufgabencontainer bereitstellen möchten.
| Name | Typ | Beschreibung |
|---|---|---|
| isReadOnly |
boolean |
Stellen Sie diesen Quellpfad als schreibgeschützten Modus ein oder nicht. Der Standardwert ist false (Lese-/Schreibmodus). Wenn Sie diesen Pfad für Linux als Lese-/Schreibmodus bereitstellen, bedeutet dies nicht, dass alle Benutzer im Container über den Lese-/Schreibzugriff für den Pfad verfügen, hängt sie vom Zugriff auf die Host-VM ab. Wenn dieser Pfad schreibgeschützt bereitgestellt wird, können alle Benutzer im Container den Pfad nicht ändern. |
| source |
Der Pfad, der für containerkunden bereitgestellt werden kann. |
ContainerHostDataPath
Die Pfade, die im Container der Containeraufgabe bereitgestellt werden.
| Wert | Beschreibung |
|---|---|
| Shared |
Der Pfad für die Aufgabe mit mehreren Instanzen, um ihre Dateien freigegeben zu haben. |
| Startup |
Der Pfad für die Startaufgabe. |
| VfsMounts |
Der Pfad enthält alle virtuellen Dateisysteme, die auf diesem Knoten bereitgestellt werden. |
| Task |
Der Vorgangspfad. |
| JobPrep |
Der Auftragsvorstellungsvorgangspfad. |
| Applications |
Der Anwendungspfad. |
ContainerRegistryReference
Eine private Containerregistrierung.
| Name | Typ | Beschreibung |
|---|---|---|
| identityReference |
Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf eine Azure-Containerregistrierung anstelle von Benutzername und Kennwort verwendet werden soll. |
|
| password |
string (password) |
Das Kennwort für die Anmeldung beim Registrierungsserver. |
| registryServer |
string (uri) |
Die Registrierungs-URL Wenn nicht angegeben, lautet der Standardwert "docker.io". |
| username |
string |
Der Benutzername, der sich beim Registrierungsserver anmeldet. |
ContainerWorkingDirectory
ContainerWorkingDirectory-Enums
| Wert | Beschreibung |
|---|---|
| taskWorkingDirectory |
Verwenden Sie das Standard-Batch-Service-Arbeitsverzeichnis Task, das die Task Resource Dateien enthält, die von Batch gefüllt werden. |
| containerImageDefault |
Verwenden Sie das Arbeitsverzeichnis, das im Container-Image definiert ist. Beachten Sie, dass dieses Verzeichnis die durch Batch heruntergeladenen Ressourcendateien nicht enthält. |
ElevationLevel
ElevationLevel-Enums
| Wert | Beschreibung |
|---|---|
| nonadmin |
Der Benutzer ist ein Standardbenutzer ohne erhöhten Zugriff. |
| admin |
Der Benutzer ist ein Benutzer mit erhöhtem Zugriff und arbeitet mit vollständigen Administratorberechtigungen. |
EnvironmentSetting
Eine Umgebungsvariable, die für einen Vorgangsprozess festgelegt werden soll.
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
Der Name der Umgebungsvariable. |
| value |
string |
Der Wert der Umgebungsvariable. |
InboundEndpoint
Ein eingehender Endpunkt auf einem Computeknoten.
| Name | Typ | Beschreibung |
|---|---|---|
| backendPort |
integer (int32) |
Die Backend-Portnummer des Endpunkts. |
| frontendPort |
integer (int32) |
Die öffentliche Portnummer des Endpunkts. |
| name |
string |
Der Name des Endpunkts. |
| protocol |
Das Protokoll des Endpunkts. |
|
| publicFQDN |
string |
Der öffentliche, vollständig qualifizierte Domainname für den Compute Node. |
| publicIPAddress |
string |
Die öffentliche IP-Adresse des Compute Node. |
InboundEndpointProtocol
InboundEndpointProtocol enums
| Wert | Beschreibung |
|---|---|
| tcp |
Verwenden Sie TCP für den Endpunkt. |
| udp |
Verwenden Sie UDP für den Endpunkt. |
NameValuePair
Stellt ein Name-Wert-Paar dar.
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
Der Name im Namen-Wert-Paar. |
| value |
string |
Der Wert im Namen-Wert-Paar. |
ResourceFile
Eine einzelne Datei oder mehrere Dateien, die in einen Computeknoten heruntergeladen werden sollen.
| Name | Typ | Beschreibung |
|---|---|---|
| autoStorageContainerName |
string |
Der Name des Speichercontainers im automatischen Speicherkonto. Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden. |
| blobPrefix |
string |
Das Blobpräfix, das beim Herunterladen von Blobs aus einem Azure Storage-Container verwendet werden soll. Nur die Blobs, deren Namen mit dem angegebenen Präfix beginnen, werden heruntergeladen. Die Eigenschaft ist nur gültig, wenn autoStorageContainerName oder storageContainerUrl verwendet wird. Dieses Präfix kann ein teilweiser Dateiname oder ein Unterverzeichnis sein. Wenn kein Präfix angegeben ist, werden alle Dateien im Container heruntergeladen. |
| fileMode |
string |
Das Attribut für den Dateiberechtigungsmodus im oktalen Format. Diese Eigenschaft gilt nur für Dateien, die auf Linux Compute Nodes heruntergeladen werden. Sie wird ignoriert, wenn sie für eine ResourceFile angegeben ist, die auf einen Windows-Compute-Node heruntergeladen wird. Wenn diese Eigenschaft für einen Linux Compute Node nicht angegeben ist, wird der Standardwert 0770 auf die Datei angewendet. |
| filePath |
string |
Der Ort auf dem Compute-Knoten, zu dem die Datei(en) heruntergeladen werden sollen, relativ zum Arbeitsverzeichnis der Task. Wenn die httpUrl-Eigenschaft angegeben ist, ist der FilePath erforderlich und beschreibt den Pfad, in den die Datei heruntergeladen wird, einschließlich des Dateinamens. Andernfalls ist filePath optional, wenn die autoStorageContainerName- oder storageContainerUrl-Eigenschaft angegeben ist, und das Verzeichnis, in das die Dateien heruntergeladen werden sollen. Wenn FilePath als Verzeichnis verwendet wird, werden alle bereits den Eingabedaten zugeordneten Verzeichnisstruktur vollständig aufbewahrt und an das angegebene FilePath-Verzeichnis angefügt. Der angegebene relative Pfad kann nicht aus dem Arbeitsverzeichnis der Aufgabe herausbrechen (zum Beispiel durch die Verwendung von '..'). |
| httpUrl |
string (uri) |
Die URL der herunterzuladenden Datei. Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden. Wenn die URL auf Azure Blob Storage verweist, muss sie von Computeknoten gelesen werden. Es gibt drei Möglichkeiten, eine solche URL für ein Blob im Azure-Speicher abzurufen: Fügen Sie eine SAS (Shared Access Signature) hinzu, die Leseberechtigungen für das Blob gewährt, eine verwaltete Identität mit Leseberechtigung verwenden oder die ACL für das Blob oder dessen Container so festlegen, dass der öffentliche Zugriff zulässig ist. |
| identityReference |
Die Referenz auf die vom Benutzer zugewiesene Identität, die zum Zugriff auf Azure Blob Storage verwendet wird, spezifiziert durch storageContainerUrl oder httpUrl. |
|
| storageContainerUrl |
string (uri) |
Die URL des Blobcontainers in Azure Blob Storage. Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden. Diese URL muss von Computeknoten lesbar und auflistenbar sein. Es gibt drei Möglichkeiten, eine solche URL für einen Container in Azure Storage abzurufen: Fügen Sie eine SAS (Shared Access Signature) hinzu, die Lese- und Listenberechtigungen für den Container gewährt, eine verwaltete Identität mit Lese- und Listenberechtigungen verwenden oder die ACL für den Container so festlegen, dass der öffentliche Zugriff zugelassen wird. |
SchedulingState
SchedulingState-Enums
| Wert | Beschreibung |
|---|---|
| enabled |
Aufgaben können auf dem Compute-Node geplant werden. |
| disabled |
Es werden keine neuen Aufgaben auf dem Compute-Node geplant. Aufgaben, die bereits auf dem Compute-Node laufen, können dennoch vollständig ausgeführt werden. Alle Compute-Knoten beginnen mit aktivierter Planung. |
UserIdentity
Die Definition der Benutzeridentität, unter der die Aufgabe ausgeführt wird. Geben Sie entweder die Eigenschaft "userName" oder "autoUser" an, aber nicht beide.
| Name | Typ | Beschreibung |
|---|---|---|
| autoUser |
Der automatische Benutzer, unter dem die Aufgabe ausgeführt wird. Die Eigenschaften "userName" und "autoUser" schließen sich gegenseitig aus; Sie müssen einen, aber nicht beide angeben. |
|
| username |
string |
Der Name der Benutzeridentität, unter der die Aufgabe ausgeführt wird. Die Eigenschaften "userName" und "autoUser" schließen sich gegenseitig aus; Sie müssen einen, aber nicht beide angeben. |
VirtualMachineInfo
Informationen zum aktuellen Status des virtuellen Computers.
| Name | Typ | Beschreibung |
|---|---|---|
| imageReference |
Der Verweis auf das Marktplatz-Image der Azure Virtual Machine. |
|
| scaleSetVmResourceId |
string |
Die Ressourcen-ID der aktuellen Virtual Machine Scale Set VM des Compute Node. Nur definiert, wenn das Batch-Konto mit seiner poolAllocationMode-Eigenschaft auf 'UserSubscription' gesetzt wurde. |