Job - Add

Fügt dem angegebenen Konto einen Auftrag hinzu.
Der Batch-Dienst unterstützt zwei Möglichkeiten, die im Rahmen eines Auftrags ausgeführte Arbeit zu steuern. Im ersten Ansatz gibt der Benutzer eine Auftrags-Manager-Aufgabe an. Der Batch-Dienst startet diese Aufgabe, wenn er bereit ist, den Auftrag zu starten. Der Auftrags-Manager-Task steuert alle anderen Aufgaben, die unter diesem Auftrag ausgeführt werden, mithilfe der Aufgaben-APIs. Beim zweiten Ansatz steuert der Benutzer die Ausführung von Aufgaben unter einem aktiven Auftrag direkt mithilfe der Aufgaben-APIs. Beachten Sie außerdem: Vermeiden Sie beim Benennen von Aufträgen vertrauliche Informationen wie Benutzernamen oder geheime Projektnamen. Diese Informationen können in Telemetrieprotokollen enthalten sein, auf die Microsoft-Supporttechniker zugreifen können.

POST {batchUrl}/jobs?api-version=2023-11-01.18.0
POST {batchUrl}/jobs?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.

api-version
query True

string

Client-API-Version.

timeout
query

integer

int32

Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden aufwenden kann. Der Standardwert ist 30 Sekunden.

Anforderungsheader

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

Name Erforderlich Typ Beschreibung
client-request-id

string

uuid

Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll.

ocp-date

string

date-time-rfc1123

Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. explizit festlegen, wenn Sie die REST-API direkt aufrufen.

Anforderungstext

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

Name Erforderlich Typ Beschreibung
id True

string

Eine Zeichenfolge, die den Auftrag innerhalb des Kontos eindeutig identifiziert.
Die ID kann eine beliebige Kombination von alphanumerischen Zeichen einschließlich Bindestrichen und Unterstrichen enthalten und darf nicht mehr als 64 Zeichen enthalten. Bei der ID wird die Groß-/Kleinschreibung beibehalten und die Groß-/Kleinschreibung wird nicht beachtet (d. h., Sie verfügen möglicherweise nicht über zwei IDs innerhalb eines Kontos, die sich nur nach Groß-/Kleinschreibung unterscheiden).

poolInfo True

PoolInformation

Der Pool, in dem der Batch-Dienst die Aufgaben des Auftrags ausführt.

allowTaskPreemption

boolean

Ob Aufgaben in diesem Auftrag von anderen Aufträgen mit hoher Priorität entfernt 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 in die Warteschlange stellen. Sie können die allowTaskPreemption eines Auftrags aktualisieren, nachdem er mithilfe der Updateauftrags-API erstellt wurde.

commonEnvironmentSettings

EnvironmentSetting[]

Die Liste der allgemeinen Umgebungsvariableneinstellungen. Diese Umgebungsvariablen werden für alle Aufgaben im Auftrag (einschließlich Auftrags-Manager, Auftragsvorbereitung und Auftragsfreigabetasks) festgelegt.
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 einen Auftrag.
Die Ausführungseinschränkungen für den Auftrag.

displayName

string

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

jobManagerTask

JobManagerTask

Details zu einer Auftrags-Manager-Aufgabe, die beim Starten des Auftrags gestartet werden soll.
Wenn der Auftrag keine Auftrags-Manager-Aufgabe angibt, muss der Benutzer dem Auftrag explizit Tasks hinzufügen. Wenn der Auftrag einen Auftrags-Manager-Task angibt, erstellt der Batch-Dienst den Auftrags-Manager-Task, wenn der Auftrag erstellt wird, und versucht, den Auftrags-Manager-Task zu planen, bevor andere Aufgaben im Auftrag geplant werden. Der typische Zweck des Auftrags-Managers besteht darin, die Auftragsausführung zu steuern und/oder zu überwachen, z. B. durch Entscheidung, welche zusätzlichen Tasks ausgeführt werden sollen, bestimmen, wann die Arbeit abgeschlossen ist usw. (Ein Auftrags-Manager-Task ist jedoch nicht auf diese Aktivitäten beschränkt. Er ist ein vollwertiger Task im System und führt alle aktionen aus, die für den Auftrag erforderlich sind.) Beispielsweise kann ein Auftrags-Manager-Task eine Datei herunterladen, die als Parameter angegeben ist, den Inhalt dieser Datei analysieren und zusätzliche Aufgaben basierend auf diesen Inhalten übermitteln.

jobPreparationTask

JobPreparationTask

Der Auftragsvorbereitungstask.
Wenn ein Auftrag über eine Auftragsvorbereitungsaufgabe verfügt, führt der Batch-Dienst den Auftragsvorbereitungstask auf einem Knoten aus, bevor Aufgaben dieses Auftrags auf diesem Computeknoten gestartet werden.

