Compute Node - List

Dienst:

Batch Service

API-Version:

2024-07-01.20.0

Listet die Computeknoten im angegebenen Pool auf.

GET {batchUrl}/pools/{poolId}/nodes?api-version=2024-07-01.20.0

Mit optionalen Parametern:

GET {batchUrl}/pools/{poolId}/nodes?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.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/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. Maximal 1000 Computeknoten können zurückgegeben werden.
timeout	query		integer int32	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Wenn der Wert größer als 30 ist, wird stattdessen der Standardwert verwendet.

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 Clientanforderungs-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. Header client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Der Fehler vom Batchdienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Authorization

Typ: apiKey
In: header

Beispiele

Node list

Beispielanforderung

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes?api-version=2024-07-01.20.0

Beispiel für eine Antwort

Statuscode:

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 eine Aufgabe im Batchdienst 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 den das Zertifikat installiert werden soll.
CertificateVisibility	Welche Benutzerkonten auf dem Computeknoten Zugriff auf die privaten Daten des Zertifikats haben sollen.
ComputeNode	Ein Computeknoten im Batchdienst.
ComputeNodeEndpointConfiguration	Die Endpunktkonfiguration für den Computeknoten.
ComputeNodeError	Fehler eines Computeknotens.
ComputeNodeIdentityReference	Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.
ComputeNodeListResult	Das Ergebnis der Auflistung der Computeknoten in einem Pool.
ComputeNodeState	Der aktuelle Zustand des Computeknotens.
ContainerHostBatchBindMountEntry	Der Eintrag des Pfad- und Bereitstellungsmodus, den Sie in Aufgabencontainer bereitstellen möchten.
ContainerHostDataPath	Die Pfade, die im Container der Containeraufgabe bereitgestellt werden.
ContainerRegistry	Eine private Containerregistrierung.
ContainerWorkingDirectory	Der Speicherort des Arbeitsverzeichnisses für containeraufgaben.
ElevationLevel	Die Höhe des Benutzers.
EnvironmentSetting	Eine Umgebungsvariable, die für einen Vorgangsprozess festgelegt werden soll.
ErrorCategory	Die Kategorie des Fehlers.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
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 wurden, 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 in einen Computeknoten heruntergeladen werden sollen.
SchedulingState	Gibt an, ob der Computeknoten für die Vorgangsplanung verfügbar ist.
StartTask	Eine Aufgabe, die ausgeführt wird, wenn ein Knoten einem Pool im Azure Batch-Dienst beitritt oder wenn der Computeknoten neu gestartet oder umimages erstellt wird.
StartTaskInformation	Informationen zu einem StartTask, der auf einem Computeknoten ausgeführt wird.
StartTaskState	Der Status der StartTask auf dem Computeknoten.
TaskContainerExecutionInformation	Enthält Informationen zum Container, den eine Aufgabe ausführt.
TaskContainerSettings	Die Containereinstellungen für eine Aufgabe.
TaskExecutionInformation	Informationen zur Ausführung einer Aufgabe.
TaskExecutionResult	Das Ergebnis der Aufgabenausführung.
TaskFailureInformation	Informationen zu einem Vorgangsfehler.
TaskInformation	Informationen zu einer Aufgabe, die auf einem Computeknoten ausgeführt wird.
TaskState	Der Status des Vorgangs.
UserIdentity	Die Definition der Benutzeridentität, unter der die Aufgabe 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 die Aufgabe 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 die Aufgabe erstellen soll.

AutoUserSpecification

