Job - List From Job Schedule

Service:

Batch Service

API Version:

2023-11-01.18.0

Listet die Aufträge auf, die unter dem angegebenen Auftragszeitplan erstellt wurden.

GET {batchUrl}/jobschedules/{jobScheduleId}/jobs?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobschedules/{jobScheduleId}/jobs?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
batchUrl	path	True	string	Die Basis-URL für alle Azure Batch-Dienstanforderungen.
jobScheduleId	path	True	string	Die ID des Auftragszeitplans, aus dem Sie eine Liste der Aufträge abrufen möchten.
api-version	query	True	string	Client-API-Version.
$expand	query		string	Eine OData-$expand-Klausel.
$filter	query		string	Eine OData-$filter-Klausel. Weitere Informationen zum Erstellen dieses Filters finden Sie unter https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule.
$select	query		string	Eine OData $select-Klausel.
maxresults	query		integer int32	Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Es können maximal 1.000 Aufträge zurückgegeben werden.
timeout	query		integer int32	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden aufwenden kann. Der Standardwert ist 30 Sekunden.

Anforderungsheader

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

Name	Erforderlich	Typ	Beschreibung
client-request-id		string uuid	Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Gibt an, ob der Server die client-request-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.

Antworten

Name	Typ	Beschreibung
200 OK	CloudJobListResult	Eine Antwort, die die Liste der Aufträge enthält. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Der Fehler vom Batch-Dienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodeflow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Authorization

Type: apiKey
In: header

Beispiele

List Job Under Job Schedule

Sample Request

HTTP

GET account.region.batch.azure.com/jobschedules/jobScheduleId/jobs?api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "jobId",
      "url": "https://account.region.batch.azure.com/jobs/jobId",
      "eTag": "0x8D4100FC46D5BF4",
      "lastModified": "2016-11-19T00:05:27.2137716Z",
      "creationTime": "2016-11-19T00:05:25.311915Z",
      "state": "active",
      "stateTransitionTime": "2016-11-19T00:05:27.2137716Z",
      "previousState": "disabled",
      "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z",
      "priority": 0,
      "maxParallelTasks": -1,
      "allowTaskPreemption": false,
      "usesTaskDependencies": false,
      "constraints": {
        "maxWallClockTime": "P10675199DT2H48M5.4775807S",
        "maxTaskRetryCount": 0
      },
      "poolInfo": {
        "poolId": "poolId"
      },
      "executionInfo": {
        "startTime": "2016-11-19T00:05:25.3309105Z",
        "poolId": "poolId"
      },
      "onAllTasksComplete": "noaction",
      "onTaskFailure": "noaction"
    }
  ]
}

Definitionen

Name	Beschreibung
AccessScope	Die Batch-Ressourcen, auf die das Token Zugriff gewährt.
ApplicationPackageReference	Ein Verweis auf ein Paket, das auf Computeknoten bereitgestellt werden soll.
AuthenticationTokenSettings	Die Einstellungen für ein Authentifizierungstoken, das der Task zum Ausführen von Batch-Dienstvorgängen verwenden kann.
AutoPoolSpecification	Gibt Merkmale für einen temporären "automatischen Pool" an. Der Batch-Dienst 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 einen Task im Batch-Dienst 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-Dateifreigabe 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 dem 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.
CloudJob	Ein Azure Batch-Auftrag.
CloudJobListResult	Das Ergebnis der Auflistung der Aufträge in einem Konto.
CloudServiceConfiguration	Die Konfiguration für Computeknoten in einem Pool basierend auf der Azure Cloud Services-Plattform.
ComputeNodeFillType	Wie Aufgaben auf Computeknoten in einem Pool verteilt werden
ComputeNodeIdentityReference	Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.
ContainerConfiguration	Die Konfiguration für containerfähige Pools.
ContainerRegistry	Eine private Containerregistrierung.
ContainerType	Die zu verwendende Containertechnologie.
ContainerWorkingDirectory	Der Speicherort des Arbeitsverzeichnisses des Containertasks.
DataDisk	Einstellungen, die von den Datenträgern verwendet werden, die Computeknoten im Pool zugeordnet sind. Wenn Sie die angefügten Datenträger verwenden, müssen Sie sie innerhalb eines virtuellen Computers einbinden 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 Datenträgerverschlüsselungskonfiguration, die auf Computeknoten im Pool angewendet wird. Die Konfiguration der Datenträgerverschlüsselung wird in einem Linux-Pool, der mit dem Azure Compute Gallery-Image erstellt wurde, nicht unterstützt.
DiskEncryptionTarget	Die Liste der Datenträgerziele Der Batch-Dienst verschlüsselt auf dem Computeknoten.
DynamicVNetAssignmentScope	Der Bereich der dynamischen VNET-Zuweisung.
ElevationLevel	Die Höhenebene des Benutzers.
EnvironmentSetting	Eine Umgebungsvariable, die für einen Vorgangsvorgang festgelegt werden soll.
ErrorCategory	Die Kategorie des Fehlers.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.
HttpHeader	Ein HTTP-Header-Name-Wert-Paar
ImageReference	Ein Verweis auf ein Azure Virtual Machines Marketplace-Image oder ein Azure Compute-Katalogimage. Informationen zum Abrufen der Liste aller von Azure Batch überprüften Azure Marketplace Imageverweise finden Sie im Vorgang "Unterstützte Images auflisten".
InboundEndpointProtocol	Das Protokoll des Endpunkts.
InboundNATPool	Ein NAT-Pool für eingehenden Datenverkehr, 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.
JobExecutionInformation	Enthält Informationen zur Ausführung eines Auftrags im Azure Batch-Dienst.
JobManagerTask	Gibt Details eines Auftrags-Manager-Tasks an.
JobNetworkConfiguration	Die Netzwerkkonfiguration für den Auftrag.
JobPreparationTask	Ein Auftragsvorbereitungstask, der vor allen Aufgaben des Auftrags auf einem beliebigen Computeknoten ausgeführt werden soll.
JobReleaseTask	Ein Auftragsfreigabetask, der bei Auftragserledigung auf einem beliebigen Computeknoten ausgeführt werden soll, auf dem der Auftrag ausgeführt wurde.
JobSchedulingError	Ein Fehler, der vom Batch-Dienst beim Planen eines Auftrags auftritt.
JobState	Der Status des Auftrags.
JobStatistics	Ressourcennutzungsstatistiken für einen Auftrag.
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 Batch-Dienstressource zugeordnet ist.
MountConfiguration	Das Dateisystem, das auf jedem Knoten bereitgestellt werden soll.
NameValuePair	Stellt ein Name-Wert-Paar dar.
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 subnetzspezifischen Bereich oder ein 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 Batch-Dienst kommuniziert.
NodePlacementConfiguration	Knotenplatzierungskonfiguration für einen Pool.
NodePlacementPolicyType	Die Platzierungsrichtlinie zum Zuweisen von Knoten im Pool.
OnAllTasksComplete	Die Aktion, die der Batch-Dienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Status Abgeschlossen befinden.
OnTaskFailure	Die Aktion, die der Batch-Dienst ausführen sollte, wenn eine Aufgabe im Auftrag fehlschlägt.
OSDisk	Einstellungen für den Betriebssystemdatenträger des Computeknotens (VM).
OutputFile	Eine Spezifikation zum Hochladen von Dateien aus einem Azure Batch Computeknoten an einen anderen Speicherort, nachdem der Batch-Dienst die Ausführung des Vorgangs abgeschlossen hat.
OutputFileBlobContainerDestination	Gibt ein Dateiuploadziel in einem Azure Blob Storage-Container an.
OutputFileDestination	Das Ziel, in das eine Datei hochgeladen werden soll.
OutputFileUploadCondition	Die Bedingungen, unter denen eine Taskausgabedatei oder eine Gruppe von Dateien hochgeladen werden soll.
OutputFileUploadOptions	Details zu einem Ausgabedateiuploadvorgang, einschließlich der Bedingungen, unter welchen Bedingungen der Upload ausgeführt werden soll.
PoolEndpointConfiguration	Die Endpunktkonfiguration für einen Pool.
PoolInformation	Gibt an, wie ein Auftrag einem Pool zugewiesen werden soll.
PoolLifetimeOption	Die Mindestlebensdauer erstellter automatischer Pools und die Zuweisung mehrerer Aufträge nach einem Zeitplan zu Pools.
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 auf einen Computeknoten heruntergeladen werden sollen.
SecurityProfile	Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die VM-Skalierungsgruppe an.
SecurityTypes	Gibt den SecurityType des virtuellen Computers an. Es muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren.
ServiceArtifactReference	Gibt die Referenz-ID des Dienstartefakts an, die verwendet wird, um dieselbe Imageversion für alle virtuellen Computer in der Skalierungsgruppe festzulegen, wenn die neueste Imageversion verwendet wird.
StartTask	Eine Aufgabe, die ausgeführt wird, wenn ein Knoten einen Pool im Azure Batch-Dienst hinzuschließt oder wenn der Computeknoten neu gestartet oder ein neuer Image erstellt wird.
StorageAccountType	Der Speicherkontotyp zum Erstellen von Datenträgern oder Betriebssystemdatenträgern.
TaskConstraints	Ausführungseinschränkungen, die auf einen Task angewendet werden sollen.
TaskContainerSettings	Die Containereinstellungen für einen Task.
TaskSchedulingPolicy	Gibt an, wie Tasks auf Computeknoten verteilt werden sollen.
UefiSettings	Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden.
UserAccount	Eigenschaften, die zum Erstellen eines Benutzers zum Ausführen von Aufgaben auf einem Azure Batch Computeknoten verwendet werden.
UserIdentity	Die Definition der Benutzeridentität, unter der der Task ausgeführt wird.
VirtualMachineConfiguration	Die Konfiguration für Computeknoten in einem Pool basierend auf der Azure Virtual Machines-Infrastruktur.
VMExtension	Die Konfiguration für VM-Erweiterungen.
WindowsConfiguration	Windows-Betriebssystemeinstellungen, die auf den virtuellen Computer angewendet werden sollen.
WindowsUserConfiguration	Eigenschaften, die zum Erstellen eines Benutzerkontos auf einem Windows-Computeknoten verwendet werden.

AccessScope

Die Batch-Ressourcen, auf die das Token Zugriff gewährt.