jobReleaseTask

JobReleaseTask

Der Auftragsfreigabetask.
Ein Auftragsfreigabetask kann nicht angegeben werden, ohne auch einen Auftragsvorbereitungstask für den Auftrag anzugeben. Der Batch-Dienst führt den Auftragsfreigabetask auf den Knoten aus, auf denen der Auftragsvorbereitungstask ausgeführt wurde. Der Hauptzweck des Auftragsfreigabetasks besteht darin, änderungen an Computeknoten rückgängig zu machen, die vom Auftragsvorbereitungstask vorgenommen wurden. Beispielaktivitäten sind das Löschen lokaler Dateien oder das Herunterfahren von Diensten, die im Rahmen der Auftragsvorbereitung gestartet wurden.

maxParallelTasks

integer

Die maximale Anzahl von Tasks, die parallel für den Auftrag ausgeführt werden können.
Der Wert von maxParallelTasks muss -1 oder größer als 0 sein, wenn angegeben. Wenn nicht angegeben, ist der Standardwert -1. Dies bedeutet, dass die Anzahl der Aufgaben, die gleichzeitig ausgeführt werden können, nicht begrenzt ist. Sie können 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.
Beachten Sie, dass alle Aufgaben als abgeschlossen gelten, wenn ein Auftrag keine Aufgaben enthält. Diese Option wird daher am häufigsten mit einer Auftrags-Manager-Aufgabe verwendet. wenn Sie die automatische Auftragsbeendigung ohne Auftrags-Manager verwenden möchten, sollten Sie onAllTasksComplete zunächst auf noaction festlegen und die Auftragseigenschaften aktualisieren, um onAllTasksComplete auf "terminatejob" festzulegen, nachdem Sie das Hinzufügen von Tasks abgeschlossen haben. 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.

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.

usesTaskDependencies

boolean

Gibt an, ob Aufgaben im Auftrag Abhängigkeiten voneinander definieren können. Die Standardeinstellung ist „false“.

Antworten

Name Typ Beschreibung
201 Created

Die Anforderung an den Batch-Dienst war erfolgreich.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: 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

Add a basic job
Add a complex job

Add a basic job

Sample Request

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



{
  "id": "jobId",
  "priority": 0,
  "poolInfo": {
    "poolId": "poolId"
  }
}

Sample Response

Add a complex job

Sample Request

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