Gibt die Parameter für den automatischen Benutzer an, der eine Aufgabe im Batchdienst 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 der Pool Windows ausführt, sollte ein Wert der Aufgabe angegeben werden, wenn eine strengere Isolierung zwischen Vorgängen erforderlich ist. Wenn die Aufgabe beispielsweise die Registrierung auf eine Weise stummschaltet, die sich auf andere Aufgaben auswirken könnte, oder wenn Zertifikate auf dem Pool angegeben wurden, auf die nicht durch normale Aufgaben zugegriffen werden sollte, aber von StartTasks zugänglich sein sollte.

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	ErrorMessage	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
values	BatchErrorDetail[]	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.

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 den das Zertifikat installiert werden soll. Der Standardwert ist currentuser. Diese Eigenschaft gilt nur für Pools, die mit Windows Compute Nodes konfiguriert sind. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis im Arbeitsverzeichnis "Aufgabe" gespeichert, und eine Umgebungsvariable AZ_BATCH_CERTIFICATES_DIR wird der Aufgabe bereitgestellt, um diesen Speicherort abzufragen. Für Zertifikate mit Sichtbarkeit von 'remoteUser' wird ein Verzeichnis "certs" im Startverzeichnis des Benutzers erstellt (z. B. /home/{user-name}/certs) und Zertifikate in diesem Verzeichnis platziert.
storeName	string	Der Name des Zertifikatspeichers auf dem Computeknoten, in den das Zertifikat installiert werden soll. Diese Eigenschaft gilt nur für Pools, die mit Windows Compute Nodes konfiguriert sind. Allgemeine Store-Namen sind: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. Der Standardwert ist "Mein".
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 in dieser Sammlung mehr als eine Sichtbarkeit angeben. Der Standardwert ist alle Konten.

CertificateStoreLocation

Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in den 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 Zugriff auf die privaten Daten des Zertifikats haben sollen.

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 startTask ausgeführt wird. Beachten Sie, dass dieses Zertifikat auch für die Aufgabe sichtbar ist, wenn der Bereich "AutoUser" sowohl für den StartTask als auch für einen Vorgang vorhanden ist.
task	string	Das Zertifikat sollte für die Benutzerkonten sichtbar sein, unter denen Auftragsaufgaben ausgeführt werden.

ComputeNode

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	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.
certificateReferences	CertificateReference[]	Die Liste der zertifikate, die auf dem Computeknoten installiert sind. Für Windows-Knoten installiert der Batchdienst die Zertifikate im angegebenen Zertifikatspeicher und -speicherort. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis im Arbeitsverzeichnis "Aufgabe" gespeichert, und eine Umgebungsvariable AZ_BATCH_CERTIFICATES_DIR wird der Aufgabe bereitgestellt, um diesen Speicherort abzufragen. Für Zertifikate mit Sichtbarkeit von 'remoteUser' wird ein Verzeichnis "certs" im Startverzeichnis des Benutzers erstellt (z. B. /home/{user-name}/certs) und Zertifikate 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 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.
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	Das letzte Mal, zu dem der Computeknoten gestartet wurde. Diese Eigenschaft ist möglicherweise nicht vorhanden, wenn der Computeknotenstatus nicht verwendet werden kann.
nodeAgentInfo	NodeAgentInformation	Informationen zur Computeknoten-Agent-Version und zum Zeitpunkt, zu dem der Computeknoten auf eine neue Version aktualisiert wurde. Der Batch-Computeknoten-Agent ist ein Programm, das auf jedem Computeknoten im Pool ausgeführt wird und Batchfunktionen auf dem Computeknoten bereitstellt.
recentTasks	TaskInformation[]	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	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	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	SchedulingState	Gibt an, ob der Computeknoten für die Vorgangsplanung verfügbar ist.
startTask	StartTask	Die aufgabe, die für die Ausführung auf dem Computeknoten angegeben ist, während sie 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 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.
startTaskInfo	StartTaskInformation	Laufzeitinformationen zur Ausführung des StartTask auf dem Computeknoten.
state	ComputeNodeState	Der aktuelle Zustand des Computeknotens. 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.
stateTransitionTime	string	Die Uhrzeit, zu der der Computeknoten seinen aktuellen Zustand eingegeben hat.
totalTasksRun	integer	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	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	Die URL des Computeknotens.
virtualMachineInfo	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://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

Fehler eines Computeknotens.

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

ComputeNodeIdentityReference

Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool 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, um den nächsten Satz von Ergebnissen abzurufen.
value	ComputeNode[]	Die Liste der Computeknoten.

ComputeNodeState

Der aktuelle Zustand des Computeknotens.

