Compute Node - List

Service:

Batch Service

API Version:

2023-11-01.18.0

Listet die Computeknoten im angegebenen Pool auf.

GET {batchUrl}/pools/{poolId}/nodes?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/pools/{poolId}/nodes?$filter={$filter}&$select={$select}&maxresults={maxresults}&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.
poolId	path	True	string	Die ID des Pools, aus dem Sie Computeknoten auflisten möchten.
api-version	query	True	string	Client-API-Version.
$filter	query		string	Eine OData-$filter-Klausel. Weitere Informationen zum Erstellen dieses Filters finden Sie unter https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.
$select	query		string	Eine OData $select-Klausel.
maxresults	query		integer int32	Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Es können maximal 1.000 Computeknoten zurückgegeben werden.
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.

Antworten

Name	Typ	Beschreibung
200 OK	ComputeNodeListResult	Eine Antwort, die die Liste der Computeknoten enthält. Headers client-request-id: string request-id: string ETag: string Last-Modified: 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 list

Sample Request

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes?api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "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": "2016-11-22T22:22:27.2236818Z",
      "lastBootTime": "2016-11-22T22:22:24.4634125Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_1-20161122t193202z",
      "vmSize": "small",
      "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
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T22:22:27.2236818Z",
        "endTime": "2016-11-22T22:22:27.567189Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-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": "2016-11-22T19:37:31.4285526Z",
      "lastBootTime": "2016-11-22T19:37:28.623369Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
      "vmSize": "small",
      "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
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T19:37:31.4285526Z",
        "endTime": "2016-11-22T19:37:31.838028Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-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": "2016-11-22T19:36:51.0013378Z",
      "lastBootTime": "2016-11-22T19:36:48.21721Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_3-20161122t193202z",
      "vmSize": "small",
      "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
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T19:36:51.0013378Z",
        "endTime": "2016-11-22T19:36:51.2363447Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
AutoUserScope	Der Bereich für den automatischen Benutzer
AutoUserSpecification	Gibt die Parameter für den automatischen Benutzer an, der einen Task im Batch-Dienst ausführt.
BatchError	Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail	Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.
CertificateReference	Ein Verweis auf ein Zertifikat, das auf Computeknoten in einem Pool installiert werden soll.
CertificateStoreLocation	Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in dem das Zertifikat installiert werden soll.
CertificateVisibility	Welche Benutzerkonten auf dem Computeknoten sollten Zugriff auf die privaten Daten des Zertifikats haben.
ComputeNode	Ein Computeknoten im Batch-Dienst.
ComputeNodeEndpointConfiguration	Die Endpunktkonfiguration für den Computeknoten.
ComputeNodeError	Ein Fehler, der bei einem Computeknoten aufgetreten ist.
ComputeNodeIdentityReference	Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.
ComputeNodeListResult	Das Ergebnis der Auflistung der Computeknoten in einem Pool.
ComputeNodeState	Der aktuelle Zustand des Computeknotens.
ContainerRegistry	Eine private Containerregistrierung.
ContainerWorkingDirectory	Der Speicherort des Aufgabenarbeitsverzeichnisses des Containers.
ElevationLevel	Die Höhenstufe des Benutzers.
EnvironmentSetting	Eine Umgebungsvariable, die für einen Vorgangsvorgang festgelegt werden soll.
ErrorCategory	Die Kategorie des Fehlers.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.
ImageReference	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 werden, finden Sie im Vorgang "Unterstützte Bilder auflisten".
InboundEndpoint	Ein eingehender Endpunkt auf einem Computeknoten.
InboundEndpointProtocol	Das Protokoll des Endpunkts.
NameValuePair	Stellt ein Name-Wert-Paar dar.
NodeAgentInformation	Informationen zum Computeknoten-Agent.
ResourceFile	Eine einzelne Datei oder mehrere Dateien, die auf einen Computeknoten heruntergeladen werden sollen.
SchedulingState	Gibt an, ob der Computeknoten für die Aufgabenplanung verfügbar ist.
StartTask	Eine Aufgabe, die ausgeführt wird, wenn ein Knoten einen Pool im Azure Batch-Dienst hinzuschließt oder wenn der Computeknoten neu gestartet oder ein neuer Image erstellt wird.
StartTaskInformation	Informationen zu einem StartTask, der auf einem Computeknoten ausgeführt wird.
StartTaskState	Der Status des StartTask auf dem Computeknoten.
TaskContainerExecutionInformation	Enthält Informationen zum Container, den ein Task ausführt.
TaskContainerSettings	Die Containereinstellungen für einen Task.
TaskExecutionInformation	Informationen zur Ausführung einer Aufgabe.
TaskExecutionResult	Das Ergebnis der Aufgabenausführung.
TaskFailureInformation	Informationen zu einem Vorgangsfehler.
TaskInformation	Informationen zu einem Task, der auf einem Computeknoten ausgeführt wird.
TaskState	Der Status des Tasks.
UserIdentity	Die Definition der Benutzeridentität, unter der der Task ausgeführt wird.
VirtualMachineInfo	Informationen zum aktuellen Status des virtuellen Computers.

AutoUserScope

Der Bereich für den automatischen Benutzer

Name	Typ	Beschreibung
pool	string	Gibt an, dass der Task als allgemeines automatisches Benutzerkonto ausgeführt wird, das auf jedem Computeknoten in einem Pool erstellt wird.
task	string	Gibt an, dass der Dienst einen neuen Benutzer für den Task erstellen soll.

AutoUserSpecification

Gibt die Parameter für den automatischen Benutzer an, der einen Task im Batch-Dienst ausführt.

