Freigeben über

Pools - Replace Pool Properties

Dienst:
Batch Service
API-Version:
2025-06-01

Aktualisiert die Eigenschaften des angegebenen Pools.
Dies ersetzt vollständig alle aktualisierbaren Eigenschaften des Pools. Zum Beispiel, wenn der Pool eine StartTask zugeordnet hat und StartTask mit dieser Anfrage nicht angegeben ist, entfernt der Batch-Service den bestehenden StartTask.

POST {endpoint}/pools/{poolId}/updateproperties?api-version=2025-06-01
Mit optionalen Parametern: 
POST {endpoint}/pools/{poolId}/updateproperties?api-version=2025-06-01&timeOut={timeOut}

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string (uri)

Batchkontoendpunkt (z. B. https://batchaccount.eastus2.batch.azure.com).
poolId
 path True

string

Die ID des Pools wird aktualisiert.
api-version
 query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.
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. Ist der Wert größer als 30, wird stattdessen der Standard verwendet."

Anforderungsheader

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

Name Erforderlich Typ Beschreibung
client-request-id

string

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-rfc7231)

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

BatchApplicationPackageReference[]

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.
metadata True

BatchMetadataItem[]

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

BatchStartTask

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.

Antworten

Name Typ Beschreibung
204 No Content

Es gibt keinen Inhalt, der für diese Anforderung gesendet werden soll, aber die Header können nützlich sein.

Header

  • DataServiceId: string
  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

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

Bereiche

Name Beschreibung
https://batch.core.windows.net//.default

Beispiele

Pool update

Beispielanforderung

POST {endpoint}/pools/poolId/updateproperties?api-version=2025-06-01



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

Beispiel für eine Antwort

Statuscode:
204

Definitionen

Name Beschreibung
AutoUserScope

AutoUserScope-Enums
AutoUserSpecification

Gibt die Optionen für den automatischen Benutzer an, der eine Azure-Batchaufgabe ausführt.
BatchApplicationPackageReference

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

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail

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

Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
BatchMetadataItem

Der Batchdienst weist diesen Metadaten keine Bedeutung zu; sie ist ausschließlich für die Verwendung von Benutzercode vorgesehen.
BatchNodeIdentityReference

Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.
BatchPoolReplaceOptions

Parameter zum Ersetzen von Eigenschaften in einem Azure-Batchpool.
BatchStartTask

Batch wiederholt Aufgaben, wenn ein Wiederherstellungsvorgang auf einem Knoten ausgelöst wird. Beispiele für Wiederherstellungsvorgänge sind (aber nicht beschränkt darauf), wenn ein fehlerhafter Knoten neu gestartet wird oder ein Computeknoten aufgrund eines Hostfehlers verschwunden ist. Wiederholungen aufgrund von Wiederherstellungsvorgängen sind unabhängig von und werden nicht für das maxTaskRetryCount gezählt. Auch wenn das maxTaskRetryCount 0 ist, kann ein interner Wiederholungsversuch aufgrund eines Wiederherstellungsvorgangs auftreten. Aus diesem Gründen sollten alle Aufgaben idempotent sein. Dies bedeutet, dass Aufgaben unterbrochen und neu gestartet werden müssen, ohne dass Beschädigte oder doppelte Daten verursacht werden. Die bewährte Methode für lange ausgeführte Aufgaben besteht darin, eine Form der Prüfpunkterstellung zu verwenden. In einigen Fällen kann der StartTask erneut ausgeführt werden, obwohl der Computeknoten nicht neu gestartet wurde. Es sollte besonders darauf geachtet werden, startTasks zu vermeiden, die Unterbrechungsvorgang erstellen oder Dienste aus dem StartTask-Arbeitsverzeichnis installieren/starten, da dadurch verhindert wird, dass Batch die StartTask erneut ausführen kann.
BatchTaskContainerSettings

Die Containereinstellungen für eine Aufgabe.
ContainerHostBatchBindMountEntry

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

Die Pfade, die im Container der Containeraufgabe bereitgestellt werden.
ContainerRegistryReference

Eine private Containerregistrierung.
ContainerWorkingDirectory

ContainerWorkingDirectory-Enums
ElevationLevel

ElevationLevel-Enums
EnvironmentSetting

Eine Umgebungsvariable, die für einen Vorgangsprozess festgelegt werden soll.
ResourceFile

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

Die Definition der Benutzeridentität, unter der die Aufgabe ausgeführt wird. Geben Sie entweder die Eigenschaft "userName" oder "autoUser" an, aber nicht beide.

AutoUserScope

Enumeration

AutoUserScope-Enums

Wert Beschreibung
task