Name	Typ	Beschreibung
creating	string	Der Batchdienst hat den zugrunde liegenden virtuellen Computer von Azure Compute abgerufen, aber er hat noch nicht begonnen, dem Pool beizutreten.
deallocated	string	Der Computeknoten wird abgeglichen.
deallocating	string	Der Computeknoten wird behandelt.
idle	string	Der Computeknoten wird derzeit keine Aufgabe ausgeführt.
leavingpool	string	Der Computeknoten verlässt den Pool, entweder weil der Benutzer ihn explizit entfernt hat oder weil die Größe des Pools geändert oder automatisch skaliert wird.
offline	string	Der Computeknoten wird derzeit nicht ausgeführt, und die Planung neuer Aufgaben für den Computeknoten ist deaktiviert.
preempted	string	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.
rebooting	string	Der Computeknoten wird neu gestartet.
reimaging	string	Der Computeknoten wird neu gestaltet.
running	string	Der Computeknoten führt einen oder mehrere Aufgaben (außer einem StartTask) aus.
starting	string	Der Batchdienst wird auf dem zugrunde liegenden virtuellen Computer gestartet.
starttaskfailed	string	Der StartTask ist für den Computeknoten (und alle Wiederholungen erschöpft) fehlgeschlagen, und waitForSuccess wird festgelegt. Der Computeknoten kann nicht zum Ausführen von Aufgaben verwendet werden.
unknown	string	Der Batchdienst hat den Kontakt mit dem Computeknoten verloren und weiß nicht den tatsächlichen Zustand.
unusable	string	Der Computeknoten kann aufgrund von Fehlern nicht für die Ausführung der Aufgabe verwendet werden.
upgradingos	string	Der Computeknoten wird einem Betriebssystemupgradevorgang unterzogen.
waitingforstarttask	string	Der StartTask wurde auf dem Computeknoten ausgeführt, aber waitForSuccess ist festgelegt und der StartTask wurde noch nicht abgeschlossen.

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	ContainerHostDataPath	Der Pfad, der für containerkunden bereitgestellt werden kann.

ContainerHostDataPath

Die Pfade, die im Container der Containeraufgabe bereitgestellt werden.

Name	Typ	Beschreibung
Applications	string	Der Anwendungspfad.
JobPrep	string	Der Auftragsvorstellungsvorgangspfad.
Shared	string	Der Pfad für die Aufgabe mit mehreren Instanzen, um ihre Dateien freigegeben zu haben.
Startup	string	Der Pfad für die Startaufgabe.
Task	string	Der Vorgangspfad.
VfsMounts	string	Der Pfad enthält alle virtuellen Dateisysteme, die auf diesem Knoten bereitgestellt werden.

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-Containerregistrierung anstelle von Benutzername und Kennwort verwendet werden soll. Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.
password	string	Das Kennwort für die Anmeldung beim Registrierungsserver.
registryServer	string	Die Registrierungs-URL. Wenn nicht angegeben, lautet der Standardwert "docker.io".
username	string	Der Benutzername, der sich beim Registrierungsserver anmeldet.

ContainerWorkingDirectory

Der Speicherort des Arbeitsverzeichnisses für containeraufgaben.

Name	Typ	Beschreibung
containerImageDefault	string	Verwenden Sie das im Containerimage definierte Arbeitsverzeichnis. Achten Sie darauf, dass dieses Verzeichnis die von Batch heruntergeladenen Ressourcendateien nicht enthält.
taskWorkingDirectory	string	Verwenden Sie das standardmäßige Arbeitsverzeichnis "Batchdienstaufgaben", das die Vorgangsressourcendateien enthält, die von Batch aufgefüllt werden.

ElevationLevel

Die Höhe 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 Vorgangsprozess festgelegt werden soll.

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

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 wurde.

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

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