Name	Typ	Beschreibung
elevationLevel	ElevationLevel	Die Höhenstufe des automatischen Benutzers. Der Standardwert ist nonAdmin.
scope	AutoUserScope	Der Bereich für den automatischen Benutzer Der Standardwert ist pool. Wenn im Pool Windows ausgeführt wird, sollte der Wert Task angegeben werden, wenn eine strengere Isolation zwischen Tasks erforderlich ist. Beispielsweise, wenn die Aufgabe die Registrierung auf eine Weise mutiert, die sich auf andere Aufgaben auswirken kann, oder wenn Zertifikate für den Pool angegeben wurden, auf die normale Aufgaben nicht zugreifen können, sondern von StartTasks zugänglich sein sollten.

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, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
values	BatchErrorDetail[]	Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthält.

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.

CertificateReference

Ein Verweis auf ein Zertifikat, das auf Computeknoten in einem Pool installiert werden soll.

Name	Typ	Beschreibung
storeLocation	CertificateStoreLocation	Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in dem das Zertifikat installiert werden soll. Der Standardwert ist currentuser. Diese Eigenschaft gilt nur für Pools, die mit Windows-Computeknoten (d. a. mit cloudServiceConfiguration oder mit virtualMachineConfiguration mithilfe einer Windows-Imagereferenz erstellt wurden). Für Linux-Computeknoten werden die Zertifikate in einem Verzeichnis innerhalb des Arbeitsverzeichnisses Task gespeichert, und eine Umgebungsvariable AZ_BATCH_CERTIFICATES_DIR wird für den Task bereitgestellt, um diesen Speicherort abzufragen. Für Zertifikate mit Sichtbarkeit von "remoteUser" wird im Basisverzeichnis des Benutzers (z. B. /home/{benutzername}/certs) ein Verzeichnis "certs" erstellt, und Zertifikate werden in diesem Verzeichnis platziert.
storeName	string	Der Name des Zertifikatspeichers auf dem Computeknoten, in dem das Zertifikat installiert werden soll. Diese Eigenschaft gilt nur für Pools, die mit Windows-Computeknoten (d. a. mit cloudServiceConfiguration oder mit virtualMachineConfiguration mithilfe einer Windows-Imagereferenz erstellt wurden). Allgemeine Speichernamen sind: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, aber auch ein beliebiger benutzerdefinierter Speichername kann verwendet werden. Der Standardwert ist My.
thumbprint	string	Der Fingerabdruck des Zertifikats.
thumbprintAlgorithm	string	Der Algorithmus, dem der Fingerabdruck zugeordnet ist. Dies muss sha1 sein.
visibility	CertificateVisibility[]	Welche Benutzerkonten auf dem Computeknoten Zugriff auf die privaten Daten des Zertifikats haben sollen. Sie können mehr als eine Sichtbarkeit in dieser Sammlung angeben. Der Standardwert ist "Alle Konten".

CertificateStoreLocation

Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in dem das Zertifikat installiert werden soll.

Name	Typ	Beschreibung
currentuser	string	Zertifikate sollten im CurrentUser-Zertifikatspeicher installiert werden.
localmachine	string	Zertifikate sollten im LocalMachine-Zertifikatspeicher installiert werden.

CertificateVisibility

Welche Benutzerkonten auf dem Computeknoten sollten Zugriff auf die privaten Daten des Zertifikats haben.

Name	Typ	Beschreibung
remoteuser	string	Das Zertifikat sollte für die Benutzerkonten sichtbar sein, unter denen Benutzer remote auf den Computeknoten zugreifen.
starttask	string	Das Zertifikat sollte für das Benutzerkonto sichtbar sein, unter dem der StartTask ausgeführt wird. Beachten Sie, dass dieses Zertifikat auch für den Task sichtbar ist, wenn der AutoUser-Bereich sowohl für startTask als auch für einen Task pool ist.
task	string	Das Zertifikat sollte für die Benutzerkonten sichtbar sein, unter denen Auftragsaufgaben ausgeführt werden.

ComputeNode

Ein Computeknoten im Batch-Dienst.

