Pool - Update Properties

Referenz

Dienst:: Batch Service

API-Version:: 2024-07-01.20.0

Aktualisiert die Eigenschaften des angegebenen Pools.
Dadurch werden alle aktualisierbaren Eigenschaften des Pools vollständig ersetzt. Wenn dem Pool beispielsweise ein StartTask zugeordnet ist und StartTask nicht mit dieser Anforderung angegeben wird, entfernt der Batchdienst den vorhandenen StartTask.

POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2024-07-01.20.0

Mit optionalen Parametern:

POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2024-07-01.20.0

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
batchUrl	path	True	string	Die Basis-URL für alle Azure Batch-Dienstanforderungen.
poolId	path	True	string	Die ID des 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 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	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.

Anforderungstext

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

Name	Erforderlich	Typ	Beschreibung
applicationPackageReferences	True	ApplicationPackageReference[]	Die Liste der Anwendungspakete, die auf jedem Computeknoten im Pool installiert werden sollen. Die Liste ersetzt alle vorhandenen Anwendungspaketverweise im Pool. Änderungen an Anwendungspaketverweise wirken sich auf alle neuen Computeknoten aus, die dem Pool beitreten, wirken sich jedoch nicht auf Computeknoten aus, die sich bereits im Pool befinden, bis sie neu gestartet oder umimages aktualisiert werden. Es gibt maximal 10 Anwendungspaketverweise für einen bestimmten Pool. Wenn Sie keine leere Auflistung angeben, werden alle vorhandenen Anwendungspaketeverweise aus dem Pool entfernt. Für einen bestimmten Pool können maximal 10 Verweise angegeben werden.
certificateReferences	True	CertificateReference[]	Eine Liste der Zertifikate, die auf jedem Computeknoten im Pool installiert werden sollen. Diese Liste ersetzt alle vorhandenen Zertifikatverweise, die im Pool konfiguriert sind. Wenn Sie eine leere Auflistung angeben, werden alle vorhandenen Zertifikatverweise aus dem Pool entfernt. Für Windows-Knoten installiert der Batchdienst die Zertifikate im angegebenen Zertifikatspeicher und -speicherort. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis im Arbeitsverzeichnis "Aufgabe" gespeichert, und eine Umgebungsvariable AZ_BATCH_CERTIFICATES_DIR wird der Aufgabe bereitgestellt, um diesen Speicherort abzufragen. Für Zertifikate mit Sichtbarkeit von 'remoteUser' wird ein Verzeichnis "certs" im Startverzeichnis des Benutzers erstellt (z. B. /home/{user-name}/certs) und Zertifikate in diesem Verzeichnis platziert. Warnung: Diese Eigenschaft ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung.
metadata	True	MetadataItem[]	Eine Liste von Name-Wert-Paaren, die dem Pool als Metadaten zugeordnet sind. Diese Liste ersetzt alle vorhandenen Metadaten, die im Pool konfiguriert sind. Wenn Sie keine leere Auflistung angeben, werden vorhandene Metadaten aus dem Pool entfernt.
startTask		StartTask	Eine Aufgabe, die auf jedem Computeknoten ausgeführt werden soll, während er dem Pool beitritt. Die Aufgabe 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.If this element is present, it overwrites any existing StartTask. Wenn dieser Parameter nicht angegeben wird, wird ein vorhandener StartTask aus dem Pool entfernt.
targetNodeCommunicationMode		NodeCommunicationMode	Der gewünschte Knotenkommunikationsmodus für den Pool. Diese Einstellung ersetzt alle vorhandenen targetNodeCommunication-Einstellungen im Pool. Wenn sie weggelassen wird, ist die vorhandene Einstellung standard.

Antworten

Name	Typ	Beschreibung
204 No Content		Die Anforderung an den Batchdienst war erfolgreich. Header client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Der Fehler vom Batchdienst.

Name

Typ

Beschreibung

204 No Content

Die Anforderung an den Batchdienst war erfolgreich.

Header

client-request-id: string
request-id: string
ETag: string
Last-Modified: string
DataServiceId: string

Other Status Codes

BatchError

Der Fehler vom Batchdienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Authorization

Typ: apiKey
In: header

Beispiele

Pool update

Beispielanforderung

HTTP

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



{
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'"
  },
  "certificateReferences": [],
  "applicationPackageReferences": [],
  "metadata": []
}