Name	Typ	Beschreibung
communityGalleryImageId	string	Eindeutiger Bezeichner des Communitykatalogbilds 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 Plattformimages oder Marketplace-Images, das zum Erstellen des Knotens verwendet wird. Dieses schreibgeschützte Feld unterscheidet sich nur dann von "Version", wenn der für "Version" angegebene Wert beim Erstellen des Pools "latest" lautet.
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.
sharedGalleryImageId	string	Eindeutiger Bezeichner des freigegebenen Katalogbilds 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 von "latest" kann angegeben werden, um die neueste Version eines Bilds auszuwählen. Wenn dieser Wert nicht angegeben wird, lautet der Standardwert "latest".
virtualMachineImageId	string	Der ARM-Ressourcenbezeichner des Azure Compute Gallery Image. Computeknoten im Pool werden mithilfe dieser Image-ID erstellt. Dies ist das Formular /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} oder /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} für immer die neueste Bildversion. Diese Eigenschaft schließt sich gegenseitig mit anderen ImageReference-Eigenschaften aus. Das Azure Compute Gallery Image muss Replikate in derselben Region aufweisen und muss sich im selben Abonnement wie das Azure Batch-Konto befinden. Wenn die Bildversion in der imageId nicht angegeben ist, wird die neueste Version verwendet. Informationen zu den Firewalleinstellungen für den Batch-Computeknoten-Agent für die Kommunikation mit dem Batchdienst finden Sie unter https://docs.microsoft.com/azure/batch/nodes-and-pools#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 die neueste Zeit, zu der der Computeknoten-Agent auf eine neue Version aktualisiert wurde.
version	string	Die Version des Batch-Computeknoten-Agents, der auf dem Computeknoten ausgeführt wird. Diese Versionsnummer kann anhand der Versionshinweise des Compute Node-Agents überprüft werden, die sich in https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.mdbefinden.

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-Computeknoten heruntergeladen werden. Sie wird ignoriert, wenn sie für eine resourceFile angegeben wird, die in einen Windows Compute Node heruntergeladen wird. Wenn diese Eigenschaft für einen Linux-Computeknoten nicht angegeben ist, wird auf die Datei ein Standardwert von 0770 angewendet.
filePath	string	Der Speicherort auf dem Computeknoten, in den die Datei(n) heruntergeladen werden soll, relativ zum Arbeitsverzeichnis der Aufgabe. 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 des Vorgangs (z. B. mithilfe von '.') herausbrechen.
httpUrl	string	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	ComputeNodeIdentityReference	Der Verweis auf die vom Benutzer zugewiesene Identität für den Zugriff auf Azure Blob Storage, der durch "storageContainerUrl" oder "httpUrl" angegeben wird Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool 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: 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

Gibt an, ob der Computeknoten für die Vorgangsplanung 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 weiterhin abgeschlossen werden. Alle Computeknoten beginnen mit aktivierter Planung.
enabled	string	Vorgänge können auf dem Computeknoten geplant werden.

StartTask

Eine Aufgabe, die ausgeführt wird, wenn ein Knoten einem Pool im Azure Batch-Dienst beitritt oder wenn der Computeknoten neu gestartet oder umimages erstellt wird.

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://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables) verwenden.
containerSettings	TaskContainerSettings	Die Einstellungen für den Container, unter dem der StartTask ausgeführt wird. Wenn dies angegeben wird, werden alle Verzeichnisse rekursiv unterhalb der AZ_BATCH_NODE_ROOT_DIR (der Stamm von Azure Batchverzeichnissen auf dem Knoten) dem Container zugeordnet, alle Taskumgebungsvariablen werden dem Container zugeordnet, und die Task-Befehlszeile wird im Container ausgeführt. Dateien, die im Container außerhalb von AZ_BATCH_NODE_ROOT_DIR erstellt wurden, werden möglicherweise nicht auf den Hostdatenträger wiedergegeben, was bedeutet, dass Batchdatei-APIs nicht auf diese Dateien zugreifen können.
environmentSettings	EnvironmentSetting[]	Eine Liste der Umgebungsvariableneinstellungen für den StartTask.
maxTaskRetryCount	integer	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	ResourceFile[]	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	UserIdentity	Die Benutzeridentität, unter der der StartTask ausgeführt wird. Wenn dies nicht angegeben wird, wird die Aufgabe als nicht administrativer Benutzer ausgeführt, der für die Aufgabe eindeutig 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".

StartTaskInformation

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

