Freigeben über


Job - Patch

Aktualisiert die Eigenschaften des angegebenen Auftrags.
Dadurch werden nur die in der Anforderung angegebenen Auftragseigenschaften ersetzt. Wenn der Auftrag z. B. Einschränkungen aufweist und eine Anforderung nicht das Einschränkungselement angibt, behält der Auftrag die vorhandenen Einschränkungen bei.

PATCH {batchUrl}/jobs/{jobId}?api-version=2024-07-01.20.0
PATCH {batchUrl}/jobs/{jobId}?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.

jobId
path True

string

Die ID des Auftrags, dessen Eigenschaften Sie aktualisieren möchten.

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

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 exakt mit dem vom Client angegebenen Wert übereinstimmt.

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 die uhrzeit der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource für den Dienst seit dem angegebenen Zeitpunkt geändert wurde.

If-Unmodified-Since

string

date-time-rfc1123

Ein Zeitstempel, der die uhrzeit der letzten Änderung der Ressource angibt, die dem Client bekannt ist. Der Vorgang wird nur ausgeführt, wenn die Ressource für den Dienst seit dem angegebenen Zeitpunkt nicht geändert wurde.

Anforderungstext

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

Name Typ Beschreibung
allowTaskPreemption

boolean

Ob Aufgaben in diesem Auftrag von anderen Aufträgen mit hoher Priorität vorgebeutet werden können
Wenn der Wert auf "True" festgelegt ist, haben andere aufträge mit hoher Priorität, die an das System übermittelt werden, Vorrang und können Vorgänge von diesem Auftrag erneut abfragn. Sie können die AllowTaskPreemption eines Auftrags aktualisieren, nachdem er mithilfe der Updateauftrags-API erstellt wurde.

constraints

JobConstraints

Die Ausführungseinschränkungen für den Auftrag.
Ohne Angabe bleiben die vorhandenen Ausführungseinschränkungen unverändert.

maxParallelTasks

integer

Die maximale Anzahl von Vorgängen, die parallel für den Auftrag ausgeführt werden können.
Der Wert von maxParallelTasks muss bei Angabe -1 oder größer als 0 sein. Wenn nicht angegeben, ist der Standardwert -1, was bedeutet, dass es keine Beschränkung für die Anzahl der Aufgaben gibt, die gleichzeitig ausgeführt werden können. Sie können die maxParallelTasks eines Auftrags aktualisieren, nachdem er mithilfe der Updateauftrags-API erstellt wurde.

metadata

MetadataItem[]

Eine Liste von Name-Wert-Paaren, die dem Auftrag als Metadaten zugeordnet sind.
Ohne Angabe bleiben die vorhandenen Auftragsmetadaten unverändert.

networkConfiguration

JobNetworkConfiguration

Die Netzwerkkonfiguration für den Auftrag.

onAllTasksComplete

OnAllTasksComplete

Die Aktion, die der Batchdienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden.
Wenn nicht angegeben, bleibt das Vervollständigungsverhalten unverändert. Sie können den Wert nicht von "terminatejob" in "noaction" ändern – d. h., nachdem Sie die automatische Beendigung des Auftrags aktiviert haben, können Sie ihn nicht wieder deaktivieren. Wenn Sie versuchen, dies zu tun, schlägt die Anforderung mit der Fehlerantwort "Ungültiger Eigenschaftswert" fehl. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).

poolInfo

PoolInformation

Der Pool, in dem der Batchdienst die Aufgaben des Auftrags ausführt.
Sie können den Pool für einen Auftrag nur ändern, wenn der Auftrag deaktiviert ist. Der Patchauftragsaufruf schlägt fehl, wenn Sie das poolInfo-Element einschließen und der Auftrag nicht deaktiviert ist. Wenn Sie eine autoPoolSpecification in der poolInfo angeben, kann nur die keepAlive-Eigenschaft der autoPoolSpecification aktualisiert werden, und dann nur, wenn die autoPoolSpecification über eine poolLifetimeOption of Job verfügt (andere Auftragseigenschaften können normal aktualisiert werden). Wenn dieser Wert nicht angegeben wird, wird der Auftrag weiterhin auf dem aktuellen Pool ausgeführt.

priority

integer

Die Priorität des Auftrags.
Prioritätswerte können zwischen -1000 und 1000 liegen, wobei -1000 die niedrigste Priorität und 1000 die höchste Priorität sind. Wenn sie weggelassen wird, bleibt die Priorität des Auftrags unverändert.

Antworten

Name Typ Beschreibung
200 OK

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

Job patch

Beispielanforderung

PATCH account.region.batch.azure.com/jobs/jobId?api-version=2024-07-01.20.0



{
  "priority": 100,
  "constraints": {
    "maxWallClockTime": "PT1H",
    "maxTaskRetryCount": -1
  },
  "poolInfo": {
    "poolId": "poolId"
  }
}

Beispiel für eine Antwort

Definitionen

Name Beschreibung
ApplicationPackageReference

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

AutomaticOSUpgradePolicy

Die Konfigurationsparameter, die zum Ausführen eines automatischen Betriebssystemupgrades verwendet werden.

AutoPoolSpecification

Gibt Merkmale für einen temporären "automatischen Pool" an. Der Batchdienst erstellt diesen automatischen Pool, wenn der Auftrag übermittelt wird.

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.

AzureBlobFileSystemConfiguration

Informationen, die zum Herstellen einer Verbindung mit einem Azure Storage-Container mithilfe von Blobfuse verwendet werden.

AzureFileShareConfiguration

Informationen, die zum Herstellen einer Verbindung mit einer Azure Fileshare verwendet werden.

BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

BatchErrorDetail

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

CachingType

Der Typ der Zwischenspeicherung, die für den Datenträger aktiviert werden soll.

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.

CIFSMountConfiguration

Informationen, die zum Herstellen einer Verbindung mit einem CIFS-Dateisystem verwendet werden.

ComputeNodeFillType

Wie Aufgaben über Computeknoten in einem Pool verteilt werden.

ComputeNodeIdentityReference

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

ContainerConfiguration

Die Konfiguration für containerfähige Pools.

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.

ContainerType

Die zu verwendende Containertechnologie.

ContainerWorkingDirectory

Der Speicherort des Arbeitsverzeichnisses für containeraufgaben.

DataDisk

Einstellungen, die von den Datenträgern verwendet werden, die Computeknoten im Pool zugeordnet sind. Wenn Sie angefügte Datenträger verwenden, müssen Sie die Datenträger innerhalb einer VM bereitstellen und formatieren, um sie zu verwenden.

DiffDiskPlacement

Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger für alle Computeknoten (VMs) im Pool an.

DiffDiskSettings

Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom Computeknoten (VM) verwendet wird.

DiskEncryptionConfiguration

Die Auf Computeknoten im Pool angewendete Datenträgerverschlüsselungskonfiguration. Die Datenträgerverschlüsselungskonfiguration wird im Linux-Pool, der mit dem Azure Compute Gallery Image erstellt wurde, nicht unterstützt.

DiskEncryptionTarget

Die Liste der Datenträgerziele für den Batchdienst wird auf dem Computeknoten verschlüsselt.

DynamicVNetAssignmentScope

Der Umfang der dynamischen vnet-Zuordnung.

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.

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

InboundEndpointProtocol

Das Protokoll des Endpunkts.

InboundNATPool

Ein eingehender NAT-Pool, der verwendet werden kann, um bestimmte Ports auf Computeknoten in einem Batchpool extern zu adressieren.

IPAddressProvisioningType

Der Bereitstellungstyp für öffentliche IP-Adressen für den Pool.

JobConstraints

Die Ausführungseinschränkungen für einen Auftrag.

JobNetworkConfiguration

Die Netzwerkkonfiguration für den Auftrag.

JobPatchParameter

Die Gruppe der Änderungen, die an einem Auftrag vorgenommen werden sollen.

LinuxUserConfiguration

Eigenschaften, die zum Erstellen eines Benutzerkontos auf einem Linux-Computeknoten verwendet werden.

LoginMode

Der Anmeldemodus für den Benutzer

ManagedDisk
MetadataItem

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

MountConfiguration

Das Dateisystem, das auf jedem Knoten bereitgestellt werden soll.

NetworkConfiguration

Die Netzwerkkonfiguration für einen Pool.

NetworkSecurityGroupRule

Eine Netzwerksicherheitsgruppenregel, die auf einen eingehenden Endpunkt angewendet werden soll.

NetworkSecurityGroupRuleAccess

Die Aktion, die für eine angegebene IP-Adresse, einen Subnetzbereich oder ein Bestimmtes Tag ausgeführt werden soll.

NFSMountConfiguration

Informationen, die zum Herstellen einer Verbindung mit einem NFS-Dateisystem verwendet werden.

NodeCommunicationMode

Bestimmt, wie ein Pool mit dem Batchdienst kommuniziert.

NodePlacementConfiguration

Knotenplatzierungskonfiguration für einen Pool.

NodePlacementPolicyType

Die Platzierungsrichtlinie zum Zuordnen von Knoten im Pool.

OnAllTasksComplete

Die Aktion, die der Batchdienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden.

OSDisk

Einstellungen für den Betriebssystemdatenträger des Computeknotens (VM).

PoolEndpointConfiguration

Die Endpunktkonfiguration für einen Pool.

PoolInformation

Gibt an, wie ein Auftrag einem Pool zugewiesen werden soll.

PoolLifetimeOption

Die mindeste Lebensdauer der erstellten automatischen Pools und wie mehreren Aufträgen in einem Zeitplan Pools zugewiesen werden.

PoolSpecification

Spezifikation zum Erstellen eines neuen Pools.

PublicIPAddressConfiguration

Die konfiguration der öffentlichen IP-Adresse der Netzwerkkonfiguration eines Pools.

ResourceFile

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

RollingUpgradePolicy