Beispiel für eine Antwort

Statuscode:: 204

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 eine Aufgabe im Batchdienst ausführt.
BatchError	Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail	Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.
CertificateReference	Ein Verweis auf ein Zertifikat, das auf Computeknoten in einem Pool installiert werden soll.
CertificateStoreLocation	Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in den das Zertifikat installiert werden soll.
CertificateVisibility	Welche Benutzerkonten auf dem Computeknoten Zugriff auf die privaten Daten des Zertifikats haben sollen.
ComputeNodeIdentityReference	Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.
ContainerHostBatchBindMountEntry	Der Eintrag des Pfad- und Bereitstellungsmodus, den Sie in Aufgabencontainer bereitstellen möchten.
ContainerHostDataPath	Die Pfade, die im Container der Containeraufgabe bereitgestellt werden.
ContainerRegistry	Eine private Containerregistrierung.
ContainerWorkingDirectory	Der Speicherort des Arbeitsverzeichnisses für containeraufgaben.
ElevationLevel	Die Höhe des Benutzers.
EnvironmentSetting	Eine Umgebungsvariable, die für einen Vorgangsprozess festgelegt werden soll.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
MetadataItem	Ein Name-Wert-Paar, das einer Batchdienstressource zugeordnet ist.
NodeCommunicationMode	Bestimmt, wie ein Pool mit dem Batchdienst kommuniziert.
PoolUpdatePropertiesParameter	Die Gruppe der Änderungen, die an einem Pool vorgenommen werden sollen.
ResourceFile	Eine einzelne Datei oder mehrere Dateien, die in einen Computeknoten heruntergeladen werden sollen.
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.
TaskContainerSettings	Die Containereinstellungen für eine Aufgabe.
UserIdentity	Die Definition der Benutzeridentität, unter der die Aufgabe ausgeführt wird.

ApplicationPackageReference

Objekt

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