{
  "id": "jobId",
  "priority": 100,
  "constraints": {
    "maxWallClockTime": "PT1H",
    "maxTaskRetryCount": -1
  },
  "jobManagerTask": {
    "id": "taskId",
    "commandLine": "myprogram.exe",
    "resourceFiles": [
      {
        "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas",
        "filePath": "myprogram.exe"
      },
      {
        "storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas",
        "filePath": "datafolder"
      }
    ],
    "environmentSettings": [
      {
        "name": "myvariable",
        "value": "myvalue"
      }
    ],
    "constraints": {
      "maxWallClockTime": "PT1H",
      "maxTaskRetryCount": 0,
      "retentionTime": "PT1H"
    },
    "requiredSlots": 2,
    "killJobOnCompletion": false,
    "userIdentity": {
      "autoUser": {
        "scope": "task",
        "elevationLevel": "admin"
      }
    },
    "runExclusive": true
  },
  "poolInfo": {
    "autoPoolSpecification": {
      "autoPoolIdPrefix": "mypool",
      "poolLifetimeOption": "job",
      "pool": {
        "vmSize": "small",
        "cloudServiceConfiguration": {
          "osFamily": "4",
          "osVersion": "*"
        },
        "resizeTimeout": "PT15M",
        "targetDedicatedNodes": 3,
        "targetLowPriorityNodes": 0,
        "taskSlotsPerNode": 2,
        "taskSchedulingPolicy": {
          "nodeFillType": "spread"
        },
        "enableAutoScale": false,
        "enableInterNodeCommunication": true,
        "startTask": {
          "commandLine": "myprogram2.exe",
          "resourceFiles": [
            {
              "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas",
              "filePath": "myprogram2.exe"
            }
          ],
          "environmentSettings": [
            {
              "name": "myvariable",
              "value": "myvalue"
            }
          ],
          "userIdentity": {
            "autoUser": {
              "scope": "task",
              "elevationLevel": "admin"
            }
          },
          "maxTaskRetryCount": 2,
          "waitForSuccess": true
        },
        "certificateReferences": [
          {
            "thumbprint": "0123456789abcdef0123456789abcdef01234567",
            "thumbprintAlgorithm": "sha1",
            "storeLocation": "localmachine",
            "storeName": "Root",
            "visibility": [
              "task"
            ]
          }
        ],
        "metadata": [
          {
            "name": "myproperty",
            "value": "myvalue"
          }
        ],
        "targetNodeCommunicationMode": "default"
      }
    }
  },
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

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.

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 Aufgabenarbeitsverzeichnisses des Containers.

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öhenstufe des Benutzers.

EnvironmentSetting

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

ErrorMessage

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

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.

JobAddParameter

Ein Azure Batch Auftrag, der hinzugefügt werden soll.

JobConstraints

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

JobManagerTask

Gibt Details zu einem Auftrags-Manager-Task an.

JobNetworkConfiguration

Die Netzwerkkonfiguration für den Auftrag.

JobPreparationTask

Ein Auftragsvorbereitungstask, der vor aufgaben des Auftrags auf einem bestimmten Computeknoten ausgeführt werden soll.

JobReleaseTask

Ein Auftragsfreigabetask, der bei Auftragsabschluss auf einem beliebigen Computeknoten ausgeführt wird, auf dem der Auftrag ausgeführt wurde.

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 eingebunden werden soll.

NetworkConfiguration

Die Netzwerkkonfiguration für einen Pool.

NetworkSecurityGroupRule

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

NetworkSecurityGroupRuleAccess

Die Aktion, die für eine angegebene IP-Adresse, einen 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 soll, wenn ein Task 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 Vorgang zum Hochladen einer Ausgabedatei, 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 Dienstartefaktverweis-ID 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, um alle Vorgänge für den Auftrag auszuführen, 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 anwendung, die bereitgestellt werden soll.
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 anwendung, die bereitgestellt werden soll. Wenn nicht angegeben, wird die Standardversion bereitgestellt.
Wenn dies in einem Pool ausgelassen wird und keine Standardversion für diese Anwendung angegeben ist, 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. Derzeit ist der einzige unterstützte Wert für die Zugriffseigenschaft "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 aktiv bleibt.
Wenn false, löscht der Batch-Dienst den Pool, sobald seine Lebensdauer (gemäß der Einstellung poolLifetimeOption) abläuft. das heißt, wenn der Auftrag 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öhenstufe 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 der Wert Task angegeben werden, wenn eine strengere Isolation zwischen Tasks erforderlich ist. Beispielsweise, wenn die Aufgabe die Registrierung auf eine Weise mutiert, die sich auf andere Aufgaben auswirken kann, oder wenn Zertifikate für den Pool angegeben wurden, auf die normale Aufgaben nicht zugreifen können, sondern von StartTasks zugänglich sein sollten.

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, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

values

BatchErrorDetail[]

Eine Auflistung von Schlüssel-Wert-Paaren mit zusätzlichen Details zum Fehler.

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.

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 Version des Azure-Gastbetriebssystems, 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 Aufgaben 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 vom Benutzer 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 die Angabe weggelassen wird, ist der Standardwert "docker.io".

username

string

Der Benutzername, der beim Registrierungsserver angemeldet werden soll.

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 Aufgabenarbeitsverzeichnisses des Containers.

Name Typ Beschreibung
containerImageDefault

string

Verwenden Sie das im Containerimage definierte Arbeitsverzeichnis. Beachten Sie, dass dieses Verzeichnis nicht die von Batch heruntergeladenen Ressourcendateien enthält.

taskWorkingDirectory

string

Verwenden Sie das Standardmäßige Batch-Dienstarbeitsverzeichnis Task, 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öhenstufe 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 Taskprozess festgelegt werden soll.

Name Typ Beschreibung
name

string

Der Name der Umgebungsvariablen.

value

string

Der Wert der Umgebungsvariablen.

ErrorMessage

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

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.

JobAddParameter

Ein Azure Batch Auftrag, der hinzugefügt werden soll.

Name Typ Standardwert Beschreibung
allowTaskPreemption

boolean

Ob Aufgaben in diesem Auftrag von anderen Aufträgen mit hoher Priorität entfernt 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 in die Warteschlange stellen. Sie können die allowTaskPreemption eines Auftrags aktualisieren, nachdem er mithilfe der Updateauftrags-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 einen Auftrag.
Die Ausführungseinschränkungen für den Auftrag.

displayName

string

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

id

string

Eine Zeichenfolge, die den Auftrag innerhalb des Kontos eindeutig identifiziert.
Die ID kann eine beliebige Kombination von alphanumerischen Zeichen einschließlich Bindestrichen und Unterstrichen enthalten und darf nicht mehr als 64 Zeichen enthalten. Bei der ID wird die Groß-/Kleinschreibung beibehalten und die Groß-/Kleinschreibung wird nicht beachtet (d. h., Sie verfügen möglicherweise nicht über zwei IDs innerhalb eines Kontos, die sich nur nach Groß-/Kleinschreibung unterscheiden).

jobManagerTask

JobManagerTask

Details zu einer Auftrags-Manager-Aufgabe, die beim Starten des Auftrags gestartet werden soll.
Wenn der Auftrag keine Auftrags-Manager-Aufgabe angibt, muss der Benutzer dem Auftrag explizit Tasks hinzufügen. Wenn der Auftrag einen Auftrags-Manager-Task angibt, erstellt der Batch-Dienst den Auftrags-Manager-Task, wenn der Auftrag erstellt wird, und versucht, den Auftrags-Manager-Task zu planen, bevor andere Aufgaben im Auftrag geplant werden. Der typische Zweck des Auftrags-Managers besteht darin, die Auftragsausführung zu steuern und/oder zu überwachen, z. B. durch Entscheidung, welche zusätzlichen Tasks ausgeführt werden sollen, bestimmen, wann die Arbeit abgeschlossen ist usw. (Ein Auftrags-Manager-Task ist jedoch nicht auf diese Aktivitäten beschränkt. Er ist ein vollwertiger Task im System und führt alle aktionen aus, die für den Auftrag erforderlich sind.) Beispielsweise kann ein Auftrags-Manager-Task eine Datei herunterladen, die als Parameter angegeben ist, den Inhalt dieser Datei analysieren und zusätzliche Aufgaben basierend auf diesen Inhalten übermitteln.

jobPreparationTask

JobPreparationTask

Der Auftragsvorbereitungstask.
Wenn ein Auftrag über eine Auftragsvorbereitungsaufgabe verfügt, führt der Batch-Dienst den Auftragsvorbereitungstask auf einem Knoten aus, bevor Aufgaben dieses Auftrags auf diesem Computeknoten gestartet werden.

jobReleaseTask

JobReleaseTask

Der Auftragsfreigabetask.
Ein Auftragsfreigabetask kann nicht angegeben werden, ohne auch einen Auftragsvorbereitungstask für den Auftrag anzugeben. Der Batch-Dienst führt den Auftragsfreigabetask auf den Knoten aus, auf denen der Auftragsvorbereitungstask ausgeführt wurde. Der Hauptzweck des Auftragsfreigabetasks besteht darin, änderungen an Computeknoten rückgängig zu machen, die vom Auftragsvorbereitungstask vorgenommen wurden. Beispielaktivitäten sind das Löschen lokaler Dateien oder das Herunterfahren von Diensten, die im Rahmen der Auftragsvorbereitung gestartet wurden.

maxParallelTasks

integer

-1

Die maximale Anzahl von Tasks, die parallel für den Auftrag ausgeführt werden können.
Der Wert von maxParallelTasks muss -1 oder größer als 0 sein, wenn angegeben. Wenn nicht angegeben, ist der Standardwert -1. Dies bedeutet, dass die Anzahl der Aufgaben, die gleichzeitig ausgeführt werden können, nicht begrenzt ist. Sie können 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.
Beachten Sie, dass alle Aufgaben als abgeschlossen gelten, wenn ein Auftrag keine Aufgaben enthält. Diese Option wird daher am häufigsten mit einer Auftrags-Manager-Aufgabe verwendet. wenn Sie die automatische Auftragsbeendigung ohne Auftrags-Manager verwenden möchten, sollten Sie onAllTasksComplete zunächst auf noaction festlegen und die Auftragseigenschaften aktualisieren, um onAllTasksComplete auf "terminatejob" festzulegen, nachdem Sie das Hinzufügen von Tasks abgeschlossen haben. 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

Der Pool, in dem der Batch-Dienst die Aufgaben des Auftrags ausführt.

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.

usesTaskDependencies

boolean

Gibt an, ob Aufgaben im Auftrag Abhängigkeiten voneinander definieren können. Die Standardeinstellung ist „false“.

JobConstraints

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

Name Typ Beschreibung
maxTaskRetryCount

integer

Die maximale Anzahl von Wiederholungsversuchen für jeden 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 jeden Task einmal und kann es dann bis zu diesem Grenzwert wiederholen. Wenn die maximale Wiederholungsanzahl beispielsweise 3 beträgt, versucht Batch eine Aufgabe bis zu 4 Mal (ein erster Versuch und drei Wiederholungen). Wenn die maximale Wiederholungsanzahl 0 ist, führt der Batch-Dienst keine Wiederholungsversuche für Tasks durch. Wenn die maximale Wiederholungsanzahl -1 beträgt, wiederholt der Batch-Dienst Tasks ohne Beschränkung. Der Standardwert ist 0 (keine Wiederholungsversuche).

maxWallClockTime

string

Die maximal verstrichene Zeit, die der Auftrag ausführen darf, gemessen ab dem Zeitpunkt, zu dem der Auftrag erstellt wird.
Wenn der Auftrag nicht innerhalb des Zeitlimits abgeschlossen wird, beendet der Batch-Dienst ihn und alle Tasks, die noch ausgeführt werden. In diesem Fall lautet der Beendigungsgrund MaxWallClockTimeExpiry. Wenn diese Eigenschaft nicht angegeben ist, gibt es keine Zeitliche Begrenzung der Ausführungsdauer des Auftrags.

JobManagerTask

Gibt Details zu einem Auftrags-Manager-Task an.

Name Typ Beschreibung
allowLowPriorityNode

boolean

Gibt an, ob der Auftrags-Manager-Task auf einem Computeknoten mit spot/low-priority ausgeführt werden kann.
Der Standardwert lautet „true“.

applicationPackageReferences

ApplicationPackageReference[]

Eine Liste der Anwendungspakete, die vom Batch-Dienst auf dem Computeknoten bereitgestellt werden, bevor die Befehlszeile ausgeführt wird.
Anwendungspakete werden heruntergeladen und in einem freigegebenen Verzeichnis bereitgestellt, nicht im Aufgabenarbeitsverzeichnis. Wenn sich ein referenziertes Anwendungspaket also bereits auf dem Computeknoten befindet und auf dem neuesten Stand ist, wird es 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 dem Task 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 umgebungsvariable AZ_BATCH_AUTHENTICATION_TOKEN bereitgestellt. Die Vorgänge, die der Task mit dem Token ausführen kann, hängen von den Einstellungen ab. Beispielsweise kann eine Aufgabe 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 "/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.

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 wird, containerConfiguration festgelegt ist, muss auch dies festgelegt werden. Wenn für den Pool, der diesen Task ausführen wird, containerConfiguration nicht festgelegt ist, darf dies nicht festgelegt werden. 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.

displayName

string

Der Anzeigename des Auftrags-Manager-Tasks.
Er 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 Auftrags-Manager-Task.

id

string

Eine Zeichenfolge, die den Auftrags-Manager-Task innerhalb des Auftrags eindeutig identifiziert.
Die ID kann eine beliebige Kombination von alphanumerischen Zeichen einschließlich Bindestrichen und Unterstrichen enthalten 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.
Bei true markiert der Batch-Dienst den Auftrag als abgeschlossen, wenn der Auftrags-Manager-Task abgeschlossen ist. Wenn Tasks zu diesem Zeitpunkt noch ausgeführt werden (außer Auftragsfreigabe), werden diese Tasks beendet. Wenn false, wirkt sich der Abschluss des Auftrags-Manager-Tasks nicht auf den Auftrag status aus. In diesem Fall sollten Sie entweder das onAllTasksComplete-Attribut verwenden, um den Auftrag zu beenden, oder sie sollten den Auftrag von einem Client oder Benutzer explizit beenden lassen. Ein Beispiel hierfür ist, wenn der Auftrags-Manager eine Reihe von Aufgaben erstellt, dann aber keine weitere Rolle bei derEn 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 um den Fortschritt zu überwachen), ist es wichtig, killJobOnCompletion auf false festzulegen.

