Compute Node - Get
Ruft Informationen zum angegebenen Computeknoten ab.
GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?api-version=2024-07-01.20.0
GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?$select={$select}&timeout={timeout}&api-version=2024-07-01.20.0
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
batch
|
path | True |
string |
Die Basis-URL für alle Azure Batch-Dienstanforderungen. |
node
|
path | True |
string |
Die ID des Computeknotens, über den Sie Informationen abrufen möchten. |
pool
|
path | True |
string |
Die ID des Pools, der den Computeknoten enthält. |
api-version
|
query | True |
string |
Client-API-Version. |
$select
|
query |
string |
Eine OData-$select-Klausel. |
|
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 |
Eine Antwort, die den Computeknoten enthält. Header
|
|
Other Status Codes |
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 get
Beispielanforderung
GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z?api-version=2024-07-01.20.0
Beispiel für eine Antwort
{
"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,
"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-22T19:37:28.623369Z"
}
}
Definitionen
Name | Beschreibung |
---|---|
Auto |
Der Bereich für den automatischen Benutzer |
Auto |
Gibt die Parameter für den automatischen Benutzer an, der eine Aufgabe im Batchdienst 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 den das Zertifikat installiert werden soll. |
Certificate |
Welche Benutzerkonten auf dem Computeknoten Zugriff auf die privaten Daten des Zertifikats haben sollen. |
Compute |
Ein Computeknoten im Batchdienst. |
Compute |
Die Endpunktkonfiguration für den Computeknoten. |
Compute |
Fehler eines Computeknotens. |
Compute |
Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet. |
Compute |
Der aktuelle Zustand des Computeknotens. |
Container |
Der Eintrag des Pfad- und Bereitstellungsmodus, den Sie in Aufgabencontainer bereitstellen möchten. |
Container |
Die Pfade, die im Container der Containeraufgabe bereitgestellt werden. |
Container |
Eine private Containerregistrierung. |
Container |
Der Speicherort des Arbeitsverzeichnisses für containeraufgaben. |
Elevation |
Die Höhe des Benutzers. |
Environment |
Eine Umgebungsvariable, die für einen Vorgangsprozess festgelegt werden soll. |
Error |
Die Kategorie des Fehlers. |
Error |
Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde. |
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 wurden, 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 in einen Computeknoten heruntergeladen werden sollen. |
Scheduling |
Gibt an, ob der Computeknoten für die Vorgangsplanung verfügbar ist. |
Start |
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. |
Start |
Informationen zu einem StartTask, der auf einem Computeknoten ausgeführt wird. |
Start |
Der Status der StartTask auf dem Computeknoten. |
Task |
Enthält Informationen zum Container, den eine Aufgabe ausführt. |
Task |
Die Containereinstellungen für eine Aufgabe. |
Task |
Informationen zur Ausführung einer Aufgabe. |
Task |
Das Ergebnis der Aufgabenausführung. |
Task |
Informationen zu einem Vorgangsfehler. |
Task |
Informationen zu einer Aufgabe, die auf einem Computeknoten ausgeführt wird. |
Task |
Der Status des Vorgangs. |
User |
Die Definition der Benutzeridentität, unter der die Aufgabe 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 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 |
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 sollen programmgesteuert genutzt werden. |
message |
Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist. |
|
values |
Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten. |
BatchErrorDetail
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt. |
value |
string |
Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind. |
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 den das Zertifikat installiert werden soll. |
|
storeName |
string |
Der Name des Zertifikatspeichers auf dem Computeknoten, in den 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 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. |
allocationTime |
string |
Die Zeit, zu der dieser Computeknoten dem Pool zugeordnet wurde. |
certificateReferences |
Die Liste der zertifikate, die auf dem Computeknoten installiert sind. 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 erkannt 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 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. |
nodeAgentInfo |
Informationen zur Computeknoten-Agent-Version und zum Zeitpunkt, zu dem der Computeknoten auf eine neue Version aktualisiert wurde. |
|
recentTasks |
Eine Liste der Aufgaben, deren Status kürzlich geändert wurde. |
|
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 |
Gibt an, ob der Computeknoten für die Vorgangsplanung verfügbar ist. |
|
startTask |
Die aufgabe, die für die Ausführung auf dem Computeknoten angegeben ist, während sie dem Pool beitritt. |
|
startTaskInfo |
Laufzeitinformationen zur Ausführung des StartTask auf dem Computeknoten. |
|
state |
Der aktuelle Zustand des Computeknotens. |
|
stateTransitionTime |
string |
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 |
Informationen zum aktuellen Status 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
Fehler eines Computeknotens.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Ein Bezeichner für den Computeknotenfehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden. |
errorDetails |
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. |
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). |
source |
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 |
Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf eine Azure-Containerregistrierung anstelle von Benutzername und Kennwort verwendet werden soll. |
|
password |
string |
Das Kennwort für die Anmeldung beim Registrierungsserver. |
registryServer |
string |
Die Registrierungs-URL. |
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 |
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. |
publisher |
string |
Der Herausgeber des Azure Virtual Machines Marketplace-Images. |
sharedGalleryImageId |
string |
Eindeutiger Bezeichner des freigegebenen Katalogbilds |
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 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. |
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-Computeknoten-Agents, der auf dem Computeknoten ausgeführt wird. |
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. |
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 für den Dateiberechtigungsmodus im oktalen Format. |
filePath |
string |
Der Speicherort auf dem Computeknoten, in den die Datei(n) heruntergeladen werden soll, relativ zum Arbeitsverzeichnis der Aufgabe. |
httpUrl |
string |
Die URL der herunterzuladenden Datei. |
identityReference |
Der Verweis auf die vom Benutzer zugewiesene Identität für den Zugriff auf Azure Blob Storage, 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 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. |
containerSettings |
Die Einstellungen für den Container, unter dem der StartTask ausgeführt wird. |
|
environmentSettings |
Eine Liste der Umgebungsvariableneinstellungen für den StartTask. |
|
maxTaskRetryCount |
integer |
Die maximale Anzahl der Wiederholungsversuche des Vorgangs. |
resourceFiles |
Eine Liste der Dateien, die der Batchdienst vor dem Ausführen der Befehlszeile auf den Computeknoten herunterladen wird. Es gibt eine maximale Größe für die Liste der Ressourcendateien. Wenn die maximale Größe überschritten wird, schlägt die Anforderung fehl, und der Antwortfehlercode lautet "RequestEntityTooLarge". Wenn dies der Fall ist, muss die Sammlung von ResourceFiles in der Größe reduziert werden. Dies kann mithilfe von .zip Dateien, Anwendungspaketen oder Docker-Containern erreicht werden. |
|
userIdentity |
Die Benutzeridentität, unter der der StartTask ausgeführt wird. |
|
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. |
StartTaskInformation
Informationen zu einem StartTask, der auf einem Computeknoten ausgeführt wird.
Name | Typ | Beschreibung |
---|---|---|
containerInfo |
Informationen zum Container, unter dem die Aufgabe ausgeführt wird. |
|
endTime |
string |
Die Zeit, zu der startTask nicht mehr ausgeführt wird. |
exitCode |
integer |
Der Exitcode des Programms, das in der Befehlszeile "StartTask" angegeben ist. |
failureInfo |
Informationen zur Beschreibung des Vorgangsfehlers, falls vorhanden. |
|
lastRetryTime |
string |
Die letzte Zeit, zu der ein Wiederholungsversuche der Aufgabe gestartet wurde. |
result |
Das Ergebnis der Aufgabenausführung. |
|
retryCount |
integer |
Die Anzahl der Wiederholungen des Vorgangs durch den Batchdienst. |
startTime |
string |
Die Uhrzeit, zu der der StartTask gestartet wurde. |
state |
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. |
state |
string |
Der Status des Containers. |
TaskContainerSettings
Die Containereinstellungen für eine Aufgabe.
Name | Typ | Beschreibung |
---|---|---|
containerHostBatchBindMounts |
Die Pfade, die Sie an containeraufgaben bereitstellen möchten. |
|
containerRunOptions |
string |
Zusätzliche Optionen für den Befehl "Container erstellen". |
imageName |
string |
Das Image, das zum Erstellen des Containers verwendet werden soll, in dem die Aufgabe ausgeführt wird. |
registry |
Die private Registrierung, die das Containerimage enthält. |
|
workingDirectory |
Der Speicherort des Arbeitsverzeichnisses für containeraufgaben. |
TaskExecutionInformation
Informationen zur Ausführung einer Aufgabe.
Name | Typ | Beschreibung |
---|---|---|
containerInfo |
Informationen zum Container, unter dem die Aufgabe ausgeführt wird. |
|
endTime |
string |
Der Zeitpunkt, zu dem die Aufgabe abgeschlossen wurde. |
exitCode |
integer |
Der Exitcode des Programms, das in der Befehlszeile "Aufgabe" angegeben ist. |
failureInfo |
Informationen zur Beschreibung des Vorgangsfehlers, falls vorhanden. |
|
lastRequeueTime |
string |
Die letzte Zeit, zu der die Aufgabe vom Batchdienst als Ergebnis einer Benutzeranforderung erneut abgefragt wurde. |
lastRetryTime |
string |
Die letzte Zeit, zu der ein Wiederholungsversuche der Aufgabe gestartet wurde. |
requeueCount |
integer |
Die Häufigkeit, mit der die Aufgabe vom Batchdienst als Ergebnis einer Benutzeranforderung erneut abgefragt wurde. |
result |
Das Ergebnis der Aufgabenausführung. |
|
retryCount |
integer |
Die Anzahl der Wiederholungen des Vorgangs durch den Batchdienst. |
startTime |
string |
Der Zeitpunkt, zu dem die Aufgabe gestartet wurde. |
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 |
Die Kategorie des Vorgangsfehlers. |
|
code |
string |
Ein Bezeichner für den Vorgangsfehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden. |
details |
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 |
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 |
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 |
Der automatische Benutzer, unter dem die Aufgabe ausgeführt wird. |
|
username |
string |
Der Name der Benutzeridentität, unter der die Aufgabe 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 des vm-Skalierungssatzes des Computeknotens. Nur definiert, wenn das Batchkonto mit der poolAllocationMode-Eigenschaft erstellt wurde, die auf "UserSubscription" festgelegt ist. |