Die Konfigurationsparameter, die beim Ausführen eines rollierenden Upgrades verwendet werden.

SecurityEncryptionTypes

Gibt den EncryptionType des verwalteten Datenträgers an. Sie ist für die Verschlüsselung nur des VMGuestState-Blobs auf "VMGuestStateOnly" und "NonPersistedTPM" festgelegt, damit der Firmwarestatus im VMGuestState-Blob nicht beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden und ist bei Verwendung vertraulicher VMs erforderlich.

SecurityProfile

Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers an.

SecurityTypes

Gibt den SecurityType des virtuellen Computers an. Sie muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren.

ServiceArtifactReference

Gibt die Dienstartefaktereferenz-ID an, die zum Festlegen derselben Imageversion für alle virtuellen Computer im Skalierungssatz bei Verwendung der neuesten Imageversion verwendet wird.

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.

StorageAccountType

Der Speicherkontotyp zum Erstellen von Datenträgern oder Betriebssystemdatenträgern.

TaskContainerSettings

Die Containereinstellungen für eine Aufgabe.

TaskSchedulingPolicy

Gibt an, wie Aufgaben über Computeknoten verteilt werden sollen.

UefiSettings

Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden.

UpgradeMode

Gibt den Modus eines Upgrades auf virtuelle Computer im Skalierungssatz an.

Mögliche Werte sind:

manuelle – Sie steuern die Anwendung von Updates auf virtuelle Computer im Skalierungssatz. Dazu verwenden Sie die ManualUpgrade-Aktion.

Automatische – Alle virtuellen Computer im Skalierungssatz werden automatisch gleichzeitig aktualisiert.

Roll- – Skalierungssatz führt Aktualisierungen in Batches mit einer optionalen Pausenzeit dazwischen durch.

UpgradePolicy

Beschreibt eine Upgraderichtlinie – automatisch, manuell oder rolliert.

UserAccount

Eigenschaften zum Erstellen eines Benutzers, der zum Ausführen von Aufgaben auf einem Azure Batch Compute Node verwendet wird.

UserIdentity

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

VirtualMachineConfiguration

Die Konfiguration für Computeknoten in einem Pool basierend auf der Azure Virtual Machines-Infrastruktur.

VMDiskSecurityProfile

Gibt die Sicherheitsprofileinstellungen für den verwalteten Datenträger an. Hinweis: Sie kann nur für vertrauliche virtuelle Computer festgelegt werden und ist bei verwendung vertraulicher VMs erforderlich.

VMExtension

Die Konfiguration für Erweiterungen virtueller Computer.

WindowsConfiguration

Windows-Betriebssystemeinstellungen, die auf den virtuellen Computer angewendet werden sollen.

WindowsUserConfiguration

Eigenschaften, die zum Erstellen eines Benutzerkontos auf einem Windows-Computeknoten verwendet werden.

ApplicationPackageReference

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.

AutomaticOSUpgradePolicy

Die Konfigurationsparameter, die zum Ausführen eines automatischen Betriebssystemupgrades verwendet werden.

Name Typ Beschreibung
disableAutomaticRollback

boolean

Gibt an, ob das Rollbackfeature des Betriebssystemimages deaktiviert werden soll.

enableAutomaticOSUpgrade

boolean

Gibt an, ob Betriebssystemupgrades automatisch auf Skalierungssatzinstanzen angewendet werden sollen, wenn eine neuere Version des Betriebssystemimages verfügbar wird.

Wenn dies für Windows-basierte Pools auf "true" festgelegt ist, können "WindowsConfiguration.enableAutomaticUpdates"- nicht auf "true" festgelegt werden.

osRollingUpgradeDeferral

boolean

Verzögern Sie Betriebssystemupgrades auf tvMs, wenn sie Aufgaben ausführen.

useRollingUpgradePolicy

boolean

Gibt an, ob die Rollupgraderichtlinie während des Automatischen Betriebssystemupgrades verwendet werden soll. Das automatische Betriebssystemupgrade wird auf die Standardrichtlinie zurückfallen, wenn keine Richtlinie für vmSS definiert ist.

AutoPoolSpecification

Gibt Merkmale für einen temporären "automatischen Pool" an. Der Batchdienst erstellt diesen automatischen Pool, wenn der Auftrag übermittelt wird.

Name Typ Beschreibung
autoPoolIdPrefix

string

Ein Präfix, das dem eindeutigen Bezeichner hinzugefügt werden soll, wenn automatisch ein Pool erstellt wird.
Der Batchdienst weist jedem automatischen Pool einen eindeutigen Bezeichner bei der Erstellung zu. Um zwischen Pools zu unterscheiden, die für unterschiedliche Zwecke erstellt wurden, können Sie dieses Element angeben, um der zugewiesenen ID ein Präfix hinzuzufügen. Das Präfix kann bis zu 20 Zeichen lang sein.

keepAlive

boolean

Gibt an, ob ein automatischer Pool nach Ablauf der Lebensdauer aktiv bleibt.
Wenn false, löscht der Batchdienst den Pool nach Ablauf der Lebensdauer (wie durch die Einstellung "poolLifetimeOption" festgelegt). das heißt, wenn der Auftrags- oder Auftragsplan abgeschlossen ist. Wenn true, löscht der Batchdienst den Pool nicht automatisch. Der Benutzer muss automatische Pools löschen, die mit dieser Option erstellt wurden.

pool

PoolSpecification

Die Poolspezifikation für den automatischen Pool.

poolLifetimeOption

PoolLifetimeOption

Die mindeste Lebensdauer der erstellten automatischen Pools und wie mehreren Aufträgen in einem Zeitplan Pools zugewiesen werden.

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

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.

AzureBlobFileSystemConfiguration

Informationen, die zum Herstellen einer Verbindung mit einem Azure Storage-Container mithilfe von Blobfuse verwendet werden.

Name Typ Beschreibung
accountKey

string

Der Azure Storage-Kontoschlüssel.
Diese Eigenschaft schließt sich gegenseitig mit sasKey und Identität aus; genau einer muss angegeben werden.

accountName

string

Der Name des Azure Storage-Kontos.

blobfuseOptions

string

Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen.
Dies sind "net use"-Optionen in Windows und "Mount"-Optionen in Linux.

containerName

string

Der Name des Azure Blob Storage-Containers.

identityReference

ComputeNodeIdentityReference

Der Verweis auf die vom Benutzer zugewiesene Identität für den Zugriff auf containerName
Diese Eigenschaft schließt sich gegenseitig mit accountKey und sasKey aus. genau einer muss angegeben werden.

relativeMountPath

string

Der relative Pfad auf dem Computeknoten, in dem das Dateisystem bereitgestellt wird
Alle Dateisysteme werden relativ zum Batch-Bereitstellungsverzeichnis bereitgestellt, auf das über die Umgebungsvariable AZ_BATCH_NODE_MOUNTS_DIR zugegriffen werden kann.

sasKey

string

Das Azure Storage SAS-Token.
Diese Eigenschaft schließt sich gegenseitig mit AccountKey und Identität aus; genau einer muss angegeben werden.

AzureFileShareConfiguration

Informationen, die zum Herstellen einer Verbindung mit einer Azure Fileshare verwendet werden.

Name Typ Beschreibung
accountKey

string

Der Azure Storage-Kontoschlüssel.

accountName

string

Der Name des Azure Storage-Kontos.

azureFileUrl

string

Die Azure Files-URL.
Dies ist das Format "https://{account}.file.core.windows.net/".

mountOptions

string

Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen.
Dies sind "net use"-Optionen in Windows und "Mount"-Optionen in Linux.

relativeMountPath

string

Der relative Pfad auf dem Computeknoten, in dem das Dateisystem bereitgestellt wird
Alle Dateisysteme werden relativ zum Batch-Bereitstellungsverzeichnis bereitgestellt, auf das über die Umgebungsvariable AZ_BATCH_NODE_MOUNTS_DIR zugegriffen werden kann.

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

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

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.

CachingType

Der Typ der Zwischenspeicherung, die für den Datenträger aktiviert werden soll.

Name Typ Beschreibung
none

string

Der Cachemodus für den Datenträger ist nicht aktiviert.

readonly

string

Der Cachemodus für den Datenträger ist schreibgeschützt.

readwrite

string

Der Cachemodus für den Datenträger ist lese- und schreibgeschützt.

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

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.

CIFSMountConfiguration

Informationen, die zum Herstellen einer Verbindung mit einem CIFS-Dateisystem verwendet werden.

Name Typ Beschreibung
mountOptions

string

Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen.
Dies sind "net use"-Optionen in Windows und "Mount"-Optionen in Linux.

password

string

Das Kennwort, das für die Authentifizierung im CIFS-Dateisystem verwendet werden soll.

relativeMountPath

string

Der relative Pfad auf dem Computeknoten, in dem das Dateisystem bereitgestellt wird
Alle Dateisysteme werden relativ zum Batch-Bereitstellungsverzeichnis bereitgestellt, auf das über die Umgebungsvariable AZ_BATCH_NODE_MOUNTS_DIR zugegriffen werden kann.

source

string

Der URI des zu mountden Dateisystems.

username

string

Der Benutzer, der für die Authentifizierung gegen das CIFS-Dateisystem verwendet werden soll.

ComputeNodeFillType

Wie Aufgaben über Computeknoten in einem Pool verteilt werden.

Name Typ Beschreibung
pack

string

So viele Aufgaben wie möglich (taskSlotsPerNode) sollten jedem Computeknoten im Pool zugewiesen werden, bevor vorgänge dem nächsten Computeknoten im Pool zugewiesen werden.

spread

string

Vorgänge sollten gleichmäßig auf allen Computeknoten im Pool zugewiesen werden.

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.

ContainerConfiguration

Die Konfiguration für containerfähige Pools.

Name Typ Beschreibung
containerImageNames

string[]