Name	Typ	Beschreibung
containerInfo	TaskContainerExecutionInformation	Informationen zum Container, unter dem die Aufgabe ausgeführt wird. Diese Eigenschaft wird nur festgelegt, wenn die Aufgabe in einem Containerkontext ausgeführt wird.
endTime	string	Die Zeit, zu der startTask nicht mehr ausgeführt wird. Dies ist die Endzeit der letzten Ausführung des StartTask, wenn diese Ausführung abgeschlossen ist (auch wenn diese Ausführung fehlgeschlagen ist und ein Wiederholungsvorgang aussteht). Dieses Element ist nicht vorhanden, wenn der StartTask zurzeit ausgeführt wird.
exitCode	integer	Der Exitcode des Programms, das in der Befehlszeile "StartTask" angegeben ist. Diese Eigenschaft wird nur festgelegt, wenn sich der StartTask im abgeschlossenen Zustand befindet. Im Allgemeinen spiegelt der Exitcode für einen Prozess die spezifische Konvention wider, die vom Anwendungsentwickler für diesen Prozess implementiert wird. Wenn Sie den Exit-Codewert verwenden, um Entscheidungen in Ihrem Code zu treffen, stellen Sie sicher, dass Sie die vom Anwendungsprozess verwendete Exit-Codekonvention kennen. Wenn der Batchdienst den StartTask (aufgrund von Timeout oder Benutzerende über die API) beendet, wird möglicherweise ein vom Betriebssystem definierter Exitcode angezeigt.
failureInfo	TaskFailureInformation	Informationen zur Beschreibung des Vorgangsfehlers, falls vorhanden. Diese Eigenschaft wird nur festgelegt, wenn sich der Vorgang im Abgeschlossenen Zustand befindet und ein Fehler aufgetreten ist.
lastRetryTime	string	Die letzte Zeit, zu der ein Wiederholungsversuche der Aufgabe gestartet wurde. Dieses Element ist nur vorhanden, wenn der Vorgang erneut überprüft wurde (d. h. "retryCount" ist "nonzero"). Wenn vorhanden, ist dies in der Regel identisch mit startTime, kann jedoch anders sein, wenn die Aufgabe aus anderen Gründen als der Wiederholung neu gestartet wurde. Wenn beispielsweise der Computeknoten während eines Wiederholungsversuchs neu gestartet wurde, wird die startTime aktualisiert, aber die letzteRetryTime nicht.
result	TaskExecutionResult	Das Ergebnis der Aufgabenausführung. Wenn der Wert "failed" ist, werden die Details des Fehlers in der failureInfo-Eigenschaft gefunden.
retryCount	integer	Die Anzahl der Wiederholungen des Vorgangs durch den Batchdienst. Vorgangsanwendungsfehler (Nicht-Null-Beendigungscode) werden wiederholt, Vorverarbeitungsfehler (die Aufgabe konnte nicht ausgeführt werden) und Dateiuploadfehler werden nicht wiederholt. Der Batchdienst versucht den Vorgang bis zum durch die Einschränkungen angegebenen Grenzwert erneut.
startTime	string	Die Uhrzeit, zu der der StartTask gestartet wurde. Dieser Wert wird jedes Mal zurückgesetzt, wenn die Aufgabe neu gestartet oder wiederholt wird (d. a. dies ist die letzte Zeit, zu der startTask gestartet wurde).
state	StartTaskState	Der Status der StartTask auf dem Computeknoten.

StartTaskState

Der Status der StartTask auf dem Computeknoten.

Name	Typ	Beschreibung
completed	string	Der StartTask wurde mit dem Beendigungscode 0 beendet, oder der StartTask ist fehlgeschlagen, und der Wiederholungsgrenzwert wurde erreicht, oder der StartTask-Prozess wurde aufgrund von Vorgangsvorbereitungsfehlern (z. B. Fehler beim Herunterladen von Ressourcendateien) nicht ausgeführt.
running	string	Der StartTask wird derzeit ausgeführt.

TaskContainerExecutionInformation

Enthält Informationen zum Container, den eine Aufgabe ausführt.

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

TaskContainerSettings

Die Containereinstellungen für eine Aufgabe.