Name	Typ	Beschreibung
affinityId	string	Ein Bezeichner, der übergeben werden kann, wenn ein Task hinzugefügt wird, um die Geplante Aufgabe auf diesem Computeknoten anzufordern. Beachten Sie, dass dies nur eine weiche Affinität ist. Wenn der Compute-Zielknoten ausgelastet ist oder nicht verfügbar ist, wenn der Task geplant ist, wird der Task an anderer Stelle geplant.
allocationTime	string	Die Zeit, zu der dieser Computeknoten dem Pool zugewiesen wurde. Dies ist der Zeitpunkt, zu dem der Computeknoten ursprünglich zugeordnet wurde und sich nach dem Festlegen nicht mehr ändert. Er wird nicht aktualisiert, wenn der Computeknoten vom Dienst geheilt oder vorzeitig aufgehoben wird.
certificateReferences	CertificateReference[]	Die Liste der auf dem Computeknoten installierten Zertifikate. Für Windows-Knoten installiert der Batch-Dienst die Zertifikate im angegebenen Zertifikatspeicher und Speicherort. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis innerhalb des Arbeitsverzeichnisses Task gespeichert, und eine Umgebungsvariable, AZ_BATCH_CERTIFICATES_DIR für den Task bereitgestellt wird, um diesen Speicherort abzufragen. Bei Zertifikaten mit sichtbarkeit von "remoteUser" wird im Basisverzeichnis des Benutzers (z. B. /home/{benutzername}/certs) ein Verzeichnis "certs" erstellt, und Zertifikate werden in diesem Verzeichnis platziert. Warnung: Diese Eigenschaft ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung .
endpointConfiguration	ComputeNodeEndpointConfiguration	Die Endpunktkonfiguration für den Computeknoten.
errors	ComputeNodeError[]	Die Liste der Fehler, die derzeit vom Computeknoten gefunden 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 könnte 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 könnte für neue Computeknoten wiederverwendet werden.
isDedicated	boolean	Gibt an, ob es sich bei diesem Computeknoten um einen dedizierten Computeknoten handelt. Wenn false, ist der Computeknoten ein Computeknoten mit spot/low-priority.
lastBootTime	string	Der letzte Zeitpunkt, zu dem der Computeknoten gestartet wurde. Diese Eigenschaft ist möglicherweise nicht vorhanden, wenn der Computeknotenstatus nicht verwendet werden kann.
nodeAgentInfo	NodeAgentInformation	Informationen zur Compute Node-Agent-Version und zum Zeitpunkt des Upgrades des Computeknotens auf eine neue Version. Der Batch Compute Node-Agent ist ein Programm, das auf jedem Computeknoten im Pool ausgeführt wird und batch-Funktionen für den Computeknoten bereitstellt.
recentTasks	TaskInformation[]	Eine Liste von Aufgaben, deren Status sich kürzlich geändert hat. Diese Eigenschaft ist nur vorhanden, wenn mindestens eine Aufgabe auf diesem Computeknoten ausgeführt wurde, seit sie dem Pool zugewiesen wurde.
runningTaskSlotsCount	integer	Die Gesamtzahl der Planungsslots, die derzeit von Auftragstasks auf dem Computeknoten verwendet werden. Dies umfasst Auftrags-Manager-Aufgaben und normale Aufgaben, aber nicht Auftragsvorbereitung, Auftragsfreigabe oder Startaufgaben.
runningTasksCount	integer	Die Gesamtzahl der derzeit ausgeführten Auftragsaufgaben auf dem Computeknoten. Dies umfasst Auftrags-Manager-Aufgaben und normale Aufgaben, aber nicht Auftragsvorbereitung, Auftragsfreigabe oder Startaufgaben.
schedulingState	SchedulingState	Gibt an, ob der Computeknoten für die Aufgabenplanung verfügbar ist.
startTask	StartTask	Der Task, der für die Ausführung auf dem Computeknoten angegeben ist, während er dem Pool beitritt. Batch wiederholt Aufgaben, wenn ein Wiederherstellungsvorgang auf einem Knoten ausgelöst wird. Beispiele für Wiederherstellungsvorgänge sind (aber nicht beschränkt auf), wenn ein fehlerhafter Knoten neu gestartet wird oder ein Computeknoten aufgrund eines Hostfehlers verschwunden ist. Wiederholungsversuche aufgrund von Wiederherstellungsvorgängen sind unabhängig von und werden nicht mit maxTaskRetryCount gezählt. Auch wenn maxTaskRetryCount 0 ist, kann es aufgrund eines Wiederherstellungsvorgangs zu einer internen Wiederholung kommen. Aus diesem Gründen sollten alle Aufgaben idempotent sein. Dies bedeutet, dass Tasks es tolerieren müssen, dass sie unterbrochen und neu gestartet werden, ohne dass es zu Beschädigungen oder doppelten Daten kommt. Die bewährte Methode für Aufgaben mit langer Ausführungsdauer besteht darin, eine Form von Prüfpunkten zu verwenden. In einigen Fällen kann startTask erneut ausgeführt werden, obwohl der Computeknoten nicht neu gestartet wurde. Es sollte besonders darauf geachtet werden, dass StartTasks vermieden werden, die einen Breakaway-Prozess erstellen oder Dienste aus dem StartTask-Arbeitsverzeichnis installieren/starten, da batch dadurch verhindert wird, dass die StartTask erneut ausgeführt werden kann.
startTaskInfo	StartTaskInformation	Laufzeitinformationen zur Ausführung des StartTask auf dem Computeknoten.
state	ComputeNodeState	Der aktuelle Zustand des Computeknotens. Der Computeknoten Spot/Low-Priority wurde vorzeitig entfernt. Aufgaben, die auf dem Computeknoten ausgeführt wurden, als er vorzeitig aufgehoben wurde, werden neu geplant, wenn ein anderer Computeknoten verfügbar wird.
stateTransitionTime	string	Der Zeitpunkt, zu dem der Computeknoten seinen aktuellen Zustand betreten hat.
totalTasksRun	integer	Die Gesamtzahl der Auftragsaufgaben, die auf dem Computeknoten abgeschlossen wurden. Dies umfasst Auftrags-Manager-Aufgaben und normale Aufgaben, aber nicht Auftragsvorbereitung, Auftragsfreigabe oder Startaufgaben.
totalTasksSucceeded	integer	Die Gesamtzahl der Auftragsaufgaben, die erfolgreich (mit exitCode 0) auf dem Computeknoten abgeschlossen wurden. Dies umfasst Auftrags-Manager-Aufgaben und normale Aufgaben, aber nicht Auftragsvorbereitung, Auftragsfreigabe oder Startaufgaben.
url	string	Die URL des Computeknotens.
virtualMachineInfo	VirtualMachineInfo	Informationen zum aktuellen Zustand des virtuellen Computers.
vmSize	string	Die Größe des virtuellen Computers, auf dem der Computeknoten gehostet wird. Informationen zu den verfügbaren Größen virtueller Computer in Pools finden Sie unter Auswählen einer VM-Größe für Computeknoten in einem Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

ComputeNodeEndpointConfiguration

Die Endpunktkonfiguration für den Computeknoten.

Name	Typ	Beschreibung
inboundEndpoints	InboundEndpoint[]	Die Liste der eingehenden Endpunkte, auf die auf dem Computeknoten zugegriffen werden kann.

ComputeNodeError

Ein Fehler, der bei einem Computeknoten aufgetreten ist.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Computeknotenfehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
errorDetails	NameValuePair[]	Die Liste der zusätzlichen Fehlerdetails im Zusammenhang mit dem Computeknotenfehler.
message	string	Eine Meldung, die den Computeknotenfehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

ComputeNodeIdentityReference

Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.

Name	Typ	Beschreibung
resourceId	string	Die ARM-Ressourcen-ID der vom Benutzer zugewiesenen Identität.

ComputeNodeListResult

Das Ergebnis der Auflistung der Computeknoten in einem Pool.

Name	Typ	Beschreibung
odata.nextLink	string	Die URL zum Abrufen der nächsten Gruppe von Ergebnissen.
value	ComputeNode[]	Die Liste der Computeknoten.