outputFiles

OutputFile[]

Eine Liste der Dateien, die der Batch-Dienst nach dem Ausführen der Befehlszeile vom 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 Zeitplanungsslots, die für die Ausführung des Tasks erforderlich sind.
Der Standardwert ist 1. Die Ausführung eines Tasks auf einem Computeknoten kann nur geplant werden, wenn der Knoten über genügend freie Zeitplanungsslots verfügt. Bei Aufgaben mit mehreren instance wird diese Eigenschaft nicht unterstützt und darf nicht angegeben werden.

resourceFiles

ResourceFile[]

Eine Liste der Dateien, die vom Batch-Dienst auf den Computeknoten heruntergeladen werden, bevor die Befehlszeile ausgeführt wird.
Dateien, die unter diesem Element aufgeführt sind, 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 Sammlung von ResourceFiles verkleinert werden. Dies kann mithilfe von .zip-Dateien, Anwendungspaketen oder Docker-Containern erreicht werden.

runExclusive

boolean

Gibt an, ob der Auftrags-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 angegeben ist, können andere Aufgaben gleichzeitig mit dem Auftrags-Manager auf einem Computeknoten ausgeführt werden. Der Auftrags-Manager-Task zählt normalerweise auf den Grenzwert für gleichzeitige Aufgaben des Computeknotens, sodass dies nur relevant ist, wenn der Computeknoten mehrere gleichzeitige Aufgaben zulässt. Der Standardwert lautet „true“.