Name	Typ	Beschreibung
job	string	Gewährt Zugriff auf alle Vorgänge für den Auftrag, der den Task enthält.

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 voll qualifiziert sein (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Die Version der bereitzustellenden Anwendung. Wenn sie nicht angegeben wird, wird die Standardversion bereitgestellt. Wenn dies in einem Pool ausgelassen wird und keine Standardversion für diese Anwendung angegeben wird, schlägt die Anforderung mit dem Fehlercode InvalidApplicationPackageReferences und HTTP status Code 409 fehl. Wenn dies für einen Task ausgelassen wird und keine Standardversion für diese Anwendung angegeben ist, schlägt der Task mit einem Vorverarbeitungsfehler fehl.

AuthenticationTokenSettings

Die Einstellungen für ein Authentifizierungstoken, das der Task zum Ausführen von Batch-Dienstvorgängen verwenden kann.

Name	Typ	Beschreibung
access	AccessScope[]	Die Batch-Ressourcen, auf die das Token Zugriff gewährt. Das Authentifizierungstoken gewährt Zugriff auf eine begrenzte Gruppe von Batch-Dienstvorgängen. Der einzige unterstützte Wert für die Access-Eigenschaft ist "job", der Zugriff auf alle Vorgänge im Zusammenhang mit dem Auftrag gewährt, der den Task enthält.

AutoPoolSpecification

Gibt Merkmale für einen temporären "automatischen Pool" an. Der Batch-Dienst 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 ein Pool automatisch erstellt wird. Der Batch-Dienst weist jedem automatischen Pool bei der Erstellung einen eindeutigen Bezeichner zu. Um zwischen Pools zu unterscheiden, die für verschiedene 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 seiner Lebensdauer am Leben erhalten werden soll. Wenn false, löscht der Batch-Dienst den Pool, sobald seine Lebensdauer (wie durch die poolLifetimeOption-Einstellung bestimmt) abläuft. das heißt, wenn der Auftrags- oder Auftragszeitplan abgeschlossen ist. Wenn true, löscht der Batch-Dienst den Pool nicht automatisch. Es liegt am Benutzer, automatische Pools zu löschen, die mit dieser Option erstellt wurden.
pool	PoolSpecification	Die Poolspezifikation für den automatischen Pool.
poolLifetimeOption	PoolLifetimeOption	Die Mindestlebensdauer erstellter automatischer Pools und die Zuweisung mehrerer Aufträge nach einem Zeitplan zu Pools.

AutoUserScope

Der Bereich für den automatischen Benutzer

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

AutoUserSpecification

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

Name	Typ	Beschreibung
elevationLevel	ElevationLevel	Die Höhenebene des automatischen Benutzers. Der Standardwert ist nonAdmin.
scope	AutoUserScope	Der Bereich für den automatischen Benutzer Der Standardwert ist pool. Wenn im Pool Windows ausgeführt wird, sollte ein Wert von Task angegeben werden, wenn eine strengere Isolation zwischen Aufgaben erforderlich ist. Beispielsweise, wenn die Aufgabe die Registrierung auf eine Weise mutiert, die sich auf andere Aufgaben auswirken könnte, oder wenn Zertifikate für den Pool angegeben wurden, auf die nicht für normale Aufgaben zugegriffen werden sollte, sondern von StartTasks zugänglich sein sollte.

AzureBlobFileSystemConfiguration

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

Name	Typ	Beschreibung
accountKey	string	Der Schlüssel des Azure-Speicherkontos. Diese Eigenschaft schließt sich mit sasKey und identity gegenseitig aus. genau eins 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 unter Linux.
containerName	string	Der Azure Blob Storage Containername.
identityReference	ComputeNodeIdentityReference	Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf containerName verwendet werden soll. Diese Eigenschaft schließt sich mit accountKey und sasKey gegenseitig aus. genau eins muss angegeben werden.
relativeMountPath	string	Der relative Pfad auf dem Computeknoten, auf dem das Dateisystem eingebunden 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 mit accountKey und identity gegenseitig aus. genau eins muss angegeben werden.

AzureFileShareConfiguration

Informationen, die zum Herstellen einer Verbindung mit einer Azure-Dateifreigabe 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 hat die Form "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 unter Linux.
relativeMountPath	string	Der relative Pfad auf dem Computeknoten, auf dem das Dateisystem eingebunden 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 sollten programmgesteuert verwendet werden.
message	ErrorMessage	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
values	BatchErrorDetail[]	Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthält.

BatchErrorDetail

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

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

CachingType

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

Name	Typ	Beschreibung
none	string	Der Zwischenspeichermodus für den Datenträger ist nicht aktiviert.
readonly	string	Der Cachemodus für den Datenträger ist schreibgeschützter.
readwrite	string	Der Zwischenspeichermodus für den Datenträger ist Lese- und Schreibzugriff.

CertificateReference

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

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

CertificateStoreLocation

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

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

CertificateVisibility

Welche Benutzerkonten auf dem Computeknoten 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 der StartTask ausgeführt wird. Beachten Sie, dass dieses Zertifikat auch für den Task sichtbar ist, wenn der AutoUser-Bereich sowohl für startTask als auch für einen Task pool ist.
task	string	Das Zertifikat sollte für die Benutzerkonten sichtbar sein, unter denen Auftragsaufgaben ausgeführt werden.

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 unter Linux.
password	string	Das Kennwort, das für die Authentifizierung beim CIFS-Dateisystem verwendet werden soll.
relativeMountPath	string	Der relative Pfad auf dem Computeknoten, auf dem das Dateisystem eingebunden 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 dateisystems, das eingebunden werden soll.
username	string	Der Benutzer, der für die Authentifizierung beim CIFS-Dateisystem verwendet werden soll.

CloudJob

Ein Azure Batch-Auftrag.

Name	Typ	Standardwert	Beschreibung
allowTaskPreemption	boolean		Ob Aufgaben in diesem Auftrag von anderen Aufträgen mit hoher Priorität vorbelastet 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 Aufgaben aus diesem Auftrag erneut quequenen. Sie können die allowTaskPreemption eines Auftrags aktualisieren, nachdem er mithilfe der Aktualisierungsauftrags-API erstellt wurde.
commonEnvironmentSettings	EnvironmentSetting[]		Die Liste der allgemeinen Umgebungsvariableneinstellungen. Diese Umgebungsvariablen werden für alle Aufgaben im Auftrag festgelegt (einschließlich Auftrags-Manager, Auftragsvorbereitung und Auftragsfreigabetasks). Einzelne Aufgaben können eine hier angegebene Umgebungseinstellung überschreiben, indem sie denselben Einstellungsnamen mit einem anderen Wert angeben.
constraints	JobConstraints		Die Ausführungseinschränkungen für den Auftrag.
creationTime	string		Die Erstellungszeit des Auftrags.
displayName	string		Der Anzeigename für den Auftrag.
eTag	string		Das ETag des Auftrags. Dies ist eine undurchsichtige Zeichenfolge. Sie können es verwenden, um zu erkennen, ob sich der Auftrag zwischen Anforderungen geändert hat. Insbesondere können Sie das ETag übergeben, wenn Sie einen Auftrag aktualisieren, um anzugeben, dass Ihre Änderungen nur wirksam werden sollen, wenn der Auftrag in der Zwischenzeit von keiner anderen Person geändert wurde.
executionInfo	JobExecutionInformation		Die Ausführungsinformationen für den Auftrag.
id	string		Eine Zeichenfolge, die den Auftrag innerhalb des Kontos eindeutig identifiziert. Bei der ID wird die Groß-/Kleinschreibung beibehalten und die Groß-/Kleinschreibung nicht beachtet (d. h. sie verfügen möglicherweise nicht über zwei IDs innerhalb eines Kontos, die sich nur nach Groß- und Kleinschreibung unterscheiden).
jobManagerTask	JobManagerTask		Details zu einer Auftrags-Manager-Aufgabe, die beim Starten des Auftrags gestartet werden soll. Der Auftrags-Manager-Task wird automatisch gestartet, wenn der Auftrag erstellt wird. Der Batch-Dienst versucht, den Auftrags-Manager-Task vor allen anderen Aufgaben im Auftrag zu planen. Beim Verkleinern eines Pools versucht der Batch-Dienst, Knoten beizubehalten, auf denen Job Manager-Aufgaben so lange wie möglich ausgeführt werden (das heißt, Computeknoten, auf denen "normale" Aufgaben ausgeführt werden, werden vor Computeknoten entfernt, auf denen Job Manager-Aufgaben ausgeführt werden). Wenn ein Auftrags-Manager-Task fehlschlägt und neu gestartet werden muss, versucht das System, ihn mit der höchsten Priorität zu planen. Wenn keine Computeknoten im Leerlauf verfügbar sind, kann das System eine der ausgeführten Tasks im Pool beenden und an die Warteschlange zurückgeben, um Platz für den Neustart des Auftrags-Manager-Tasks zu schaffen. Beachten Sie, dass eine Auftrags-Manager-Aufgabe in einem Auftrag keine Priorität gegenüber Aufgaben in anderen Aufträgen hat. Bei allen Aufträgen werden nur Prioritäten auf Auftragsebene beachtet. Wenn beispielsweise ein Auftrags-Manager in einem Auftrag der Priorität 0 neu gestartet werden muss, verdrängt er keine Aufgaben eines Auftrags der Priorität 1. Batch wiederholt Aufgaben, wenn ein Wiederherstellungsvorgang auf einem Knoten ausgelöst wird. Beispiele für Wiederherstellungsvorgänge sind (aber nicht beschränkt auf), wenn ein fehlerhafter Knoten neu gestartet wird oder ein Computeknoten aufgrund eines Hostfehlers verschwunden ist. Wiederholungsversuche aufgrund von Wiederherstellungsvorgängen sind unabhängig von und werden nicht mit maxTaskRetryCount gezählt. Auch wenn maxTaskRetryCount 0 ist, kann es aufgrund eines Wiederherstellungsvorgangs zu einer internen Wiederholung kommen. Aus diesem Gründen sollten alle Aufgaben idempotent sein. Dies bedeutet, dass Tasks es tolerieren müssen, dass sie unterbrochen und neu gestartet werden, ohne dass es zu Beschädigungen oder doppelten Daten kommt. Die bewährte Methode für Aufgaben mit langer Ausführungsdauer besteht darin, eine Form von Prüfpunkten zu verwenden.
jobPreparationTask	JobPreparationTask		Der Vorgang zur Auftragsvorbereitung. Der Auftragsvorbereitungstask ist eine spezielle Aufgabe, die auf jedem Computeknoten vor jeder anderen Aufgabe des Auftrags ausgeführt wird.
jobReleaseTask	JobReleaseTask		Der Auftragsfreigabetask. Der Auftragsfreigabetask ist eine spezielle Aufgabe, die am Ende des Auftrags auf jedem Computeknoten ausgeführt wird, der eine andere Aufgabe des Auftrags ausgeführt hat.
lastModified	string		Der Zeitpunkt der letzten Änderung des Auftrags. Dies ist der letzte Zeitpunkt, zu dem sich die Daten auf Auftragsebene, z. B. der Auftragsstatus oder die Priorität, geändert haben. Änderungen auf Aufgabenebene, z. B. das Hinzufügen neuer Aufgaben oder aufgabenverändernder Status, werden nicht mit einbeglichen.
maxParallelTasks	integer	-1	Die maximale Anzahl von Aufgaben, die parallel für den Auftrag ausgeführt werden können. Der Wert von maxParallelTasks muss -1 oder größer als 0 sein, sofern angegeben. Wenn nicht angegeben, ist der Standardwert -1. Dies bedeutet, dass es keine Begrenzung für die Anzahl von 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. Der Batch-Dienst weist Metadaten keine Bedeutung zu. es dient ausschließlich der Verwendung von Benutzercode.
networkConfiguration	JobNetworkConfiguration		Die Netzwerkkonfiguration für den Auftrag.
onAllTasksComplete	OnAllTasksComplete		Die Aktion, die der Batch-Dienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Status Abgeschlossen befinden. Der Standardwert ist noaction.
onTaskFailure	OnTaskFailure		Die Aktion, die der Batch-Dienst ausführen sollte, wenn eine Aufgabe im Auftrag fehlschlägt. Ein Task gilt als fehlgeschlagen, wenn eine failureInfo vorhanden ist. Eine failureInfo wird festgelegt, wenn der Task mit einem Exitcode von ungleich 0 abgeschlossen wird, nachdem die Wiederholungsanzahl ausgeschöpft wurde, oder wenn ein Fehler beim Starten des Tasks aufgetreten ist, z. B. aufgrund eines Fehlers zum Herunterladen einer Ressourcendatei. Der Standardwert ist noaction.
poolInfo	PoolInformation		Die Pooleinstellungen, die dem Auftrag zugeordnet sind.
previousState	JobState		Der vorherige Status des Auftrags. Diese Eigenschaft wird nicht festgelegt, wenn sich der Auftrag im anfangs aktiven Zustand befindet.
previousStateTransitionTime	string		Der Zeitpunkt, zu dem der Auftrag in den vorherigen Zustand eingetreten ist. Diese Eigenschaft wird nicht festgelegt, wenn sich der Auftrag im anfangs aktiven Zustand befindet.
priority	integer		Die Priorität des Auftrags. Die Prioritätswerte reichen von -1.000 bis 1.000. Dabei ist -1.000 die niedrigste Priorität und 1000 die höchste Priorität. Der Standardwert ist 0.
state	JobState		Der aktuelle Status des Auftrags.
stateTransitionTime	string		Die Zeit, zu der der Auftrag in den aktuellen Zustand eingetreten ist.
stats	JobStatistics		Ressourcennutzungsstatistiken für die gesamte Lebensdauer des Auftrags. Diese Eigenschaft wird nur aufgefüllt, wenn der CloudJob mit einer expand-Klausel einschließlich des Attributs "stats" abgerufen wurde. andernfalls ist es NULL. Die Statistiken sind möglicherweise nicht sofort verfügbar. Der Batch-Dienst führt ein regelmäßiges Rollup von Statistiken aus. Die typische Verzögerung beträgt etwa 30 Minuten.
url	string		Die URL des Auftrags.
usesTaskDependencies	boolean		Gibt an, ob Aufgaben im Auftrag Abhängigkeiten voneinander definieren können. Die Standardeinstellung ist „false“.

CloudJobListResult

Das Ergebnis der Auflistung der Aufträge in einem Konto.

Name	Typ	Beschreibung
odata.nextLink	string	Die URL zum Abrufen der nächsten Gruppe von Ergebnissen.
value	CloudJob[]	Die Liste der Aufträge.

CloudServiceConfiguration

Die Konfiguration für Computeknoten in einem Pool basierend auf der Azure Cloud Services-Plattform.

Name	Typ	Beschreibung
osFamily	string	Die Azure-Gastbetriebssystemfamilie, die auf den virtuellen Computern im Pool installiert werden soll. Mögliche Werte sind: 2 – Betriebssystemfamilie 2, entspricht Windows Server 2008 R2 SP1. 3 : Betriebssystemfamilie 3, entspricht Windows Server 2012. 4 : Betriebssystemfamilie 4, entspricht Windows Server 2012 R2. 5 : Betriebssystemfamilie 5, entspricht Windows Server 2016. 6 : Betriebssystemfamilie 6, entspricht Windows Server 2019. Weitere Informationen finden Sie unter Azure-Gastbetriebssystemversionen (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
osVersion	string	Die Azure-Gastbetriebssystemversion, die auf den virtuellen Computern im Pool installiert werden soll. Der Standardwert ist * und gibt die neueste Betriebssystemversion für die angegebene Betriebssystemfamilie an.

ComputeNodeFillType

Wie Aufgaben auf Computeknoten in einem Pool verteilt werden

Name	Typ	Beschreibung
pack	string	Jedem Computeknoten im Pool sollten so viele Tasks wie möglich (taskSlotsPerNode) zugewiesen werden, bevor aufgaben dem nächsten Computeknoten im Pool zugewiesen werden.
spread	string	Aufgaben sollten gleichmäßig auf allen Computeknoten im Pool zugewiesen werden.

ComputeNodeIdentityReference

Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.

Name	Typ	Beschreibung
resourceId	string	Die ARM-Ressourcen-ID der benutzerseitig zugewiesenen Identität.

ContainerConfiguration

Die Konfiguration für containerfähige Pools.

Name	Typ	Beschreibung
containerImageNames	string[]	Die Auflistung von Containerimagenamen. Dies ist der vollständige Imageverweis, wie für "Docker Pull" angegeben wird. Ein Image wird aus der Docker-Standardregistrierung bezogen, es sei denn, das Image ist mit einer alternativen Registrierung vollständig qualifiziert.
containerRegistries	ContainerRegistry[]	Zusätzliche private Registrierungen, aus denen Container abgerufen werden können. Wenn Images aus einer privaten Registrierung heruntergeladen werden müssen, die Anmeldeinformationen erfordert, müssen diese Anmeldeinformationen hier angegeben werden.
type	ContainerType	Die zu verwendende Containertechnologie.

ContainerRegistry

Eine private Containerregistrierung.

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

ContainerType

Die zu verwendende Containertechnologie.

Name	Typ	Beschreibung
criCompatible	string	Zum Starten der Container wird eine CRI-basierte Technologie verwendet.
dockerCompatible	string	Zum Starten der Container wird eine Docker-kompatible Containertechnologie verwendet.

ContainerWorkingDirectory

Der Speicherort des Arbeitsverzeichnisses des Containertasks.

Name	Typ	Beschreibung
containerImageDefault	string	Verwenden Sie das im Containerimage definierte Arbeitsverzeichnis. Achten Sie darauf, dass dieses Verzeichnis die von Batch heruntergeladenen Ressourcendateien nicht enthält.
taskWorkingDirectory	string	Verwenden Sie das Standardmäßige Arbeitsverzeichnis Batch-Diensttask, das die Aufgabenressourcendateien enthält, die von Batch aufgefüllt werden.

DataDisk

Einstellungen, die von den Datenträgern verwendet werden, die Computeknoten im Pool zugeordnet sind. Wenn Sie die angefügten Datenträger verwenden, müssen Sie sie innerhalb eines virtuellen Computers einbinden 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 das Zwischenspeichern 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 Nummer der logischen Einheit. Der lun wird verwendet, um jeden Datenträger eindeutig zu identifizieren. Beim Anfügen mehrerer Datenträger sollte jeder eine eigene Lun aufweisen. Der Wert muss zwischen 0 und 63 liegen, einschließlich.
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 kurzlebige 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 VMs im Pool an. Diese Eigenschaft kann vom Benutzer in der Anforderung verwendet werden, um den Speicherort auszuwählen, z. B. zwischenspeichern des Speicherplatzes für die kurzlebige Betriebssystemdatenträgerbereitstellung. Weitere Informationen zu den Anforderungen für kurzlebige Betriebssystemdatenträger finden Sie unter Anforderungen an kurzlebige Betriebssystemdatenträgergröße für Windows-VMs unter https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements und Linux-VMs unter https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

Die Datenträgerverschlüsselungskonfiguration, die auf Computeknoten im Pool angewendet wird. Die Konfiguration der Datenträgerverschlüsselung wird in einem Linux-Pool, der mit dem Azure Compute Gallery-Image erstellt wurde, nicht unterstützt.

Name	Typ	Beschreibung
targets	DiskEncryptionTarget[]	Die Liste der Datenträgerziele Batch Service verschlüsselt auf dem Computeknoten. Wenn nicht angegeben, werden keine Datenträger auf den Computeknoten im Pool verschlüsselt. Im Linux-Pool wird nur "TemporaryDisk" unterstützt. im Windows-Pool müssen "OsDisk" und "TemporaryDisk" angegeben werden.

DiskEncryptionTarget

Die Liste der Datenträgerziele Der Batch-Dienst verschlüsselt auf dem Computeknoten.

Name	Typ	Beschreibung
osdisk	string	Der Betriebssystemdatenträger auf dem Computeknoten ist verschlüsselt.
temporarydisk	string	Der temporäre Datenträger auf dem Computeknoten wird verschlüsselt. Unter Linux gilt diese Verschlüsselung für andere Partitionen (z. B. auf eingebundenen Datenträgern), wenn die Verschlüsselung zum Startzeitpunkt erfolgt.

DynamicVNetAssignmentScope

Der Bereich der dynamischen VNET-Zuweisung.

Name	Typ	Beschreibung
job	string	Die dynamische VNet-Zuweisung erfolgt pro Auftrag.
none	string	Es ist keine dynamische VNET-Zuweisung aktiviert.

ElevationLevel

Die Höhenebene des Benutzers.

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

EnvironmentSetting

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

Name	Typ	Beschreibung
name	string	Der Name der Umgebungsvariablen.
value	string	Der Wert der Umgebungsvariablen.

ErrorCategory

Die Kategorie des Fehlers.

Name	Typ	Beschreibung
servererror	string	Der Fehler ist auf ein internes Serverproblem zurückzuführen.
usererror	string	Der Fehler ist auf ein Benutzerproblem zurückzuführen, z. B. eine falsche Konfiguration.

ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.

Name	Typ	Beschreibung
lang	string	Der Sprachcode der Fehlermeldung
value	string	Der Text der Meldung.

HttpHeader

Ein HTTP-Header-Name-Wert-Paar

Name	Typ	Beschreibung
name	string	Der Name des Headers, der beim Hochladen von Ausgabedateien verwendet werden soll, wobei die Groß-/Kleinschreibung nicht beachtet wird.
value	string	Der Wert des Headers, der beim Hochladen von Ausgabedateien verwendet werden soll

ImageReference

Ein Verweis auf ein Azure Virtual Machines Marketplace-Image oder ein Azure Compute-Katalogimage. Informationen zum Abrufen der Liste aller von Azure Batch überprüften Azure Marketplace Imageverweise finden Sie im Vorgang "Unterstützte Images auflisten".

Name	Typ	Beschreibung
exactVersion	string	Die spezifische Version des Plattformimages oder Marketplace-Images, das zum Erstellen des Knotens verwendet wird. Dieses schreibgeschützte Feld unterscheidet sich von "version" nur, wenn der für "version" angegebene Wert bei der Erstellung des Pools "neueste" war.
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.
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. Der Wert "latest" kann angegeben werden, um die neueste Version eines Images auszuwählen. Wenn nicht angegeben, lautet der Standardwert "latest".
virtualMachineImageId	string	Der ARM-Ressourcenbezeichner des Azure Compute-Katalogimages. Computeknoten im Pool werden mithilfe dieser Image-ID erstellt. Dies hat das Format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} oder /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} für immer die neueste Imageversion. Diese Eigenschaft schließt sich gegenseitig mit anderen ImageReference-Eigenschaften aus. Das Azure Compute Gallery-Image muss Replikate in derselben Region aufweisen und sich im selben Abonnement wie das Azure Batch-Konto befinden. Wenn die Imageversion in der imageId nicht angegeben ist, wird die neueste Version verwendet. Informationen zu den Firewalleinstellungen für den Batch Compute Node-Agent für die Kommunikation mit dem Batch-Dienst finden Sie unter https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#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 NAT-Pool für eingehenden Datenverkehr, 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 22, 3389, 29876 und 29877, da diese reserviert sind. Wenn reservierte Werte bereitgestellt werden, schlägt die Anforderung mit HTTP-status Code 400 fehl.
frontendPortRangeEnd	integer	Die letzte Portnummer im Bereich externer Ports, die verwendet wird, um eingehenden Zugriff auf den back-EndPort auf einzelnen Computeknoten zu ermöglichen. Zulässige Werte liegen zwischen 1 und 65534 mit Ausnahme von Ports von 50000 bis 55000, die vom Batch-Dienst reserviert werden. Alle Bereiche innerhalb eines Pools müssen eindeutig sein und können sich nicht überschneiden. Jeder Bereich muss mindestens 40 Ports enthalten. Wenn reservierte oder überlappende Werte bereitgestellt werden, schlägt die Anforderung mit HTTP-status Code 400 fehl.
frontendPortRangeStart	integer	Die erste Portnummer im Bereich der externen Ports, die verwendet wird, um eingehenden Zugriff auf den back-EndPort auf einzelnen Computeknoten zu ermöglichen. Zulässige Werte liegen zwischen 1 und 65534, mit Ausnahme der reservierten Ports von 50000 bis 55000. Alle Bereiche innerhalb eines Pools müssen eindeutig sein und können sich nicht überschneiden. Jeder Bereich muss mindestens 40 Ports enthalten. Wenn reservierte oder überlappende Werte bereitgestellt werden, schlägt die Anforderung mit HTTP-status Code 400 fehl.
name	string	Der Name des Endpunkts. Der Name muss innerhalb eines Batchpools eindeutig sein und kann Buchstaben, Zahlen, Unterstriche, Punkte und Bindestriche enthalten. Namen müssen mit einem Buchstaben oder einer Zahl beginnen, mit einem Buchstaben, einer Zahl oder einem Unterstrich enden und dürfen nicht länger als 77 Zeichen sein. Wenn ungültige Werte bereitgestellt werden, schlägt die Anforderung mit HTTP-status Code 400 fehl.
networkSecurityGroupRules	NetworkSecurityGroupRule[]	Eine Liste der Netzwerksicherheitsgruppenregeln, 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 Netzwerksicherheitsgruppenregeln angegeben sind, wird eine Standardregel erstellt, um eingehenden Zugriff auf den angegebenen backPort zuzulassen. Wenn die maximale Anzahl von Netzwerksicherheitsgruppenregeln überschritten wird, schlägt die Anforderung mit HTTP-status Code 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-Adresse wird von Batch erstellt und verwaltet. Abhängig von der Größe des Pools können mehrere öffentliche IP-Adressen vorhanden sein.
nopublicipaddresses	string	Es wird keine öffentliche IP-Adresse erstellt.
usermanaged	string	Öffentliche IP-Adressen 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 der Wiederholungen für jeden Vorgang. Der Batch-Dienst versucht einen Vorgang erneut, wenn sein Exitcode nicht zero ist. Beachten Sie, dass dieser Wert die Anzahl der Wiederholungen ausdrücklich steuert. Der Batch-Dienst versucht jeden Task einmal und kann dann bis zu diesem Grenzwert erneut versuchen. Wenn die maximale Wiederholungsanzahl beispielsweise 3 beträgt, versucht Batch einen Vorgang bis zu vier Mal (ein erster Versuch und 3 Wiederholungen). Wenn die maximale Wiederholungsanzahl 0 ist, führt der Batch-Dienst keine Wiederholungsaufgaben durch. Wenn die maximale Wiederholungsanzahl -1 beträgt, wiederholt der Batch-Dienst Tasks ohne Limit. Der Standardwert ist 0 (keine Wiederholungsversuche).
maxWallClockTime	string	Die maximale verstrichene Zeit, die der Auftrag ausführen darf, gemessen an der Zeit, zu der der Auftrag erstellt wird. Wenn der Auftrag nicht innerhalb des Zeitlimits abgeschlossen wird, beendet der Batch-Dienst ihn und alle Aufgaben, die noch ausgeführt werden. In diesem Fall lautet der Kündigungsgrund MaxWallClockTimeExpiry. Wenn diese Eigenschaft nicht angegeben ist, gibt es kein Zeitlimit für die Ausführungsdauer des Auftrags.