ComputeNodeState

Der aktuelle Zustand des Computeknotens.

Name	Typ	Beschreibung
creating	string	Der Batch-Dienst hat den zugrunde liegenden virtuellen Computer von Azure Compute abgerufen, aber noch nicht mit dem Beitritt zum Pool begonnen.
idle	string	Auf dem Computeknoten wird derzeit kein Task ausgeführt.
leavingpool	string	Der Computeknoten verlässt den Pool, entweder weil der Benutzer ihn explizit entfernt hat oder weil der Pool die Größe ändert oder automatisch skaliert.
offline	string	Der Computeknoten führt derzeit keine Aufgabe aus, und die Planung neuer Aufgaben für den Computeknoten ist deaktiviert.
preempted	string	Der Computeknoten Spot/Low-Priority wurde vorzeitig entfernt. Aufgaben, die auf dem Computeknoten ausgeführt wurden, als er vorzeitig aufgehoben wurde, werden neu geplant, wenn ein anderer Computeknoten verfügbar wird.
rebooting	string	Der Computeknoten wird neu gestartet.
reimaging	string	Der Computeknoten wird neu erstellt.
running	string	Der Computeknoten führt eine oder mehrere Tasks (mit Ausnahme eines StartTask) aus.
starting	string	Der Batch-Dienst wird auf dem zugrunde liegenden virtuellen Computer gestartet.
starttaskfailed	string	Der StartTask ist auf dem Computeknoten fehlgeschlagen (und hat alle Wiederholungsversuche erschöpft), und waitForSuccess ist festgelegt. Der Computeknoten kann nicht zum Ausführen von Tasks verwendet werden.
unknown	string	Der Batch-Dienst hat den Kontakt mit dem Computeknoten verloren und kennt seinen wahren Zustand nicht.
unusable	string	Der Computeknoten kann aufgrund von Fehlern nicht für die Aufgabenausführung verwendet werden.
waitingforstarttask	string	StartTask wurde auf dem Computeknoten ausgeführt, aber waitForSuccess ist festgelegt, und startTask ist noch nicht abgeschlossen.

ContainerRegistry

Eine private Containerregistrierung.

Name	Typ	Beschreibung
identityReference	ComputeNodeIdentityReference	Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf eine Azure Container Registry anstelle von Benutzername und Kennwort verwendet werden soll. Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.
password	string	Das Kennwort für die Anmeldung beim Registrierungsserver.
registryServer	string	Die Registrierungs-URL Wenn die Angabe weggelassen wird, ist der Standardwert "docker.io".
username	string	Der Benutzername, der beim Registrierungsserver angemeldet werden soll.

ContainerWorkingDirectory

Der Speicherort des Aufgabenarbeitsverzeichnisses des Containers.

Name	Typ	Beschreibung
containerImageDefault	string	Verwenden Sie das im Containerimage definierte Arbeitsverzeichnis. Beachten Sie, dass dieses Verzeichnis nicht die von Batch heruntergeladenen Ressourcendateien enthält.
taskWorkingDirectory	string	Verwenden Sie das Standardmäßige Batch-Dienstarbeitsverzeichnis Task, das die Aufgabenressourcendateien enthält, die von Batch aufgefüllt werden.

ElevationLevel

Die Höhenstufe des Benutzers.

Name	Typ	Beschreibung
admin	string	Der Benutzer ist ein Benutzer mit erhöhtem Zugriff und arbeitet mit vollständigen Administratorberechtigungen.
nonadmin	string	Der Benutzer ist ein Standardbenutzer ohne erhöhten Zugriff.

EnvironmentSetting

Eine Umgebungsvariable, die für einen Vorgangsvorgang festgelegt werden soll.

Name	Typ	Beschreibung
name	string	Der Name der Umgebungsvariablen.
value	string	Der Wert der Umgebungsvariablen.

ErrorCategory

Die Kategorie des Fehlers.

Name	Typ	Beschreibung
servererror	string	Der Fehler ist auf ein internes Serverproblem zurückzuführen.
usererror	string	Der Fehler ist auf ein Benutzerproblem zurückzuführen, z. B. eine Fehlkonfiguration.

ErrorMessage

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

Name	Typ	Beschreibung
lang	string	Der Sprachcode der Fehlermeldung
value	string	Der Text der Meldung.

ImageReference

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 werden, finden Sie im Vorgang "Unterstützte Bilder auflisten".

Name	Typ	Beschreibung
exactVersion	string	Die spezifische Version des Plattformimages oder Marketplace-Images, das zum Erstellen des Knotens verwendet wird. Dieses schreibgeschützte Feld unterscheidet sich von "version" nur, wenn der Wert für "version" bei der Erstellung des Pools "latest" angegeben wurde.
offer	string	Der Angebotstyp des Azure Virtual Machines Marketplace-Images. Beispiel: UbuntuServer oder WindowsServer.
publisher	string	Der Herausgeber des Azure Virtual Machines Marketplace-Images. Beispiel: Canonical oder MicrosoftWindowsServer.
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. Der Wert "latest" kann angegeben werden, um die neueste Version eines Images auszuwählen. Wenn die Angabe weggelassen wird, ist der Standardwert "latest".
virtualMachineImageId	string	Der ARM-Ressourcenbezeichner des Azure Compute Gallery-Images. Computeknoten im Pool werden mit dieser Image-ID erstellt. Dies hat das Format /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} für immer die neueste Imageversion. Diese Eigenschaft schließt sich mit anderen ImageReference-Eigenschaften gegenseitig aus. Das Azure Compute Gallery-Image muss Über Replikate in derselben Region verfügen und sich im selben Abonnement wie das Azure Batch-Konto befinden. Wenn die Imageversion nicht in der imageId angegeben ist, wird die neueste Version verwendet. Informationen zu den Firewalleinstellungen für den Batch Compute Node-Agent für die Kommunikation mit dem Batch-Dienst finden Sie unter https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpoint

Ein eingehender Endpunkt auf einem Computeknoten.

Name	Typ	Beschreibung
backendPort	integer	Die Back-End-Portnummer des Endpunkts.
frontendPort	integer	Die öffentliche Portnummer des Endpunkts.
name	string	Der Name des Endpunkts.
protocol	InboundEndpointProtocol	Das Protokoll des Endpunkts.
publicFQDN	string	Der öffentliche vollqualifizierte Domänenname für den Computeknoten.
publicIPAddress	string	Die öffentliche IP-Adresse des Computeknotens.

InboundEndpointProtocol

Das Protokoll des Endpunkts.

Name	Typ	Beschreibung
tcp	string	Verwenden Sie TCP für den Endpunkt.
udp	string	Verwenden Sie UDP für den Endpunkt.

NameValuePair

Stellt ein Name-Wert-Paar dar.

Name	Typ	Beschreibung
name	string	Der Name im Name-Wert-Paar.
value	string	Der Wert im Name-Wert-Paar.

NodeAgentInformation

Informationen zum Computeknoten-Agent.

Name	Typ	Beschreibung
lastUpdateTime	string	Der Zeitpunkt, zu dem der Computeknoten-Agent auf dem Computeknoten aktualisiert wurde. Dies ist der letzte Zeitpunkt, zu dem der Computeknoten-Agent auf eine neue Version aktualisiert wurde.
version	string	Die Version des Batch Compute Node-Agents, der auf dem Computeknoten ausgeführt wird. Diese Versionsnummer kann anhand der Versionshinweise des Compute Node-Agents unter https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.mdüberprüft werden.

ResourceFile

Eine einzelne Datei oder mehrere Dateien, die auf einen Computeknoten heruntergeladen werden sollen.

Name	Typ	Beschreibung
autoStorageContainerName	string	Der Name des Speichercontainers im Konto des automatischen Speichers. 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 partieller Dateiname oder ein Unterverzeichnis sein. Wenn kein Präfix angegeben wird, werden alle Dateien im Container heruntergeladen.
fileMode	string	Das Attribut des Dateiberechtigungsmodus im oktalen Format. Diese Eigenschaft gilt nur für Dateien, die auf Linux-Computeknoten heruntergeladen werden. Sie wird ignoriert, wenn sie für eine resourceFile-Datei angegeben wird, die auf einen Windows-Computeknoten heruntergeladen wird. Wenn diese Eigenschaft nicht für einen Linux-Computeknoten angegeben ist, wird der Standardwert 0770 auf die Datei angewendet.
filePath	string	Der Speicherort auf dem Computeknoten, in den die Datei(en) heruntergeladen werden sollen, relativ zum Arbeitsverzeichnis des Tasks. 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 und das Verzeichnis, in das die Dateien heruntergeladen werden sollen, wenn die Eigenschaft autoStorageContainerName oder storageContainerUrl angegeben wird. Für den Fall, dass filePath als Verzeichnis verwendet wird, wird jede Verzeichnisstruktur, die den Eingabedaten bereits zugeordnet ist, vollständig beibehalten und an das angegebene FilePath-Verzeichnis angefügt. Der angegebene relative Pfad kann nicht aus dem Arbeitsverzeichnis der Aufgabe herausbrechen (z. B. mithilfe von "..").
httpUrl	string	Die URL der herunterzuladenden Bilds. Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden. Wenn die URL auf Azure Blob Storage zeigt, muss sie von Computeknoten gelesen werden. Es gibt drei Möglichkeiten, eine solche URL für ein Blob in Azure Storage abzurufen: Beispielsweise eine SAS (Shared Access Signature), die Leseberechtigungen für das Blob gewährt, eine verwaltete Identität mit Leseberechtigung verwenden oder die ACL für das Blob oder seinen Container festlegen, um den öffentlichen Zugriff zuzulassen.
identityReference	ComputeNodeIdentityReference	Der Verweis auf die benutzerseitig zugewiesene Identität, die für den Zugriff auf Azure Blob Storage verwendet werden soll, der durch storageContainerUrl oder httpUrl angegeben wird. Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.
storageContainerUrl	string	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: Beispielsweise eine SAS (Shared Access Signature), 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 festlegen, um den öffentlichen Zugriff zuzulassen.

SchedulingState

Gibt an, ob der Computeknoten für die Aufgabenplanung verfügbar ist.

Name	Typ	Beschreibung
disabled	string	Auf dem Computeknoten werden keine neuen Aufgaben geplant. Aufgaben, die bereits auf dem Computeknoten ausgeführt werden, können noch bis zum Abschluss ausgeführt werden. Alle Computeknoten beginnen mit aktivierter Planung.
enabled	string	Aufgaben können auf dem Computeknoten geplant werden.

StartTask

Eine Aufgabe, die ausgeführt wird, wenn ein Knoten einen Pool im Azure Batch-Dienst hinzuschließt oder wenn der Computeknoten neu gestartet oder ein neuer Image erstellt wird.

