Pool - Patch

Dienst:

Batch Service

API-Version:

2023-11-01.18.0

Updates die Eigenschaften des angegebenen Pools.
Dadurch werden nur die Pooleigenschaften ersetzt, die in der Anforderung angegeben sind. Wenn dem Pool beispielsweise ein StartTask zugeordnet ist und eine Anforderung kein StartTask-Element angibt, behält der Pool den vorhandenen StartTask bei.

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

Mit optionalen Parametern:

PATCH {batchUrl}/pools/{poolId}?timeout={timeout}&api-version=2023-11-01.18.0

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
batchUrl	path	True	string	Die Basis-URL für alle Azure Batch-Dienstanforderungen.
poolId	path	True	string	Die ID des zu aktualisierenden Pools.
api-version	query	True	string	Client-API-Version.
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 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. explizit festlegen, wenn Sie die REST-API direkt aufrufen.
If-Match		string	Ein ETag-Wert, der der Version der Ressource zugeordnet ist, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn das aktuelle ETag der Ressource für den Dienst genau dem vom Client angegebenen Wert entspricht.
If-None-Match		string	Ein ETag-Wert, der der Version der Ressource zugeordnet ist, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn das aktuelle ETag der Ressource für den Dienst nicht mit dem vom Client angegebenen Wert übereinstimmt.
If-Modified-Since		string date-time-rfc1123	Ein Zeitstempel, der den Zeitpunkt der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource im Dienst seit der angegebenen Zeit geändert wurde.
If-Unmodified-Since		string date-time-rfc1123	Ein Zeitstempel, der den Zeitpunkt der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource im Dienst seit der angegebenen Zeit nicht mehr geändert wurde.

Anforderungstext

Media Types: "application/json; odata=minimalmetadata"

Name	Typ	Beschreibung
applicationPackageReferences	ApplicationPackageReference[]	Eine Liste der Pakete, die auf jedem Computeknoten im Pool installiert werden sollen. Änderungen an Paketverweise wirken sich auf alle neuen Knoten aus, die dem Pool beitreten, aber nicht auf Computeknoten, die sich bereits im Pool befinden, bis sie neu gestartet oder neu erstellt werden. Wenn dieses Element vorhanden ist, ersetzt es alle vorhandenen Package-Verweise. Wenn Sie eine leere Auflistung angeben, werden alle Paketverweise aus dem Pool entfernt. Wenn nicht angegeben, bleiben alle vorhandenen Paketverweise unverändert.
certificateReferences	CertificateReference[]	Eine Liste der Zertifikate, die auf jedem Computeknoten im Pool installiert werden sollen. Wenn dieses Element vorhanden ist, ersetzt es alle vorhandenen Zertifikatverweise, die im Pool konfiguriert sind. Wenn nicht angegeben, bleiben alle vorhandenen Zertifikatverweise unverändert. Für Windows-Knoten installiert der Batch-Dienst die Zertifikate im angegebenen Zertifikatspeicher und Speicherort. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis innerhalb des Arbeitsverzeichnisses Task gespeichert, und eine Umgebungsvariable, AZ_BATCH_CERTIFICATES_DIR für den Task bereitgestellt wird, um diesen Speicherort abzufragen. Bei Zertifikaten mit sichtbarkeit von "remoteUser" wird im Basisverzeichnis des Benutzers (z. B. /home/{benutzername}/certs) ein Verzeichnis "certs" erstellt, und Zertifikate werden in diesem Verzeichnis platziert. Warnung: Diese Eigenschaft ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung .
metadata	MetadataItem[]	Eine Liste von Name-Wert-Paaren, die dem Pool als Metadaten zugeordnet sind. Wenn dieses Element vorhanden ist, werden alle vorhandenen Metadaten ersetzt, die im Pool konfiguriert sind. Wenn Sie eine leere Auflistung angeben, werden alle Metadaten aus dem Pool entfernt. Wenn sie weggelassen werden, bleiben alle vorhandenen Metadaten unverändert.
startTask	StartTask	Ein Task, der auf jedem Computeknoten ausgeführt werden soll, während er dem Pool beitritt. Der Task wird ausgeführt, wenn der Computeknoten dem Pool hinzugefügt wird oder wenn der Computeknoten neu gestartet wird. Wenn dieses Element vorhanden ist, überschreibt es alle vorhandenen StartTask-Elemente. Wenn sie nicht angegeben wird, bleibt die vorhandene StartTask unverändert.
targetNodeCommunicationMode	NodeCommunicationMode	Der gewünschte Knotenkommunikationsmodus für den Pool. Wenn dieses Element vorhanden ist, ersetzt es den vorhandenen targetNodeCommunicationMode, der im Pool konfiguriert ist. Wenn sie weggelassen werden, bleiben alle vorhandenen Metadaten unverändert.

