Compute Node - List
Listet die Computeknoten im angegebenen Pool auf.
GET {batchUrl}/pools/{poolId}/nodes?api-version=2023-11-01.18.0
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 |
---|---|---|---|---|
batch
|
path | True |
string |
Die Basis-URL für alle Azure Batch-Dienstanforderungen. |
pool
|
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 |
Eine Antwort, die die Liste der Computeknoten enthält. Headers
|
|
Other Status Codes |
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
GET account.region.batch.azure.com/pools/poolId/nodes?api-version=2023-11-01.18.0
Sample Response
{
"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 |
---|---|
Auto |
Der Bereich für den automatischen Benutzer |
Auto |
Gibt die Parameter für den automatischen Benutzer an, der einen Task im Batch-Dienst ausführt. |
Batch |
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort. |
Batch |
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind. |
Certificate |
Ein Verweis auf ein Zertifikat, das auf Computeknoten in einem Pool installiert werden soll. |
Certificate |
Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in dem das Zertifikat installiert werden soll. |
Certificate |
Welche Benutzerkonten auf dem Computeknoten sollten Zugriff auf die privaten Daten des Zertifikats haben. |
Compute |
Ein Computeknoten im Batch-Dienst. |
Compute |
Die Endpunktkonfiguration für den Computeknoten. |
Compute |
Ein Fehler, der bei einem Computeknoten aufgetreten ist. |
Compute |
Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet. |
Compute |
Das Ergebnis der Auflistung der Computeknoten in einem Pool. |
Compute |
Der aktuelle Zustand des Computeknotens. |
Container |
Eine private Containerregistrierung. |
Container |
Der Speicherort des Aufgabenarbeitsverzeichnisses des Containers. |
Elevation |
Die Höhenstufe des Benutzers. |
Environment |
Eine Umgebungsvariable, die für einen Vorgangsvorgang festgelegt werden soll. |
Error |
Die Kategorie des Fehlers. |
Error |
Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird. |
Image |
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". |
Inbound |
Ein eingehender Endpunkt auf einem Computeknoten. |
Inbound |
Das Protokoll des Endpunkts. |
Name |
Stellt ein Name-Wert-Paar dar. |
Node |
Informationen zum Computeknoten-Agent. |
Resource |
Eine einzelne Datei oder mehrere Dateien, die auf einen Computeknoten heruntergeladen werden sollen. |
Scheduling |
Gibt an, ob der Computeknoten für die Aufgabenplanung verfügbar ist. |
Start |
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. |
Start |
Informationen zu einem StartTask, der auf einem Computeknoten ausgeführt wird. |
Start |
Der Status des StartTask auf dem Computeknoten. |
Task |
Enthält Informationen zum Container, den ein Task ausführt. |
Task |
Die Containereinstellungen für einen Task. |
Task |
Informationen zur Ausführung einer Aufgabe. |
Task |
Das Ergebnis der Aufgabenausführung. |
Task |
Informationen zu einem Vorgangsfehler. |
Task |
Informationen zu einem Task, der auf einem Computeknoten ausgeführt wird. |
Task |
Der Status des Tasks. |
User |
Die Definition der Benutzeridentität, unter der der Task ausgeführt wird. |
Virtual |
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 |
Die Höhenstufe des automatischen Benutzers. |
|
scope |
Der Bereich für den automatischen Benutzer |
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 |
Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
|
values |
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 |
Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in dem das Zertifikat installiert werden soll. |
|
storeName |
string |
Der Name des Zertifikatspeichers auf dem Computeknoten, in dem das Zertifikat installiert werden soll. |
thumbprint |
string |
Der Fingerabdruck des Zertifikats. |
thumbprintAlgorithm |
string |
Der Algorithmus, dem der Fingerabdruck zugeordnet ist. Dies muss sha1 sein. |
visibility |
Welche Benutzerkonten auf dem Computeknoten Zugriff auf die privaten Daten des Zertifikats haben sollen. |
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. |
allocationTime |
string |
Die Zeit, zu der dieser Computeknoten dem Pool zugewiesen wurde. |
certificateReferences |
Die Liste der auf dem Computeknoten installierten Zertifikate. Warnung: Diese Eigenschaft ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung . |
|
endpointConfiguration |
Die Endpunktkonfiguration für den Computeknoten. |
|
errors |
Die Liste der Fehler, die derzeit vom Computeknoten gefunden werden. |
|
id |
string |
Die ID des Computeknotens. |
ipAddress |
string |
Die IP-Adresse, die andere Knoten für die Kommunikation mit diesem Computeknoten verwenden können. |
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. |
nodeAgentInfo |
Informationen zur Compute Node-Agent-Version und zum Zeitpunkt des Upgrades des Computeknotens auf eine neue Version. |
|
recentTasks |
Eine Liste von Aufgaben, deren Status sich kürzlich geändert hat. |
|
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 |
Gibt an, ob der Computeknoten für die Aufgabenplanung verfügbar ist. |
|
startTask |
Der Task, der für die Ausführung auf dem Computeknoten angegeben ist, während er dem Pool beitritt. |
|
startTaskInfo |
Laufzeitinformationen zur Ausführung des StartTask auf dem Computeknoten. |
|
state |
Der aktuelle Zustand des Computeknotens. |
|
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 |
Informationen zum aktuellen Zustand des virtuellen Computers. |
|
vmSize |
string |
Die Größe des virtuellen Computers, auf dem der Computeknoten gehostet wird. |
ComputeNodeEndpointConfiguration
Die Endpunktkonfiguration für den Computeknoten.
Name | Typ | Beschreibung |
---|---|---|
inboundEndpoints |
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 |
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 |
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 |
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. |
|
password |
string |
Das Kennwort für die Anmeldung beim Registrierungsserver. |
registryServer |
string |
Die Registrierungs-URL |
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. |
publisher |
string |
Der Herausgeber des Azure Virtual Machines Marketplace-Images. |
sku |
string |
Die SKU des Azure Virtual Machines Marketplace-Images. |
version |
string |
Die Version des Azure Virtual Machines Marketplace-Images. |
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. |
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 |
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. |
version |
string |
Die Version des Batch Compute Node-Agents, der auf dem Computeknoten ausgeführt wird. |
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. |
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. |
fileMode |
string |
Das Attribut des Dateiberechtigungsmodus im oktalen Format. |
filePath |
string |
Der Speicherort auf dem Computeknoten, in den die Datei(en) heruntergeladen werden sollen, relativ zum Arbeitsverzeichnis des Tasks. |
httpUrl |
string |
Die URL der herunterzuladenden Bilds. |
identityReference |
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. |
|
storageContainerUrl |
string |
Die URL des Blobcontainers in Azure Blob Storage. |
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. |
containerSettings |
Die Einstellungen für den Container, unter dem startTask ausgeführt wird. |
|
environmentSettings |
Eine Liste der Umgebungsvariableneinstellungen für startTask. |
|
maxTaskRetryCount |
integer |
Die maximale Anzahl von Wiederholungsversuchen für den Task. |
resourceFiles |
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. |
|
userIdentity |
Die Benutzeridentität, unter der startTask ausgeführt wird. |
|
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. |
StartTaskInformation
Informationen zu einem StartTask, der auf einem Computeknoten ausgeführt wird.
Name | Typ | Beschreibung |
---|---|---|
containerInfo |
Informationen zum Container, unter dem der Task ausgeführt wird. |
|
endTime |
string |
Der Zeitpunkt, zu dem die Ausführung von StartTask beendet wurde. |
exitCode |
integer |
Der Exitcode des Programms, das in der StartTask-Befehlszeile angegeben ist. |
failureInfo |
Informationen, die den Vorgangsfehler beschreiben, falls vorhanden. |
|
lastRetryTime |
string |
Die letzte Zeit, zu der eine Wiederholung des Tasks ausgeführt wurde. |
result |
Das Ergebnis der Taskausführung. |
|
retryCount |
integer |
Gibt an, wie oft der Task vom Batch-Dienst wiederholt wurde. |
startTime |
string |
Der Zeitpunkt, zu dem die StartTask-Ausführung gestartet wurde. |
state |
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. |
state |
string |
Der Status des Containers. |
TaskContainerSettings
Die Containereinstellungen für einen Task.
Name | Typ | Beschreibung |
---|---|---|
containerRunOptions |
string |
Zusätzliche Optionen für den Befehl container create. |
imageName |
string |
Das Image, das zum Erstellen des Containers verwendet werden soll, in dem der Task ausgeführt wird. |
registry |
Die private Registrierung, die das Containerimage enthält. |
|
workingDirectory |
Der Speicherort des Arbeitsverzeichnisses des Containertasks. |
TaskExecutionInformation
Informationen zur Ausführung einer Aufgabe.
Name | Typ | Beschreibung |
---|---|---|
containerInfo |
Informationen zum Container, unter dem der Task ausgeführt wird. |
|
endTime |
string |
Der Zeitpunkt, zu dem die Aufgabe abgeschlossen wurde. |
exitCode |
integer |
Der Exitcode des Programms, der in der Task-Befehlszeile angegeben ist. |
failureInfo |
Informationen, die den Vorgangsfehler beschreiben, falls vorhanden. |
|
lastRequeueTime |
string |
Der letzte Zeitpunkt, zu dem der Task durch den Batch-Dienst als Ergebnis einer Benutzeranforderung erneut in die Warteschlange gestellt wurde. |
lastRetryTime |
string |
Der letzte Zeitpunkt, zu dem eine Wiederholung des Tasks ausgeführt wurde. |
requeueCount |
integer |
Gibt an, wie oft der Task vom Batch-Dienst als Ergebnis einer Benutzeranforderung zurückgefragt wurde. |
result |
Das Ergebnis der Taskausführung. |
|
retryCount |
integer |
Die Anzahl der Wiederholungen des Vorgangs durch den Batch-Dienst. |
startTime |
string |
Die Zeit, zu der die Ausführung des Tasks gestartet wurde. |
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 |
Die Kategorie des Vorgangsfehlers. |
|
code |
string |
Ein Bezeichner für den Vorgangsfehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden. |
details |
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 |
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 |
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 |
Der automatische Benutzer, unter dem der Task ausgeführt wird. |
|
username |
string |
Der Name der Benutzeridentität, unter der der Task ausgeführt wird. |
VirtualMachineInfo
Informationen zum aktuellen Status des virtuellen Computers.
Name | Typ | Beschreibung |
---|---|---|
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. |