Name	Typ	Beschreibung
commandLine	string	Die Befehlszeile von StartTask. Die Befehlszeile wird nicht unter einer Shell ausgeführt und kann daher keine Shellfeatures wie die Erweiterung von Umgebungsvariablen nutzen. Wenn Sie solche 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" unter Linux. Wenn die Befehlszeile auf Dateipfade verweist, sollte sie einen relativen Pfad (relativ zum Arbeitsverzeichnis Task) oder die von Batch bereitgestellte Umgebungsvariable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) verwenden.
containerSettings	TaskContainerSettings	Die Einstellungen für den Container, unter dem startTask ausgeführt wird. Wenn dies angegeben ist, werden alle Verzeichnisse rekursiv unterhalb der AZ_BATCH_NODE_ROOT_DIR (dem Stammverzeichnis der Azure Batch Verzeichnisse auf dem Knoten) dem Container zugeordnet, alle Taskumgebungsvariablen werden dem Container zugeordnet, und die Taskbefehlszeile wird im Container ausgeführt. Dateien, die im Container außerhalb von AZ_BATCH_NODE_ROOT_DIR erstellt werden, werden möglicherweise nicht auf den Hostdatenträger wiedergegeben, was bedeutet, dass Batch-Datei-APIs nicht auf diese Dateien zugreifen können.
environmentSettings	EnvironmentSetting[]	Eine Liste der Umgebungsvariableneinstellungen für startTask.
maxTaskRetryCount	integer	Die maximale Anzahl von Wiederholungsversuchen für den Task. Der Batch-Dienst führt einen Task erneut aus, wenn der Exitcode ungleich null ist. Beachten Sie, dass dieser Wert die Anzahl der Wiederholungen ausdrücklich steuert. Der Batch-Dienst versucht den Task einmal und kann es dann bis zu diesem Grenzwert wiederholen. Wenn die maximale Wiederholungsanzahl beispielsweise 3 beträgt, versucht Batch den Task bis zu 4 Mal (ein erster Versuch und drei Wiederholungen). Wenn die maximale Wiederholungsanzahl 0 ist, führt der Batch-Dienst den Vorgang nicht erneut aus. Wenn die maximale Wiederholungsanzahl -1 beträgt, wiederholt der Batch-Dienst die Aufgabe ohne Beschränkung. Dies wird jedoch nicht für einen Starttask oder einen Vorgang empfohlen. Der Standardwert ist 0 (keine Wiederholungsversuche).
resourceFiles	ResourceFile[]	Eine Liste der Dateien, die vom Batch-Dienst auf den Computeknoten heruntergeladen werden, bevor die Befehlszeile ausgeführt 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. In diesem Fall muss die Sammlung von ResourceFiles verkleinert werden. Dies kann mithilfe von .zip-Dateien, Anwendungspaketen oder Docker-Containern erreicht werden. Dateien, die unter diesem Element aufgeführt sind, befinden sich im Arbeitsverzeichnis des Tasks.
userIdentity	UserIdentity	Die Benutzeridentität, unter der startTask ausgeführt wird. Wenn der Task nicht angegeben wird, wird er als nicht administrativer Benutzer ausgeführt, der für den Task eindeutig ist.
waitForSuccess	boolean	Gibt an, ob der Batch-Dienst warten soll, bis die StartTask erfolgreich abgeschlossen wurde (d. h. das Beenden mit Exitcode 0), bevor Aufgaben auf dem Computeknoten geplant werden. Wenn true und startTask auf einem Knoten fehlschlägt, führt der Batch-Dienst die StartTask erneut auf die maximale Wiederholungsanzahl (maxTaskRetryCount) aus. Wenn der Task nach allen Wiederholungsversuchen immer noch nicht erfolgreich abgeschlossen wurde, markiert der Batch-Dienst den Knoten als unbrauchbar und plant keine Tasks dafür. Diese Bedingung kann über die Details zu Status und Fehlerinformationen des Computeknotens erkannt werden. Bei false wartet der Batch-Dienst nicht auf den Abschluss von StartTask. In diesem Fall können andere Tasks mit der Ausführung auf dem Computeknoten beginnen, während startTask noch ausgeführt wird. Und selbst wenn startTask fehlschlägt, werden neue Tasks weiterhin auf dem Computeknoten geplant. Der Standardwert ist „true“.

StartTaskInformation

Informationen zu einem StartTask, der auf einem Computeknoten ausgeführt wird.

Name	Typ	Beschreibung
containerInfo	TaskContainerExecutionInformation	Informationen zum Container, unter dem der Task ausgeführt wird. Diese Eigenschaft wird nur festgelegt, wenn der Task in einem Containerkontext ausgeführt wird.
endTime	string	Der Zeitpunkt, zu dem die Ausführung von StartTask beendet wurde. Dies ist die Endzeit der letzten Ausführung von StartTask, wenn diese Ausführung abgeschlossen wurde (auch wenn diese Ausführung fehlgeschlagen ist und ein Wiederholungsversuch aussteht). Dieses Element ist nicht vorhanden, wenn startTask derzeit ausgeführt wird.
exitCode	integer	Der Exitcode des Programms, das in der StartTask-Befehlszeile angegeben ist. Diese Eigenschaft wird nur festgelegt, wenn startTask den Status "Abgeschlossen" aufweist. Im Allgemeinen spiegelt der Exitcode für einen Prozess die spezifische Konvention wider, die vom Anwendungsentwickler für diesen Prozess implementiert wurde. Wenn Sie den Exitcodewert verwenden, um Entscheidungen in Ihrem Code zu treffen, sollten Sie sicherstellen, dass Sie die vom Anwendungsprozess verwendete Exitcodekonvention kennen. Wenn der Batch-Dienst jedoch startTask beendet (aufgrund eines Timeouts oder einer Benutzerbeendigung über die API), wird möglicherweise ein vom Betriebssystem definierter Exitcode angezeigt.
failureInfo	TaskFailureInformation	Informationen, die den Vorgangsfehler beschreiben, falls vorhanden. Diese Eigenschaft wird nur festgelegt, wenn sich der Task im Status Abgeschlossen befindet und ein Fehler aufgetreten ist.
lastRetryTime	string	Die letzte Zeit, zu der eine Wiederholung des Tasks ausgeführt wurde. Dieses Element ist nur vorhanden, wenn der Task wiederholt wurde (d. h. retryCount ist ungleich null). Falls vorhanden, entspricht dies in der Regel startTime, kann sich jedoch unterscheiden, wenn der Task aus anderen Gründen als einem Wiederholungsversuch neu gestartet wurde. Wenn beispielsweise der Computeknoten während eines Wiederholungsversuchs neu gestartet wurde, wird startTime aktualisiert, lastRetryTime jedoch nicht.
result	TaskExecutionResult	Das Ergebnis der Taskausführung. Wenn der Wert "failed" lautet, finden Sie die Details des Fehlers in der failureInfo-Eigenschaft.
retryCount	integer	Gibt an, wie oft der Task vom Batch-Dienst wiederholt wurde. Fehler bei Der Aufgabenanwendung (Exitcode ungleich Null) werden wiederholt, Fehler bei der Vorverarbeitung (der Task konnte nicht ausgeführt werden) und Fehler beim Dateiupload werden nicht wiederholt. Der Batch-Dienst versucht den Task bis zu dem durch die Einschränkungen angegebenen Grenzwert.
startTime	string	Der Zeitpunkt, zu dem die StartTask-Ausführung gestartet wurde. Dieser Wert wird jedes Mal zurückgesetzt, wenn die Aufgabe neu gestartet oder wiederholt wird (d. a. dies ist der letzte Zeitpunkt, zu dem die StartTask-Ausführung gestartet wurde).
state	StartTaskState	Der Status von StartTask auf dem Computeknoten.