Antworten

Name	Typ	Beschreibung
200 OK		Die Anforderung an den Batch-Dienst war erfolgreich. Header client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Der Fehler vom Batch-Dienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodeflow

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

Patch the Pool

Beispielanforderung

HTTP

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



{
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'"
  }
}

Beispiel für eine Antwort

Statuscode:

200

Definitionen

Name	Beschreibung
ApplicationPackageReference	Ein Verweis auf ein Paket, das auf Computeknoten bereitgestellt werden soll.
AutoUserScope	Der Bereich für den automatischen Benutzer
AutoUserSpecification	Gibt die Parameter für den automatischen Benutzer an, der einen Task im Batch-Dienst ausführt.
BatchError	Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail	Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.
CertificateReference	Ein Verweis auf ein Zertifikat, das auf Computeknoten in einem Pool installiert werden soll.
CertificateStoreLocation	Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in dem das Zertifikat installiert werden soll.
CertificateVisibility	Welche Benutzerkonten auf dem Computeknoten sollten Zugriff auf die privaten Daten des Zertifikats haben.
ComputeNodeIdentityReference	Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.
ContainerRegistry	Eine private Containerregistrierung.
ContainerWorkingDirectory	Der Speicherort des Arbeitsverzeichnisses des Containertasks.
ElevationLevel	Die Höhenebene des Benutzers.
EnvironmentSetting	Eine Umgebungsvariable, die für einen Vorgangsvorgang festgelegt werden soll.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.
MetadataItem	Ein Name-Wert-Paar, das einer Batch-Dienstressource zugeordnet ist.
NodeCommunicationMode	Bestimmt, wie ein Pool mit dem Batch-Dienst kommuniziert.
PoolPatchParameter	Der Satz von Änderungen, die an einem Pool vorgenommen werden sollen.
ResourceFile	Eine einzelne Datei oder mehrere Dateien, die auf einen Computeknoten heruntergeladen werden sollen.
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 neu erstellt wird.
TaskContainerSettings	Die Containereinstellungen für einen Task.
UserIdentity	Die Definition der Benutzeridentität, unter der der Task ausgeführt wird.

ApplicationPackageReference

Ein Verweis auf ein Paket, das auf Computeknoten bereitgestellt werden soll.