JobExecutionInformation

Enthält Informationen zur Ausführung eines Auftrags im Azure Batch-Dienst.

Name	Typ	Beschreibung
endTime	string	Die Abschlusszeit des Auftrags. Diese Eigenschaft wird nur festgelegt, wenn sich der Auftrag im Status abgeschlossen befindet.
poolId	string	Die ID des Pools, dem dieser Auftrag zugewiesen ist. Dieses Element enthält den tatsächlichen Pool, in dem der Auftrag zugewiesen wird. Wenn Sie Auftragsdetails aus dem Dienst abrufen, enthalten sie auch ein poolInfo-Element, das die Poolkonfigurationsdaten aus dem Zeitpunkt enthält, als der Auftrag hinzugefügt oder aktualisiert wurde. Dieses poolInfo-Element kann auch ein poolId-Element enthalten. Wenn dies der Fall ist, sind die beiden IDs identisch. Andernfalls bedeutet dies, dass der Auftrag in einem automatischen Pool ausgeführt wurde und diese Eigenschaft die ID dieses automatischen Pools enthält.
schedulingError	JobSchedulingError	Details zu allen Fehlern, die der Dienst beim Starten des Auftrags gefunden hat. Diese Eigenschaft wird nicht festgelegt, wenn beim Starten des Auftrags kein Fehler aufgetreten ist.
startTime	string	Die Startzeit des Auftrags. Dies ist der Zeitpunkt, zu dem der Auftrag erstellt wurde.
terminateReason	string	Eine Zeichenfolge, die den Grund beschreibt, aus dem der Auftrag beendet wurde. Diese Eigenschaft wird nur festgelegt, wenn sich der Auftrag im Status abgeschlossen befindet. Wenn der Batch-Dienst den Auftrag beendet, legt er den Grund wie folgt fest: JMComplete – der Auftrags-Manager-Task wurde abgeschlossen, und killJobOnCompletion wurde auf true festgelegt. MaxWallClockTimeExpiry : Der Auftrag hat seine maxWallClockTime-Einschränkung erreicht. TerminateJobSchedule: Der Auftrag wurde als Teil eines Zeitplans ausgeführt, und der Zeitplan wurde beendet. AllTasksComplete: Das onAllTasksComplete-Attribut des Auftrags ist auf terminatejob festgelegt, und alle Aufgaben im Auftrag sind abgeschlossen. TaskFailed: Das onTaskFailure-Attribut des Auftrags ist auf performExitOptionsJobAction festgelegt, und ein Task im Auftrag ist mit einer Exitbedingung fehlgeschlagen, die eine jobAction von terminatejob angegeben hat. Jede andere Zeichenfolge ist ein benutzerdefinierter Grund, der in einem Aufruf des Vorgangs "Auftrag beenden" angegeben wird.