Name	Typ	Beschreibung
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	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 zum Erstellen des Containers verwendet werden soll, in dem die Aufgabe ausgeführt wird. Dies ist der vollständige Imageverweis, wie für "Docker Pull" angegeben. Wenn kein Tag als Teil des Bildnamens 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 sie bereits bei der Poolerstellung bereitgestellt wurde.
workingDirectory	ContainerWorkingDirectory	Der Speicherort des Arbeitsverzeichnisses für containeraufgaben. Der Standardwert ist "taskWorkingDirectory".

TaskExecutionInformation

Informationen zur Ausführung einer Aufgabe.

Name	Typ	Beschreibung
containerInfo	TaskContainerExecutionInformation	Informationen zum Container, unter dem die Aufgabe ausgeführt wird. Diese Eigenschaft wird nur festgelegt, wenn die Aufgabe in einem Containerkontext ausgeführt wird.
endTime	string	Der Zeitpunkt, zu dem die Aufgabe abgeschlossen wurde. Diese Eigenschaft wird nur festgelegt, wenn sich der Vorgang im Status "Abgeschlossen" befindet.
exitCode	integer	Der Exitcode des Programms, das in der Befehlszeile "Aufgabe" angegeben ist. Diese Eigenschaft wird nur festgelegt, wenn sich der Vorgang im abgeschlossenen Zustand befindet. Im Allgemeinen spiegelt der Exitcode für einen Prozess die spezifische Konvention wider, die vom Anwendungsentwickler für diesen Prozess implementiert wird. Wenn Sie den Exit-Codewert verwenden, um Entscheidungen in Ihrem Code zu treffen, stellen Sie sicher, dass Sie die vom Anwendungsprozess verwendete Exit-Codekonvention kennen. Wenn der Batchdienst die Aufgabe (aufgrund eines Timeouts oder einer Benutzerendung über die API) beendet, wird möglicherweise ein vom Betriebssystem definierter Beendigungscode angezeigt.
failureInfo	TaskFailureInformation	Informationen zur Beschreibung des Vorgangsfehlers, falls vorhanden. Diese Eigenschaft wird nur festgelegt, wenn sich der Vorgang im Abgeschlossenen Zustand befindet und ein Fehler aufgetreten ist.
lastRequeueTime	string	Die letzte Zeit, zu der die Aufgabe vom Batchdienst als Ergebnis einer Benutzeranforderung erneut abgefragt wurde. Diese Eigenschaft wird nur festgelegt, wenn "requeueCount" nicht "nonzero" ist.
lastRetryTime	string	Die letzte Zeit, zu der ein Wiederholungsversuche der Aufgabe gestartet wurde. Dieses Element ist nur vorhanden, wenn der Vorgang erneut überprüft wurde (d. h. "retryCount" ist "nonzero"). Wenn vorhanden, ist dies in der Regel identisch mit startTime, kann jedoch anders sein, wenn die Aufgabe aus anderen Gründen als der Wiederholung neu gestartet wurde. Wenn beispielsweise der Computeknoten während eines Wiederholungsversuchs neu gestartet wurde, wird die startTime aktualisiert, aber die letzteRetryTime nicht.
requeueCount	integer	Die Häufigkeit, mit der die Aufgabe vom Batchdienst als Ergebnis einer Benutzeranforderung erneut abgefragt 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 die Ausführung von Aufgaben auf den Computeknoten zur Ausführung erneut abgefragt wird. Diese Anzahl verfolgt, wie oft der Vorgang aus diesen Gründen erneut abgefragt wurde.
result	TaskExecutionResult	Das Ergebnis der Aufgabenausführung. Wenn der Wert "failed" ist, werden die Details des Fehlers in der failureInfo-Eigenschaft gefunden.
retryCount	integer	Die Anzahl der Wiederholungen des Vorgangs durch den Batchdienst. Vorgangsanwendungsfehler (Nicht-Null-Beendigungscode) werden wiederholt, Vorverarbeitungsfehler (die Aufgabe konnte nicht ausgeführt werden) und Dateiuploadfehler werden nicht wiederholt. Der Batchdienst versucht den Vorgang bis zum durch die Einschränkungen angegebenen Grenzwert erneut.
startTime	string	Der Zeitpunkt, zu dem die Aufgabe gestartet wurde. "Ausführen" entspricht dem Ausführungszustand. Wenn der Vorgang also Ressourcendateien oder Pakete angibt, gibt die Startzeit den Zeitpunkt an, zu dem der Vorgang gestartet hat, diese herunterzuladen oder bereitzustellen. Wenn die Aufgabe neu gestartet oder erneut ausgeführt wurde, ist dies der letzte Zeitpunkt, zu dem die Aufgabe gestartet wurde. Diese Eigenschaft ist nur für Aufgaben vorhanden, die sich im Zustand "Ausführen" oder "Abgeschlossen" befinden.