Spezifiziert, dass der Dienst einen neuen Benutzer für die Aufgabe anlegen soll.
pool

Spezifiziert, dass die Aufgabe als gemeinsames automatisches Benutzerkonto ausgeführt wird, das auf jedem Rechenknoten in einem Pool erstellt wird.

AutoUserSpecification

Objekt

Gibt die Optionen für den automatischen Benutzer an, der eine Azure-Batchaufgabe 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. Dies ist beispielsweise der Fall, wenn die Aufgabe die Registrierung in einer Weise ändert, die sich auf andere Aufgaben auswirken kann.

BatchApplicationPackageReference

Objekt

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

Name Typ Beschreibung
applicationId

string

Die ID der zu implementierenden 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 in einem Pool weggelassen wird und für diese Anwendung keine Standardversion angegeben ist, schlägt die Anfrage mit dem Fehlercode InvalidApplicationPackageReferences und dem HTTP-Statuscode 409 fehl. Wenn dies bei einer Aufgabe weggelassen wird und für diese Anwendung keine Standardversion angegeben ist, scheitert die Aufgabe mit einem Vorverarbeitungsfehler.

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

BatchErrorMessage

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.

BatchErrorMessage

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.

BatchMetadataItem

Objekt

Der Batchdienst weist diesen Metadaten keine Bedeutung zu; sie ist ausschließlich für die Verwendung von Benutzercode vorgesehen.

Name Typ Beschreibung
name

string

Der Name des Metadatenelements.
value

string

Der Wert des Metadatenelements.

BatchNodeIdentityReference

Objekt

Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.

Name Typ Beschreibung
resourceId

string (arm-id)

Die ARM-Ressourcen-ID der vom Benutzer zugewiesenen Identität.

BatchPoolReplaceOptions

Objekt

Parameter zum Ersetzen von Eigenschaften in einem Azure-Batchpool.

Name Typ Beschreibung
applicationPackageReferences

BatchApplicationPackageReference[]

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.
metadata

BatchMetadataItem[]

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

BatchStartTask

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.

BatchStartTask

Objekt

Batch wiederholt Aufgaben, wenn ein Wiederherstellungsvorgang auf einem Knoten ausgelöst wird. Beispiele für Wiederherstellungsvorgänge sind (aber nicht beschränkt darauf), wenn ein fehlerhafter Knoten neu gestartet wird oder ein Computeknoten aufgrund eines Hostfehlers verschwunden ist. Wiederholungen aufgrund von Wiederherstellungsvorgängen sind unabhängig von und werden nicht für das maxTaskRetryCount gezählt. Auch wenn das maxTaskRetryCount 0 ist, kann ein interner Wiederholungsversuch aufgrund eines Wiederherstellungsvorgangs auftreten. Aus diesem Gründen sollten alle Aufgaben idempotent sein. Dies bedeutet, dass Aufgaben unterbrochen und neu gestartet werden müssen, ohne dass Beschädigte oder doppelte Daten verursacht werden. Die bewährte Methode für lange ausgeführte Aufgaben besteht darin, eine Form der Prüfpunkterstellung zu verwenden. In einigen Fällen kann der StartTask erneut ausgeführt werden, obwohl der Computeknoten nicht neu gestartet wurde. Es sollte besonders darauf geachtet werden, startTasks zu vermeiden, die Unterbrechungsvorgang erstellen oder Dienste aus dem StartTask-Arbeitsverzeichnis installieren/starten, da dadurch verhindert wird, dass Batch die StartTask erneut ausführen kann.

Name Typ Beschreibung
commandLine

string

Die Befehlszeile des StartTask. Die Befehlszeile wird nicht unter einer Shell ausgeführt und kann daher nicht von Shellfeatures wie der Erweiterung der Umgebungsvariablen profitieren. Wenn Sie diese Features nutzen möchten, sollten Sie die Shell in der Befehlszeile aufrufen, z. B. mit "cmd /c MyCommand" in Windows oder "/bin/sh -c MyCommand" in Linux. Wenn sich die Befehlszeile auf Dateipfade bezieht, sollte sie einen relativen Pfad (relativ zum Arbeitsverzeichnis "Aufgabe") verwenden oder die vom Batch bereitgestellte Umgebungsvariable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables) verwenden.
containerSettings

BatchTaskContainerSettings