Name	Typ	Beschreibung
applicationId	string	Die ID der bereitzustellenden Anwendung. Beim Erstellen eines Pools muss die Anwendungs-ID des Pakets vollqualifizierte sein (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Die Version der bereitzustellenden Anwendung. Wenn sie weggelassen wird, wird die Standardversion bereitgestellt. Wenn dies für einen Pool nicht angegeben wird und für diese Anwendung keine Standardversion angegeben wird, schlägt die Anforderung mit dem Fehlercode InvalidApplicationPackageReferences und DEM HTTP-Statuscode 409 fehl. Wenn dies für eine Aufgabe nicht angegeben wird und für diese Anwendung keine Standardversion angegeben wird, schlägt die Aufgabe mit einem Vorverarbeitungsfehler fehl.

AutoUserScope

Enumeration

Der Bereich für den automatischen Benutzer

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

AutoUserSpecification

Objekt

Gibt die Parameter für den automatischen Benutzer an, der eine Aufgabe im Batchdienst ausführt.

Name	Typ	Beschreibung
elevationLevel	ElevationLevel	Die Höhenstufe des automatischen Benutzers. Der Standardwert ist "nonAdmin".
scope	AutoUserScope	Der Bereich für den automatischen Benutzer Der Standardwert ist Pool. Wenn der Pool Windows ausführt, sollte ein Wert der Aufgabe angegeben werden, wenn eine strengere Isolierung zwischen Vorgängen erforderlich ist. Wenn die Aufgabe beispielsweise die Registrierung auf eine Weise stummschaltet, die sich auf andere Aufgaben auswirken könnte, oder wenn Zertifikate auf dem Pool angegeben wurden, auf die nicht durch normale Aufgaben zugegriffen werden sollte, aber von StartTasks zugänglich sein sollte.

BatchError

Objekt

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
message	ErrorMessage	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
values	BatchErrorDetail[]	Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten.

BatchErrorDetail

Objekt

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

Objekt

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

Name	Typ	Beschreibung
storeLocation	CertificateStoreLocation	Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in den das Zertifikat installiert werden soll. Der Standardwert ist currentuser. Diese Eigenschaft gilt nur für Pools, die mit Windows Compute Nodes konfiguriert sind. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis im Arbeitsverzeichnis "Aufgabe" gespeichert, und eine Umgebungsvariable AZ_BATCH_CERTIFICATES_DIR wird der Aufgabe bereitgestellt, um diesen Speicherort abzufragen. Für Zertifikate mit Sichtbarkeit von 'remoteUser' wird ein Verzeichnis "certs" im Startverzeichnis des Benutzers erstellt (z. B. /home/{user-name}/certs) und Zertifikate in diesem Verzeichnis platziert.
storeName	string	Der Name des Zertifikatspeichers auf dem Computeknoten, in den das Zertifikat installiert werden soll. Diese Eigenschaft gilt nur für Pools, die mit Windows Compute Nodes konfiguriert sind. Allgemeine Store-Namen sind: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. Der Standardwert ist "Mein".
thumbprint	string	Der Fingerabdruck des Zertifikats.
thumbprintAlgorithm	string	Der Algorithmus, dem der Fingerabdruck zugeordnet ist. Dies muss sha1 sein.
visibility	CertificateVisibility[]	Welche Benutzerkonten auf dem Computeknoten Zugriff auf die privaten Daten des Zertifikats haben sollen. Sie können in dieser Sammlung mehr als eine Sichtbarkeit angeben. Der Standardwert ist alle Konten.

CertificateStoreLocation

Enumeration

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

Wert	Beschreibung
currentuser	Zertifikate sollten im CurrentUser-Zertifikatspeicher installiert werden.
localmachine	Zertifikate sollten im LocalMachine-Zertifikatspeicher installiert werden.

CertificateVisibility

Enumeration

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

Wert	Beschreibung
remoteuser	Das Zertifikat sollte für die Benutzerkonten sichtbar sein, unter denen Benutzer remote auf den Computeknoten zugreifen.
starttask	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	Das Zertifikat sollte für die Benutzerkonten sichtbar sein, unter denen Auftragsaufgaben ausgeführt werden.

ComputeNodeIdentityReference

Objekt

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.

ContainerHostBatchBindMountEntry

Objekt

Der Eintrag des Pfad- und Bereitstellungsmodus, den Sie in Aufgabencontainer bereitstellen möchten.

Name	Typ	Beschreibung
isReadOnly	boolean	Stellen Sie diesen Quellpfad als schreibgeschützten Modus ein oder nicht. Der Standardwert ist false (Lese-/Schreibmodus). Wenn Sie diesen Pfad für Linux als Lese-/Schreibmodus bereitstellen, bedeutet dies nicht, dass alle Benutzer im Container über den Lese-/Schreibzugriff für den Pfad verfügen, hängt sie vom Zugriff auf die Host-VM ab. Wenn dieser Pfad schreibgeschützt bereitgestellt wird, können alle Benutzer im Container den Pfad nicht ändern.
source	ContainerHostDataPath	Der Pfad, der für containerkunden bereitgestellt werden kann.

ContainerHostDataPath

Enumeration

Die Pfade, die im Container der Containeraufgabe bereitgestellt werden.

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

ContainerRegistry

Objekt

Eine private Containerregistrierung.

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

ContainerWorkingDirectory

Enumeration

Der Speicherort des Arbeitsverzeichnisses für containeraufgaben.

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

ElevationLevel

Enumeration

Die Höhe des Benutzers.

Wert	Beschreibung
admin	Der Benutzer ist ein Benutzer mit erhöhtem Zugriff und arbeitet mit vollständigen Administratorberechtigungen.
nonadmin	Der Benutzer ist ein Standardbenutzer ohne erhöhten Zugriff.

EnvironmentSetting

Objekt

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.

ErrorMessage

Objekt

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.

MetadataItem

Objekt

Ein Name-Wert-Paar, das einer Batchdienstressource zugeordnet ist.

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

NodeCommunicationMode

Enumeration

Bestimmt, wie ein Pool mit dem Batchdienst kommuniziert.

Wert	Beschreibung
classic	Knoten, die den klassischen Kommunikationsmodus verwenden, erfordern eingehende TCP-Kommunikation an den Ports 29876 und 29877 aus dem "BatchNodeManagement". {region}" -Diensttag und ausgehende TCP-Kommunikation am Port 443 zu "Storage.region" und "BatchNodeManagement". {region}"-Diensttags.
default	Der Knotenkommunikationsmodus wird automatisch vom Batchdienst festgelegt.
simplified	Knoten, die den vereinfachten Kommunikationsmodus verwenden, erfordern ausgehende TCP-Kommunikation an Port 443 zum "BatchNodeManagement". {region}" -Diensttag. Es sind keine offenen eingehenden Ports erforderlich.