userIdentity

UserIdentity

Die Benutzeridentität, unter der der Auftrags-Manager-Task ausgeführt wird.
Wenn der Task nicht angegeben wird, wird er 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, auf denen Tasks aus dem Auftrag ausgeführt werden, für die Dauer des Tasks verknüpft werden. 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 zu berücksichtigen, die Aufgaben aus dem Auftrag ausführen. Dies kann bis zur Anzahl der Computeknoten im Pool sein. Der Dienstprinzipal "MicrosoftAzureBatch" muss über die Role-Based Access Control Rolle "Mitwirkender virtueller Computer" (Classic Virtual Machine Contributor, 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 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. Dies hat die Form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Wenn dem angegebenen VNet Netzwerksicherheitsgruppen (NSG) zugeordnet sind, müssen einige reservierte Systemports für die eingehende Kommunikation vom Azure Batch-Dienst 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. 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 aufgaben des Auftrags auf einem bestimmten Computeknoten ausgeführt werden soll.

Name Typ Beschreibung
commandLine

string

Die Befehlszeile des Auftragsvorbereitungstasks.
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.

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

id

string

Eine Zeichenfolge, die den Auftragsvorbereitungstask innerhalb des Auftrags eindeutig identifiziert.
Die ID kann eine beliebige Kombination von alphanumerischen Zeichen einschließlich Bindestrichen und Unterstrichen enthalten 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 dann erneut ausgeführt, wenn ein Computeknoten ein erneutes Image 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 einen Auftragsvorbereitungstask immer so schreiben, dass er idempotent ist und sich bei mehrfacher Ausführung ordnungsgemäß verhält. Der Standardwert lautet „true“.

resourceFiles

ResourceFile[]

Eine Liste der Dateien, die vom Batch-Dienst auf den Computeknoten heruntergeladen werden, bevor die Befehlszeile ausgeführt wird.
Dateien, die unter diesem Element aufgeführt sind, 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 Sammlung von ResourceFiles verkleinert werden. Dies kann mithilfe von .zip-Dateien, Anwendungspaketen oder Docker-Containern erreicht werden.

userIdentity

UserIdentity

Die Benutzeridentität, unter der der Auftragsvorbereitungstask ausgeführt wird.
Wenn diese Angabe ausgelassen 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 dem Exitcode 0 beendet wird.
Wenn true und der Auftragsvorbereitungstask auf einem Knoten fehlschlägt, führt der Batch-Dienst den Auftragsvorbereitungstask bis zu seiner maximalen Wiederholungsanzahl (wie im constraints-Element angegeben) erneut aus. Wenn die Aufgabe 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 kann Aufgaben anderer Aufträge ausführen. Bei "false" wartet der Batch-Dienst nicht auf den Abschluss des Auftragsvorbereitungstask. In diesem Fall können andere Aufgaben des Auftrags mit der Ausführung auf dem Computeknoten beginnen, 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 Auftragsabschluss auf einem beliebigen Computeknoten ausgeführt wird, 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 "/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 der Auftragsfreigabetask 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 den Auftragsfreigabetask.

id

string

Eine Zeichenfolge, die den Auftragsfreigabetask innerhalb des Auftrags eindeutig identifiziert.
Die ID kann eine beliebige Kombination von alphanumerischen Zeichen einschließlich Bindestrichen und Unterstrichen enthalten 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, ist der HTTP-status Code 400 (ungültige Anforderung).

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.

retentionTime

string

Die Mindestdauer 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 der Task nicht angegeben wird, wird er als nicht administrativer Benutzer ausgeführt, der für den Task eindeutig ist.

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

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. TerminateReason des Auftrags ist auf "AllTasksComplete" festgelegt.

OnTaskFailure

Die Aktion, die der Batch-Dienst ausführen soll, wenn ein Task 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 Platzhalter werden unterstützt: * entspricht 0 oder mehr Zeichen (z. B. Muster abc* entspricht abc oder abcdef), ** mit jedem Verzeichnis, ? entspricht einem einzelnen Zeichen, [abc] einem Zeichen in den Klammern und [a-c] einem Zeichen im Bereich. Klammern können eine Negation enthalten, um einem nicht angegebenen Zeichen zu entsprechen (z. B. [!abc] entspricht einem beliebigen Zeichen außer a, b oder c). Wenn ein Dateiname mit "." beginnt, wird er standardmäßig ignoriert, kann aber durch explizite Angabe abgeglichen werden (z. B. .gif nicht mit .a.gif übereinstimmt, sondern ..gif). Ein einfaches Beispiel: ***.txt entspricht jeder Datei, die nicht in "." beginnt und mit .txt im Arbeitsverzeichnis "Aufgabe" oder einem beliebigen Unterverzeichnis endet. Wenn der Dateiname ein Feldhalterzeichen enthält, kann er mithilfe von Klammern (z. B. abc[] mit einer Datei namens abc übereinstimmen). Beachten Sie, dass sowohl \ als auch / unter Windows als Verzeichnistrennzeichen behandelt werden, aber nur / unter Linux. Umgebungsvariablen (%var% unter Windows oder $var unter Linux) werden vor dem Anwenden des Musters erweitert.

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 Dateien hochgeladen werden sollen.
Wenn Sie keine verwaltete Identität verwenden, muss die URL eine Shared Access Signature (SAS) enthalten, die Schreibberechtigungen für den Container erteilt.

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 containerUrl angegeben wird.
Die Identität muss über Schreibzugriff auf den Azure Blob Storage Container verfügen.

path

string

Das Zielblob oder virtuelle Verzeichnis im Azure Storage-Container.
Wenn filePattern auf eine bestimmte Datei verweist (d. h. keine Wildcards enthält), ist path der Name des Blobs, in das diese Datei hochgeladen werden soll. Wenn filePattern einen oder mehrere Wildcards enthält (und daher mit mehreren Dateien übereinstimmen kann), ist path der Name des virtuellen Blobverzeichnisses (das jedem Blobnamen vorangestellt ist), in das die Dateien hochgeladen werden sollen. Wenn nicht angegeben, werden Die Dateien 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, in 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 Dateien hoch, nachdem der Vorgangsprozess beendet wurde, unabhängig davon, was der Exitcode war.

taskfailure

string

Laden Sie die Dateien erst hoch, nachdem der Vorgangsprozess mit einem Exitcode ungleich null beendet wurde.

tasksuccess

string

Laden Sie die Datei(en) erst hoch, nachdem der Vorgangsprozess mit dem Exitcode 0 beendet wurde.

OutputFileUploadOptions

Details zu einem Vorgang zum Hochladen einer Ausgabedatei, 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 Status Abgeschlossen, und der Poolerstellungsfehler wird in der Planungsfehlereigenschaft des Auftrags festgelegt. Der Batch-Dienst verwaltet die Lebensdauer (sowohl die Erstellung als auch das Löschen 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 Spezifikation für den automatischen Pool angeben, aber nicht beides.

poolId

string

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

PoolLifetimeOption

Die 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 reserviert 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 Auftrag, der nach dem Zeitplan erstellt wurde.

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 anwenden, nicht auf Aufträge.

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 zur Verfügung stellt.
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 zulässigen Lizenzen, die im Pool verfügbar sind, 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 Paketverweisen wirken sich auf alle neuen Knoten aus, die dem Pool beitreten, wirken sich jedoch nicht auf Computeknoten aus, die sich bereits im Pool befinden, bis sie neu gestartet oder ein erneutes Image erstellt werden. Es gibt maximal 10 Paketverweise für einen bestimmten Pool.

autoScaleEvaluationInterval

string

Das Zeitintervall, in dem die Poolgröße gemäß der Formel für die autoskalierte 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 angeben, der kleiner als 5 Minuten oder größer als 168 Stunden ist, lehnt der Batch-Dienst die Anforderung mit einem ungültigen Eigenschaftswertfehler ab. Wenn Sie die REST-API direkt aufrufen, ist 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. 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.

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 der beiden angegeben ist, gibt der Batch-Dienst einen Fehler zurück. Wenn Sie die REST-API direkt aufrufen, ist der HTTP-status Code 400 (ungültige Anforderung). Diese Eigenschaft kann nicht angegeben werden, wenn das Batch-Konto mit der poolAllocationMode-Eigenschaft erstellt wurde, die auf "UserSubscription" festgelegt ist.

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.
Bei 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 die direkte Kommunikation zwischen Computeknoten zulässt.
Das Aktivieren der Knotenkommunikation 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 seine gewünschte Größe nicht erreicht. Der Standardwert ist „FALSE“.

metadata

MetadataItem[]

Eine Liste von Name-Wert-Paaren, die dem Pool als Metadaten zugeordnet sind.
Der 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 von weniger als 5 Minuten angeben, lehnt der Batch-Dienst die Anforderung mit einem Fehler ab. Wenn Sie die REST-API direkt aufrufen, ist 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. Wenn sie angegeben sind, werden diese Tags an die dem Pool zugeordneten, untergeordneten Azure-Ressourcen weitergegeben. Diese Eigenschaft kann nur angegeben werden, wenn das Batch-Konto erstellt wurde, wobei die poolAllocationMode-Eigenschaft auf "UserSubscription" festgelegt ist.

startTask

StartTask

Ein Task, der auf jedem Computeknoten ausgeführt werden soll, wenn 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 Tasks, 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 aufgrund eines Wiederherstellungsvorgangs eine interne Wiederholung erfolgen. Aus diesem Gründen sollten alle Tasks 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, StartTasks zu vermeiden, die einen Unterbrechungsprozess erstellen oder Dienste aus dem StartTask-Arbeitsverzeichnis installieren/starten, da dies verhindert, dass Batch die StartTask erneut ausführen kann.

targetDedicatedNodes

integer

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

targetLowPriorityNodes

integer

Die gewünschte Anzahl von Computeknoten mit spot/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 beides festlegen.

targetNodeCommunicationMode

NodeCommunicationMode

Der kommunikationsmodus für den gewünschten Knoten für den Pool.
Wenn der Wert nicht angegeben wird, 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 des vmSize-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 der beiden angegeben ist, gibt der Batch-Dienst einen Fehler zurück. Wenn Sie die REST-API direkt aufrufen, ist 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 die gleiche Größe.
Informationen zu verfügbaren Größen virtueller Computer in Pools finden Sie unter Auswählen einer VM-Größe für Computeknoten in einem Azure 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 Konto des automatischen Speichers.
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 wird, 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. Andernfalls ist filePath optional und das Verzeichnis, in das die Dateien heruntergeladen werden sollen, wenn die Eigenschaft autoStorageContainerName oder storageContainerUrl angegeben wird. Für den Fall, dass filePath als Verzeichnis verwendet wird, wird jede Verzeichnisstruktur, die den Eingabedaten bereits 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. mithilfe 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: Beispielsweise eine SAS (Shared Access Signature), die Leseberechtigungen für das Blob gewährt, eine verwaltete Identität mit Leseberechtigung verwenden oder die ACL für das Blob oder seinen Container festlegen, um den öffentlichen Zugriff zuzulassen.

identityReference

ComputeNodeIdentityReference

Der Verweis auf die benutzerseitig zugewiesene Identität, die für den Zugriff auf Azure Blob Storage verwendet werden soll, der durch storageContainerUrl oder httpUrl angegeben wird.
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 von Computeknoten lesbar und auflistenbar sein. Es gibt drei Möglichkeiten, eine solche URL für einen Container in Azure Storage abzurufen: Beispielsweise eine SAS (Shared Access Signature), die Lese- und Listenberechtigungen für den Container gewährt, eine verwaltete Identität mit Lese- und Listenberechtigungen verwenden oder die ACL für den Container festlegen, um den ö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 Dienstartefaktverweis-ID 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 Dienstartefakt-Referenz-ID von ServiceArtifactReference
Die Dienstartefakt-Verweis-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 Vorgang. Der Batch-Dienst versucht einen Vorgang erneut, wenn sein Exitcode nicht zero ist.
Beachten Sie, dass dieser Wert speziell die Anzahl von Wiederholungen für die ausführbare Task-Datei steuert, die auf einen nonzero-Exitcode zurückzuführen ist. Der Batch-Dienst versucht den Task einmal und kann dann bis zu diesem Grenzwert wiederholen. Wenn die maximale Wiederholungsanzahl beispielsweise 3 beträgt, versucht Batch den Vorgang bis zu vier Mal (ein erster Versuch und 3 Wiederholungen). Wenn die maximale Wiederholungsanzahl 0 ist, versucht der Batch-Dienst den Vorgang nach dem ersten Versuch nicht mehr. Wenn die maximale Wiederholungsanzahl -1 beträgt, wiederholt der Batch-Dienst den Vorgang ohne Einschränkung. Dies wird jedoch nicht für einen Startvorgang oder eine beliebige Aufgabe empfohlen. Der Standardwert ist 0 (keine Wiederholungsversuche).

maxWallClockTime

string

Die maximal verstrichene Zeit, die der Task ausführen kann, gemessen an 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 kein Zeitlimit für die Ausführungsdauer des Tasks.

retentionTime

string

Die mindeste Zeit zum Beibehalten des Aufgabenverzeichnisses auf dem Computeknoten, auf 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 container create.
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 der Task 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 Arbeitsverzeichnisses des Containertasks.
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 auf jedem 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 eigenschaft containerSettings 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 auf den 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 damit verbundenen 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 Konfiguration der Datenträgerverschlüsselung für den Pool.
Falls angegeben, wird die Verschlüsselung für jeden Knoten im Pool während der Knotenbereitstellung ausgefü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. Ohne Angabe wird kein Rabatt für die lokale Lizenzierung 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 Computeknoten-Agents, die als SKUs bezeichnet werden, für verschiedene Betriebssysteme. Sie müssen eine Serverknoten-Agent-SKU angeben, die mit dem ausgewählten Imageverweis übereinstimmt. Informationen zum Abrufen der Liste der unterstützten Serverknoten-Agent-SKUs zusammen mit der Liste der verifizierten 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".