Pool - Patch
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
PATCH {batchUrl}/pools/{poolId}?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 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 |
Eine Liste der Pakete, die auf jedem Computeknoten im Pool installiert werden sollen. |
|
certificateReferences |
Eine Liste der Zertifikate, die auf jedem Computeknoten im Pool installiert werden sollen. Warnung: Diese Eigenschaft ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung . |
|
metadata |
Eine Liste von Name-Wert-Paaren, die dem Pool als Metadaten zugeordnet sind. |
|
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. |
|
targetNodeCommunicationMode |
Der gewünschte Knotenkommunikationsmodus für den Pool. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die Anforderung an den Batch-Dienst war erfolgreich. Header
|
|
Other Status Codes |
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
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
Definitionen
Name | Beschreibung |
---|---|
Application |
Ein Verweis auf ein Paket, das auf Computeknoten bereitgestellt werden soll. |
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 |
Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet. |
Container |
Eine private Containerregistrierung. |
Container |
Der Speicherort des Arbeitsverzeichnisses des Containertasks. |
Elevation |
Die Höhenebene des Benutzers. |
Environment |
Eine Umgebungsvariable, die für einen Vorgangsvorgang festgelegt werden soll. |
Error |
Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird. |
Metadata |
Ein Name-Wert-Paar, das einer Batch-Dienstressource zugeordnet ist. |
Node |
Bestimmt, wie ein Pool mit dem Batch-Dienst kommuniziert. |
Pool |
Der Satz von Änderungen, die an einem Pool vorgenommen werden sollen. |
Resource |
Eine einzelne Datei oder mehrere Dateien, die auf einen Computeknoten heruntergeladen werden sollen. |
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 neu erstellt wird. |
Task |
Die Containereinstellungen für einen Task. |
User |
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. |
version |
string |
Die Version der anwendung, die bereitgestellt werden soll. Wenn nicht angegeben, wird die Standardversion bereitgestellt. |
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öhenebene 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 sollten Zugriff auf die privaten Daten des Zertifikats haben. |
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 |
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 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 |
Eine Liste der Pakete, die auf jedem Computeknoten im Pool installiert werden sollen. |
|
certificateReferences |
Eine Liste der Zertifikate, die auf jedem Computeknoten im Pool installiert werden sollen. Warnung: Diese Eigenschaft ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung . |
|
metadata |
Eine Liste von Name-Wert-Paaren, die dem Pool als Metadaten zugeordnet sind. |
|
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. |
|
targetNodeCommunicationMode |
Der gewünschte Knotenkommunikationsmodus für den Pool. |
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. |
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. |
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 Vorgang. |
resourceFiles |
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. |
|
userIdentity |
Die Benutzeridentität, unter der startTask ausgeführt wird. |
|
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. |
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. |
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. |