Die Auflistung der Containerimagenamen.
Dies ist der vollständige Imageverweis, wie für "Docker Pull" angegeben. Ein Image wird aus der Standard-Docker-Registrierung stammen, es sei denn, das Image ist vollqualifizierte mit einer alternativen Registrierung.

containerRegistries

ContainerRegistry[]

Zusätzliche private Register, aus denen Container abgerufen werden können.
Wenn Bilder aus einer privaten Registrierung heruntergeladen werden müssen, die Anmeldeinformationen erfordert, müssen diese Anmeldeinformationen hier angegeben werden.

type

ContainerType

Die zu verwendende Containertechnologie.

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

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

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.

ContainerType

Die zu verwendende Containertechnologie.

Name Typ Beschreibung
criCompatible

string

Eine CRI-basierte Technologie wird verwendet, um die Container zu starten.

dockerCompatible

string

Eine Docker-kompatible Containertechnologie wird verwendet, um die Container zu starten.

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.

DataDisk

Einstellungen, die von den Datenträgern verwendet werden, die Computeknoten im Pool zugeordnet sind. Wenn Sie angefügte Datenträger verwenden, müssen Sie die Datenträger innerhalb einer VM bereitstellen und formatieren, um sie zu verwenden.

Name Typ Beschreibung
caching

CachingType

Der Typ der Zwischenspeicherung, die für die Datenträger aktiviert werden soll.
Der Standardwert für die Zwischenspeicherung ist "readwrite". Informationen zu den Zwischenspeicherungsoptionen finden Sie unter: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB

integer

Die anfängliche Datenträgergröße in Gigabyte.

lun

integer

Die wahrheitslogische Einheitsnummer.
Die Lun wird verwendet, um jeden Datenträger eindeutig zu identifizieren. Wenn sie mehrere Datenträger anfügen, sollte jeder eine unterschiedliche Lun aufweisen. Der Wert muss zwischen 0 und 63 (einschließlich) liegen.

storageAccountType

StorageAccountType

Der Speicherkontotyp, der für den Datenträger verwendet werden soll.
Wenn nicht angegeben, lautet der Standardwert "standard_lrs".

DiffDiskPlacement

Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger für alle Computeknoten (VMs) im Pool an.

Name Typ Beschreibung
CacheDisk

string

Der ephemerale Betriebssystemdatenträger wird im VM-Cache gespeichert.

DiffDiskSettings

Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom Computeknoten (VM) verwendet wird.

Name Typ Beschreibung
placement

DiffDiskPlacement

Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger für alle virtuellen Computer im Pool an.
Diese Eigenschaft kann vom Benutzer in der Anforderung verwendet werden, um den Speicherort auszuwählen, z. B. Cachespeicherplatz für die Bereitstellung ephemerer Betriebssystemdatenträger. Weitere Informationen zu den Anforderungen an ephemerale Betriebssystemdatenträgergrößen finden Sie unter ephemeren Betriebssystemgrößenanforderungen für Windows-VMs unter https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements und Linux-VMs unter https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

Die Auf Computeknoten im Pool angewendete Datenträgerverschlüsselungskonfiguration. Die Datenträgerverschlüsselungskonfiguration wird im Linux-Pool, der mit dem Azure Compute Gallery Image erstellt wurde, nicht unterstützt.

Name Typ Beschreibung
targets

DiskEncryptionTarget[]

Die Liste der Datenträgerziele für den Batchdienst wird auf dem Computeknoten verschlüsselt.
Die Liste der Datenträgerziele für den Batchdienst wird auf dem Computeknoten verschlüsselt.

DiskEncryptionTarget

Die Liste der Datenträgerziele für den Batchdienst wird auf dem Computeknoten verschlüsselt.

Name Typ Beschreibung
osdisk

string

Der Betriebssystemdatenträger auf dem Computeknoten ist verschlüsselt.

temporarydisk

string

Der temporäre Datenträger auf dem Computeknoten ist verschlüsselt. Unter Linux gilt diese Verschlüsselung für andere Partitionen (z. B. auf bereitgestellten Datenträgern), wenn die Verschlüsselung zur Startzeit auftritt.

DynamicVNetAssignmentScope

Der Umfang der dynamischen vnet-Zuordnung.

Name Typ Beschreibung
job

string

Die dynamische VNet-Zuordnung erfolgt pro Auftrag.

none

string

Es ist keine dynamische VNet-Zuweisung aktiviert.

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.

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
Diese Eigenschaft schließt sich gegenseitig mit anderen Eigenschaften aus und kann aus dem Get-Aufruf der Communitygalerie abgerufen werden.

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.
Beispiel: UbuntuServer oder WindowsServer.

publisher

string

Der Herausgeber des Azure Virtual Machines Marketplace-Images.
Beispiel: Canonical oder MicrosoftWindowsServer.

sharedGalleryImageId

string

Eindeutiger Bezeichner des freigegebenen Katalogbilds
Diese Eigenschaft schließt sich gegenseitig mit anderen Eigenschaften aus und kann aus dem GET-Aufruf des freigegebenen Katalogbilds abgerufen werden.

sku

string

Die SKU des Azure Virtual Machines Marketplace-Images.
Beispiel: 18.04-LTS oder 2019-Datacenter.

version

string

Die Version des Azure Virtual Machines Marketplace-Images.
Ein Wert von "latest" kann angegeben werden, um die neueste Version eines Bilds auszuwählen. Wenn dieser Wert nicht angegeben wird, lautet der Standardwert "latest".

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.
Diese Eigenschaft schließt sich gegenseitig mit anderen ImageReference-Eigenschaften aus. Das Azure Compute Gallery Image muss Replikate in derselben Region aufweisen und muss sich im selben Abonnement wie das Azure Batch-Konto befinden. Wenn die Bildversion in der imageId nicht angegeben ist, wird die neueste Version verwendet. Informationen zu den Firewalleinstellungen für den Batch-Computeknoten-Agent für die Kommunikation mit dem Batchdienst finden Sie unter https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

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.

InboundNATPool

Ein eingehender NAT-Pool, der verwendet werden kann, um bestimmte Ports auf Computeknoten in einem Batchpool extern zu adressieren.

Name Typ Beschreibung
backendPort

integer

Die Portnummer auf dem Computeknoten.
Dies muss innerhalb eines Batchpools eindeutig sein. Zulässige Werte liegen zwischen 1 und 65535, mit Ausnahme von 29876 und 29877, da diese reserviert sind. Wenn reservierte Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.

frontendPortRangeEnd

integer

Die letzte Portnummer im Bereich externer Ports, die verwendet werden, um eingehenden Zugriff auf den Back-EndPort auf einzelnen Computeknoten bereitzustellen.
Zulässige Werte liegen zwischen 1 und 65534 mit Ausnahme von Ports von 50000 bis 55000, die vom Batchdienst reserviert sind. Alle Bereiche innerhalb eines Pools müssen eindeutig sein und können nicht überlappen. Jeder Bereich muss mindestens 40 Ports enthalten. Wenn reservierte oder überlappende Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.

frontendPortRangeStart

integer

Die erste Portnummer im Bereich externer Ports, die verwendet werden, um eingehenden Zugriff auf den Back-EndPort auf einzelnen Computeknoten bereitzustellen.
Zulässige Werte liegen zwischen 1 und 65534 mit Ausnahme von Ports von 50000 bis 55000, die reserviert sind. Alle Bereiche innerhalb eines Pools müssen eindeutig sein und können nicht überlappen. Jeder Bereich muss mindestens 40 Ports enthalten. Wenn reservierte oder überlappende Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.

name

string

Der Name des Endpunkts.
Der Name muss innerhalb eines Batchpools eindeutig sein, kann Buchstaben, Zahlen, Unterstriche, Punkte und Bindestriche enthalten. Namen müssen mit einem Buchstaben oder einer Zahl beginnen, müssen mit einem Buchstaben, einer Zahl oder einem Unterstrich enden und dürfen 77 Zeichen nicht überschreiten. Wenn ungültige Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.

networkSecurityGroupRules

NetworkSecurityGroupRule[]

Eine Liste der Regeln für Netzwerksicherheitsgruppen, die auf den Endpunkt angewendet werden.
Die maximale Anzahl von Regeln, die für alle Endpunkte in einem Batchpool angegeben werden können, beträgt 25. Wenn keine Regeln für Netzwerksicherheitsgruppen angegeben sind, wird eine Standardregel erstellt, um den eingehenden Zugriff auf den angegebenen Back-EndPort zuzulassen. Wenn die maximale Anzahl von Netzwerksicherheitsgruppenregeln überschritten wird, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.

protocol

InboundEndpointProtocol

Das Protokoll des Endpunkts.

IPAddressProvisioningType

Der Bereitstellungstyp für öffentliche IP-Adressen für den Pool.

Name Typ Beschreibung
batchmanaged

string

Eine öffentliche IP wird von Batch erstellt und verwaltet. Je nach Größe des Pools können mehrere öffentliche IPs vorhanden sein.

nopublicipaddresses

string

Es wird keine öffentliche IP-Adresse erstellt.

usermanaged

string

Öffentliche IPs werden vom Benutzer bereitgestellt und zum Bereitstellen der Computeknoten verwendet.

JobConstraints

Die Ausführungseinschränkungen für einen Auftrag.

Name Typ Beschreibung
maxTaskRetryCount

integer

Die maximale Anzahl von Wiederholungsversuchen für jeden Vorgang. 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 jeden Vorgang einmal und kann dann bis zu diesem Grenzwert erneut versuchen. Wenn die maximale Wiederholungsanzahl beispielsweise 3 ist, versucht Batch eine Aufgabe bis zu 4 Mal (ein erster Versuch und 3 Wiederholungsversuche). Wenn die maximale Wiederholungsanzahl 0 ist, führt der Batchdienst keine Wiederholungsaufgaben durch. Wenn die maximale Wiederholungsanzahl -1 ist, wiederholt der Batchdienst Vorgänge ohne Grenzwert. Der Standardwert ist 0 (keine Wiederholungen).