StartTaskState

Der Status des StartTask auf dem Computeknoten.

Name	Typ	Beschreibung
completed	string	StartTask wurde mit Exitcode 0 beendet, oder der StartTask ist fehlgeschlagen und das Wiederholungslimit wurde erreicht, oder der StartTask-Prozess wurde aufgrund von Fehlern bei der Aufgabenvorbereitung (z. B. Fehler beim Herunterladen von Ressourcendateien) nicht ausgeführt.
running	string	StartTask wird derzeit ausgeführt.

TaskContainerExecutionInformation

Enthält Informationen zum Container, den ein Task ausführt.

Name	Typ	Beschreibung
containerId	string	ID des Containers.
error	string	Detaillierte Fehlerinformationen zum Container. Dies ist die detaillierte Fehlerzeichenfolge des Docker-Diensts, sofern verfügbar. Es entspricht dem von "docker inspect" zurückgegebenen Fehlerfeld.
state	string	Der Status des Containers. Dies ist der Zustand des Containers gemäß dem Docker-Dienst. Es entspricht dem status Feld, das von "docker inspect" zurückgegeben wird.

TaskContainerSettings

Die Containereinstellungen für einen Task.

Name	Typ	Beschreibung
containerRunOptions	string	Zusätzliche Optionen für den Befehl container create. Diese zusätzlichen Optionen werden zusätzlich zu den vom Batch-Dienst gesteuerten Optionen als Argumente für den Befehl "docker create" bereitgestellt.
imageName	string	Das Image, das zum Erstellen des Containers verwendet werden soll, in dem der Task ausgeführt wird. Dies ist der vollständige Imageverweis, wie für "Docker Pull" angegeben wird. Wenn kein Tag als Teil des Imagenamens angegeben wird, wird das Tag ":latest" als Standard verwendet.
registry	ContainerRegistry	Die private Registrierung, die das Containerimage enthält. Diese Einstellung kann weggelassen werden, wenn bereits bei der Poolerstellung angegeben wurde.
workingDirectory	ContainerWorkingDirectory	Der Speicherort des Arbeitsverzeichnisses des Containertasks. Der Standardwert ist "taskWorkingDirectory".

TaskExecutionInformation

Informationen zur Ausführung einer Aufgabe.

Name	Typ	Beschreibung
containerInfo	TaskContainerExecutionInformation	Informationen zum Container, unter dem der Task ausgeführt wird. Diese Eigenschaft wird nur festgelegt, wenn der Task in einem Containerkontext ausgeführt wird.
endTime	string	Der Zeitpunkt, zu dem die Aufgabe abgeschlossen wurde. Diese Eigenschaft wird nur festgelegt, wenn sich die Aufgabe im Status Abgeschlossen befindet.
exitCode	integer	Der Exitcode des Programms, der in der Task-Befehlszeile angegeben ist. Diese Eigenschaft wird nur festgelegt, wenn sich die Aufgabe im Zustand abgeschlossen befindet. Im Allgemeinen spiegelt der Exitcode für einen Prozess die spezifische Konvention wider, die vom Anwendungsentwickler für diesen Prozess implementiert wurde. Wenn Sie den Exitcodewert verwenden, um Entscheidungen in Ihrem Code zu treffen, stellen Sie sicher, dass Sie die vom Anwendungsprozess verwendete Exitcodekonvention kennen. Wenn der Batch-Dienst den Task jedoch beendet (aufgrund eines Timeouts oder einer Benutzerbeendigung über die API), wird möglicherweise ein vom Betriebssystem definierter Exitcode angezeigt.
failureInfo	TaskFailureInformation	Informationen, die den Vorgangsfehler beschreiben, falls vorhanden. Diese Eigenschaft wird nur festgelegt, wenn sich der Task im Zustand abgeschlossen befindet und ein Fehler aufgetreten ist.
lastRequeueTime	string	Der letzte Zeitpunkt, zu dem der Task durch den Batch-Dienst als Ergebnis einer Benutzeranforderung erneut in die Warteschlange gestellt wurde. Diese Eigenschaft wird nur festgelegt, wenn die RequeueCount nonzero ist.
lastRetryTime	string	Der letzte Zeitpunkt, zu dem eine Wiederholung des Tasks ausgeführt wurde. Dieses Element ist nur vorhanden, wenn der Task erneut ausgeführt wurde (d. h. retryCount ist nonzero). Falls vorhanden, ist dies in der Regel identisch mit startTime, kann sich jedoch unterscheiden, wenn der Task aus anderen Gründen als wiederholungsbedingt neu gestartet wurde. Wenn beispielsweise der Computeknoten während eines Wiederholungsversuchs neu gestartet wurde, wird startTime aktualisiert, lastRetryTime jedoch nicht.
requeueCount	integer	Gibt an, wie oft der Task vom Batch-Dienst als Ergebnis einer Benutzeranforderung zurückgefragt wurde. Wenn der Benutzer Computeknoten aus einem Pool entfernt (durch Ändern der Größe/Verkleinerung des Pools) oder wenn der Auftrag deaktiviert wird, kann der Benutzer angeben, dass ausgeführte Tasks auf den Computeknoten für die Ausführung erneut zurückgefragt werden. Mit dieser Anzahl wird nachverfolgt, wie oft die Aufgabe aus diesen Gründen erneut zurückgefragt wurde.
result	TaskExecutionResult	Das Ergebnis der Taskausführung. Wenn der Wert "failed" ist, finden Sie die Details des Fehlers in der failureInfo-Eigenschaft.
retryCount	integer	Die Anzahl der Wiederholungen des Vorgangs durch den Batch-Dienst. Aufgabenanwendungsfehler (Nicht-Null-Exitcode) werden wiederholt, Fehler bei der Vorverarbeitung (der Task konnte nicht ausgeführt werden) und Dateiuploadfehler werden nicht wiederholt. Der Batch-Dienst versucht den Vorgang bis zu dem durch die Einschränkungen angegebenen Grenzwert erneut.
startTime	string	Die Zeit, zu der die Ausführung des Tasks gestartet wurde. "Ausführen" entspricht dem Ausführungszustand. Wenn der Task also Ressourcendateien oder Pakete angibt, gibt die Startzeit den Zeitpunkt an, zu dem der Task mit dem Herunterladen oder Bereitstellen dieser Dateien begonnen hat. Wenn der Task neu gestartet oder erneut ausgeführt wurde, ist dies der letzte Zeitpunkt, zu dem die Ausführung des Tasks gestartet wurde. Diese Eigenschaft ist nur für Aufgaben vorhanden, die sich im Status "Ausgeführt" oder "Abgeschlossen" befinden.