Name	Typ	Beschreibung
applicationId	string	Die ID der anwendung, die bereitgestellt werden soll. Beim Erstellen eines Pools muss die Anwendungs-ID des Pakets voll qualifiziert sein (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Die Version der anwendung, die bereitgestellt werden soll. Wenn nicht angegeben, wird die Standardversion bereitgestellt. Wenn dies in einem Pool ausgelassen wird und keine Standardversion für diese Anwendung angegeben ist, schlägt die Anforderung mit dem Fehlercode InvalidApplicationPackageReferences und HTTP status Code 409 fehl. Wenn dies für einen Task ausgelassen wird und keine Standardversion für diese Anwendung angegeben ist, schlägt der Task mit einem Vorverarbeitungsfehler fehl.

AutoUserScope

Der Bereich für den automatischen Benutzer

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

AutoUserSpecification

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

Name	Typ	Beschreibung
elevationLevel	ElevationLevel	Die Höhenebene des automatischen Benutzers. Der Standardwert ist nonAdmin.
scope	AutoUserScope	Der Bereich für den automatischen Benutzer Der Standardwert ist pool. Wenn im Pool Windows ausgeführt wird, sollte ein Wert von Task angegeben werden, wenn eine strengere Isolation zwischen Aufgaben erforderlich ist. Beispielsweise, wenn die Aufgabe die Registrierung auf eine Weise mutiert, die sich auf andere Aufgaben auswirken könnte, oder wenn Zertifikate für den Pool angegeben wurden, auf die nicht für normale Aufgaben zugegriffen werden sollte, sondern 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 sollten programmgesteuert verwendet werden.
message	ErrorMessage	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
values	BatchErrorDetail[]	Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthält.

BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.

Name	Typ	Beschreibung
key	string	Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt.
value	string	Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind.

CertificateReference

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

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

CertificateStoreLocation

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

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

CertificateVisibility

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

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

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 benutzerseitig zugewiesenen Identität.

ContainerRegistry

Eine private Containerregistrierung.

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

ContainerWorkingDirectory

Der Speicherort des Arbeitsverzeichnisses des Containertasks.

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 Batch-Diensttask, das die Aufgabenressourcendateien enthält, die von Batch aufgefüllt werden.

ElevationLevel

Die Höhenebene 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.

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.

MetadataItem

Ein Name-Wert-Paar, das einer Batch-Dienstressource zugeordnet ist.

Name	Typ	Beschreibung
name	string	Der Name des Metadatenelements.
value	string	Der Wert des Metadatenelements.

NodeCommunicationMode

Bestimmt, wie ein Pool mit dem Batch-Dienst kommuniziert.

Name	Typ	Beschreibung
classic	string	Knoten, die den klassischen Kommunikationsmodus verwenden, erfordern eingehende TCP-Kommunikation an den Ports 29876 und 29877 von "BatchNodeManagement. {region}"-Diensttag und ausgehende TCP-Kommunikation an Port 443 an "Storage.region" und "BatchNodeManagement". {region}"-Diensttags.
default	string	Der Knotenkommunikationsmodus wird automatisch vom Batch-Dienst festgelegt.
simplified	string	Knoten, die den vereinfachten Kommunikationsmodus verwenden, erfordern ausgehende TCP-Kommunikation an Port 443 an "BatchNodeManagement. {region}"-Diensttag. Es sind keine offenen eingehenden Ports erforderlich.

PoolPatchParameter

Der Satz von Änderungen, die an einem Pool vorgenommen werden sollen.

Name	Typ	Beschreibung
applicationPackageReferences	ApplicationPackageReference[]	Eine Liste der Pakete, die auf jedem Computeknoten im Pool installiert werden sollen. Änderungen an Paketverweise wirken sich auf alle neuen Knoten aus, die dem Pool beitreten, aber nicht auf Computeknoten, die sich bereits im Pool befinden, bis sie neu gestartet oder neu erstellt werden. Wenn dieses Element vorhanden ist, ersetzt es alle vorhandenen Package-Verweise. Wenn Sie eine leere Auflistung angeben, werden alle Paketverweise aus dem Pool entfernt. Wenn nicht angegeben, bleiben alle vorhandenen Paketverweise unverändert.
certificateReferences	CertificateReference[]	Eine Liste der Zertifikate, die auf jedem Computeknoten im Pool installiert werden sollen. Wenn dieses Element vorhanden ist, ersetzt es alle vorhandenen Zertifikatverweise, die im Pool konfiguriert sind. Wenn nicht angegeben, bleiben alle vorhandenen Zertifikatverweise unverändert. Für Windows-Knoten installiert der Batch-Dienst die Zertifikate im angegebenen Zertifikatspeicher und Speicherort. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis innerhalb des Arbeitsverzeichnisses Task gespeichert, und eine Umgebungsvariable, AZ_BATCH_CERTIFICATES_DIR für den Task bereitgestellt wird, um diesen Speicherort abzufragen. Bei Zertifikaten mit sichtbarkeit von "remoteUser" wird im Basisverzeichnis des Benutzers (z. B. /home/{benutzername}/certs) ein Verzeichnis "certs" erstellt, und Zertifikate werden in diesem Verzeichnis platziert. Warnung: Diese Eigenschaft ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung .
metadata	MetadataItem[]	Eine Liste von Name-Wert-Paaren, die dem Pool als Metadaten zugeordnet sind. Wenn dieses Element vorhanden ist, werden alle vorhandenen Metadaten ersetzt, die im Pool konfiguriert sind. Wenn Sie eine leere Auflistung angeben, werden alle Metadaten aus dem Pool entfernt. Wenn sie weggelassen werden, bleiben alle vorhandenen Metadaten unverändert.
startTask	StartTask	Ein Task, der auf jedem Computeknoten ausgeführt werden soll, während er dem Pool beitritt. Der Task wird ausgeführt, wenn der Computeknoten dem Pool hinzugefügt wird oder wenn der Computeknoten neu gestartet wird. Wenn dieses Element vorhanden ist, überschreibt es alle vorhandenen StartTask-Elemente. Wenn sie nicht angegeben wird, bleibt die vorhandene StartTask unverändert.
targetNodeCommunicationMode	NodeCommunicationMode	Der gewünschte Knotenkommunikationsmodus für den Pool. Wenn dieses Element vorhanden ist, ersetzt es den vorhandenen targetNodeCommunicationMode, der im Pool konfiguriert ist. Wenn sie weggelassen werden, bleiben alle vorhandenen Metadaten unverändert.

ResourceFile

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

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

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 neu erstellt wird.

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

TaskContainerSettings

Die Containereinstellungen für einen Task.

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

UserIdentity

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

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