maxWallClockTime

string

Die maximale verstrichene Zeit, die der Auftrag ausführen kann, gemessen vom Zeitpunkt der Erstellung des Auftrags.
Wenn der Auftrag nicht innerhalb des Zeitlimits abgeschlossen wird, beendet der Batchdienst ihn und alle Aufgaben, die noch ausgeführt werden. In diesem Fall ist der Kündigungsgrund MaxWallClockTimeExpiry. Wenn diese Eigenschaft nicht angegeben ist, gibt es kein Zeitlimit für die Ausführung des Auftrags.

JobNetworkConfiguration

Die Netzwerkkonfiguration für den Auftrag.

Name Typ Beschreibung
skipWithdrawFromVNet

boolean

Gibt an, ob Computeknoten vom virtuellen Netzwerk an DNC zurückgenommen werden sollen, wenn der Auftrag beendet oder gelöscht wird.
Wenn true, bleiben Knoten mit dem virtuellen Netzwerk mit DNC verbunden. Wenn false, werden Knoten automatisch zurückgenommen, wenn der Auftrag endet. Standardwert ist "false".

subnetId

string

Der ARM-Ressourcenbezeichner des virtuellen Netzwerksubnetz, in dem Computerknoten ausgeführt werden, die Vorgänge aus dem Auftrag ausführen, werden für die Dauer des Vorgangs verknüpft.
Das virtuelle Netzwerk muss sich in derselben Region und im gleichen Abonnement wie das Azure-Batchkonto befinden. Das angegebene Subnetz sollte über genügend kostenlose IP-Adressen verfügen, um die Anzahl der Computeknoten aufzunehmen, die Aufgaben aus dem Auftrag ausführen. Dies kann bis zur Anzahl der Computeknoten im Pool sein. Der Dienstprinzipal "MicrosoftAzureBatch" muss über die Rolle "Classic Virtual Machine Contributor" Role-Based Access Control (RBAC) für das angegebene VNet verfügen, damit der Azure-Batchdienst Aufgaben auf den Knoten planen kann. Dies kann überprüft werden, indem überprüft wird, ob das angegebene VNet über alle zugehörigen Netzwerksicherheitsgruppen (Network Security Groups, NSG) verfügt. Wenn die Kommunikation mit den Knoten im angegebenen Subnetz von einer NSG verweigert wird, legt der Batchdienst den Status der Computeknoten auf unbrauchbar fest. Dies ist das Format "/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}". Wenn das angegebene VNet über zugeordnete Netzwerksicherheitsgruppen (Network Security Groups, NSG) verfügt, müssen einige reservierte Systemports für eingehende Kommunikation vom Azure Batch-Dienst aktiviert werden. Aktivieren Sie für Pools, die mit einer Konfiguration für virtuelle Computer erstellt wurden, ports 29876 und 29877 sowie Port 22 für Linux und Port 3389 für Windows. Port 443 muss auch für ausgehende Verbindungen für die Kommunikation mit Azure Storage geöffnet sein. Weitere Informationen finden Sie unter: https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPatchParameter

Die Gruppe der Änderungen, die an einem Auftrag vorgenommen werden sollen.

Name Typ Beschreibung
allowTaskPreemption

boolean

Ob Aufgaben in diesem Auftrag von anderen Aufträgen mit hoher Priorität vorgebeutet werden können
Wenn der Wert auf "True" festgelegt ist, haben andere aufträge mit hoher Priorität, die an das System übermittelt werden, Vorrang und können Vorgänge von diesem Auftrag erneut abfragn. Sie können die AllowTaskPreemption eines Auftrags aktualisieren, nachdem er mithilfe der Updateauftrags-API erstellt wurde.

constraints

JobConstraints

Die Ausführungseinschränkungen für den Auftrag.
Ohne Angabe bleiben die vorhandenen Ausführungseinschränkungen unverändert.

maxParallelTasks

integer

Die maximale Anzahl von Vorgängen, die parallel für den Auftrag ausgeführt werden können.
Der Wert von maxParallelTasks muss bei Angabe -1 oder größer als 0 sein. Wenn nicht angegeben, ist der Standardwert -1, was bedeutet, dass es keine Beschränkung für die Anzahl der Aufgaben gibt, die gleichzeitig ausgeführt werden können. Sie können die maxParallelTasks eines Auftrags aktualisieren, nachdem er mithilfe der Updateauftrags-API erstellt wurde.

metadata

MetadataItem[]

Eine Liste von Name-Wert-Paaren, die dem Auftrag als Metadaten zugeordnet sind.
Ohne Angabe bleiben die vorhandenen Auftragsmetadaten unverändert.

networkConfiguration

JobNetworkConfiguration

Die Netzwerkkonfiguration für den Auftrag.

onAllTasksComplete

OnAllTasksComplete

Die Aktion, die der Batchdienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden.
Wenn nicht angegeben, bleibt das Vervollständigungsverhalten unverändert. Sie können den Wert nicht von "terminatejob" in "noaction" ändern – d. h., nachdem Sie die automatische Beendigung des Auftrags aktiviert haben, können Sie ihn nicht wieder deaktivieren. Wenn Sie versuchen, dies zu tun, schlägt die Anforderung mit der Fehlerantwort "Ungültiger Eigenschaftswert" fehl. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).

poolInfo

PoolInformation

Der Pool, in dem der Batchdienst die Aufgaben des Auftrags ausführt.
Sie können den Pool für einen Auftrag nur ändern, wenn der Auftrag deaktiviert ist. Der Patchauftragsaufruf schlägt fehl, wenn Sie das poolInfo-Element einschließen und der Auftrag nicht deaktiviert ist. Wenn Sie eine autoPoolSpecification in der poolInfo angeben, kann nur die keepAlive-Eigenschaft der autoPoolSpecification aktualisiert werden, und dann nur, wenn die autoPoolSpecification über eine poolLifetimeOption of Job verfügt (andere Auftragseigenschaften können normal aktualisiert werden). Wenn dieser Wert nicht angegeben wird, wird der Auftrag weiterhin auf dem aktuellen Pool ausgeführt.

priority

integer

Die Priorität des Auftrags.
Prioritätswerte können zwischen -1000 und 1000 liegen, wobei -1000 die niedrigste Priorität und 1000 die höchste Priorität sind. Wenn sie weggelassen wird, bleibt die Priorität des Auftrags unverändert.

LinuxUserConfiguration

Eigenschaften, die zum Erstellen eines Benutzerkontos auf einem Linux-Computeknoten verwendet werden.

Name Typ Beschreibung
gid

integer

Die Gruppen-ID für das Benutzerkonto.
Die Uid- und gid-Eigenschaften müssen zusammen oder gar nicht angegeben werden. Wenn das zugrunde liegende Betriebssystem nicht angegeben ist, wird das Gid ausgewählt.

sshPrivateKey

string

Der private SSH-Schlüssel für das Benutzerkonto.
Der private Schlüssel darf nicht kennwortgeschützter Schlüssel sein. Der private Schlüssel wird verwendet, um die asymmetrische schlüsselbasierte Authentifizierung für SSH zwischen Computeknoten in einem Linux-Pool automatisch zu konfigurieren, wenn die Eigenschaft "enableInterNodeCommunication" des Pools "true" ist (wird ignoriert, wenn "enableInterNodeCommunication" falsch ist). Dazu wird das Schlüsselpaar in das SSH-Verzeichnis des Benutzers eingefügt. Wenn nicht angegeben, wird kennwortloses SSH nicht zwischen Computeknoten konfiguriert (es erfolgt keine Änderung des SSH-Verzeichnisses des Benutzers).

uid

integer

Die Benutzer-ID des Benutzerkontos.
Die Uid- und gid-Eigenschaften müssen zusammen oder gar nicht angegeben werden. Wenn das zugrunde liegende Betriebssystem nicht angegeben ist, wird die UID ausgewählt.

LoginMode

Der Anmeldemodus für den Benutzer

Name Typ Beschreibung
batch

string

Der LOGON32_LOGON_BATCH Win32-Anmeldemodus. Der Batchanmeldungsmodus wird für lange ausgeführte parallele Prozesse empfohlen.

interactive

string

Der LOGON32_LOGON_INTERACTIVE Win32-Anmeldemodus. UAC ist für Windows-Pools aktiviert. Wenn diese Option mit einer erhöhten Benutzeridentität in einem Windows-Pool verwendet wird, wird die Benutzersitzung nicht erhöht, es sei denn, die Anwendung, die von der Befehlszeile "Aufgabe" ausgeführt wird, ist so konfiguriert, dass immer Administratorrechte erforderlich sind oder immer maximale Berechtigungen erforderlich sind.

ManagedDisk

Name Typ Beschreibung
securityProfile

VMDiskSecurityProfile

Gibt die Sicherheitsprofileinstellungen für den verwalteten Datenträger an.
Gibt die Sicherheitsprofileinstellungen für den verwalteten Datenträger an. Hinweis: Sie kann nur für vertrauliche virtuelle Computer festgelegt werden und ist bei verwendung vertraulicher VMs erforderlich.

storageAccountType

StorageAccountType

Der Speicherkontotyp für verwaltete Datenträger.

MetadataItem

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

Name Typ Beschreibung
name

string

Der Name des Metadatenelements.

value

string

Der Wert des Metadatenelements.

MountConfiguration

Das Dateisystem, das auf jedem Knoten bereitgestellt werden soll.

Name Typ Beschreibung
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

Der Azure Storage-Container, der mithilfe von BLOB-FUSE auf jedem Knoten bereitgestellt werden soll.
Diese Eigenschaft schließt sich gegenseitig mit allen anderen Eigenschaften aus.

azureFileShareConfiguration

AzureFileShareConfiguration