TaskExecutionResult

Das Ergebnis der Aufgabenausführung.

Name	Typ	Beschreibung
failure	string	Während der Verarbeitung der Aufgabe ist ein Fehler aufgetreten. Der Fehler ist möglicherweise aufgetreten, bevor der Vorgangsprozess gestartet wurde, während der Vorgangsprozess ausgeführt wurde oder nachdem der Vorgangsprozess beendet wurde.
success	string	Der Task wurde erfolgreich ausgeführt.

TaskFailureInformation

Informationen zu einem Vorgangsfehler.

Name	Typ	Beschreibung
category	ErrorCategory	Die Kategorie des Vorgangsfehlers.
code	string	Ein Bezeichner für den Vorgangsfehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
details	NameValuePair[]	Eine Liste mit zusätzlichen Details im Zusammenhang mit dem Fehler.
message	string	Eine Meldung, die den Vorgangsfehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

TaskInformation

Informationen zu einem Task, der auf einem Computeknoten ausgeführt wird.

Name	Typ	Beschreibung
executionInfo	TaskExecutionInformation	Informationen zur Ausführung der Aufgabe.
jobId	string	Die ID des Auftrags, zu dem die Aufgabe gehört.
subtaskId	integer	Die ID des Teiltasks, wenn es sich bei der Aufgabe um einen Task mit mehreren instance handelt.
taskId	string	Die ID der Aufgabe.
taskState	TaskState	Der aktuelle Status der Aufgabe.
taskUrl	string	Die URL der Aufgabe.

TaskState

Der Status des Tasks.

Name	Typ	Beschreibung
active	string	Der Task befindet sich in der Warteschlange und kann ausgeführt werden, ist aber derzeit keinem Computeknoten zugewiesen. Ein Task wechselt in diesen Zustand, wenn er erstellt wird, wenn er aktiviert ist, nachdem er deaktiviert wurde, oder wenn er nach einer fehlgeschlagenen Ausführung auf einen Wiederholungsversuch wartet.
completed	string	Der Task kann nicht mehr ausgeführt werden, in der Regel, weil der Task erfolgreich abgeschlossen wurde oder der Task nicht erfolgreich abgeschlossen wurde und sein Wiederholungslimit ausgeschöpft hat. Ein Task wird auch als abgeschlossen markiert, wenn beim Starten der Aufgabe ein Fehler aufgetreten ist oder wenn der Task beendet wurde.
preparing	string	Der Task wurde einem Computeknoten zugewiesen, wartet jedoch auf den Abschluss eines erforderlichen Auftragsvorbereitungstasks auf dem Computeknoten. Wenn der Auftragsvorbereitungstask erfolgreich ist, wird der Task zur Ausführung verschoben. Wenn der Auftragsvorbereitungstask fehlschlägt, wird der Task wieder aktiv und kann einem anderen Computeknoten zugewiesen werden.
running	string	Der Task wird auf einem Computeknoten ausgeführt. Dies schließt die Vorbereitung auf Aufgabenebene ein, z. B. das Herunterladen von Ressourcendateien oder das Bereitstellen von Paketen, die für den Task angegeben sind. Dies bedeutet nicht unbedingt, dass die Taskbefehlszeile mit der Ausführung begonnen hat.

UserIdentity

Die Definition der Benutzeridentität, unter der der Task ausgeführt wird.

Name	Typ	Beschreibung
autoUser	AutoUserSpecification	Der automatische Benutzer, unter dem der Task ausgeführt wird. Die Eigenschaften userName und autoUser schließen sich gegenseitig aus. Sie müssen eine angeben, aber nicht beide.
username	string	Der Name der Benutzeridentität, unter der der Task ausgeführt wird. Die Eigenschaften userName und autoUser schließen sich gegenseitig aus. Sie müssen eine angeben, aber nicht beide.

VirtualMachineInfo

Informationen zum aktuellen Status des virtuellen Computers.

Name	Typ	Beschreibung
imageReference	ImageReference	Der Verweis auf das Marketplace-Image des virtuellen Azure-Computers.
scaleSetVmResourceId	string	Die Ressourcen-ID der aktuellen VM-Skalierungsgruppe des Computeknotens. Wird nur definiert, wenn das Batch-Konto mit der poolAllocationMode-Eigenschaft erstellt wurde, die auf "UserSubscription" festgelegt ist.