Die Einstellungen für den Container, unter dem der StartTask ausgeführt wird. Wenn dies angegeben ist, werden alle Verzeichnisse rekursiv unterhalb der AZ_BATCH_NODE_ROOT_DIR (der Wurzel der Azure Batch-Verzeichnisse auf dem Knoten) in den Container abgebildet, alle Task-Umgebungsvariablen werden in den Container abgebildet und die Task-Befehlszeile wird im Container ausgeführt. Dateien, die außerhalb AZ_BATCH_NODE_ROOT_DIR im Container erzeugt werden, werden möglicherweise nicht auf die Host-Festplatte zurückgewiesen, was bedeutet, dass Batch-Datei-APIs nicht auf diese Dateien zugreifen können.
environmentSettings

EnvironmentSetting[]

Eine Liste der Umgebungsvariableneinstellungen für den StartTask.
maxTaskRetryCount

integer (int32)

Die maximale Anzahl der Wiederholungsversuche des Vorgangs. Der Batchdienst ruft eine Aufgabe erneut auf, wenn der Beendigungscode nicht null ist. Beachten Sie, dass dieser Wert speziell die Anzahl der Wiederholungen steuert. Der Batchdienst versucht die Aufgabe einmal, und kann dann bis zu diesem Grenzwert erneut versuchen. Wenn die maximale Wiederholungsanzahl beispielsweise 3 ist, versucht Batch die Aufgabe bis zu 4 Mal (ein erster Versuch und 3 Wiederholungsversuche). Wenn die maximale Wiederholungsanzahl 0 ist, wird der Batchdienst den Vorgang nicht wiederholen. Wenn die maximale Wiederholungsanzahl -1 ist, wiederholt der Batchdienst den Vorgang ohne Beschränkung, dies wird jedoch nicht für einen Startvorgang oder einen Vorgang empfohlen. Der Standardwert ist 0 (keine Wiederholungen).
resourceFiles

ResourceFile[]

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. Unter diesem Element aufgelistete Dateien befinden sich im Arbeitsverzeichnis der Aufgabe.
userIdentity

UserIdentity

Die Benutzeridentität, unter der die StartTask ausgeführt wird. Wenn sie weggelassen wird, läuft die Aufgabe als nicht-administrativer Benutzer, der einzigartig für die Aufgabe ist.
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. Wenn "true" und "StartTask" auf einem Knoten fehlschlägt, wiederholt der Batchdienst die StartTask bis zur maximalen Wiederholungsanzahl (maxTaskRetryCount). Wenn die Aufgabe nach allen Wiederholungen noch nicht erfolgreich abgeschlossen wurde, markiert der Batchdienst den Knoten nicht verwendbar und plant keine Vorgänge. Diese Bedingung kann über den Computerknotenstatus und Fehlerinformationen erkannt werden. Wenn "false" lautet, wartet der Batchdienst nicht, bis der StartTask abgeschlossen ist. In diesem Fall können andere Aufgaben mit der Ausführung auf dem Computeknoten beginnen, während der StartTask noch ausgeführt wird. und auch wenn der StartTask fehlschlägt, werden neue Aufgaben weiterhin auf dem Computeknoten geplant. Der Standardwert ist "true".

BatchTaskContainerSettings

Objekt

Die Containereinstellungen für eine Aufgabe.

Name Typ Beschreibung
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

Die Pfade, die Sie an containeraufgaben bereitstellen möchten. Wenn dieses Array null ist oder nicht vorhanden ist, stellt die Containeraufgabe das gesamte temporäre Laufwerk in Windows (oder AZ_BATCH_NODE_ROOT_DIR in Linux) ein. Es werden keine Datenpfade in Container bereitgestellt, wenn dieses Array als leer festgelegt ist.
containerRunOptions

string

Zusätzliche Optionen für den Befehl "Container erstellen". Diese zusätzlichen Optionen werden zusätzlich zu den vom Batchdienst gesteuerten Befehlen als Argumente für den Befehl "docker create" bereitgestellt.
imageName

string

Das Image, das verwendet wird, um den Container zu erstellen, in dem die Aufgabe ausgeführt wird. Dies ist die vollständige Image-Referenz, wie sie bei "docker pull" angegeben wäre. Wenn kein Tag im Bildnamen angegeben ist, wird standardmäßig das Tag ":latest" verwendet.
registry

ContainerRegistryReference

Das private Register, das das Container-Image enthält. Diese Einstellung kann weggelassen werden, wenn sie bereits bei der Poolerstellung bereitgestellt wurde.
workingDirectory

ContainerWorkingDirectory

Der Standort des Arbeitsverzeichnisses Container Task. Der Standardwert ist "taskWorkingDirectory".

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
Shared

Der Pfad für die Aufgabe mit mehreren Instanzen, um ihre Dateien freigegeben zu haben.
Startup

Der Pfad für die Startaufgabe.
VfsMounts

Der Pfad enthält alle virtuellen Dateisysteme, die auf diesem Knoten bereitgestellt werden.
Task