Die Azure-Dateifreigabe, die auf jedem Knoten bereitgestellt werden soll.
Diese Eigenschaft schließt sich gegenseitig mit allen anderen Eigenschaften aus.

cifsMountConfiguration

CIFSMountConfiguration

Das CIFS/SMB-Dateisystem, das auf jedem Knoten bereitgestellt werden soll.
Diese Eigenschaft schließt sich gegenseitig mit allen anderen Eigenschaften aus.

nfsMountConfiguration

NFSMountConfiguration

Das NFS-Dateisystem, das auf jedem Knoten bereitgestellt werden soll.
Diese Eigenschaft schließt sich gegenseitig mit allen anderen Eigenschaften aus.

NetworkConfiguration

Die Netzwerkkonfiguration für einen Pool.

Name Typ Beschreibung
dynamicVNetAssignmentScope

DynamicVNetAssignmentScope

Der Umfang der dynamischen vnet-Zuordnung.

enableAcceleratedNetworking

boolean

Gibt an, ob dieser Pool beschleunigte Netzwerke aktivieren soll.
Das beschleunigte Netzwerk ermöglicht die einzelne E/A-Virtualisierung (SR-IOV) für einen virtuellen Computer, was zu einer verbesserten Netzwerkleistung führen kann. Weitere Informationen finden Sie unter: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.

endpointConfiguration

PoolEndpointConfiguration

Die Konfiguration für Endpunkte auf Computeknoten im Batchpool.

publicIPAddressConfiguration

PublicIPAddressConfiguration

Die Öffentliche IPAddress-Konfiguration für Computeknoten im Batchpool.
Die konfiguration der öffentlichen IP-Adresse der Netzwerkkonfiguration eines Pools.

subnetId

string

Der ARM-Ressourcenbezeichner des virtuellen Netzwerksubnetz, dem die Computeknoten des Pools beitreten. Dies ist das Format "/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}".
Das virtuelle Netzwerk muss sich in derselben Region und im gleichen Abonnement wie das Azure-Batchkonto befinden. Das angegebene Subnetz sollte über genügend kostenlose IP-Adressen verfügen, um die Anzahl der Computeknoten im Pool aufzunehmen. Wenn das Subnetz nicht über genügend freie IP-Adressen verfügt, weist der Pool Knoten teilweise zu, und es tritt ein Fehler bei der Größenänderung auf. Der Dienstprinzipal "MicrosoftAzureBatch" muss über die Rolle "Classic Virtual Machine Contributor" Role-Based Access Control (RBAC) für das angegebene VNet verfügen. Das angegebene Subnetz muss die Kommunikation vom Azure Batch-Dienst zulassen, um Aufgaben auf den Knoten planen zu können. Dies kann überprüft werden, indem überprüft wird, ob das angegebene VNet über alle zugehörigen Netzwerksicherheitsgruppen (Network Security Groups, NSG) verfügt. Wenn die Kommunikation mit den Knoten im angegebenen Subnetz von einer NSG verweigert wird, legt der Batchdienst den Status der Computeknoten auf unbrauchbar fest. Nur virtuelle ARM-Netzwerke ('Microsoft.Network/virtualNetworks') werden unterstützt. Wenn das angegebene VNet über eine zugeordnete Netzwerksicherheitsgruppen (Network Security Groups, NSG) verfügt, müssen einige reservierte Systemports für eingehende Kommunikation aktiviert werden, einschließlich ports 29876 und 29877. Aktivieren Sie auch ausgehende Verbindungen mit Azure Storage auf Port 443. Weitere Informationen finden Sie unter: https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Eine Netzwerksicherheitsgruppenregel, die auf einen eingehenden Endpunkt angewendet werden soll.

Name Typ Beschreibung
access

NetworkSecurityGroupRuleAccess

Die Aktion, die für eine angegebene IP-Adresse, einen Subnetzbereich oder ein Bestimmtes Tag ausgeführt werden soll.

priority

integer

Die Priorität für diese Regel.
Prioritäten innerhalb eines Pools müssen eindeutig sein und in der Reihenfolge der Priorität ausgewertet werden. Je niedriger die Zahl ist, desto höher ist die Priorität. Regeln können beispielsweise mit den Bestellnummern 150, 250 und 350 angegeben werden. Die Regel mit der Bestellnummer 150 hat Vorrang vor der Regel mit einer Reihenfolge von 250. Zulässige Prioritäten sind 150 bis 4096. Wenn reservierte oder doppelte Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.

sourceAddressPrefix

string

Das Quelladressenpräfix oder -tag, das für die Regel übereinstimmen soll.
Gültige Werte sind eine einzelne IP-Adresse (d. h. 10.10.10.10), IP-Subnetz (d. h. 192.168.1.0/24), Standardtag oder * (für alle Adressen). Wenn andere Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.

sourcePortRanges

string[]

Die Quellportbereiche, die für die Regel übereinstimmen sollen.
Gültige Werte sind "" (für alle Ports 0 - 65535), einen bestimmten Port (d. h. 22) oder einen Portbereich (d. h. 100-200). Die Ports müssen im Bereich von 0 bis 65535 liegen. Jeder Eintrag in dieser Sammlung darf keinen anderen Eintrag überlappen (entweder ein Bereich oder ein einzelner Port). Wenn andere Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl. Der Standardwert ist ''.

NetworkSecurityGroupRuleAccess

Die Aktion, die für eine angegebene IP-Adresse, einen Subnetzbereich oder ein Bestimmtes Tag ausgeführt werden soll.

Name Typ Beschreibung
allow

string

Zugriff zulassen.

deny

string

Zugriff verweigern.

NFSMountConfiguration

Informationen, die zum Herstellen einer Verbindung mit einem NFS-Dateisystem verwendet werden.

Name Typ Beschreibung
mountOptions

string

Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen.
Dies sind "net use"-Optionen in Windows und "Mount"-Optionen in Linux.

relativeMountPath

string

Der relative Pfad auf dem Computeknoten, in dem das Dateisystem bereitgestellt wird
Alle Dateisysteme werden relativ zum Batch-Bereitstellungsverzeichnis bereitgestellt, auf das über die Umgebungsvariable AZ_BATCH_NODE_MOUNTS_DIR zugegriffen werden kann.

source

string

Der URI des zu mountden Dateisystems.

NodeCommunicationMode

Bestimmt, wie ein Pool mit dem Batchdienst kommuniziert.

Name Typ Beschreibung
classic

string

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

string

Der Knotenkommunikationsmodus wird automatisch vom Batchdienst festgelegt.

simplified

string

Knoten, die den vereinfachten Kommunikationsmodus verwenden, erfordern ausgehende TCP-Kommunikation an Port 443 zum "BatchNodeManagement". {region}" -Diensttag. Es sind keine offenen eingehenden Ports erforderlich.

NodePlacementConfiguration

Knotenplatzierungskonfiguration für einen Pool.

Name Typ Beschreibung
policy

NodePlacementPolicyType

Knotenplatzierungsrichtlinientyp in Batchpools.
Zuordnungsrichtlinie, die vom Batchdienst zum Bereitstellen der Knoten verwendet wird. Wenn nicht angegeben, verwendet Batch die Regionalrichtlinie.

NodePlacementPolicyType

Die Platzierungsrichtlinie zum Zuordnen von Knoten im Pool.

Name Typ Beschreibung
regional

string

Alle Knoten im Pool werden in derselben Region zugewiesen.

zonal

string

Knoten im Pool werden über verschiedene Verfügbarkeitszonen verteilt, wobei der Best-Effort-Ausgleich gewährleistet ist.

OnAllTasksComplete

Die Aktion, die der Batchdienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden.

Name Typ Beschreibung
noaction

string

Nichts tun. Der Auftrag bleibt aktiv, es sei denn, er wird mit anderen Mitteln beendet oder deaktiviert.

terminatejob

string

Beenden Sie den Auftrag. Der "terminateReason" des Auftrags ist auf "AllTasksComplete" festgelegt.

OSDisk

Einstellungen für den Betriebssystemdatenträger des Computeknotens (VM).

Name Typ Beschreibung
caching

CachingType

Gibt die Zwischenspeicherungsanforderungen an. Mögliche Werte sind: None, ReadOnly, ReadWrite. Die Standardwerte sind: Keine für den Standardspeicher. ReadOnly für Premium-Speicher.
Der Standardwert für die Zwischenspeicherung ist keine. Informationen zu den Zwischenspeicherungsoptionen finden Sie unter: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB

integer

Die anfängliche Datenträgergröße in GB beim Erstellen eines neuen Betriebssystemdatenträgers.

ephemeralOSDiskSettings

DiffDiskSettings

Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom Computeknoten (VM) verwendet wird.

managedDisk

ManagedDisk

Die Parameter des verwalteten Datenträgers.

writeAcceleratorEnabled

boolean

Gibt an, ob writeAccelerator auf dem Datenträger aktiviert oder deaktiviert werden soll.

PoolEndpointConfiguration

Die Endpunktkonfiguration für einen Pool.

Name Typ Beschreibung
inboundNATPools

InboundNATPool[]

Eine Liste der eingehenden NAT-Pools, die verwendet werden können, um bestimmte Ports für einen einzelnen Computeknoten extern zu adressieren.
Die maximale Anzahl eingehender NAT-Pools pro Batchpool beträgt 5. Wenn die maximale Anzahl eingehender NAT-Pools überschritten wird, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl. Dies kann nicht angegeben werden, wenn der IPAddressProvisioningType NoPublicIPAddresses ist.

PoolInformation

Gibt an, wie ein Auftrag einem Pool zugewiesen werden soll.

Name Typ Beschreibung
autoPoolSpecification

AutoPoolSpecification