TaskExecutionResult

Das Ergebnis der Aufgabenausführung.

Name	Typ	Beschreibung
failure	string	Fehler bei der Verarbeitung des Vorgangs. Möglicherweise ist der Fehler aufgetreten, bevor der Vorgangsprozess gestartet wurde, während der Aufgabenprozess ausgeführt wurde oder nachdem der Aufgabenvorgang beendet wurde.
success	string	Die Aufgabe 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 sollen programmgesteuert genutzt werden.
details	NameValuePair[]	Eine Liste mit zusätzlichen Details im Zusammenhang mit dem Fehler.
message	string	Eine Meldung zur Beschreibung des Vorgangsfehlers, die für die Anzeige in einer Benutzeroberfläche geeignet ist.

TaskInformation

Informationen zu einer Aufgabe, die 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 der Vorgang gehört.
subtaskId	integer	Die ID des Teilvorgangs, wenn der Vorgang ein Vorgang mit mehreren Instanzen ist.
taskId	string	Die ID des Vorgangs.
taskState	TaskState	Der aktuelle Status des Vorgangs.
taskUrl	string	Die URL der Aufgabe.

TaskState

Der Status des Vorgangs.

Name	Typ	Beschreibung
active	string	Die Aufgabe ist in die Warteschlange eingereiht und kann ausgeführt werden, ist jedoch derzeit keinem Computeknoten zugewiesen. Eine Aufgabe gibt diesen Zustand ein, wenn sie erstellt wird, wenn sie aktiviert ist, nachdem sie deaktiviert wurde, oder wenn sie auf einen Wiederholungsvorgang nach einer fehlgeschlagenen Ausführung wartet.
completed	string	Der Vorgang kann nicht mehr ausgeführt werden, in der Regel weil der Vorgang erfolgreich abgeschlossen wurde oder der Vorgang nicht erfolgreich abgeschlossen wurde und den Wiederholungsgrenzwert erschöpft hat. Eine Aufgabe wird auch als abgeschlossen markiert, wenn beim Starten der Aufgabe ein Fehler aufgetreten ist oder wenn die Aufgabe beendet wurde.
preparing	string	Die Aufgabe wurde einem Computeknoten zugewiesen, wartet jedoch auf eine erforderliche Auftragsvorbereitungsaufgabe auf den Computeknoten. Wenn der Auftragsvorbereitungsvorgang erfolgreich ist, wird der Vorgang in die Ausführung verschoben. Wenn der Auftragsvorbereitungsvorgang fehlschlägt, kehrt der Vorgang wieder zu "Aktiv" zurück und kann einem anderen Computeknoten zugewiesen werden.
running	string	Die Aufgabe wird auf einem Computeknoten ausgeführt. Dies umfasst die Vorbereitung auf Vorgangsebene, z. B. das Herunterladen von Ressourcendateien oder die Bereitstellung von Paketen, die für den Vorgang angegeben sind. Dies bedeutet nicht unbedingt, dass die Befehlszeile "Aufgabe" mit der Ausführung begonnen hat.

UserIdentity

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

Name	Typ	Beschreibung
autoUser	AutoUserSpecification	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	ImageReference	Der Verweis auf das Marketplace-Image des virtuellen Azure-Computers.
scaleSetVmResourceId	string	Die Ressourcen-ID des vm-Skalierungssatzes des Computeknotens. Nur definiert, wenn das Batchkonto mit der poolAllocationMode-Eigenschaft erstellt wurde, die auf "UserSubscription" festgelegt ist.