Der Vorgangspfad.
JobPrep

Der Auftragsvorstellungsvorgangspfad.
Applications

Der Anwendungspfad.

ContainerRegistryReference

Objekt

Eine private Containerregistrierung.

Name Typ Beschreibung
identityReference

BatchNodeIdentityReference

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 (password)

Das Kennwort für die Anmeldung beim Registrierungsserver.
registryServer

string (uri)

Die Registrierungs-URL Wenn nicht angegeben, lautet der Standardwert "docker.io".
username

string

Der Benutzername, der sich beim Registrierungsserver anmeldet.

ContainerWorkingDirectory

Enumeration

ContainerWorkingDirectory-Enums

Wert Beschreibung
taskWorkingDirectory

Verwenden Sie das Standard-Batch-Service-Arbeitsverzeichnis Task, das die Task Resource Dateien enthält, die von Batch gefüllt werden.
containerImageDefault

Verwenden Sie das Arbeitsverzeichnis, das im Container-Image definiert ist. Beachten Sie, dass dieses Verzeichnis die durch Batch heruntergeladenen Ressourcendateien nicht enthält.

ElevationLevel

Enumeration

ElevationLevel-Enums

Wert Beschreibung
nonadmin

Der Benutzer ist ein Standardbenutzer ohne erhöhten Zugriff.
admin

Der Benutzer ist ein Benutzer mit erhöhtem Zugriff und arbeitet mit vollständigen Administratorberechtigungen.

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.

ResourceFile

Objekt

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. 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 teilweiser Dateiname oder ein Unterverzeichnis sein. Wenn kein Präfix angegeben ist, werden alle Dateien im Container heruntergeladen.
fileMode

string

Das Attribut für den Dateiberechtigungsmodus im oktalen Format. Diese Eigenschaft gilt nur für Dateien, die auf Linux Compute Nodes heruntergeladen werden. Sie wird ignoriert, wenn sie für eine ResourceFile angegeben ist, die auf einen Windows-Compute-Node heruntergeladen wird. Wenn diese Eigenschaft für einen Linux Compute Node nicht angegeben ist, wird der Standardwert 0770 auf die Datei angewendet.
filePath

string

Der Ort auf dem Compute-Knoten, zu dem die Datei(en) heruntergeladen werden sollen, relativ zum Arbeitsverzeichnis der Task. 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, wenn die autoStorageContainerName- oder storageContainerUrl-Eigenschaft angegeben ist, und das Verzeichnis, in das die Dateien heruntergeladen werden sollen. Wenn FilePath als Verzeichnis verwendet wird, werden alle bereits den Eingabedaten zugeordneten Verzeichnisstruktur vollständig aufbewahrt und an das angegebene FilePath-Verzeichnis angefügt. Der angegebene relative Pfad kann nicht aus dem Arbeitsverzeichnis der Aufgabe herausbrechen (zum Beispiel durch die Verwendung von '..').
httpUrl

string (uri)

Die URL der herunterzuladenden Datei. Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden. Wenn die URL auf Azure Blob Storage verweist, muss sie von Computeknoten gelesen werden. Es gibt drei Möglichkeiten, eine solche URL für ein Blob im Azure-Speicher abzurufen: Fügen Sie eine SAS (Shared Access Signature) hinzu, die Leseberechtigungen für das Blob gewährt, eine verwaltete Identität mit Leseberechtigung verwenden oder die ACL für das Blob oder dessen Container so festlegen, dass der öffentliche Zugriff zulässig ist.
identityReference

BatchNodeIdentityReference

Die Referenz auf die vom Benutzer zugewiesene Identität, die zum Zugriff auf Azure Blob Storage verwendet wird, spezifiziert durch storageContainerUrl oder httpUrl.
storageContainerUrl

string (uri)

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: Fügen Sie eine SAS (Shared Access Signature) hinzu, 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 so festlegen, dass der öffentliche Zugriff zugelassen wird.

UserIdentity

Objekt

Die Definition der Benutzeridentität, unter der die Aufgabe ausgeführt wird. Geben Sie entweder die Eigenschaft "userName" oder "autoUser" an, aber nicht beide.

Name Typ Beschreibung
autoUser

AutoUserSpecification

Der automatische Benutzer, unter dem die Aufgabe ausgeführt wird. Die Eigenschaften "userName" und "autoUser" schließen sich gegenseitig aus; Sie müssen einen, aber nicht beide angeben.
username

string

Der Name der Benutzeridentität, unter der die Aufgabe ausgeführt wird. Die Eigenschaften "userName" und "autoUser" schließen sich gegenseitig aus; Sie müssen einen, aber nicht beide angeben.