Merkmale für einen temporären "automatischen Pool". Der Batchdienst erstellt diesen automatischen Pool, wenn der Auftrag übermittelt wird.
Wenn die automatische Poolerstellung fehlschlägt, verschiebt der Batchdienst den Auftrag in einen abgeschlossenen Zustand, und der Poolerstellungsfehler wird in der Planungsfehlereigenschaft des Auftrags festgelegt. Der Batchdienst verwaltet die Lebensdauer (sowohl die Erstellung als auch, es sei denn, keepAlive ist angegeben, Löschvorgang) des automatischen Pools. Alle Benutzeraktionen, die sich auf die Lebensdauer des automatischen Pools auswirken, während der Auftrag aktiv ist, führen zu unerwartetem Verhalten. Sie müssen entweder die Pool-ID oder die Spezifikation für den automatischen Pool angeben, aber nicht beides.

poolId

string

Die ID eines vorhandenen Pools. Alle Aufgaben des Auftrags werden im angegebenen Pool ausgeführt.
Sie müssen sicherstellen, dass der Pool, auf den von dieser Eigenschaft verwiesen wird, vorhanden ist. Wenn der Pool zum Zeitpunkt, zu dem der Batchdienst versucht, einen Auftrag zu planen, nicht vorhanden ist, werden keine Aufgaben für den Auftrag ausgeführt, bis Sie einen Pool mit dieser ID erstellen. Beachten Sie, dass der Batchdienst die Auftragsanforderung nicht ablehnt. Es wird nur Aufgaben ausgeführt, bis der Pool vorhanden ist. Sie müssen entweder die Pool-ID oder die Spezifikation für den automatischen Pool angeben, aber nicht beides.

PoolLifetimeOption

Die mindeste Lebensdauer der erstellten automatischen Pools und wie mehreren Aufträgen in einem Zeitplan Pools zugewiesen werden.

Name Typ Beschreibung
job

string

Der Pool ist für die Lebensdauer des Auftrags vorhanden, dem er zugeordnet ist. Der Batchdienst erstellt den Pool, wenn er den Auftrag erstellt. Wenn die Option "Auftrag" auf einen Auftragsplan angewendet wird, erstellt der Batchdienst einen neuen automatischen Pool für jeden Auftrag, der im Zeitplan erstellt wurde.

jobschedule

string

Der Pool ist für die Lebensdauer des Auftragsplans vorhanden. Der Batchdienst erstellt den Pool, wenn er den ersten Auftrag im Zeitplan erstellt. Sie können diese Option nur auf Auftragspläne und nicht auf Aufträge anwenden.

PoolSpecification

Spezifikation zum Erstellen eines neuen Pools.

Name Typ Beschreibung
applicationPackageReferences

ApplicationPackageReference[]

Die Liste der Pakete, die auf jedem Computeknoten im Pool installiert werden sollen.
Beim Erstellen eines Pools muss die Anwendungs-ID des Pakets vollqualifizierte sein (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Änderungen an Paketverweise wirken sich auf alle neuen Knoten aus, die dem Pool beitreten, wirken sich jedoch nicht auf Computeknoten aus, die sich bereits im Pool befinden, bis sie neu gestartet oder umimages neu erstellt wurden. Es gibt maximal 10 Paketverweise für einen bestimmten Pool.

autoScaleEvaluationInterval

string

Das Zeitintervall, in dem die Poolgröße automatisch entsprechend der Autoskalenformel angepasst werden soll.
Der Standardwert beträgt 15 Minuten. Der Mindest- und Maximalwert beträgt 5 Minuten bzw. 168 Stunden. Wenn Sie einen Wert angeben, der kleiner als 5 Minuten oder größer als 168 Stunden ist, lehnt der Batchdienst die Anforderung mit einem ungültigen Eigenschaftswertfehler ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).

autoScaleFormula

string

Die Formel für die gewünschte Anzahl von Computeknoten im Pool.
Diese Eigenschaft darf nicht angegeben werden, wenn enableAutoScale auf "false" festgelegt ist. Es ist erforderlich, wenn enableAutoScale auf "true" festgelegt ist. Die Formel wird vor der Erstellung des Pools auf Gültigkeit überprüft. Wenn die Formel ungültig ist, lehnt der Batchdienst die Anforderung mit detaillierten Fehlerinformationen ab.

certificateReferences

CertificateReference[]

Eine Liste der Zertifikate, die auf jedem Computeknoten im Pool installiert werden sollen.
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.

displayName

string

Der Anzeigename für den Pool.
Der Anzeigename muss nicht eindeutig sein und kann alle Unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.

enableAutoScale

boolean

Gibt an, ob die Poolgröße im Laufe der Zeit automatisch angepasst werden soll.
Wenn false, muss mindestens eine der targetDedicatedNodes und targetLowPriorityNodes angegeben werden. Bei "true" ist das autoScaleFormula-Element erforderlich. Der Pool ändert die Größe automatisch entsprechend der Formel. Der Standardwert ist "false".

enableInterNodeCommunication

boolean

Gibt an, ob der Pool die direkte Kommunikation zwischen Computeknoten zulässt.
Das Aktivieren der Kommunikation zwischen Knoten begrenzt die maximale Größe des Pools aufgrund von Bereitstellungseinschränkungen auf den Computeknoten des Pools. Dies kann dazu führen, dass der Pool seine gewünschte Größe nicht erreicht. Der Standardwert ist "false".

metadata

MetadataItem[]

Eine Liste von Name-Wert-Paaren, die dem Pool als Metadaten zugeordnet sind.
Der Batchdienst weist Metadaten keine Bedeutung zu; sie ist ausschließlich für die Verwendung von Benutzercode vorgesehen.

mountConfiguration

MountConfiguration[]

Eine Liste der Dateisysteme, die auf jedem Knoten im Pool bereitgestellt werden sollen.
Dies unterstützt Azure Files, NFS, CIFS/SMB und Blobfuse.

networkConfiguration

NetworkConfiguration

Die Netzwerkkonfiguration für den Pool.
Die Netzwerkkonfiguration für einen Pool.

resizeTimeout

string

Das Timeout für die Zuordnung von Computeknoten zum Pool.
Dieses Timeout gilt nur für die manuelle Skalierung; es hat keine Auswirkung, wenn enableAutoScale auf "true" festgelegt ist. Der Standardwert beträgt 15 Minuten. Der Mindestwert beträgt 5 Minuten. Wenn Sie einen Wert kleiner als 5 Minuten angeben, lehnt der Batchdienst die Anforderung mit einem Fehler ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).

resourceTags

object

Die vom Benutzer angegebenen Tags, die dem Pool zugeordnet sind.
Die benutzerdefinierten Tags, die dem Azure-Batchpool zugeordnet werden sollen. Wenn angegeben, werden diese Tags an die zugrunde stehenden Azure-Ressourcen verteilt, die dem Pool zugeordnet sind. Diese Eigenschaft kann nur angegeben werden, wenn das Batchkonto mit der poolAllocationMode-Eigenschaft auf "UserSubscription" festgelegt wurde.

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

targetDedicatedNodes

integer

Die gewünschte Anzahl dedizierter Computeknoten im Pool.
Diese Eigenschaft darf nicht angegeben werden, wenn enableAutoScale auf "true" festgelegt ist. Wenn "enableAutoScale" auf "false" festgelegt ist, müssen Sie entweder targetDedicatedNodes, targetLowPriorityNodes oder beides festlegen.

targetLowPriorityNodes

integer

Die gewünschte Anzahl von Computeknoten mit Spot-/Niedriger Priorität im Pool.
Diese Eigenschaft darf nicht angegeben werden, wenn enableAutoScale auf "true" festgelegt ist. Wenn "enableAutoScale" auf "false" festgelegt ist, müssen Sie entweder targetDedicatedNodes, targetLowPriorityNodes oder beides festlegen.

targetNodeCommunicationMode

NodeCommunicationMode

Der gewünschte Knotenkommunikationsmodus für den Pool.
Wenn dieser Wert nicht angegeben wird, lautet der Standardwert "Default".

taskSchedulingPolicy

TaskSchedulingPolicy

Wie Aufgaben über Computeknoten in einem Pool verteilt werden.
Wenn nicht angegeben, wird die Standardeinstellung verteilt.

taskSlotsPerNode

integer

Die Anzahl der Aufgabenplätze, die zum Ausführen gleichzeitiger Aufgaben auf einem einzelnen Computeknoten im Pool verwendet werden können.
Der Standardwert ist 1. Der Maximalwert ist kleiner als 4 Mal die Anzahl der Kerne der vmSize des Pools oder 256.

upgradePolicy

UpgradePolicy

Die Upgraderichtlinie für den Pool.
Beschreibt eine Upgraderichtlinie – automatisch, manuell oder rolliert.

userAccounts

UserAccount[]

Die Liste der Benutzerkonten, die auf jedem Computeknoten im Pool erstellt werden sollen.

virtualMachineConfiguration

VirtualMachineConfiguration

Die Konfiguration des virtuellen Computers für den Pool.
Diese Eigenschaft muss angegeben werden.

vmSize

string

Die Größe der virtuellen Computer im Pool. Alle virtuellen Computer in einem Pool haben die gleiche Größe.
Informationen zu verfügbaren Größen virtueller Computer in Pools finden Sie unter Auswählen einer VM-Größe für Computeknoten in einem Azure-Batchpool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

PublicIPAddressConfiguration

Die konfiguration der öffentlichen IP-Adresse der Netzwerkkonfiguration eines Pools.

Name Typ Beschreibung
ipAddressIds

string[]

Die Liste der öffentlichen IPs, die der Batchdienst beim Bereitstellen von Computeknoten verwendet.
Die hier angegebene Anzahl von IPs begrenzt die maximale Größe des Pools – 100 dedizierte Knoten oder 100 Spot/Low-Priority-Knoten können für jede öffentliche IP zugewiesen werden. Ein Pool, der 250 dedizierte VMs benötigt, benötigt beispielsweise mindestens 3 öffentliche IPs. Jedes Element dieser Auflistung weist das Format auf: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision

IPAddressProvisioningType

Der Bereitstellungstyp für öffentliche IP-Adressen für den Pool.
Der Standardwert ist BatchManaged.

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.
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-Computeknoten heruntergeladen werden. Sie wird ignoriert, wenn sie für eine resourceFile angegeben wird, die in einen Windows Compute Node heruntergeladen wird. Wenn diese Eigenschaft für einen Linux-Computeknoten nicht angegeben ist, wird auf die Datei ein Standardwert von 0770 angewendet.

filePath

string

Der Speicherort auf dem Computeknoten, in den die Datei(n) heruntergeladen werden soll, relativ zum Arbeitsverzeichnis der Aufgabe.
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 des Vorgangs (z. B. mithilfe von '.') herausbrechen.

httpUrl

string

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

ComputeNodeIdentityReference

Der Verweis auf die vom Benutzer zugewiesene Identität für den Zugriff auf Azure Blob Storage, der durch "storageContainerUrl" oder "httpUrl" angegeben wird
Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool 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: 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.

RollingUpgradePolicy

Die Konfigurationsparameter, die beim Ausführen eines rollierenden Upgrades verwendet werden.

Name Typ Beschreibung
enableCrossZoneUpgrade

boolean

Zulassen, dass VMSS AZ-Grenzen beim Erstellen von Upgradebatches ignoriert. Berücksichtigen Sie die Updatedomäne und maxBatchInstancePercent, um die Batchgröße zu ermitteln. Dieses Feld kann nur bei Verwendung von NodePlacementConfiguration als Zonal auf "true" oder "false" festgelegt werden.

maxBatchInstancePercent

integer

Der maximale Prozentsatz der gesamten Instanzen des virtuellen Computers, die gleichzeitig durch das rollierende Upgrade in einem Batch aktualisiert werden. Da dies ein Maximum ist, können fehlerhafte Instanzen in früheren oder zukünftigen Batches dazu führen, dass der Prozentsatz der Instanzen in einem Batch verringert wird, um eine höhere Zuverlässigkeit sicherzustellen. Der Wert dieses Felds sollte zwischen 5 und 100 (einschließlich) liegen. Wenn "maxBatchInstancePercent" und "maxUnhealthyInstancePercent" mit dem Wert zugewiesen sind, sollte der Wert von "maxBatchInstancePercent" nicht größer als "maxUnhealthyInstancePercent" sein.

maxUnhealthyInstancePercent

integer

Der maximale Prozentsatz der Instanzen des virtuellen Computers im Skalierungssatz, der gleichzeitig fehlerhaft sein kann, entweder aufgrund eines Upgrades oder durch die Integritätsprüfungen des virtuellen Computers in einem fehlerhaften Zustand gefunden wird, bevor das Rollupgrade abgebrochen wird. Diese Einschränkung wird vor dem Starten eines Batches überprüft. Der Wert dieses Felds sollte zwischen 5 und 100 (einschließlich) liegen. Wenn "maxBatchInstancePercent" und "maxUnhealthyInstancePercent" mit dem Wert zugewiesen sind, sollte der Wert von "maxBatchInstancePercent" nicht größer als "maxUnhealthyInstancePercent" sein.

maxUnhealthyUpgradedInstancePercent

integer

Der maximale Prozentsatz der aktualisierten Virtuellen Computerinstanzen, die sich in einem fehlerhaften Zustand befinden. Diese Überprüfung erfolgt, nachdem jeder Batch aktualisiert wurde. Wenn dieser Prozentsatz jemals überschritten wird, wird das rollierende Update abgebrochen. Der Wert dieses Felds sollte zwischen 0 und 100 (einschließlich) liegen.

pauseTimeBetweenBatches

string

Die Wartezeit zwischen Abschluss des Updates für alle virtuellen Computer in einem Batch und starten den nächsten Batch. Die Zeitdauer sollte im ISO 8601-Format angegeben werden.

prioritizeUnhealthyInstances

boolean

Aktualisieren Sie alle fehlerhaften Instanzen in einem Skalierungssatz, bevor alle fehlerfreien Instanzen auftreten.

rollbackFailedInstancesOnPolicyBreach

boolean

Fehler bei Rollbackinstanzen beim vorherigen Modell, wenn die Richtlinie für das Rollupgrade verletzt wird.

SecurityEncryptionTypes

Gibt den EncryptionType des verwalteten Datenträgers an. Sie ist für die Verschlüsselung nur des VMGuestState-Blobs auf "VMGuestStateOnly" und "NonPersistedTPM" festgelegt, damit der Firmwarestatus im VMGuestState-Blob nicht beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden und ist bei Verwendung vertraulicher VMs erforderlich.

Name Typ Beschreibung
NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers an.

Name Typ Beschreibung
encryptionAtHost

boolean

Diese Eigenschaft kann vom Benutzer in der Anforderung verwendet werden, um die Hostverschlüsselung für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers zu aktivieren oder zu deaktivieren. Dadurch wird die Verschlüsselung für alle Datenträger einschließlich Ressourcen-/Temp-Datenträger auf dem Host selbst aktiviert. Weitere Informationen zur Verschlüsselung bei Hostanforderungen finden Sie unter https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes.

securityType

SecurityTypes

Gibt den SecurityType des virtuellen Computers an. Sie muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren.

uefiSettings

UefiSettings

Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden.
Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden.

SecurityTypes

Gibt den SecurityType des virtuellen Computers an. Sie muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren.

Name Typ Beschreibung
confidentialVM

string

Azure Vertraulich Computing bietet vertrauliche VMs für Mandanten mit hohen Sicherheits- und Vertraulichkeitsanforderungen. Diese virtuellen Computer bieten eine starke, hardwaregezwungene Grenze, um Ihre Sicherheitsanforderungen zu erfüllen. Sie können vertrauliche VMs für Migrationen verwenden, ohne Änderungen an Ihrem Code vorzunehmen, wobei die Plattform, die den Status Ihrer VM schützt, nicht gelesen oder geändert wird.

trustedLaunch

string

Der vertrauenswürdige Start schützt vor erweiterten und beständigen Angriffstechniken.

ServiceArtifactReference

Gibt die Dienstartefaktereferenz-ID an, die zum Festlegen derselben Imageversion für alle virtuellen Computer im Skalierungssatz bei Verwendung der neuesten Imageversion verwendet wird.

Name Typ Beschreibung
id

string

Die Dienstartefaktereferenz-ID von ServiceArtifactReference
Die Dienstartefaktereferenz-ID in Form von /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

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.
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://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables) verwenden.

containerSettings

TaskContainerSettings

Die Einstellungen für den Container, unter dem der StartTask ausgeführt wird.
Wenn dies angegeben wird, werden alle Verzeichnisse rekursiv unterhalb der AZ_BATCH_NODE_ROOT_DIR (der Stamm von Azure Batchverzeichnissen auf dem Knoten) dem Container zugeordnet, alle Taskumgebungsvariablen 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 wurden, werden möglicherweise nicht auf den Hostdatenträger wiedergegeben, was bedeutet, dass Batchdatei-APIs nicht auf diese Dateien zugreifen können.

environmentSettings

EnvironmentSetting[]

Eine Liste der Umgebungsvariableneinstellungen für den StartTask.

maxTaskRetryCount

integer

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 der StartTask ausgeführt wird.
Wenn dies nicht angegeben wird, wird die Aufgabe als nicht administrativer Benutzer ausgeführt, der für die Aufgabe eindeutig 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".

StorageAccountType

Der Speicherkontotyp zum Erstellen von Datenträgern oder Betriebssystemdatenträgern.

Name Typ Beschreibung
premium_lrs

string

Der Datenträger/Betriebssystemdatenträger sollte einen lokal redundanten Premiumspeicher verwenden.

standard_lrs

string

Der Datenträger/Betriebssystemdatenträger sollte standardmäßigen lokal redundanten Speicher verwenden.

standardssd_lrs

string

Der Datenträger/Betriebssystemdatenträger sollte standardmäßigen SSD lokal redundanten Speicher verwenden.

TaskContainerSettings

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 zum Erstellen des Containers verwendet werden soll, in dem die Aufgabe ausgeführt wird.
Dies ist der vollständige Imageverweis, wie für "Docker Pull" angegeben. Wenn kein Tag als Teil des Bildnamens 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 sie bereits bei der Poolerstellung bereitgestellt wurde.

workingDirectory

ContainerWorkingDirectory

Der Speicherort des Arbeitsverzeichnisses für containeraufgaben.
Der Standardwert ist "taskWorkingDirectory".

TaskSchedulingPolicy

Gibt an, wie Aufgaben über Computeknoten verteilt werden sollen.

Name Typ Beschreibung
nodeFillType

ComputeNodeFillType

Wie Aufgaben über Computeknoten in einem Pool verteilt werden.
Wenn nicht angegeben, wird die Standardeinstellung verteilt.

UefiSettings

Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden.

Name Typ Beschreibung
secureBootEnabled

boolean

Gibt an, ob der sichere Start auf dem virtuellen Computer aktiviert werden soll.

vTpmEnabled

boolean

Gibt an, ob vTPM auf dem virtuellen Computer aktiviert werden soll.

UpgradeMode

Gibt den Modus eines Upgrades auf virtuelle Computer im Skalierungssatz an.

Mögliche Werte sind:

manuelle – Sie steuern die Anwendung von Updates auf virtuelle Computer im Skalierungssatz. Dazu verwenden Sie die ManualUpgrade-Aktion.

Automatische – Alle virtuellen Computer im Skalierungssatz werden automatisch gleichzeitig aktualisiert.

Roll- – Skalierungssatz führt Aktualisierungen in Batches mit einer optionalen Pausenzeit dazwischen durch.

Name Typ Beschreibung
automatic

string

Alle virtuellen Computer im Skalierungssatz werden automatisch gleichzeitig aktualisiert.