JobManagerTask

Gibt Details eines Auftrags-Manager-Tasks an.

Name	Typ	Beschreibung
allowLowPriorityNode	boolean	Gibt an, ob der Job Manager-Task auf einem Computeknoten mit spot/low-priority ausgeführt werden kann. Der Standardwert lautet „true“.
applicationPackageReferences	ApplicationPackageReference[]	Eine Liste der Anwendungspakete, die der Batch-Dienst auf dem Computeknoten bereitstellt, bevor die Befehlszeile ausgeführt wird. Anwendungspakete werden heruntergeladen und in einem freigegebenen Verzeichnis bereitgestellt, nicht im Arbeitsverzeichnis Task. Wenn sich ein Anwendungspaket, auf das verwiesen wird, bereits auf dem Computeknoten befindet und auf dem neuesten Stand ist, wird es daher nicht erneut heruntergeladen. Die vorhandene Kopie auf dem Computeknoten wird verwendet. Wenn ein Anwendungspaket, auf das verwiesen wird, nicht installiert werden kann, z. B. weil das Paket gelöscht wurde oder der Download fehlgeschlagen ist, schlägt der Task fehl.
authenticationTokenSettings	AuthenticationTokenSettings	Die Einstellungen für ein Authentifizierungstoken, das der Task zum Ausführen von Batch-Dienstvorgängen verwenden kann. Wenn diese Eigenschaft festgelegt ist, stellt der Batch-Dienst der Aufgabe ein Authentifizierungstoken bereit, das zum Authentifizieren von Batch-Dienstvorgängen verwendet werden kann, ohne dass ein Kontozugriffsschlüssel erforderlich ist. Das Token wird über die AZ_BATCH_AUTHENTICATION_TOKEN Umgebungsvariable bereitgestellt. Die Vorgänge, die der Task mit dem Token ausführen kann, hängen von den Einstellungen ab. Beispielsweise kann ein Task Auftragsberechtigungen anfordern, um dem Auftrag weitere Aufgaben hinzuzufügen, oder die status des Auftrags oder anderer Aufgaben unter dem Auftrag überprüfen.
commandLine	string	Die Befehlszeile des Auftrags-Manager-Tasks. Die Befehlszeile wird nicht unter einer Shell ausgeführt und kann daher keine Shellfeatures wie die Erweiterung von Umgebungsvariablen nutzen. Wenn Sie solche Features nutzen möchten, sollten Sie die Shell in der Befehlszeile aufrufen, z. B. mit "cmd /c MyCommand" in Windows oder mit "/bin/sh -c MyCommand" unter Linux. Wenn die Befehlszeile auf Dateipfade verweist, sollte sie einen relativen Pfad (relativ zum Arbeitsverzeichnis Task) verwenden oder die von Batch bereitgestellte Umgebungsvariable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) verwenden.
constraints	TaskConstraints	Einschränkungen, die für den Auftrags-Manager-Task gelten.
containerSettings	TaskContainerSettings	Die Einstellungen für den Container, unter dem der Auftrags-Manager-Task ausgeführt wird. Wenn für den Pool, der diesen Task ausführen soll, containerConfiguration festgelegt ist, muss auch dies festgelegt werden. Wenn für den Pool, der diesen Task ausführen soll, containerConfiguration nicht festgelegt ist, darf dies nicht festgelegt werden. Wenn dies angegeben ist, werden alle Verzeichnisse, die sich rekursiv unterhalb des AZ_BATCH_NODE_ROOT_DIR befinden (der Stamm der Azure Batch Verzeichnisse auf dem Knoten) dem Container zugeordnet, alle Umgebungsvariablen der Aufgabe werden dem Container zugeordnet, und die Task-Befehlszeile wird im Container ausgeführt. Dateien, die im Container außerhalb von AZ_BATCH_NODE_ROOT_DIR erstellt werden, werden möglicherweise nicht auf dem Hostdatenträger angezeigt, was bedeutet, dass Batch-Datei-APIs nicht auf diese Dateien zugreifen können.
displayName	string	Der Anzeigename des Auftrags-Manager-Tasks. Sie muss nicht eindeutig sein und kann unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.
environmentSettings	EnvironmentSetting[]	Eine Liste der Umgebungsvariableneinstellungen für den Job Manager-Task.
id	string	Eine Zeichenfolge, die den Auftrags-Manager-Task innerhalb des Auftrags eindeutig identifiziert. Die ID kann eine beliebige Kombination alphanumerischer Zeichen enthalten, einschließlich Bindestrichen und Unterstrichen, und darf nicht mehr als 64 Zeichen enthalten.
killJobOnCompletion	boolean	Gibt an, ob der Abschluss des Auftrags-Manager-Tasks den Abschluss des gesamten Auftrags bedeutet. Wenn true, markiert der Batch-Dienst den Auftrag als abgeschlossen, wenn der Auftrags-Manager-Task abgeschlossen ist. Wenn Aufgaben zu diesem Zeitpunkt noch ausgeführt werden (mit Ausnahme der Auftragsfreigabe), werden diese Aufgaben beendet. Wenn false, wirkt sich die Vervollständigung des Auftrags-Manager-Tasks nicht auf den status Auftrag aus. In diesem Fall sollten Sie entweder das onAllTasksComplete-Attribut verwenden, um den Auftrag zu beenden, oder ein Client oder Benutzer sollte den Auftrag explizit beenden. Ein Beispiel hierfür ist, wenn der Auftrags-Manager eine Reihe von Aufgaben erstellt, dann aber keine weitere Rolle bei der Ausführung übernimmt. Der Standardwert lautet „true“. Wenn Sie die Attribute onAllTasksComplete und onTaskFailure verwenden, um die Lebensdauer des Auftrags zu steuern, und die Auftrags-Manager-Aufgabe nur zum Erstellen der Aufgaben für den Auftrag verwenden (nicht zum Überwachen des Status), ist es wichtig, killJobOnCompletion auf false festzulegen.
outputFiles	OutputFile[]	Eine Liste der Dateien, die der Batch-Dienst nach dem Ausführen der Befehlszeile aus dem Computeknoten hochlädt. Bei Aufgaben mit mehreren instance werden die Dateien nur aus dem Computeknoten hochgeladen, auf dem der primäre Task ausgeführt wird.
requiredSlots	integer	Die Anzahl der Planungsslots, die der Task zum Ausführen benötigt. Der Standardwert ist 1. Eine Aufgabe kann nur für die Ausführung auf einem Computeknoten geplant werden, wenn der Knoten über genügend freie Planungsslots verfügt. Für Aufgaben mit mehreren instance wird diese Eigenschaft nicht unterstützt und darf nicht angegeben werden.
resourceFiles	ResourceFile[]	Eine Liste der Dateien, die der Batch-Dienst vor dem Ausführen der Befehlszeile auf den Computeknoten lädt. Die unter diesem Element aufgeführten Dateien befinden sich im Arbeitsverzeichnis des Tasks. Es gibt eine maximale Größe für die Liste der Ressourcendateien. Wenn die maximale Größe überschritten wird, schlägt die Anforderung fehl, und der Antwortfehlercode lautet RequestEntityTooLarge. In diesem Fall muss die Auflistung von ResourceFiles verkleinert werden. Dies kann mit .zip-Dateien, Anwendungspaketen oder Docker-Containern erreicht werden.
runExclusive	boolean	Gibt an, ob der Job Manager-Task die exklusive Verwendung des Computeknotens erfordert, in dem er ausgeführt wird. Wenn true, werden keine anderen Tasks auf demselben Knoten ausgeführt, solange der Auftrags-Manager ausgeführt wird. Wenn false, können andere Aufgaben gleichzeitig mit dem Auftrags-Manager auf einem Computeknoten ausgeführt werden. Der Auftrags-Manager-Task zählt normalerweise mit dem Gleichzeitigen Vorgangslimit des Computeknotens, sodass dies nur relevant ist, wenn der Computeknoten mehrere gleichzeitige Tasks zulässt. Der Standardwert lautet „true“.
userIdentity	UserIdentity	Die Benutzeridentität, unter der der Auftrags-Manager-Task ausgeführt wird. Wenn er nicht angegeben wird, wird der Task als nicht administrativer Benutzer ausgeführt, der für den Task eindeutig ist.

JobNetworkConfiguration

Die Netzwerkkonfiguration für den Auftrag.

Name	Typ	Beschreibung
subnetId	string	Der ARM-Ressourcenbezeichner des Subnetzes des virtuellen Netzwerks, dem Computeknoten, die Aufgaben aus dem Auftrag ausführen, für die Dauer des Tasks beitreten. Dies funktioniert nur mit einem VirtualMachineConfiguration-Pool. Das virtuelle Netzwerk muss sich in derselben Region und demselben Abonnement wie das Azure Batch-Konto befinden. Das angegebene Subnetz sollte über genügend freie 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 "Mitwirkender virtueller klassischer Computer" Role-Based Access Control (RBAC) für das angegebene VNET verfügen, damit Azure Batch Dienst Aufgaben auf den Knoten planen kann. Dies kann überprüft werden, indem überprüft wird, ob das angegebene VNET über netzwerksicherheitsgruppen (NSG) verfügt. Wenn die Kommunikation mit den Knoten im angegebenen Subnetz von einer NSG verweigert wird, legt der Batch-Dienst den Zustand der Computeknoten auf unbrauchbar fest. Dies hat das Format /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Wenn das angegebene VNET über netzwerksicherheitsgruppen (NSG) verfügt, müssen einige reservierte Systemports für die eingehende Kommunikation vom Azure Batch-Dienst aktiviert sein. Aktivieren Sie für Pools, die mit einer VM-Konfiguration erstellt wurden, die 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/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPreparationTask

Ein Auftragsvorbereitungstask, der vor allen Aufgaben des Auftrags auf einem beliebigen Computeknoten ausgeführt werden soll.

Name	Typ	Beschreibung
commandLine	string	Die Befehlszeile des Auftragsvorbereitungstask. Die Befehlszeile wird nicht unter einer Shell ausgeführt und kann daher keine Shellfeatures wie die Erweiterung von Umgebungsvariablen nutzen. Wenn Sie solche Features nutzen möchten, sollten Sie die Shell in der Befehlszeile aufrufen, z. B. mit "cmd /c MyCommand" in Windows oder mit "/bin/sh -c MyCommand" unter Linux. Wenn die Befehlszeile auf Dateipfade verweist, sollte sie einen relativen Pfad (relativ zum Arbeitsverzeichnis Task) verwenden oder die von Batch bereitgestellte Umgebungsvariable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) verwenden.
constraints	TaskConstraints	Einschränkungen, die für den Auftragsvorbereitungstask gelten.
containerSettings	TaskContainerSettings	Die Einstellungen für den Container, unter dem der Auftragsvorbereitungstask ausgeführt wird. Wenn dies angegeben ist, werden alle Verzeichnisse, die sich rekursiv unterhalb des AZ_BATCH_NODE_ROOT_DIR befinden (der Stamm der Azure Batch Verzeichnisse auf dem Knoten) dem Container zugeordnet, alle Umgebungsvariablen der Aufgabe werden dem Container zugeordnet, und die Task-Befehlszeile wird im Container ausgeführt. Dateien, die im Container außerhalb von AZ_BATCH_NODE_ROOT_DIR erstellt werden, werden möglicherweise nicht auf dem Hostdatenträger angezeigt, was bedeutet, dass Batch-Datei-APIs nicht auf diese Dateien zugreifen können.
environmentSettings	EnvironmentSetting[]	Eine Liste der Umgebungsvariableneinstellungen für den Auftragsvorbereitungstask.
id	string	Eine Zeichenfolge, die den Auftragsvorbereitungstask innerhalb des Auftrags eindeutig identifiziert. Die ID kann eine beliebige Kombination alphanumerischer Zeichen enthalten, einschließlich Bindestrichen und Unterstrichen, und darf nicht mehr als 64 Zeichen enthalten. Wenn Sie diese Eigenschaft nicht angeben, weist der Batch-Dienst den Standardwert "jobpreparation" zu. Keine andere Aufgabe im Auftrag kann dieselbe ID wie die Auftragsvorbereitungsaufgabe aufweisen. Wenn Sie versuchen, einen Task mit derselben ID zu übermitteln, lehnt der Batch-Dienst die Anforderung mit dem Fehlercode TaskIdSameAsJobPreparationTask ab. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-status Code 409 (Konflikt).
rerunOnNodeRebootAfterSuccess	boolean	Gibt an, ob der Batch-Dienst den Auftragsvorbereitungstask nach dem Neustart eines Computeknotens erneut ausführen soll. Der Auftragsvorbereitungstask wird immer erneut ausgeführt, wenn ein Computeknoten neu erstellt wird oder wenn der Auftragsvorbereitungstask nicht abgeschlossen wurde (z. B. weil der Neustart während der Ausführung des Tasks erfolgte). Daher sollten Sie immer einen Auftragsvorbereitungstask schreiben, um idempotent zu sein und sich bei mehrfacher Ausführung ordnungsgemäß zu verhalten. Der Standardwert lautet „true“.
resourceFiles	ResourceFile[]	Eine Liste der Dateien, die der Batch-Dienst vor dem Ausführen der Befehlszeile auf den Computeknoten lädt. Die unter diesem Element aufgeführten Dateien befinden sich im Arbeitsverzeichnis des Tasks. Es gibt eine maximale Größe für die Liste der Ressourcendateien. Wenn die maximale Größe überschritten wird, schlägt die Anforderung fehl, und der Antwortfehlercode lautet RequestEntityTooLarge. In diesem Fall muss die Auflistung von ResourceFiles verkleinert werden. Dies kann mit .zip-Dateien, Anwendungspaketen oder Docker-Containern erreicht werden.
userIdentity	UserIdentity	Die Benutzeridentität, unter der der Auftragsvorbereitungstask ausgeführt wird. Wenn er nicht angegeben wird, wird der Task als nicht administrativer Benutzer ausgeführt, der für die Aufgabe auf Windows-Computeknoten eindeutig ist, oder als nicht administrativer Benutzer, der für den Pool auf Linux-Computeknoten eindeutig ist.
waitForSuccess	boolean	Gibt an, ob der Batch-Dienst auf den erfolgreichen Abschluss des Auftragsvorbereitungstask warten soll, bevor andere Aufgaben des Auftrags auf dem Computeknoten geplant werden. Ein Auftragsvorbereitungstask wurde erfolgreich abgeschlossen, wenn er mit Exitcode 0 beendet wird. Wenn true und der Auftragsvorbereitungstask auf einem Knoten fehlschlägt, wiederholt der Batch-Dienst den Auftragsvorbereitungstask bis zu seiner maximalen Wiederholungsanzahl (wie im constraints-Element angegeben). Wenn der Task nach allen Wiederholungen immer noch nicht erfolgreich abgeschlossen wurde, plant der Batch-Dienst keine Aufgaben des Auftrags auf dem Knoten. Der Knoten bleibt aktiv und berechtigt zum Ausführen von Aufgaben anderer Aufträge. Wenn false, wartet der Batch-Dienst nicht auf den Abschluss des Auftragsvorbereitungstask. In diesem Fall können andere Aufgaben des Auftrags auf dem Computeknoten ausgeführt werden, während der Task zur Auftragsvorbereitung noch ausgeführt wird. und selbst wenn der Auftragsvorbereitungstask fehlschlägt, werden neue Aufgaben weiterhin auf dem Computeknoten geplant. Der Standardwert lautet „true“.

JobReleaseTask

Ein Auftragsfreigabetask, der bei Auftragserledigung auf einem beliebigen Computeknoten ausgeführt werden soll, auf dem der Auftrag ausgeführt wurde.

Name	Typ	Beschreibung
commandLine	string	Die Befehlszeile des Auftragsfreigabetasks. Die Befehlszeile wird nicht unter einer Shell ausgeführt und kann daher keine Shellfeatures wie die Erweiterung von Umgebungsvariablen nutzen. Wenn Sie solche Features nutzen möchten, sollten Sie die Shell in der Befehlszeile aufrufen, z. B. mit "cmd /c MyCommand" in Windows oder mit "/bin/sh -c MyCommand" unter Linux. Wenn die Befehlszeile auf Dateipfade verweist, sollte sie einen relativen Pfad (relativ zum Arbeitsverzeichnis Task) verwenden oder die von Batch bereitgestellte Umgebungsvariable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) verwenden.
containerSettings	TaskContainerSettings	Die Einstellungen für den Container, unter dem der Auftragsfreigabetask ausgeführt wird. Wenn dies angegeben ist, werden alle Verzeichnisse, die sich rekursiv unterhalb des AZ_BATCH_NODE_ROOT_DIR befinden (der Stamm der Azure Batch Verzeichnisse auf dem Knoten) dem Container zugeordnet, alle Umgebungsvariablen der Aufgabe werden dem Container zugeordnet, und die Task-Befehlszeile wird im Container ausgeführt. Dateien, die im Container außerhalb von AZ_BATCH_NODE_ROOT_DIR erstellt werden, werden möglicherweise nicht auf dem Hostdatenträger angezeigt, was bedeutet, dass Batch-Datei-APIs nicht auf diese Dateien zugreifen können.
environmentSettings	EnvironmentSetting[]	Eine Liste der Umgebungsvariableneinstellungen für den Auftragsfreigabetask.
id	string	Eine Zeichenfolge, die den Auftragsfreigabetask innerhalb des Auftrags eindeutig identifiziert. Die ID kann eine beliebige Kombination alphanumerischer Zeichen enthalten, einschließlich Bindestrichen und Unterstrichen, und darf nicht mehr als 64 Zeichen enthalten. Wenn Sie diese Eigenschaft nicht angeben, weist der Batch-Dienst den Standardwert "jobrelease" zu. Keine andere Aufgabe im Auftrag kann dieselbe ID wie der Auftragsfreigabetask aufweisen. Wenn Sie versuchen, einen Task mit derselben ID zu übermitteln, lehnt der Batch-Dienst die Anforderung mit dem Fehlercode TaskIdSameAsJobReleaseTask ab. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-status Code 409 (Konflikt).
maxWallClockTime	string	Die maximal verstrichene Zeit, die der Auftragsfreigabetask auf einem bestimmten Computeknoten ausgeführt werden kann, gemessen ab dem Zeitpunkt, zu dem der Task gestartet wird. Wenn der Task nicht innerhalb des Zeitlimits abgeschlossen wird, wird er vom Batch-Dienst beendet. Der Standardwert beträgt 15 Minuten. Sie dürfen kein Timeout angeben, das länger als 15 Minuten ist. Wenn Sie dies tun, lehnt der Batch-Dienst dies mit einem Fehler ab. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-status Code 400 (Ungültige Anforderung).
resourceFiles	ResourceFile[]	Eine Liste der Dateien, die der Batch-Dienst vor dem Ausführen der Befehlszeile auf den Computeknoten lädt. Es gibt eine maximale Größe für die Liste der Ressourcendateien. Wenn die maximale Größe überschritten wird, schlägt die Anforderung fehl, und der Antwortfehlercode lautet RequestEntityTooLarge. In diesem Fall muss die Auflistung von ResourceFiles verkleinert werden. Dies kann mit .zip-Dateien, Anwendungspaketen oder Docker-Containern erreicht werden. Die unter diesem Element aufgeführten Dateien befinden sich im Arbeitsverzeichnis des Tasks.
retentionTime	string	Die mindeste Zeit zum Beibehalten des Aufgabenverzeichnisses für den Auftragsfreigabetask auf dem Computeknoten. Nach diesem Zeitpunkt kann der Batch-Dienst das Aufgabenverzeichnis und seinen gesamten Inhalt löschen. Der Standardwert ist 7 Tage, d. h. das Aufgabenverzeichnis wird 7 Tage lang aufbewahrt, es sei denn, der Computeknoten wird entfernt oder der Auftrag gelöscht.
userIdentity	UserIdentity	Die Benutzeridentität, unter der der Auftragsfreigabetask ausgeführt wird. Wenn er nicht angegeben wird, wird der Task als nicht administrativer Benutzer ausgeführt, der für den Task eindeutig ist.

JobSchedulingError

Ein Fehler, der vom Batch-Dienst beim Planen eines Auftrags auftritt.

Name	Typ	Beschreibung
category	ErrorCategory	Die Kategorie des Auftragsplanungsfehlers.
code	string	Ein Bezeichner für den Auftragsplanungsfehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
details	NameValuePair[]	Eine Liste mit zusätzlichen Fehlerdetails im Zusammenhang mit dem Planungsfehler.
message	string	Eine Meldung, die den Auftragsplanungsfehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

JobState

Der Status des Auftrags.

Name	Typ	Beschreibung
active	string	Der Auftrag ist verfügbar, um Aufgaben planen zu lassen.
completed	string	Alle Aufgaben wurden beendet, und das System akzeptiert keine weiteren Aufgaben oder keine weiteren Änderungen am Auftrag.
deleting	string	Ein Benutzer hat angefordert, dass der Auftrag gelöscht wird, aber der Löschvorgang wird noch ausgeführt (z. B. weil das System weiterhin ausgeführte Tasks beendet).
disabled	string	Ein Benutzer hat den Auftrag deaktiviert. Es werden keine Tasks ausgeführt, und es werden keine neuen Aufgaben geplant.
disabling	string	Ein Benutzer hat die Deaktivierung des Auftrags angefordert, aber der Deaktivierungsvorgang wird noch ausgeführt (z. B. warten, bis Aufgaben beendet werden).
enabling	string	Ein Benutzer hat die Aktivierung des Auftrags angefordert, aber der Aktivierungsvorgang wird noch ausgeführt.
terminating	string	Der Auftrag wird gerade abgeschlossen, entweder weil ein Auftrags-Manager-Task abgeschlossen wurde oder weil der Benutzer den Auftrag beendet hat, aber der Beendigungsvorgang weiterhin ausgeführt wird (z. B. weil Auftragsfreigabetasks ausgeführt werden).

JobStatistics

Ressourcennutzungsstatistiken für einen Auftrag.

Name	Typ	Beschreibung
kernelCPUTime	string	Die gesamte CPU-Zeit im Kernelmodus (zusammengefasst über alle Kerne und alle Computeknoten), die von allen Aufgaben im Auftrag verbraucht wird.
lastUpdateTime	string	Der Zeitpunkt, zu dem die Statistiken zuletzt aktualisiert wurden. Alle Statistiken sind auf den Bereich zwischen startTime und lastUpdateTime beschränkt.
numFailedTasks	integer	Die Gesamtanzahl der Aufgaben im Auftrag, für die während des angegebenen Zeitraums ein Fehler aufgetreten ist. Ein Task schlägt fehl, wenn die maximale Wiederholungsanzahl erschöpft ist, ohne den Exitcode 0 zurückzugeben.
numSucceededTasks	integer	Die Gesamtanzahl der Aufgaben, die im Auftrag während des angegebenen Zeitraums erfolgreich abgeschlossen wurden. Ein Task wird erfolgreich abgeschlossen, wenn er den Exitcode 0 zurückgibt.
numTaskRetries	integer	Die Gesamtanzahl der Wiederholungsversuche für alle Aufgaben im Auftrag während des angegebenen Zeitbereichs.
readIOGiB	number	Die Gesamtdatenmenge in GiB, die von allen Aufgaben im Auftrag vom Datenträger gelesen wird.
readIOps	integer	Die Gesamtanzahl der Datenträgerlesevorgänge, die von allen Aufgaben im Auftrag ausgeführt werden.
startTime	string	Die Startzeit des von der Statistik erfassten Zeitbereichs.
url	string	Die URL der Statistiken.
userCPUTime	string	Die gesamte CPU-Zeit im Benutzermodus (zusammengefasst für alle Kerne und alle Computeknoten), die von allen Aufgaben im Auftrag verbraucht wird.
waitTime	string	Die Gesamtwartezeit aller Aufgaben im Auftrag. Die Wartezeit für einen Task wird als die verstrichene Zeit zwischen der Erstellung des Vorgangs und dem Beginn der Taskausführung definiert. (Wenn der Task aufgrund von Fehlern wiederholt wird, ist die Wartezeit die Zeit bis zur letzten Taskausführung.) Dieser Wert wird nur in den Statistiken zur Kontolebensdauer gemeldet. sie ist nicht in der Auftragsstatistik enthalten.
wallClockTime	string	Die gesamte Wanduhrzeit aller Aufgaben im Auftrag. Die Wanduhrzeit ist die verstrichene Zeit von der Ausführung des Tasks auf einem Computeknoten bis zum Abschluss (oder bis zum letzten Zeitpunkt der Statistikaktualisierung, wenn die Aufgabe bis dahin noch nicht abgeschlossen war). Wenn ein Vorgang erneut ausgeführt wurde, schließt dies die Wanduhrzeit aller Vorgangsversuche ein.
writeIOGiB	number	Die Gesamtdatenmenge in GiB, die von allen Tasks im Auftrag auf den Datenträger geschrieben wird.
writeIOps	integer	Die Gesamtzahl der Datenträgerschreibvorgänge, die von allen Tasks im Auftrag ausgeführt werden.

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 Eigenschaften uid und gid müssen zusammen oder gar nicht angegeben werden. Wenn nicht angegeben, wählt das zugrunde liegende Betriebssystem den Gid aus.
sshPrivateKey	string	Der private SSH-Schlüssel für das Benutzerkonto. Der private Schlüssel darf nicht kennwortgeschützter 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 (sie wird ignoriert, wenn enableInterNodeCommunication false ist). Dazu wird das Schlüsselpaar im SSH-Verzeichnis des Benutzers platziert. Wenn nicht angegeben, wird ssh ohne Kennwort nicht zwischen Computeknoten konfiguriert (es erfolgt keine Änderung des SSH-Verzeichnisses des Benutzers).
uid	integer	Die Benutzer-ID des Benutzerkontos. Die Eigenschaften uid und gid müssen zusammen oder gar nicht angegeben werden. Wenn nicht angegeben, wählt das zugrunde liegende Betriebssystem die UID aus.

LoginMode

Der Anmeldemodus für den Benutzer

Name	Typ	Beschreibung
batch	string	Der LOGON32_LOGON_BATCH Win32-Anmeldemodus. Der Batchanmeldungsmodus wird für lang andauernde parallele Prozesse empfohlen.
interactive	string	Der LOGON32_LOGON_INTERACTIVE Win32-Anmeldemodus. Die UAC ist für Windows VirtualMachineConfiguration-Pools aktiviert. Wenn diese Option mit einer Benutzeridentität mit erhöhten Rechten in einem Windows VirtualMachineConfiguration-Pool verwendet wird, wird die Benutzersitzung nur dann erhöht, wenn die von der Task-Befehlszeile ausgeführte Anwendung so konfiguriert ist, dass immer Administratorrechte erforderlich sind oder immer maximale Berechtigungen erforderlich sind.

ManagedDisk

Name	Typ	Beschreibung
storageAccountType	StorageAccountType	Der Speicherkontotyp für verwaltete Datenträger.

MetadataItem

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

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

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 mit allen anderen Eigenschaften gegenseitig aus.
azureFileShareConfiguration	AzureFileShareConfiguration	Die Azure-Dateifreigabe, die auf jedem Knoten bereitgestellt werden soll. Diese Eigenschaft schließt sich mit allen anderen Eigenschaften gegenseitig aus.
cifsMountConfiguration	CIFSMountConfiguration	Das CIFS/SMB-Dateisystem, das auf jedem Knoten bereitgestellt werden soll. Diese Eigenschaft schließt sich mit allen anderen Eigenschaften gegenseitig aus.
nfsMountConfiguration	NFSMountConfiguration	Das NFS-Dateisystem, das auf jedem Knoten bereitgestellt werden soll. Diese Eigenschaft schließt sich mit allen anderen Eigenschaften gegenseitig aus.

NameValuePair

Stellt ein Name-Wert-Paar dar.

Name	Typ	Beschreibung
name	string	Der Name im Name-Wert-Paar.
value	string	Der Wert im Name-Wert-Paar.

NetworkConfiguration

Die Netzwerkkonfiguration für einen Pool.

Name	Typ	Beschreibung
dynamicVNetAssignmentScope	DynamicVNetAssignmentScope	Der Bereich der dynamischen VNET-Zuweisung.
enableAcceleratedNetworking	boolean	Gibt an, ob dieser Pool beschleunigten Netzwerkbetrieb aktivieren soll. Der beschleunigte Netzwerkbetrieb ermöglicht die Single Root-E/A-Virtualisierung (SR-IOV) auf einem 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. Die Konfiguration des Poolendpunkts wird nur für Pools mit der virtualMachineConfiguration-Eigenschaft unterstützt.
publicIPAddressConfiguration	PublicIPAddressConfiguration	Die Öffentliche IPAddress-Konfiguration für Computeknoten im Batchpool. Die Öffentliche IP-Konfigurationseigenschaft wird nur in Pools mit der virtualMachineConfiguration-Eigenschaft unterstützt.
subnetId	string	Der ARM-Ressourcenbezeichner des Subnetzes des virtuellen Netzwerks, dem die Computeknoten des Pools beitreten. Dies hat die Form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Das virtuelle Netzwerk muss sich in derselben Region und demselben Abonnement wie das Azure Batch-Konto befinden. Das angegebene Subnetz sollte über genügend freie IP-Adressen verfügen, um die Anzahl der Computeknoten im Pool zu berücksichtigen. Wenn das Subnetz nicht über genügend freie IP-Adressen verfügt, weist der Pool Knoten teilweise zu, und es tritt ein Fehler beim Ändern der Größe auf. Der Dienstprinzipal "MicrosoftAzureBatch" muss über die Rolle "Mitwirkender für klassische virtuelle Computer" 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 dem angegebenen VNET Netzwerksicherheitsgruppen (NSG) zugeordnet sind. Wenn die Kommunikation mit den Knoten im angegebenen Subnetz von einer NSG verweigert wird, legt der Batch-Dienst den Zustand der Computeknoten auf unbrauchbar fest. Für Pools, die mit virtualMachineConfiguration erstellt wurden, werden nur virtuelle ARM-Netzwerke ("Microsoft.Network/virtualNetworks") unterstützt, aber für Pools, die mit cloudServiceConfiguration erstellt wurden, werden sowohl ARM als auch klassische virtuelle Netzwerke unterstützt. Falls dem angegebenen VNET Netzwerksicherheitsgruppen (NSGs) zugeordnet sind, müssen einige reservierte Systemports für die eingehende Kommunikation aktiviert werden. Aktivieren Sie für Pools, die mit einer VM-Konfiguration erstellt wurden, die Ports 29876 und 29877 sowie Port 22 für Linux und Port 3389 für Windows. Aktivieren Sie für Pools, die mit einer Clouddienstkonfiguration erstellt wurden, die Ports 10100, 20100 und 30100. Aktivieren Sie auch ausgehende Verbindungen mit Azure Storage an Port 443. Weitere Informationen finden Sie unter: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#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 subnetzspezifischen Bereich oder ein 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 Nummer ist, desto höher ist die Priorität. Beispielsweise können Regeln mit den Bestellnummern 150, 250 und 350 angegeben werden. Die Regel mit der Ordnungsnummer 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 HTTP-status Code 400 fehl.
sourceAddressPrefix	string	Das Quelladresspräfix oder -tag, das bzw. das für die Regel übereinstimmen soll. Gültige Werte sind eine einzelne IP-Adresse (d. h. 10.10.10.10), ein IP-Subnetz (d. h. 192.168.1.0/24), ein Standardtag oder * (für alle Adressen). Wenn andere Werte bereitgestellt werden, schlägt die Anforderung mit HTTP-status Code 400 fehl.
sourcePortRanges	string[]	Die Quellportbereiche, die für die Regel übereinstimmen sollen. Gültige Werte sind "" (für alle Ports 0 bis 65535), ein bestimmter Port (d. h. 22) oder ein Portbereich (d. h. 100-200). Die Ports müssen im Bereich von 0 bis 65535 liegen. Jeder Eintrag in dieser Auflistung darf keinen anderen Eintrag (entweder ein Bereich oder ein einzelner Port) überlappen. Wenn andere Werte bereitgestellt werden, schlägt die Anforderung mit HTTP-status Code 400 fehl. Der Standardwert ist "".

NetworkSecurityGroupRuleAccess

Die Aktion, die für eine angegebene IP-Adresse, einen subnetzspezifischen Bereich oder ein 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 unter Linux.
relativeMountPath	string	Der relative Pfad auf dem Computeknoten, auf dem das Dateisystem eingebunden 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 dateisystems, das eingebunden werden soll.

NodeCommunicationMode

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

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

NodePlacementConfiguration

Knotenplatzierungskonfiguration für einen Pool.

Name	Typ	Beschreibung
policy	NodePlacementPolicyType	Knotenplatzierungsrichtlinientyp für Batchpools. Zuordnungsrichtlinie, die vom Batch-Dienst zum Bereitstellen der Knoten verwendet wird. Falls nicht angegeben, verwendet Batch die Regionalpolitik.

NodePlacementPolicyType

Die Platzierungsrichtlinie zum Zuweisen von Knoten im Pool.

Name	Typ	Beschreibung
regional	string	Alle Knoten im Pool werden in derselben Region zugeordnet.
zonal	string	Knoten im Pool werden auf verschiedene Verfügbarkeitszonen verteilt, wobei ein Optimalaufwand ausgeglichen wird.

OnAllTasksComplete

Die Aktion, die der Batch-Dienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Status Abgeschlossen befinden.

Name	Typ	Beschreibung
noaction	string	Sie unternehmen nichts. Der Auftrag bleibt aktiv, es sei denn, er wird auf andere Art beendet oder deaktiviert.
terminatejob	string	Beenden Sie den Auftrag. Der Abschluss des AuftragsReason ist auf "AllTasksComplete" festgelegt.

OnTaskFailure

Die Aktion, die der Batch-Dienst ausführen sollte, wenn eine Aufgabe im Auftrag fehlschlägt.