manual

string

Sie steuern die Anwendung von Updates auf virtuelle Computer im Skalierungssatz. Dazu verwenden Sie die ManualUpgrade-Aktion.

rolling

string

Die vorhandenen Instanzen in einem Skalierungssatz werden in Batches heruntergesetzt, um aktualisiert zu werden. Sobald der aktualisierte Batch abgeschlossen ist, beginnen die Instanzen erneut mit dem Datenverkehr, und der nächste Batch beginnt. Dies wird fortgesetzt, bis alle Instanzen up-to-date gebracht wurden.

UpgradePolicy

Beschreibt eine Upgraderichtlinie – automatisch, manuell oder rolliert.

Name Typ Beschreibung
automaticOSUpgradePolicy

AutomaticOSUpgradePolicy

Konfigurationsparameter, die zum Ausführen des automatischen Betriebssystemupgrades verwendet werden.
Die Konfigurationsparameter, die zum Ausführen eines automatischen Betriebssystemupgrades verwendet werden.

mode

UpgradeMode

Gibt den Modus eines Upgrades auf virtuelle Computer im Skalierungssatz an.

Mögliche Werte sind:

manuelle – Sie steuern die Anwendung von Updates auf virtuelle Computer im Skalierungssatz. Dazu verwenden Sie die ManualUpgrade-Aktion.

Automatische – Alle virtuellen Computer im Skalierungssatz werden automatisch gleichzeitig aktualisiert.

Roll- – Skalierungssatz führt Aktualisierungen in Batches mit einer optionalen Pausenzeit dazwischen durch.

rollingUpgradePolicy

RollingUpgradePolicy

Die Konfigurationsparameter, die beim Ausführen eines rollierenden Upgrades verwendet werden.
Die Konfigurationsparameter, die beim Ausführen eines rollierenden Upgrades verwendet werden.

UserAccount

Eigenschaften zum Erstellen eines Benutzers, der zum Ausführen von Aufgaben auf einem Azure Batch Compute Node verwendet wird.

Name Typ Beschreibung
elevationLevel

ElevationLevel

Die Höhe des Benutzerkontos.
Der Standardwert ist "nonAdmin".

linuxUserConfiguration

LinuxUserConfiguration

Die Linux-spezifische Benutzerkonfiguration für das Benutzerkonto.
Diese Eigenschaft wird ignoriert, wenn sie in einem Windows-Pool angegeben ist. Wenn nicht angegeben, wird der Benutzer mit den Standardoptionen erstellt.

name

string

Der Name des Benutzerkontos. Namen können bis zu einer maximalen Länge von 20 Unicode-Zeichen enthalten.

password

string

Das Kennwort für das Benutzerkonto.

windowsUserConfiguration

WindowsUserConfiguration

Die Windows-spezifische Benutzerkonfiguration für das Benutzerkonto.
Diese Eigenschaft kann nur angegeben werden, wenn sich der Benutzer in einem Windows-Pool befindet. Wenn nicht angegeben und in einem Windows-Pool, wird der Benutzer mit den Standardoptionen erstellt.

UserIdentity

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

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.

VirtualMachineConfiguration

Die Konfiguration für Computeknoten in einem Pool basierend auf der Azure Virtual Machines-Infrastruktur.

Name Typ Beschreibung
containerConfiguration

ContainerConfiguration

Die Containerkonfiguration für den Pool.
Wenn angegeben, wird das Setup für jeden Computeknoten im Pool ausgeführt, damit Aufgaben in Containern ausgeführt werden können. Alle regulären Aufgaben und Auftrags-Manager-Aufgaben, die auf diesem Pool ausgeführt werden, müssen die eigenschaft containerSettings angeben, und alle anderen Aufgaben können sie angeben.

dataDisks

DataDisk[]

Die Konfiguration für Datenträger, die an die Computeknoten im Pool angefügt sind.
Diese Eigenschaft muss angegeben werden, wenn die Computeknoten im Pool über leere Datenträger verfügen müssen, die an sie angefügt sind. Dies kann nicht aktualisiert werden. Jeder Computeknoten erhält einen eigenen Datenträger (der Datenträger ist keine Dateifreigabe). Vorhandene Datenträger können nicht angefügt werden, jeder angefügte Datenträger ist leer. Wenn der Computeknoten aus dem Pool entfernt wird, werden auch der Datenträger und alle damit verbundenen Daten gelöscht. Der Datenträger ist nach dem Anfügen nicht formatiert, es muss vor der Verwendung formatiert werden . Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux und https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

diskEncryptionConfiguration

DiskEncryptionConfiguration

Die Datenträgerverschlüsselungskonfiguration für den Pool.
Wenn angegeben, wird die Verschlüsselung für jeden Knoten im Pool während der Knotenbereitstellung ausgeführt.

extensions

VMExtension[]

Die Erweiterung des virtuellen Computers für den Pool.
Wenn angegeben, werden die in dieser Konfiguration genannten Erweiterungen auf jedem Knoten installiert.

imageReference

ImageReference

Ein Verweis auf das Azure Virtual Machines Marketplace-Image oder das zu verwendende benutzerdefinierte Virtuelle Computerimage.

licenseType

string

Der Typ der lokalen Lizenz, die beim Bereitstellen des Betriebssystems verwendet werden soll.
Dies gilt nur für Images, die das Windows-Betriebssystem enthalten, und sollten nur verwendet werden, wenn Sie gültige lokale Lizenzen für die Computeknoten besitzen, die bereitgestellt werden. Ohne Angabe wird kein lokaler Lizenzierungsrabatt angewendet. Werte sind:

Windows_Server – Die lokale Lizenz gilt für Windows Server. Windows_Client – Die lokale Lizenz ist für Windows Client.

nodeAgentSKUId

string

Die SKU des Batch-Computeknoten-Agents, der auf Computeknoten im Pool bereitgestellt werden soll.
Der Batch Compute Node-Agent ist ein Programm, das auf jedem Computeknoten im Pool ausgeführt wird und die Befehls- und Steuerungsschnittstelle zwischen dem Computeknoten und dem Batchdienst bereitstellt. Es gibt unterschiedliche Implementierungen des Compute Node-Agents, die als SKUs bezeichnet werden, für verschiedene Betriebssysteme. Sie müssen eine Computeknoten-Agent-SKU angeben, die dem ausgewählten Imageverweis entspricht. Informationen zum Abrufen der Liste der unterstützten ComputeKnoten-Agent-SKUs sowie deren Liste der überprüften Imageverweise finden Sie unter "Liste unterstützter Computeknoten-Agent-SKUs".

nodePlacementConfiguration

NodePlacementConfiguration

Die Knotenplatzierungskonfiguration für den Pool.
Diese Konfiguration gibt Regeln für die physische Zuordnung von Knoten im Pool an.

osDisk

OSDisk

Einstellungen für den Betriebssystemdatenträger des virtuellen Computers.

securityProfile

SecurityProfile

Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers an.
Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers an.

serviceArtifactReference

ServiceArtifactReference

Gibt die Dienstartefaktereferenz-ID an, die zum Festlegen derselben Imageversion für alle virtuellen Computer im Skalierungssatz bei Verwendung der neuesten Imageversion verwendet wird.
Die Dienstartefaktereferenz-ID in Form von /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

windowsConfiguration

WindowsConfiguration

Windows-Betriebssystemeinstellungen auf dem virtuellen Computer.
Diese Eigenschaft darf nicht angegeben werden, wenn die imageReference-Eigenschaft ein Linux-Betriebssystemimage angibt.

VMDiskSecurityProfile

Gibt die Sicherheitsprofileinstellungen für den verwalteten Datenträger an. Hinweis: Sie kann nur für vertrauliche virtuelle Computer festgelegt werden und ist bei verwendung vertraulicher VMs erforderlich.

Name Typ Beschreibung
securityEncryptionType

SecurityEncryptionTypes

Gibt den EncryptionType des verwalteten Datenträgers an. Sie ist für die Verschlüsselung nur des VMGuestState-Blobs auf "VMGuestStateOnly" und "NonPersistedTPM" festgelegt, damit der Firmwarestatus im VMGuestState-Blob nicht beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden und ist bei Verwendung vertraulicher VMs erforderlich.

VMExtension

Die Konfiguration für Erweiterungen virtueller Computer.

Name Typ Beschreibung
autoUpgradeMinorVersion

boolean

Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zur Bereitstellungszeit verfügbar ist. Nach der Bereitstellung aktualisiert die Erweiterung jedoch keine Nebenversionen, es sei denn, sie werden erneut bereitgestellt, auch wenn diese Eigenschaft auf "true" festgelegt ist.

enableAutomaticUpgrade

boolean

Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist.

name

string

Der Name der Erweiterung des virtuellen Computers.

protectedSettings

object

Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten.

provisionAfterExtensions

string[]

Die Sammlung von Erweiterungsnamen.
Sammlung von Erweiterungsnamen, nach denen diese Erweiterung bereitgestellt werden muss.

publisher

string

Der Name des Herausgebers des Erweiterungshandlers.

settings

object

JSON-formatierte öffentliche Einstellungen für die Erweiterung.

type

string

Der Typ der Erweiterung.

typeHandlerVersion

string

Die Version des Skripthandlers.

WindowsConfiguration

Windows-Betriebssystemeinstellungen, die auf den virtuellen Computer angewendet werden sollen.

Name Typ Beschreibung
enableAutomaticUpdates

boolean

Gibt an, ob automatische Updates auf dem virtuellen Computer aktiviert sind.
Wenn dieser Wert nicht angegeben wird, ist der Standardwert "true".

WindowsUserConfiguration

Eigenschaften, die zum Erstellen eines Benutzerkontos auf einem Windows-Computeknoten verwendet werden.

Name Typ Beschreibung
loginMode

LoginMode

Der Anmeldemodus für den Benutzer
Der Standardwert ist "batch".