Name	Typ	Beschreibung
noaction	string	Sie unternehmen nichts. Der Auftrag bleibt aktiv, es sei denn, er wird auf andere Art beendet oder deaktiviert.
performexitoptionsjobaction	string	Führen Sie die Aktion aus, die der Vorgangsausgangsbedingung in der exitConditions-Auflistung des Tasks zugeordnet ist. (Dies kann weiterhin dazu führen, dass keine Aktion ausgeführt wird, wenn dies der Task angibt.)

OSDisk

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

Name	Typ	Beschreibung
caching	CachingType	Gibt die Cacheanforderungen an. Mögliche Werte sind: None, ReadOnly, ReadWrite. Die Standardwerte sind: Keine für Standardspeicher. ReadOnly für Storage Premium. Der Standardwert für die Zwischenspeicherung ist none. 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.

OutputFile

Eine Spezifikation zum Hochladen von Dateien aus einem Azure Batch Computeknoten an einen anderen Speicherort, nachdem der Batch-Dienst die Ausführung des Vorgangs abgeschlossen hat.

Name	Typ	Beschreibung
destination	OutputFileDestination	Das Ziel für die Ausgabedateien.
filePattern	string	Ein Muster, das angibt, welche Dateien hochgeladen werden sollen. Sowohl relative als auch absolute Pfade werden unterstützt. Relative Pfade sind relativ zum Arbeitsverzeichnis Task. Die folgenden Wildcards werden unterstützt: * entspricht 0 oder mehr Zeichen (z. B. Muster abc* entspricht abc oder abcdef), ** entspricht jedem Verzeichnis, ? entspricht jedem einzelnen Zeichen, [abc] entspricht einem Zeichen in den Klammern und [a-c] einem Zeichen im Bereich. Klammern können eine Negation enthalten, die mit einem nicht angegebenen Zeichen übereinstimmt (z. B. [!abc] entspricht einem beliebigen Zeichen, aber a, b oder c). Wenn ein Dateiname mit "." beginnt, wird er standardmäßig ignoriert, kann aber durch explizite Angabe abgeglichen werden (z. B. stimmt.gif nicht mit .a.gif überein, sondern.gif ). Ein einfaches Beispiel: ***.txt entspricht jeder Datei, die nicht mit "." beginnt und mit .txt im Arbeitsverzeichnis der Aufgabe oder in einem beliebigen Unterverzeichnis endet. Wenn der Dateiname ein Wildcardzeichen enthält, kann er mithilfe von Klammern mit Escapezeichen versehen werden (z. B. würde abc[] mit einer Datei namens abc übereinstimmen). Beachten Sie, dass sowohl \ als auch / unter Windows als Verzeichnistrennzeichen behandelt werden, aber nur / ist unter Linux. Umgebungsvariablen (%var% unter Windows oder $var unter Linux) werden erweitert, bevor das Muster angewendet wird.
uploadOptions	OutputFileUploadOptions	Zusätzliche Optionen für den Uploadvorgang, einschließlich der Bedingungen, unter welchen Bedingungen der Upload ausgeführt werden soll.

OutputFileBlobContainerDestination

Gibt ein Dateiuploadziel in einem Azure Blob Storage-Container an.

Name	Typ	Beschreibung
containerUrl	string	Die URL des Containers in Azure Blob Storage, in den die Datei(en) hochgeladen werden soll. Wenn keine verwaltete Identität verwendet wird, muss die URL eine SAS (Shared Access Signature) enthalten, die Schreibberechtigungen für den Container erteilt.
identityReference	ComputeNodeIdentityReference	Der Verweis auf die benutzerseitig zugewiesene Identität, die für den Zugriff auf Azure Blob Storage verwendet werden soll, der durch containerUrl angegeben wird. Die Identität muss Schreibzugriff auf den Azure Blob Storage Container haben.
path	string	Das Zielblob oder das virtuelle Verzeichnis innerhalb des Azure Storage-Containers. Wenn filePattern auf eine bestimmte Datei verweist (d. h. keine Feldhalter enthält), ist pfad der Name des Blobs, in das diese Datei hochgeladen werden soll. Wenn filePattern einen oder mehrere Feldhalter enthält (und daher möglicherweise mit mehreren Dateien übereinstimmt), ist pfad der Name des virtuellen Blobverzeichnisses (dem jedem Blobnamen vorangestellt ist), in das die Datei(en) hochgeladen werden soll. Wenn sie nicht angegeben werden, werden Datei(en) in den Stamm des Containers mit einem Blobnamen hochgeladen, der ihrem Dateinamen entspricht.
uploadHeaders	HttpHeader[]	Eine Liste von Name-Wert-Paaren für Header, die beim Hochladen von Ausgabedateien verwendet werden sollen Diese Header werden beim Hochladen von Dateien in Azure Storage angegeben. Offizielles Dokument zu zulässigen Headern beim Hochladen von Blobs: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

Das Ziel, in das eine Datei hochgeladen werden soll.

Name	Typ	Beschreibung
container	OutputFileBlobContainerDestination	Ein Speicherort in Azure Blob Storage, an den Dateien hochgeladen werden.

OutputFileUploadCondition

Die Bedingungen, unter denen eine Taskausgabedatei oder eine Gruppe von Dateien hochgeladen werden soll.

Name	Typ	Beschreibung
taskcompletion	string	Laden Sie die Datei(en) nach Dem Beenden des Vorgangs hoch, unabhängig davon, was der Exitcode war.
taskfailure	string	Laden Sie die Datei(en) erst hoch, nachdem der Vorgangsprozess mit einem nichtzero-Exitcode beendet wurde.
tasksuccess	string	Laden Sie die Datei(en) erst hoch, nachdem der Vorgangsprozess mit dem Exitcode 0 beendet wurde.

OutputFileUploadOptions

Details zu einem Ausgabedateiuploadvorgang, einschließlich der Bedingungen, unter welchen Bedingungen der Upload ausgeführt werden soll.

Name	Typ	Beschreibung
uploadCondition	OutputFileUploadCondition	Die Bedingungen, unter denen die Taskausgabedatei oder der Satz von Dateien hochgeladen werden soll. Der Standardwert ist taskcompletion.

PoolEndpointConfiguration

Die Endpunktkonfiguration für einen Pool.

Name	Typ	Beschreibung
inboundNATPools	InboundNATPool[]	Eine Liste eingehender NAT-Pools, die verwendet werden können, um bestimmte Ports auf einem 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 HTTP-status Code 400 fehl. Dies kann nicht angegeben werden, wenn IPAddressProvisioningType den Wert NoPublicIPAddresses hat.

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 Batch-Dienst erstellt diesen automatischen Pool, wenn der Auftrag übermittelt wird. Wenn die automatische Poolerstellung fehlschlägt, verschiebt der Batch-Dienst den Auftrag in den Zustand abgeschlossen, und der Poolerstellungsfehler wird in der Eigenschaft "Zeitplanfehler" des Auftrags festgelegt. Der Batch-Dienst verwaltet die Lebensdauer (sowohl die Erstellung als auch die Löschung des automatischen Pools, sofern keepAlive nicht angegeben ist). 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 Automatische Poolspezifikation 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 diese Eigenschaft verweist, vorhanden ist. Wenn der Pool zum Zeitpunkt, zu dem der Batch-Dienst 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 Batch-Dienst die Auftragsanforderung nicht ablehnt. Aufgaben werden einfach erst ausgeführt, wenn der Pool vorhanden ist. Sie müssen entweder die Pool-ID oder die Automatische Poolspezifikation angeben, aber nicht beides.

PoolLifetimeOption

Die Mindestlebensdauer erstellter automatischer Pools und die Zuweisung mehrerer Aufträge nach einem Zeitplan zu Pools.

Name	Typ	Beschreibung
job	string	Der Pool ist für die Lebensdauer des Auftrags vorhanden, für den er bestimmt ist. Der Batch-Dienst erstellt den Pool, wenn er den Auftrag erstellt. Wenn die Option "Auftrag" auf einen Auftragszeitplan angewendet wird, erstellt der Batch-Dienst einen neuen automatischen Pool für jeden im Zeitplan erstellten Auftrag.
jobschedule	string	Der Pool ist für die Lebensdauer des Auftragszeitplans vorhanden. Der Batch-Dienst erstellt den Pool, wenn er den ersten Auftrag nach dem Zeitplan erstellt. Sie können diese Option nur auf Auftragszeitpläne und nicht auf Aufträge anwenden.

PoolSpecification

Spezifikation zum Erstellen eines neuen Pools.

Name	Typ	Beschreibung
applicationLicenses	string[]	Die Liste der Anwendungslizenzen, die der Batch-Dienst auf jedem Computeknoten im Pool verfügbar macht. Die Liste der Anwendungslizenzen muss eine Teilmenge der verfügbaren Batch-Dienstanwendungslizenzen sein. Wenn eine Lizenz angefordert wird, die nicht unterstützt wird, schlägt die Poolerstellung fehl. Die für den Pool verfügbaren zulässigen Lizenzen sind "maya", "vray", "3dsmax", "arnold". Für jede Anwendungslizenz, die dem Pool hinzugefügt wird, fallen zusätzliche Gebühren an.
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 voll qualifiziert 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, aber nicht auf Computeknoten, die sich bereits im Pool befinden, bis sie neu gestartet oder neu erstellt werden. Es gibt maximal 10 Paketverweise in einem bestimmten Pool.
autoScaleEvaluationInterval	string	Das Zeitintervall, in dem die Poolgröße gemäß der Formel für die automatische Skalierung automatisch angepasst werden soll. Der Standardwert beträgt 15 Minuten. Der Mindest- und Höchstwert beträgt 5 Minuten bzw. 168 Stunden. Wenn Sie einen Wert kleiner als 5 Minuten oder mehr als 168 Stunden angeben, lehnt der Batch-Dienst die Anforderung mit einem Ungültigen Eigenschaftswertfehler ab. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-status Code 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. Dies ist erforderlich, wenn enableAutoScale auf true festgelegt ist. Die Formel wird auf Gültigkeit überprüft, bevor der Pool erstellt wird. Wenn die Formel ungültig ist, lehnt der Batch-Dienst 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 Batch-Dienst die Zertifikate im angegebenen Zertifikatspeicher und Speicherort. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis innerhalb des Arbeitsverzeichnisses Task gespeichert, und eine Umgebungsvariable, AZ_BATCH_CERTIFICATES_DIR für den Task bereitgestellt wird, um diesen Speicherort abzufragen. Bei Zertifikaten mit sichtbarkeit von "remoteUser" wird im Basisverzeichnis des Benutzers (z. B. /home/{benutzername}/certs) ein Verzeichnis "certs" erstellt, und Zertifikate werden in diesem Verzeichnis platziert. Warnung: Diese Eigenschaft ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung .
cloudServiceConfiguration	CloudServiceConfiguration	Die Clouddienstkonfiguration für den Pool. Diese Eigenschaft muss angegeben werden, wenn der Pool mit Azure PaaS-VMs erstellt werden muss. Diese Eigenschaft und virtualMachineConfiguration schließen sich gegenseitig aus, und eine der Eigenschaften muss angegeben werden. Wenn keines angegeben ist, gibt der Batch-Dienst einen Fehler zurück. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-status Code 400 (Ungültige Anforderung). Diese Eigenschaft kann nicht angegeben werden, wenn das Batch-Konto mit der poolAllocationMode-Eigenschaft auf "UserSubscription" festgelegt wurde.
displayName	string	Der Anzeigename für den Pool. Der Anzeigename muss nicht eindeutig sein und kann 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 einer von targetDedicatedNodes und targetLowPriorityNodes angegeben werden. Wenn true, ist das autoScaleFormula-Element erforderlich. Die Größe des Pools wird automatisch entsprechend der Formel geändert. Der Standardwert ist „FALSE“.
enableInterNodeCommunication	boolean	Gibt an, ob der Pool eine direkte Kommunikation zwischen Computeknoten zulässt. Die Aktivierung der Kommunikation zwischen Knoten schränkt die maximale Größe des Pools aufgrund von Bereitstellungseinschränkungen für die Computeknoten des Pools ein. Dies kann dazu führen, dass der Pool die 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 Batch-Dienst weist Metadaten keine Bedeutung zu. es dient ausschließlich der Verwendung von Benutzercode.
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 Batch-Dienst die Anforderung mit einem Fehler ab. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-status Code 400 (Ungültige Anforderung).
resourceTags	object	Die benutzerdefinierten Tags, die dem Pool zugeordnet sind. Die benutzerdefinierten Tags, die dem Azure Batch Pool zugeordnet werden sollen. Bei Angabe werden diese Tags an die dem Pool zugeordneten unterstützenden Azure-Ressourcen weitergegeben. Diese Eigenschaft kann nur angegeben werden, wenn das Batch-Konto mit der poolAllocationMode-Eigenschaft auf "UserSubscription" festgelegt wurde.
startTask	StartTask	Ein Task, der auf jedem Computeknoten ausgeführt werden soll, während er dem Pool beitritt. Der Task wird ausgeführt, wenn der Computeknoten dem Pool hinzugefügt wird oder wenn der Computeknoten neu gestartet wird. Batch wiederholt Aufgaben, wenn ein Wiederherstellungsvorgang auf einem Knoten ausgelöst wird. Beispiele für Wiederherstellungsvorgänge sind (aber nicht beschränkt auf), wenn ein fehlerhafter Knoten neu gestartet wird oder ein Computeknoten aufgrund eines Hostfehlers verschwunden ist. Wiederholungsversuche aufgrund von Wiederherstellungsvorgängen sind unabhängig von und werden nicht mit maxTaskRetryCount gezählt. Auch wenn maxTaskRetryCount 0 ist, kann es aufgrund eines Wiederherstellungsvorgangs zu einer internen Wiederholung kommen. Aus diesem Gründen sollten alle Aufgaben idempotent sein. Dies bedeutet, dass Tasks es tolerieren müssen, dass sie unterbrochen und neu gestartet werden, ohne dass es zu Beschädigungen oder doppelten Daten kommt. Die bewährte Methode für Aufgaben mit langer Ausführungsdauer besteht darin, eine Form von Prüfpunkten zu verwenden. In einigen Fällen kann startTask erneut ausgeführt werden, obwohl der Computeknoten nicht neu gestartet wurde. Es sollte besonders darauf geachtet werden, dass StartTasks vermieden werden, die einen Breakaway-Prozess erstellen oder Dienste aus dem StartTask-Arbeitsverzeichnis installieren/starten, da batch dadurch verhindert wird, dass die StartTask erneut ausgeführt werden 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 beide festlegen.
targetLowPriorityNodes	integer	Die gewünschte Anzahl von Computeknoten mit spot/low-priority 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 beide festlegen.
targetNodeCommunicationMode	NodeCommunicationMode	Der gewünschte Knotenkommunikationsmodus für den Pool. Wenn nicht angegeben, lautet der Standardwert Default.
taskSchedulingPolicy	TaskSchedulingPolicy	Wie Aufgaben auf Computeknoten in einem Pool verteilt werden Wenn nicht angegeben, ist der Standardwert Spread.
taskSlotsPerNode	integer	Die Anzahl von Taskslots, die verwendet werden können, um gleichzeitige Tasks auf einem einzelnen Computeknoten im Pool auszuführen. Der Standardwert ist 1. Der Maximalwert ist der 4-fache der Anzahl der Kerne der vmSize des Pools oder 256.
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, wenn der Pool mit Azure IaaS-VMs erstellt werden muss. Diese Eigenschaft und cloudServiceConfiguration schließen sich gegenseitig aus, und eine der Eigenschaften muss angegeben werden. Wenn keines angegeben ist, gibt der Batch-Dienst einen Fehler zurück. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-status Code 400 (Ungültige Anforderung).
vmSize	string	Die Größe der virtuellen Computer im Pool. Alle virtuellen Computer in einem Pool haben dieselbe Größe. Informationen zu den verfügbaren Größen virtueller Computer in Pools finden Sie unter Auswählen einer VM-Größe für Computeknoten in einem Azure Batch Pool (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 IP-Adressen, die der Batch-Dienst bei der Bereitstellung von Computeknoten verwendet. Die anzahl der hier angegebenen IP-Adressen begrenzt die maximale Größe des Pools– 100 dedizierte Knoten oder 100 Spot-/Low-Priority-Knoten können für jede öffentliche IP-Adresse zugeordnet werden. Ein Pool, der 250 dedizierte VMs benötigt, benötigt beispielsweise mindestens drei öffentliche IP-Adressen, die angegeben sind. Jedes Element dieser Auflistung hat die folgende Form: /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 auf einen Computeknoten heruntergeladen werden sollen.

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

SecurityProfile

Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die VM-Skalierungsgruppe 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 VM-Skalierungsgruppe zu aktivieren oder zu deaktivieren. Dadurch wird die Verschlüsselung für alle Datenträger aktiviert, einschließlich ressourcen-/temporärer Datenträger auf dem Host selbst.
securityType	SecurityTypes	Gibt den SecurityType des virtuellen Computers an. Es 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. Es muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren.

Name	Typ	Beschreibung
trustedLaunch	string	Der vertrauenswürdige Start bietet Schutz vor komplexen und permanenten Angriffstechniken.

ServiceArtifactReference

Gibt die Referenz-ID des Dienstartefakts an, die verwendet wird, um dieselbe Imageversion für alle virtuellen Computer in der Skalierungsgruppe festzulegen, wenn die neueste Imageversion verwendet wird.

Name	Typ	Beschreibung
id	string	Die Referenz-ID des Dienstartefakts von ServiceArtifactReference Die Dienstartefaktverweis-ID in Form von /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

Eine Aufgabe, die ausgeführt wird, wenn ein Knoten einen Pool im Azure Batch-Dienst hinzuschließt oder wenn der Computeknoten neu gestartet oder ein neuer Image erstellt wird.

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

TaskConstraints

Ausführungseinschränkungen, die auf einen Task angewendet werden sollen.

Name	Typ	Beschreibung
maxTaskRetryCount	integer	Die maximale Anzahl von Wiederholungsversuchen für den Task. Der Batch-Dienst führt einen Task erneut aus, wenn der Exitcode ungleich null ist. Beachten Sie, dass dieser Wert speziell die Anzahl von Wiederholungen für die ausführbare Task-Datei steuert, die auf einen Exitcode ungleich null zurückzuführen ist. Der Batch-Dienst versucht den Task einmal und kann es dann bis zu diesem Grenzwert wiederholen. Wenn die maximale Wiederholungsanzahl beispielsweise 3 beträgt, versucht Batch den Task bis zu 4 Mal (ein erster Versuch und drei Wiederholungen). Wenn die maximale Wiederholungsanzahl 0 ist, versucht der Batch-Dienst den Task nach dem ersten Versuch nicht erneut. Wenn die maximale Wiederholungsanzahl -1 beträgt, wiederholt der Batch-Dienst die Aufgabe ohne Beschränkung. Dies wird jedoch nicht für einen Starttask oder einen Vorgang empfohlen. Der Standardwert ist 0 (keine Wiederholungsversuche).
maxWallClockTime	string	Die maximal verstrichene Zeit, die der Task ausführen kann, gemessen ab dem Zeitpunkt, zu dem der Task gestartet wird. Wenn der Task nicht innerhalb des Zeitlimits abgeschlossen wird, wird er vom Batch-Dienst beendet. Wenn dies nicht angegeben ist, gibt es keine Zeitliche Begrenzung für die Dauer der Ausführung des Tasks.
retentionTime	string	Die mindeste Zeit, um das Aufgabenverzeichnis auf dem Computeknoten beizubehalten, in dem es ausgeführt wurde, ab dem Zeitpunkt, zu dem die Ausführung abgeschlossen ist. Nach diesem Zeitpunkt kann der Batch-Dienst das Aufgabenverzeichnis und seinen gesamten Inhalt löschen. Der Standardwert ist 7 Tage, d. h. das Aufgabenverzeichnis wird 7 Tage lang aufbewahrt, es sei denn, der Computeknoten wird entfernt oder der Auftrag gelöscht.

TaskContainerSettings

Die Containereinstellungen für einen Task.

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

TaskSchedulingPolicy

Gibt an, wie Tasks auf Computeknoten verteilt werden sollen.

Name	Typ	Beschreibung
nodeFillType	ComputeNodeFillType	Wie Aufgaben auf Computeknoten in einem Pool verteilt werden. Wenn nicht angegeben, ist der Standardwert spread.

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.

UserAccount

Eigenschaften, die zum Erstellen eines Benutzers zum Ausführen von Aufgaben auf einem Azure Batch Computeknoten verwendet werden.

Name	Typ	Beschreibung
elevationLevel	ElevationLevel	Die Höhenstufe des Benutzerkontos. Der Standardwert ist nonAdmin.
linuxUserConfiguration	LinuxUserConfiguration	Die Linux-spezifische Benutzerkonfiguration für das Benutzerkonto. Diese Eigenschaft wird ignoriert, wenn sie für einen Windows-Pool angegeben wird. Wenn nicht angegeben, wird der Benutzer mit den Standardoptionen erstellt.
name	string	Der Name des Benutzerkontos. Namen können beliebige Unicode-Zeichen bis zu einer maximalen Länge von 20 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 der Task ausgeführt wird.

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

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. Falls angegeben, wird das Setup für jeden Computeknoten im Pool ausgeführt, damit Tasks in Containern ausgeführt werden können. Alle regulären Tasks und Auftrags-Manager-Aufgaben, die in diesem Pool ausgeführt werden, müssen die containerSettings-Eigenschaft angeben, und alle anderen Tasks 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 für die Computeknoten im Pool leere Datenträger angefügt sein müssen. 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, da jeder angefügte Datenträger leer ist. Wenn der Computeknoten aus dem Pool entfernt wird, werden auch der Datenträger und alle zugeordneten Daten gelöscht. Der Datenträger ist nach dem Anfügen nicht formatiert. Er muss vor der Verwendung formatiert werden. Weitere Informationen finden Sie unter https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux und https://docs.microsoft.com/en-us/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. Falls angegeben, wird die Verschlüsselung für jeden Knoten im Pool während der Knotenbereitstellung durchgeführt.
extensions	VMExtension[]	Die VM-Erweiterung für den Pool. Falls 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 VM-Image.
licenseType	string	Der Typ der lokalen Lizenz, die bei der Bereitstellung des Betriebssystems verwendet werden soll. Dies gilt nur für Images, die das Windows-Betriebssystem enthalten, und sollte nur verwendet werden, wenn Sie über gültige lokale Lizenzen für die Computeknoten verfügen, die bereitgestellt werden. Wenn nicht angegeben, wird kein lokaler Lizenzierungsrabatt angewendet. Gültige Werte: Windows_Server: Die lokale Lizenz gilt für Windows Server. Windows_Client: Die lokale Lizenz gilt für den Windows-Client.
nodeAgentSKUId	string	Die SKU des Batch Compute Node-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 Batch-Dienst bereitstellt. Es gibt verschiedene Implementierungen des Compute Node-Agents, die als SKUs bezeichnet werden, für verschiedene Betriebssysteme. Sie müssen eine Compute Node-Agent-SKU angeben, die der ausgewählten Imagereferenz entspricht. Informationen zum Abrufen der Liste der unterstützten Serverknoten-Agent-SKUs sowie deren Liste der überprüften Imageverweise finden Sie im Vorgang "Auflisten unterstützter Serverknoten-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 VM-Skalierungsgruppe an. Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die VM-Skalierungsgruppe an.
serviceArtifactReference	ServiceArtifactReference	Gibt die Dienstartefaktverweis-ID an, die verwendet wird, um dieselbe Imageversion für alle virtuellen Computer in der Skalierungsgruppe festzulegen, wenn die neueste Imageversion verwendet wird. Die Dienstartefakt-Verweis-ID in Form von /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{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.

VMExtension

Die Konfiguration für VM-Erweiterungen.

Name	Typ	Beschreibung
autoUpgradeMinorVersion	boolean	Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zur Bereitstellungszeit verfügbar ist. Abgesehen von erneuten Bereitstellungen führt die Erweiterung nach der Bereitstellung jedoch keine Upgrades für Nebenversionen aus, selbst 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 VM-Erweiterung.
protectedSettings	object	Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder überhaupt keine geschützten Einstellungen enthalten.
provisionAfterExtensions	string[]	Die Auflistung der Erweiterungsnamen. Auflistung von Erweiterungsnamen, nach denen diese Erweiterung bereitgestellt werden muss.
publisher	string	Der Name des Erweiterungshandlerherausgebers.
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 nicht angegeben, 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 für VirtualMachineConfiguration-Pools ist "batch" und für CloudServiceConfiguration-Pools "interaktiv".