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. Beim ersten Ansatz gibt der Benutzer einen Auftrags-Manager-Task an. Der Batch-Dienst startet diesen Task, wenn er bereit ist, den Auftrag zu starten. Der Auftrags-Manager-Task steuert alle anderen Aufgaben, die unter diesem Auftrag mithilfe der Task-APIs ausgeführt werden. Beim zweiten Ansatz steuert der Benutzer direkt die Ausführung von Aufgaben unter einem aktiven Auftrag mithilfe der Task-APIs. Beachten Sie auch: Vermeiden Sie beim Benennen von Aufträgen die Einbeziehung vertraulicher Informationen wie Benutzernamen oder Geheimnisprojektnamen. Diese Informationen können in Telemetrieprotokollen enthalten sein, auf die Microsoft-Supporttechniker zugreifen können.

POST {batchUrl}/jobs?api-version=2021-06-01.14.0
POST {batchUrl}/jobs?timeout={timeout}&api-version=2021-06-01.14.0

URI-Parameter

Name In Required Type Description
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 in Sekunden, die der Server mit der Verarbeitung der Anforderung verbringen kann. Der Standardwert ist 30 Sekunden.

Anforderungsheader

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

Name Required Type Description
client-request-id
  • string
uuid

Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Verzierung 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 ausgegeben wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. Legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.

Anforderungstext

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

Name Required Type Description
id True
  • string

Eine Zeichenfolge, die den Auftrag innerhalb des Kontos eindeutig identifiziert.
Die ID kann eine beliebige Kombination alphanumerischer Zeichen enthalten, einschließlich Bindestriche und Unterstriche, 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

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

commonEnvironmentSettings

Die Liste der allgemeinen Einstellungen für Umgebungsvariablen. Diese Umgebungsvariablen werden für alle Aufgaben im Auftrag festgelegt (einschließlich Auftrags-Manager, Auftragsvorbereitung und Auftragsfreigabeaufgaben).
Einzelne Tasks können eine hier angegebene Umgebungseinstellung überschreiben, indem sie den gleichen Einstellungsnamen mit einem anderen Wert angeben.

constraints

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

Details zu einem Auftrags-Manager-Task, der beim Starten des Auftrags gestartet werden soll.
Wenn im Auftrag kein Auftrags-Manager-Task angegeben wird, muss der Benutzer dem Auftrag explizit Aufgaben hinzufügen. Wenn vom Auftrag ein Auftrags-Manager-Task angegeben wird, erstellt der Batch-Dienst den Auftrags-Manager-Task, wenn der Auftrag erstellt wird, und versucht, den Auftrags-Manager-Task vor dem Planen anderer Aufgaben im Auftrag zu planen. Der typische Zweck des Auftrags-Manager-Tasks besteht darin, die Auftragsausführung zu steuern und/oder zu überwachen, z. B. indem entschieden wird, welche zusätzlichen Aufgaben ausgeführt werden sollen, ob die Arbeit abgeschlossen ist usw. (Ein Auftrags-Manager-Task ist jedoch nicht auf diese Aktivitäten beschränkt. Es handelt sich um eine voll funktionsfähige Aufgabe im System und um alle Aktionen, die für den Auftrag erforderlich sind.) Beispielsweise kann ein Auftrags-Manager-Task eine als Parameter angegebene Datei herunterladen, den Inhalt dieser Datei analysieren und zusätzliche Aufgaben basierend auf diesen Inhalten übermitteln.

jobPreparationTask

Die Auftragsvorbereitungsaufgabe.
Wenn ein Auftrag über einen Auftragsvorbereitungstak verfügt, wird der Auftragsvorbereitungstak vom Batch-Dienst auf einem Knoten ausgeführt, bevor Aufgaben dieses Auftrags auf diesem Computeknoten gestartet werden.

jobReleaseTask

Der Auftragsfreigabe-Task.
Ein Auftragsfreigabe-Task kann nicht angegeben werden, ohne auch einen Auftragsvorbereitungs-Task für den Auftrag anzugeben. Der Batch-Dienst führt den Auftragsfreigabe-Task auf den Knoten aus, auf denen der Auftragsvorbereitungstak ausgeführt wurde. Der Hauptzweck des Auftragsfreigabe-Task besteht darin, Änderungen an Computeknoten rückgängig zu machen, die vom Task zur Auftragsvorbereitung vorgenommen wurden. Beispiele für Aktivitä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 Aufgaben, 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 kein Wert angegeben wird, ist der Standardwert -1. Dies bedeutet, dass es keine Beschränkung für die Anzahl von Aufgaben gibt, die gleichzeitig ausgeführt werden können. Sie können die maxParallelTasks eines Auftrags aktualisieren, nachdem er mithilfe der API für den Updateauftrag erstellt wurde.

metadata

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

Die Netzwerkkonfiguration für den Auftrag.

onAllTasksComplete

Die Aktion, die der Batch-Dienst ausführen soll, wenn sich alle Tasks im Auftrag im Status Abgeschlossen befinden.
Beachten Sie, dass alle Aufgaben als abgeschlossen betrachtet werden, wenn ein Auftrag keine Aufgaben enthält. Diese Option wird daher am häufigsten mit einem Auftrags-Manager-Task verwendet. Wenn Sie die automatische Auftragsbeendigung ohne Auftrags-Manager verwenden möchten, sollten Sie zunächst aufAllTasksComplete auf noaction festlegen und die Auftragseigenschaften aktualisieren, um aufAllTasksComplete auf terminatejob zu setzen, nachdem Sie das Hinzufügen von Aufgaben abgeschlossen haben. Der Standardwert ist noaction.

onTaskFailure

Die Aktion, die der Batch-Dienst ausführen soll, wenn ein Task im Auftrag fehlschlägt.
Ein Task gilt als fehlgeschlagen, wenn über eine failureInfo verfügt. Eine failureInfo wird festgelegt, wenn der Task mit einem Exitcode abgeschlossen wird, der nicht 0 (null) ist, nachdem die Anzahl der Wiederholungen erschöpft wurde, oder wenn beim Starten der Aufgabe ein Fehler aufgetreten ist, z. B. aufgrund eines Fehlers beim Herunterladen der 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 Tasks im Auftrag Abhängigkeiten voneinander definieren können. Der Standardwert ist false.

Antworten

Name Type Description
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

Der Fehler des Batch-Diensts.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow

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

Scopes

Name Description
user_impersonation Identität Ihres Benutzerkontos imitieren

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=2021-06-01.14.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "jobId",
  "priority": 0,
  "poolInfo": {
    "poolId": "poolId"
  }
}

Sample Response

Add a complex job

Sample Request

POST account.region.batch.azure.com/jobs?api-version=2021-06-01.14.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "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"
          }
        ]
      }
    }
  },
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Definitionen

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

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

Verteilung von Aufgaben auf Computeknoten in einem Pool.

ComputeNodeIdentityReference

Der Verweis auf eine vom Benutzer 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 wird, 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 kurzlebigen Datenträgerplatzierung für Betriebssystemdatenträger für alle Computeknoten (VMs) im Pool an.

DiffDiskSettings

Gibt die kurzlebige Datenträger-Einstellungen 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 Datenträgerverschlüsselungskonfiguration wird für Linux-Pools, die mit Shared Image Gallery Image erstellt wurden, nicht unterstützt.

DynamicVNetAssignmentScope

Der Bereich der dynamischen VNET-Zuweisung.

ElevationLevel

Die Höhe des Benutzers.

EnvironmentSetting

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

ErrorMessage

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

ImageReference

Ein Verweis auf ein Azure Virtual Machines Marketplace-Image oder ein Shared Image Gallery Image. Informationen zum Abrufen der Liste aller Azure Marketplace Imageverweise, die von Azure Batch überprüft werden, finden Sie im Vorgang "List Supported Images".

InboundEndpointProtocol

Das Protokoll des Endpunkts.

InboundNATPool

Ein NAT-Eingangspool, der verwendet werden kann, um bestimmte Ports auf Computeknoten in einem Batch-Pool extern zu adressen.

IPAddressProvisioningType

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

JobAddParameter

Ein Azure Batch hinzuzufügenden Auftrag.

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 jedem Computeknoten ausgeführt werden soll, 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

MetadataItem

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

MountConfiguration

Das Dateisystem, das auf jedem Knoten bereitgestellt werden soll.

NetworkConfiguration

Die Netzwerkkonfiguration für einen Pool.

NetworkSecurityGroupRule

Eine Netzwerksicherheitsgruppe-Regel, die auf einen eingehenden Endpunkt angewendet werden soll.

NetworkSecurityGroupRuleAccess

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

NFSMountConfiguration

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

NodePlacementConfiguration

Knotenplatzierungskonfiguration für einen Pool.

NodePlacementPolicyType

Die Platzierungsrichtlinie zum Zuordnen von Knoten im Pool.

OnAllTasksComplete

Die Aktion, die der Batch-Dienst ausführen soll, wenn alle Tasks im Auftrag den Status Abgeschlossen haben.

OnTaskFailure

Die Aktion, die der Batch-Dienst ergreifen 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 von einem Azure Batch Computeknoten an einen anderen Speicherort, nachdem der Batch-Dienst die Ausführung des Taskprozesses 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 zum Uploadvorgang einer Ausgabedatei, einschließlich der Bedingungen für den Upload.

PoolEndpointConfiguration

Die Endpunktkonfiguration für einen Pool.

PoolInformation

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

PoolLifetimeOption

Die Mindestlebensdauer von erstellten automatischen Pools und die Zuweisung mehrerer Aufträge zu Pools nach einem Zeitplan.

PoolSpecification

Spezifikation zum Erstellen eines neuen Pools.

PublicIPAddressConfiguration

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

ResourceFile

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

StartTask

Ein Task, der ausgeführt wird, wenn ein Knoten einem Pool im Azure Batch beitritt oder wenn der Computeknoten neu gestartet oder ein Image erstellt wird.

StorageAccountType

Der Speicherkontotyp für die Verwendung beim Erstellen von Datenträ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.

UserAccount

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

UserIdentity

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

VirtualMachineConfiguration

Die Konfiguration für Computeknoten in einem Pool, die auf der Azure Virtual Machines basiert.

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.

ApplicationPackageReference

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

Name Type Description
applicationId
  • string

Die ID der bereitzustellende Anwendung.

version
  • string

Die Version der bereitzustellende Anwendung. Wenn sie nicht angegeben wird, wird die Standardversion bereitgestellt.
Wenn dies für einen Pool ausgelassen wird und keine Standardversion für diese Anwendung angegeben ist, schlägt die Anforderung mit dem Fehlercode InvalidApplicationPackageReferences und dem HTTP-Statuscode 409 fehl. Wenn dies für einen Task ausgelassen wird und für diese Anwendung keine Standardversion angegeben ist, tritt beim Task ein Vorverarbeitungsfehler auf.

AuthenticationTokenSettings

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

Name Type Description
access
  • string[]

Die Batch-Ressourcen, auf die das Token Zugriff gewährt.
Das Authentifizierungstoken gewährt Zugriff auf eine begrenzte Anzahl von Batch-Dienstvorgängen. Derzeit ist der einzige unterstützte Wert für die Access-Eigenschaft "job", der Zugriff auf alle Vorgänge gewährt, die sich auf den Auftrag beziehen, 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 Type Description
autoPoolIdPrefix
  • string

Ein Präfix, das dem eindeutigen Bezeichner hinzugefügt werden soll, wenn automatisch ein Pool 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 bleiben soll.
False gibt an, dass der Batch-Dienst den Pool löscht, sobald seine Lebensdauer abläuft (gemäß der Einstellung poolLifetimeOption). das heißt, wenn der Auftrag oder Auftragszeitplan abgeschlossen ist. True gibt an, dass der Batch-Dienst den Pool nicht automatisch löscht. Der Benutzer kann die mit dieser Option erstellten automatischen Pools löschen.

pool

Die Poolspezifikation für den automatischen Pool.

poolLifetimeOption

Die Mindestlebensdauer der erstellten automatischen Pools und die Zuweisung mehrerer Aufträge nach einem Zeitplan zu Pools.

AutoUserScope

Der Bereich für den automatischen Benutzer

Name Type Description
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 eine Aufgabe im Batch-Dienst ausführt.

Name Type Description
elevationLevel

Die Rechteerweiterungsebene des automatischen Benutzers.
Der Standardwert ist nonAdmin.

scope

Der Bereich für den automatischen Benutzer
Der Standardwert ist pool. Wenn der Pool ausgeführt wird, Windows der Wert Task angegeben werden, wenn eine strengere Isolation zwischen Tasks erforderlich ist. Beispielsweise, wenn der Task die Registrierung auf eine Weise verändert, die sich auf andere Aufgaben auswirken kann, oder wenn Zertifikate für den Pool angegeben wurden, auf die normale Aufgaben nicht, aber für StartTasks zugänglich sein sollten.

AzureBlobFileSystemConfiguration

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

Name Type Description
accountKey
  • string

Der Azure Storage-Kontoschlüssel.
Diese Eigenschaft schließen sich mit sasKey und identity gegenseitig aus. genau eine muss angegeben werden.

accountName
  • string

Der Azure Storage Kontoname.

blobfuseOptions
  • string

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

containerName
  • string

Der Azure Blob Storage Containername.

identityReference

Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf containerName verwendet werden soll.
Diese Eigenschaft schließen sich mit accountKey und sasKey gegenseitig aus. genau eine 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

Der Azure Storage SAS-Token.
Diese Eigenschaft schließen sich mit accountKey und identity gegenseitig aus. genau eine muss angegeben werden.

AzureFileShareConfiguration

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

Name Type Description
accountKey
  • string

Der Azure Storage-Kontoschlüssel

accountName
  • string

Der Azure Storage Kontoname.

azureFileUrl
  • string

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

mountOptions
  • string

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

relativeMountPath
  • string

Der relative Pfad auf dem Computeknoten, 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 empfangene Fehlerantwort.

Name Type Description
code
  • string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.

message

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

values

Eine Auflistung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten.

BatchErrorDetail

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

Name Type Description
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 Type Description
none
  • string

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

readonly
  • string

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

readwrite
  • string

Der Zwischenspeicherungsmodus für den Datenträger lautet Lese- und Schreibzugriff.

CertificateReference

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

Name Type Description
storeLocation

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 konfiguriert sind (d. b. mit cloudServiceConfiguration oder virtualMachineConfiguration unter Verwendung eines Windows Imageverweis). Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis im Arbeitsverzeichnis Task gespeichert, und dem Task wird eine Umgebungsvariable AZ_BATCH_CERTIFICATES_DIR bereitgestellt, um diesen Speicherort abzufragen. Für Zertifikate mit Sichtbarkeit von "remoteUser" wird ein Verzeichnis "certs" im Stammverzeichnis des Benutzers erstellt (z. B. /home/{Benutzername}/certs), 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 konfiguriert sind (d. b. mit cloudServiceConfiguration oder virtualMachineConfiguration unter Verwendung eines Windows Imageverweis). Allgemeine Speichernamen sind: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, aber auch jeder benutzerdefinierte 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
  • string[]

Welche Benutzerkonten auf dem Computeknoten Zugriff auf die privaten Daten des Zertifikats haben sollen.
Sie können in dieser Auflistung mehrere Sichtbarkeiten angeben. Der Standardwert ist alle Konten.

CertificateStoreLocation

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

Name Type Description
currentuser
  • string

Zertifikate sollten im CurrentUser-Zertifikatspeicher installiert werden.

localmachine
  • string

Zertifikate sollten im LocalMachine-Zertifikatspeicher installiert werden.

CIFSMountConfiguration

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

Name Type Description
mountOptions
  • string

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

password
  • string

Das Kennwort, das für die Authentifizierung 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 bereitgestellt 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 Type Description
osFamily
  • string

Die Azure-Gastbetriebssystemfamilie, die auf den virtuellen Computern im Pool installiert werden soll.
Mögliche Werte sind: 2 – Betriebssystemfamilie 2, äquivalent zu 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-Gastbetriebssystemre releases ( https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases) .

osVersion
  • string

Die Azure-Gastbetriebssystemversion, die auf den virtuellen Computern im Pool installiert werden soll.
Der Standardwert ist *, der die neueste Betriebssystemversion für die angegebene Betriebssystemfamilie angibt.

ComputeNodeFillType

Verteilung von Aufgaben auf Computeknoten in einem Pool.

Name Type Description
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 vom Benutzer zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.

Name Type Description
resourceId
  • string

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

ContainerConfiguration

Die Konfiguration für containerfähige Pools.

Name Type Description
containerImageNames
  • string[]

Die Auflistung von Containerimagenamen.
Dies ist der vollständige Imageverweis, wie in "docker pull" angegeben. Ein Image wird aus der Docker-Standardregistrierung bezogen, es sei denn, das Image ist mit einer alternativen Registrierung vollqualifiziert.

containerRegistries

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

Die zu verwendende Containertechnologie.

ContainerRegistry

Eine private Containerregistrierung.

Name Type Description
identityReference

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 vom Benutzer 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 dieser Wert nicht angegeben wird, lautet der Standardwert "docker.io".

username
  • string

Der Benutzername, der beim Registrierungsserver angemeldet werden soll.

ContainerType

Die zu verwendende Containertechnologie.

Name Type Description
dockerCompatible
  • string

Zum Starten der Container wird eine Docker-kompatible Containertechnologie verwendet.

ContainerWorkingDirectory

Der Speicherort des Aufgabenarbeitsverzeichnisses des Containers.

Name Type Description
containerImageDefault
  • string

Verwenden Sie das arbeitsverzeichnis, das im Container Image definiert ist. Achten Sie darauf, dass dieses Verzeichnis nicht die von Batch heruntergeladenen Ressourcendateien enthält.

taskWorkingDirectory
  • string

Verwenden Sie das Standardarbeitsverzeichnis des Batch-Diensttasks, das die von Batch aufgefüllten Taskressourcendateien enthält.

DataDisk

Einstellungen, die von den Datenträgern verwendet wird, 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 Type Description
caching

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

diskSizeGB
  • integer

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

lun
  • integer

Die nummer der logischen Einheit.
Die LUN wird verwendet, um jeden Datenträger eindeutig zu identifizieren. Wenn Sie mehrere Datenträger anfügen, sollte jeder über eine eigene LUN verfügen. Der Wert muss zwischen 0 und 63 (einschließlich) liegen.

storageAccountType

Der Speicherkontotyp, der für den Datenträger verwendet werden soll.
Wenn diese Angabe nicht erfolgt, ist der Standardwert "standard_lrs".

DiffDiskPlacement

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

Name Type Description
CacheDisk
  • string

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

DiffDiskSettings

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

Name Type Description
placement

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. Cachedatenträgerspeicherplatz für die kurzlebige Bereitstellung von Betriebssystemdatenträgern. Weitere Informationen zu den Größenanforderungen für kurzlebige Betriebssystemdatenträger finden Sie unter Größenanforderungen für kurzlebige Betriebssystemdatenträger 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 Datenträgerverschlüsselungskonfiguration wird für Linux-Pools, die mit Shared Image Gallery Image erstellt wurden, nicht unterstützt.

Name Type Description
targets
  • string[]

Die Liste der Datenträgerziele, die batch service verschlüsselt, wird auf dem Computeknoten verschlüsselt.
Wenn diese Angabe nicht erfolgt, werden keine Datenträger auf den Computeknoten im Pool verschlüsselt. Im Linux-Pool wird nur "TemporaryDisk" unterstützt. in Windows Pool müssen "OsDisk" und "TemporaryDisk" angegeben werden.

DynamicVNetAssignmentScope

Der Bereich der dynamischen VNET-Zuweisung.

Name Type Description
job
  • string

Die dynamische VNET-Zuweisung erfolgt pro Auftrag.

none
  • string

Es ist keine dynamische VNET-Zuweisung aktiviert.

ElevationLevel

Die Höhe des Benutzers.

Name Type Description
admin
  • string

Der Benutzer ist ein Benutzer mit erhöhten Zugriffsrechten und arbeitet mit vollständigen Administratorberechtigungen.

nonadmin
  • string

Der Benutzer ist ein Standardbenutzer ohne erhöhte Zugriffsrechte.

EnvironmentSetting

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

Name Type Description
name
  • string

Der Name der Umgebungsvariablen.

value
  • string

Der Wert der Umgebungsvariablen.

ErrorMessage

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

Name Type Description
lang
  • string

Der Sprachcode der Fehlermeldung.

value
  • string

Der Text der Meldung.

ImageReference

Ein Verweis auf ein Azure Virtual Machines Marketplace-Image oder ein Shared Image Gallery Image. Informationen zum Abrufen der Liste aller Azure Marketplace Imageverweise, die von Azure Batch überprüft werden, finden Sie im Vorgang "List Supported Images".

Name Type Description
exactVersion
  • string

Die spezifische Version des Plattformimages oder Marketplace-Images, das zum Erstellen des Knotens verwendet wird. Dieses schreibgeschützte Feld unterscheidet sich nur von "version", wenn der beim Erstellen des Pools für "version" angegebene Wert "latest" 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 dieser Wert nicht angegeben wird, lautet der Standardwert "latest".

virtualMachineImageId
  • string

Der ARM-Ressourcenbezeichner des Shared Image Gallery Image. Computeknoten im Pool werden mit 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ßen sich mit anderen ImageReference-Eigenschaften gegenseitig aus. Das Shared Image Gallery Image muss über Replikate in derselben Region verfügen und sich im selben Abonnement wie das Azure Batch-Konto befinden. Wenn die Imageversion nicht in der imageId 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 Type Description
tcp
  • string

Verwenden Sie TCP für den Endpunkt.

udp
  • string

Verwenden Sie UDP für den Endpunkt.

InboundNATPool

Ein NAT-Eingangspool, der verwendet werden kann, um bestimmte Ports auf Computeknoten in einem Batch-Pool extern zu adressen.

Name Type Description
backendPort
  • integer

Die Portnummer auf dem Computeknoten.
Dies muss innerhalb eines Batch-Pools 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 dem HTTP-Statuscode 400 fehl.

frontendPortRangeEnd
  • integer

Die letzte Portnummer im Bereich externer Ports, die verwendet wird, um eingehenden Zugriff auf backendPort auf einzelnen Computeknoten zu ermöglichen.
Zulässige Werte liegen zwischen 1 und 65534, mit Ausnahme von Ports zwischen 50.000 und 5.5.000, die vom Batch-Dienst reserviert werden. Alle Bereiche innerhalb eines Pools müssen eindeutig sein und dürfen sich nicht überschneiden. Jeder Bereich muss mindestens 40 Ports enthalten. Wenn reservierte oder überlappende Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.

frontendPortRangeStart
  • integer

Die erste Portnummer im Bereich der externen Ports, die verwendet wird, um eingehenden Zugriff auf backendPort auf einzelnen Computeknoten zu ermöglichen.
Zulässige Werte liegen zwischen 1 und 65534, mit Ausnahme von Ports zwischen 50.000 und 5.5.000, die reserviert sind. Alle Bereiche innerhalb eines Pools müssen eindeutig sein und dürfen sich nicht überschneiden. Jeder Bereich muss mindestens 40 Ports enthalten. Wenn reservierte oder überlappende Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.

name
  • string

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

networkSecurityGroupRules

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

protocol

Das Protokoll des Endpunkts.

IPAddressProvisioningType

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

Name Type Description
batchmanaged
  • string

Eine öffentliche IP-Adresse wird von Batch erstellt und verwaltet. Abhängig von der Größe des Pools können mehrere öffentliche IPs verwendet werden.

nopublicipaddresses
  • string

Es wird keine öffentliche IP-Adresse erstellt.

usermanaged
  • string

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

JobAddParameter

Ein Azure Batch hinzuzufügenden Auftrag.

Name Type Description
commonEnvironmentSettings

Die Liste der allgemeinen Einstellungen für Umgebungsvariablen. Diese Umgebungsvariablen werden für alle Aufgaben im Auftrag festgelegt (einschließlich Auftrags-Manager, Auftragsvorbereitung und Auftragsfreigabeaufgaben).
Einzelne Tasks können eine hier angegebene Umgebungseinstellung überschreiben, indem sie den gleichen Einstellungsnamen mit einem anderen Wert angeben.

constraints

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 alphanumerischer Zeichen enthalten, einschließlich Bindestriche und Unterstriche, 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

Details zu einem Auftrags-Manager-Task, der beim Starten des Auftrags gestartet werden soll.
Wenn im Auftrag kein Auftrags-Manager-Task angegeben wird, muss der Benutzer dem Auftrag explizit Aufgaben hinzufügen. Wenn vom Auftrag ein Auftrags-Manager-Task angegeben wird, erstellt der Batch-Dienst den Auftrags-Manager-Task, wenn der Auftrag erstellt wird, und versucht, den Auftrags-Manager-Task vor dem Planen anderer Aufgaben im Auftrag zu planen. Der typische Zweck des Auftrags-Manager-Tasks besteht darin, die Auftragsausführung zu steuern und/oder zu überwachen, z. B. indem entschieden wird, welche zusätzlichen Aufgaben ausgeführt werden sollen, ob die Arbeit abgeschlossen ist usw. (Ein Auftrags-Manager-Task ist jedoch nicht auf diese Aktivitäten beschränkt. Es handelt sich um eine voll funktionsfähige Aufgabe im System und um alle Aktionen, die für den Auftrag erforderlich sind.) Beispielsweise kann ein Auftrags-Manager-Task eine als Parameter angegebene Datei herunterladen, den Inhalt dieser Datei analysieren und zusätzliche Aufgaben basierend auf diesen Inhalten übermitteln.

jobPreparationTask

Die Auftragsvorbereitungsaufgabe.
Wenn ein Auftrag über einen Auftragsvorbereitungstak verfügt, wird der Auftragsvorbereitungstak vom Batch-Dienst auf einem Knoten ausgeführt, bevor Aufgaben dieses Auftrags auf diesem Computeknoten gestartet werden.

jobReleaseTask

Der Auftragsfreigabe-Task.
Ein Auftragsfreigabe-Task kann nicht angegeben werden, ohne auch einen Auftragsvorbereitungs-Task für den Auftrag anzugeben. Der Batch-Dienst führt den Auftragsfreigabe-Task auf den Knoten aus, auf denen der Auftragsvorbereitungstak ausgeführt wurde. Der Hauptzweck des Auftragsfreigabe-Task besteht darin, Änderungen an Computeknoten rückgängig zu machen, die vom Task zur Auftragsvorbereitung vorgenommen wurden. Beispiele für Aktivitä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 Aufgaben, 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 kein Wert angegeben wird, ist der Standardwert -1. Dies bedeutet, dass es keine Beschränkung für die Anzahl von Aufgaben gibt, die gleichzeitig ausgeführt werden können. Sie können die maxParallelTasks eines Auftrags aktualisieren, nachdem er mithilfe der API für den Updateauftrag erstellt wurde.

metadata

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

Die Netzwerkkonfiguration für den Auftrag.

onAllTasksComplete

Die Aktion, die der Batch-Dienst ausführen soll, wenn sich alle Tasks im Auftrag im Status Abgeschlossen befinden.
Beachten Sie, dass alle Aufgaben als abgeschlossen betrachtet werden, wenn ein Auftrag keine Aufgaben enthält. Diese Option wird daher am häufigsten mit einem Auftrags-Manager-Task verwendet. Wenn Sie die automatische Auftragsbeendigung ohne Auftrags-Manager verwenden möchten, sollten Sie zunächst aufAllTasksComplete auf noaction festlegen und die Auftragseigenschaften aktualisieren, um aufAllTasksComplete auf terminatejob zu setzen, nachdem Sie das Hinzufügen von Aufgaben abgeschlossen haben. Der Standardwert ist noaction.

onTaskFailure

Die Aktion, die der Batch-Dienst ausführen soll, wenn ein Task im Auftrag fehlschlägt.
Ein Task gilt als fehlgeschlagen, wenn über eine failureInfo verfügt. Eine failureInfo wird festgelegt, wenn der Task mit einem Exitcode abgeschlossen wird, der nicht 0 (null) ist, nachdem die Anzahl der Wiederholungen erschöpft wurde, oder wenn beim Starten der Aufgabe ein Fehler aufgetreten ist, z. B. aufgrund eines Fehlers beim Herunterladen der Ressourcendatei. Der Standardwert ist noaction.

poolInfo

Der Pool, in dem der Batch-Dienst die Aufgaben des Auftrags ausgefü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 Tasks im Auftrag Abhängigkeiten voneinander definieren können. Der Standardwert ist false.

JobConstraints

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

Name Type Description
maxTaskRetryCount
  • integer

Die maximale Anzahl, mit der jeder Task wiederholt werden kann. Der Batch-Dienst gibt einen Task erneut aus, wenn sein Exitcode ungleich 0 (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 einen Task bis zu viermal (ein erster Versuch und drei Wiederholungen). Wenn die maximale Wiederholungsanzahl 0 beträgt, führt der Batch-Dienst keine Wiederholungsaufgaben aus. Wenn die maximale Wiederholungsanzahl -1 beträgt, wird der Batch-Dienst Tasks ohne Beschränkung erneut ausführen. Der Standardwert ist 0 (keine Wiederholungsversuche).

maxWallClockTime
  • string

Die maximal verstrichene Zeit, die der Auftrag ab dem Zeitpunkt der Auftragserstelle ausgeführt werden kann.
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 ist der Beendigungsgrund MaxWallClockTimeExpiry. Wenn diese Eigenschaft nicht angegeben wird, gibt es kein Zeitlimit für die Ausführung des Auftrags.

JobManagerTask

Gibt Details zu einem Auftrags-Manager-Task an.

Name Type Description
allowLowPriorityNode
  • boolean

Gibt an, ob der Auftrags-Manager-Task auf einem Computeknoten mit niedriger Priorität ausgeführt werden kann.
Der Standardwert lautet „true“.

applicationPackageReferences

Eine Liste der Anwendungspakete, die der Batch-Dienst auf dem Computeknoten bereitstellt, bevor die Befehlszeile ausgeführt wird.
Anwendungspakete werden heruntergeladen und in einem freigegebenen Verzeichnis bereitgestellt, nicht im Aufgabenarbeitsverzeichnis. Wenn sich ein Anwendungspaket, auf das verwiesen wird, bereits auf dem Computeknoten befindet und auf dem neuesten Stand ist, wird es daher nicht erneut heruntergeladen. Die vorhandene Kopie auf dem Computeknoten wird verwendet. Wenn ein Anwendungspaket, auf das verwiesen wird, nicht installiert werden kann, z. B. weil das Paket gelöscht wurde oder der Download fehlgeschlagen ist, schlägt der Task fehl.

authenticationTokenSettings

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 ohne Kontozugriffsschlüssel verwendet werden kann. Das Token wird über die umgebungsvariable AZ_BATCH_AUTHENTICATION_TOKEN bereitgestellt. Welche Vorgänge der Task mit dem Token ausführen kann, hängt von den Einstellungen ab. Beispielsweise kann ein Task Auftragsberechtigungen anfordern, um dem Auftrag andere Aufgaben hinzuzufügen, oder den Status des Auftrags oder anderer Tasks unter dem Auftrag überprüfen.

commandLine
  • string

Die Befehlszeile des Auftrags-Manager-Task.
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 sich die Befehlszeile auf Dateipfade bezieht, sollte sie einen relativen Pfad (relativ zum Taskarbeitsverzeichnis) oder die von Batch bereitgestellte Umgebungsvariable ( https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) verwenden.

constraints

Einschränkungen, die für den Auftrags-Manager-Task gelten.

containerSettings

Die Einstellungen für den Container, unter dem der Auftrags-Manager-Task ausgeführt wird.
Wenn für den Pool, in dem dieser Task ausgeführt wird, containerConfiguration festgelegt ist, muss dies auch festgelegt werden. Wenn für den Pool, in dem dieser Task ausgeführt wird, containerConfiguration nicht festgelegt ist, darf dies nicht festgelegt werden. Wenn dies angegeben wird, werden alle Verzeichnisse rekursiv unterhalb der AZ_BATCH_NODE_ROOT_DIR (der Stamm 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 werden möglicherweise nicht auf dem Hostdatenträger widergespiegelt, was bedeutet, dass Batch-Datei-APIs nicht auf diese Dateien zugreifen können.

displayName
  • string

Der Anzeigename des Auftrags-Manager-Task.
Er muss nicht eindeutig sein und darf unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.

environmentSettings

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 alphanumerischer Zeichen enthalten, einschließlich Bindestriche und Unterstriche, 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.
True gibt an, dass der Batch-Dienst den Auftrag nach Abschluss des Auftrags-Manager-Tasks als abgeschlossen markiert. Wenn tasks zu diesem Zeitpunkt noch ausgeführt werden (außer Auftragsfreigabe), werden diese Tasks beendet. False gibt an, dass sich der Abschluss des Auftrags-Manager-Tasks nicht auf den Auftragsstatus auswirkt. In diesem Fall sollten Sie entweder das onAllTasksComplete-Attribut verwenden, um den Auftrag zu beenden, oder einen Client oder Benutzer den Auftrag explizit beenden lassen. Ein Beispiel hierfür ist, wenn der Auftrags-Manager eine Reihe von Aufgaben erstellt, aber dann keine weitere Rolle bei der Ausführung übernimmt. Der Standardwert lautet „true“. Wenn Sie die Attribute onAllTasksComplete und onTaskFailure verwenden, um die Auftragslebensdauer zu steuern, und den Auftrags-Manager-Task nur zum Erstellen der Tasks für den Auftrag verwenden (nicht zum Überwachen des Fortschritts), ist es wichtig, killJobOnCompletion auf FALSE festzulegen.

outputFiles

Eine Liste der Dateien, die der Batch-Dienst nach dem Ausführen der Befehlszeile vom Computeknoten hochladen wird.
Bei Tasks mit mehreren Instanzen werden die Dateien nur von dem Computeknoten hochgeladen, auf dem der primäre Task ausgeführt wird.

requiredSlots
  • integer

Die Anzahl der Zeitplanungsslots, die der Task für die Ausführung benötigt.
Der Standardwert ist 1. Eine Aufgabe kann nur für die Ausführung auf einem Computeknoten geplant werden, wenn auf dem Knoten genügend freie Zeitplanungsslots verfügbar sind. Bei Tasks mit mehreren Instanzen wird diese Eigenschaft nicht unterstützt und darf nicht angegeben werden.

resourceFiles

Eine Liste der Dateien, die der Batch-Dienst auf den Computeknoten herunterladt, bevor die Befehlszeile ausgeführt wird.
Dateien, die unter diesem Element aufgelistet sind, befinden sich im Arbeitsverzeichnis der Aufgabe. Es gibt eine maximale Größe für die Liste der Ressourcendateien. Wenn die maximale Größe überschritten wird, tritt bei der Anforderung ein Fehler auf, und der Antwortfehlercode ist RequestEntityTooLarge. In diesem Fall muss die Sammlung von ResourceFiles verkleinert werden. Dies kann mithilfe von .zip, Anwendungspaketen oder Docker-Containern erreicht werden.

runExclusive
  • boolean

Gibt an, ob der Auftrags-Manager-Task die exklusive Verwendung des Computeknotens erfordert, auf dem er ausgeführt wird.
True gibt an, dass keine anderen Tasks auf demselben Knoten ausgeführt werden, solange der Auftrags-Manager ausgeführt wird. False gibt an, dass andere Tasks gleichzeitig mit dem Auftrags-Manager auf einem Computeknoten ausgeführt werden können. Der Auftrags-Manager-Task wird normalerweise anhand des Grenzwerts für gleichzeitige Aufgaben des Computeknotens gezählt. Dies ist daher nur relevant, wenn der Computeknoten mehrere gleichzeitige Aufgaben zulässt. Der Standardwert lautet „true“.

userIdentity

Die Benutzeridentität, unter der der Auftrags-Manager-Task ausgeführt wird.
Wenn dieser Wert nicht angegeben wird, wird der Task als nicht administrativer Benutzer ausgeführt, der für den Task eindeutig ist.

JobNetworkConfiguration

Die Netzwerkkonfiguration für den Auftrag.

Name Type Description
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 beitreten. Dies funktioniert nur mit einem VirtualMachineConfiguration-Pool.
Das virtuelle Netzwerk muss sich in derselben Region und demselben Abonnement wie das Azure Batch befinden. Das angegebene Subnetz sollte über genügend freie IP-Adressen verfügen, um die Anzahl der Computeknoten aufnehmen zu können, die Aufgaben aus dem Auftrag ausführen. Dies kann bis zur Anzahl der Computeknoten im Pool sein. Der Dienstprinzipal "MicrosoftAzureBatch" muss über die RBAC-Rolle (Classic Virtual Machine Role-Based Access Control Contributor) für das angegebene VNET verfügen, damit der Azure Batch-Dienst Aufgaben auf den Knoten planen kann. Dies kann überprüft werden, indem überprüft wird, ob das angegebene VNET über zugeordnete Netzwerksicherheitsgruppen (NSG) verfügt. Wenn die Kommunikation mit den Knoten im angegebenen Subnetz durch eine NSG verweigert wird, wird der Zustand der Computeknoten vom Batch-Dienst auf nicht verwendbar festgelegt. Dies hat das Formular /subscriptions/{Abonnement}/resourceGroups/{Gruppe}/providers/{Anbieter}/virtualNetworks/{Netzwerk}/subnets/{Subnetz}. Wenn dem angegebenen VNET Netzwerksicherheitsgruppen (NSG) zugeordnet sind, müssen einige reservierte Systemports für die eingehende Kommunikation vom Azure Batch aktiviert werden. Aktivieren Sie für Pools, die mit einer Konfiguration für virtuelle Computer 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 dem Azure Storage. 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 Type Description
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 Aufgabenarbeitsverzeichnis) oder die von Batch bereitgestellte Umgebungsvariable ( https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) verwenden.

constraints

Einschränkungen, die für den Auftragsvorbereitungstask gelten.

containerSettings

Die Einstellungen für den Container, unter dem der Auftragsvorbereitungstask ausgeführt wird.
Wenn dies angegeben ist, werden alle Verzeichnisse rekursiv unterhalb des AZ_BATCH_NODE_ROOT_DIR (stamm der Azure Batch Verzeichnisse auf dem Knoten) dem Container zugeordnet, alle Taskumgebungsvariablen werden dem Container zugeordnet, und die Task-Befehlszeile wird im Container ausgeführt. Dateien, die im Container außerhalb von AZ_BATCH_NODE_ROOT_DIR erstellt werden, werden möglicherweise nicht auf dem Hostdatenträger widergespiegelt, was bedeutet, dass Batch-Datei-APIs nicht auf diese Dateien zugreifen können.

environmentSettings

Eine Liste der Umgebungsvariableneinstellungen für den Task "Auftragsvorbereitung".

id
  • string

Eine Zeichenfolge, die den Auftragsvorbereitungstask innerhalb des Auftrags eindeutig identifiziert.
Die ID kann eine beliebige Kombination alphanumerischer Zeichen einschließlich Bindestriche und Unterstriche 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 die gleiche ID wie der Auftragsvorbereitungstask aufweisen. Wenn Sie versuchen, einen Task mit der gleichen ID zu übermitteln, lehnt der Batch-Dienst die Anforderung mit dem Fehlercode TaskIdSameAsJobPreparationTask ab. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 409 (Konflikt).

rerunOnNodeRebootAfterSuccess
  • boolean

Gibt an, ob der Batch-Dienst den Auftragsvorbereitungstask nach einem Neustart eines Computeknotens erneut ausführen soll.
Der Auftragsvorbereitungstask wird immer dann erneut ausgeführt, wenn ein Computeknoten neu gestartet wird oder wenn der Auftragsvorbereitungstask nicht abgeschlossen wurde (z. B. weil der Neustart während der Ausführung des Tasks aufgetreten ist). Daher sollten Sie immer eine Auftragsvorbereitungsaufgabe schreiben, um idempotent zu sein und sich ordnungsgemäß zu verhalten, wenn sie mehrmals ausgeführt wird. Der Standardwert lautet „true“.

resourceFiles

Eine Liste der Dateien, die der Batch-Dienst auf den Computeknoten herunterlädt, 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 mit .zip Dateien, Anwendungspaketen oder Docker-Containern erreicht werden.

userIdentity

Die Benutzeridentität, unter der der Auftragsvorbereitungstask ausgeführt wird.
Wenn er nicht angegeben wird, wird der Task als nicht administrativer Benutzer ausgeführt, der für den Task 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 Auftragsvorbereitungstasks warten soll, bevor andere Tasks 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, versucht der Batch-Dienst den Auftragsvorbereitungstask bis zur maximalen Wiederholungsanzahl (wie im Constraints-Element angegeben). Wenn der Task nach allen Wiederholungsversuche immer noch nicht erfolgreich abgeschlossen wurde, plant der Batch-Dienst tasks des Auftrags nicht für den Knoten. Der Knoten bleibt aktiv und berechtigt, Aufgaben anderer Aufträge auszuführen. False gibt an, dass der Batch-Dienst nicht auf den Abschluss des Auftragsvorbereitungstasks wartet. In diesem Fall können andere Tasks des Auftrags auf dem Computeknoten ausgeführt werden, während der Auftragsvorbereitungstask noch ausgeführt wird. und auch wenn die Auftragsvorbereitungsaufgabe fehlschlägt, werden neue Tasks weiterhin auf dem Computeknoten geplant. Der Standardwert lautet „true“.

JobReleaseTask

Ein Auftragsfreigabetask, der bei Auftragsabschluss auf jedem Computeknoten ausgeführt werden soll, auf dem der Auftrag ausgeführt wurde.

Name Type Description
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 Aufgabenarbeitsverzeichnis) oder die von Batch bereitgestellte Umgebungsvariable ( https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) verwenden.

containerSettings

Die Einstellungen für den Container, unter dem der Auftragsfreigabetask ausgeführt wird.
Wenn dies angegeben ist, werden alle Verzeichnisse rekursiv unterhalb des AZ_BATCH_NODE_ROOT_DIR (stamm der Azure Batch Verzeichnisse auf dem Knoten) dem Container zugeordnet, alle Taskumgebungsvariablen werden dem Container zugeordnet, und die Task-Befehlszeile wird im Container ausgeführt. Dateien, die im Container außerhalb von AZ_BATCH_NODE_ROOT_DIR erstellt werden, werden möglicherweise nicht auf dem Hostdatenträger widergespiegelt, was bedeutet, dass Batch-Datei-APIs nicht auf diese Dateien zugreifen können.

environmentSettings

Eine Liste der Umgebungsvariableneinstellungen für den Task "Auftragsfreigabe".

id
  • string

Eine Zeichenfolge, die den Auftragsfreigabetask innerhalb des Auftrags eindeutig identifiziert.
Die ID kann eine beliebige Kombination alphanumerischer Zeichen einschließlich Bindestriche und Unterstriche enthalten und darf nicht mehr als 64 Zeichen enthalten. Wenn Sie diese Eigenschaft nicht angeben, weist der Batch-Dienst den Standardwert 'jobrelease' zu. Kein anderer Task im Auftrag kann die gleiche ID wie der Auftragsfreigabetask aufweisen. Wenn Sie versuchen, einen Task mit der gleichen ID zu übermitteln, lehnt der Batch-Dienst die Anforderung mit dem Fehlercode TaskIdSameAsJobReleaseTask ab. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 409 (Konflikt).

maxWallClockTime
  • string

Die maximal verstrichene Zeit, die der Auftragsfreigabetask auf einem bestimmten Computeknoten ausgeführt werden kann, gemessen ab dem Start der Aufgabe. Wenn der Task nicht innerhalb des Zeitlimits abgeschlossen wird, beendet der Batch-Dienst ihn. Der Standardwert beträgt 15 Minuten. Sie dürfen kein Timeout angeben, das länger als 15 Minuten ist. Wenn Sie dies tun, lehnt der Batch-Dienst dies mit einem Fehler ab. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).

resourceFiles

Eine Liste der Dateien, die der Batch-Dienst auf den Computeknoten herunterlädt, 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 mit .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 mindeste Zeit zum Beibehalten des Aufgabenverzeichnisses für den Task "Auftragsfreigabe" auf dem Computeknoten. Nach diesem Zeitpunkt kann der Batch-Dienst das Aufgabenverzeichnis und seinen gesamten Inhalt löschen.
Der Standardwert beträgt 7 Tage, d. h. das Aufgabenverzeichnis wird sieben Tage lang aufbewahrt, es sei denn, der Computeknoten wird entfernt oder der Auftrag wird gelöscht.

userIdentity

Die Benutzeridentität, unter der der Task "Auftragsfreigabe" ausgeführt wird.
Wenn dieser Wert nicht angegeben wird, wird der Task 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 Type Description
gid
  • integer

Die Gruppen-ID für das Benutzerkonto.
Die Eigenschaften uid und gid müssen zusammen oder überhaupt nicht angegeben werden. Wenn nicht angegeben, wählt das zugrunde liegende Betriebssystem die GID aus.

sshPrivateKey
  • string

Der private SSH-Schlüssel für das Benutzerkonto.
Der private Schlüssel darf nicht kennwortgeschützt sein. Der private Schlüssel wird verwendet, um automatisch die Authentifizierung mit asymmetrischem Schlüssel für SSH zwischen Computeknoten in einem Linux-Pool zu konfigurieren, wenn die enableInterNodeCommunication-Eigenschaft des Pools true ist (sie wird ignoriert, wenn enableInterNodeCommunication false ist). Hierzu wird das Schlüsselpaar im SSH-Verzeichnis des Benutzers platziert. Ohne Angabe wird keine kennwortfreie SSH 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 überhaupt nicht angegeben werden. Wenn nicht angegeben, wählt das zugrunde liegende Betriebssystem die UID aus.

LoginMode

Der Anmeldemodus für den Benutzer

Name Type Description
batch
  • string

Der LOGON32_LOGON_BATCH Win32-Anmeldemodus. Der Batchanmeldungsmodus wird für parallele Prozesse mit langer Ausführungsweise 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 Taskbefehlszeile ausgeführte Anwendung so konfiguriert ist, dass sie immer Administratorrechte oder immer maximale Berechtigungen erfordert.

MetadataItem

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

Name Type Description
name
  • string

Der Name des Metadatenelements.

value
  • string

Der Wert des Metadatenelements.

MountConfiguration

Das Dateisystem, das auf jedem Knoten bereitgestellt werden soll.

Name Type Description
azureBlobFileSystemConfiguration

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

azureFileShareConfiguration

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

cifsMountConfiguration

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

nfsMountConfiguration

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

NetworkConfiguration

Die Netzwerkkonfiguration für einen Pool.

Name Type Description
dynamicVNetAssignmentScope

Der Bereich der dynamischen VNET-Zuweisung.

endpointConfiguration

Die Konfiguration für Endpunkte auf Computeknoten im Batch-Pool.
Die Konfiguration des Poolendpunkts wird nur für Pools mit der VirtualMachineConfiguration-Eigenschaft unterstützt.

publicIPAddressConfiguration

Die Öffentliche IPAddress-Konfiguration für Computeknoten im Batch-Pool.
Die Konfigurationseigenschaft für öffentliche IP-Adressen wird nur für 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 das Formular /subscriptions/{Abonnement}/resourceGroups/{Gruppe}/providers/{Anbieter}/virtualNetworks/{Netzwerk}/subnets/{Subnetz}.
Das virtuelle Netzwerk muss sich in derselben Region und demselben Abonnement wie das Azure Batch befinden. Das angegebene Subnetz sollte über genügend freie IP-Adressen verfügen, um die Anzahl der Computeknoten im Pool aufnehmen zu können. Wenn das Subnetz nicht über genügend freie IP-Adressen verfügen, weist der Pool Knoten teilweise zu, und es tritt ein Größenfehler 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 ermöglichen, um Aufgaben auf den Knoten planen zu können. Dies kann überprüft werden, indem überprüft wird, ob das angegebene VNET über zugeordnete Netzwerksicherheitsgruppen (NSG) verfügt. Wenn die Kommunikation mit den Knoten im angegebenen Subnetz durch eine NSG verweigert wird, wird der Zustand der Computeknoten vom Batch-Dienst auf nicht verwendbar festgelegt. 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 Konfiguration virtueller Computer 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 außerdem ausgehende Verbindungen mit Azure Storage 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 Netzwerksicherheitsgruppe-Regel, die auf einen eingehenden Endpunkt angewendet werden soll.

Name Type Description
access

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

priority
  • integer

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

sourceAddressPrefix
  • string

Das Quelladressenpräfix oder -tag, das mit der 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 dem HTTP-Statuscode 400 fehl.

sourcePortRanges
  • string[]

Die Quellportbereiche, die mit der Regel übereinstimmen.
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 überlappen (entweder einen Bereich oder einen einzelnen Port). Wenn andere Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl. Der Standardwert ist "".

NetworkSecurityGroupRuleAccess

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

Name Type Description
allow
  • string

Zugriff zulassen.

deny
  • string

Zugriff verweigern.

NFSMountConfiguration

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

Name Type Description
mountOptions
  • string

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

relativeMountPath
  • string

Der relative Pfad auf dem Computeknoten, 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 bereitgestellt werden soll.

NodePlacementConfiguration

Knotenplatzierungskonfiguration für einen Pool.

Name Type Description
policy

Knotenplatzierungsrichtlinientyp für Batch-Pools.
Zuordnungsrichtlinie, die vom Batch-Dienst zum Bereitstellen der Knoten verwendet wird. Wenn keine Angabe erfolgt, verwendet Batch die regionale Richtlinie.

NodePlacementPolicyType

Die Platzierungsrichtlinie zum Zuordnen von Knoten im Pool.

Name Type Description
regional
  • string

Alle Knoten im Pool werden in derselben Region zugeordnet.

zonal
  • string

Knoten im Pool werden auf verschiedene Verfügbarkeitszonen mit bestmöglichem Lastenausgleich verteilt.

OnAllTasksComplete

Die Aktion, die der Batch-Dienst ausführen soll, wenn alle Tasks im Auftrag den Status Abgeschlossen haben.

Name Type Description
noaction
  • string

Sie unternehmen nichts. Der Auftrag bleibt aktiv, es sei denn, er wird auf andere Weise beendet oder deaktiviert.

terminatejob
  • string

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

OnTaskFailure

Die Aktion, die der Batch-Dienst ergreifen soll, wenn ein Task im Auftrag fehlschlägt.

Name Type Description
noaction
  • string

Sie unternehmen nichts. Der Auftrag bleibt aktiv, es sei denn, er wird auf andere Weise beendet oder deaktiviert.

performexitoptionsjobaction
  • string

Führen Sie die Aktion aus, die der Task-Beendigungsbedingung in der exitConditions-Sammlung des Tasks zugeordnet ist. (Dies kann immer noch dazu führen, dass keine Aktion ausgeführt wird, wenn dies vom Task angegeben wird.)

OSDisk

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

Name Type Description
ephemeralOSDiskSettings

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

OutputFile

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

Name Type Description
destination

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 Aufgabenarbeitsverzeichnis. Die folgenden Platzhalter werden unterstützt: * entspricht 0 oder mehr Zeichen (z. B. das Muster abc* entspricht abc oder abcdef), ** entspricht einem beliebigen Verzeichnis, ? entspricht einem beliebigen einzelnen Zeichen, [abc] entspricht einem Zeichen in den Klammern, und [a-c] entspricht einem Zeichen im Bereich. Klammern können eine Negation enthalten, um ein beliebiges Zeichen abzugleichen, das nicht angegeben ist (z.B. [!abc] entspricht einem beliebigen Zeichen, aber a, b oder c). Wenn ein Dateiname mit "." beginnt, wird er standardmäßig ignoriert, kann aber durch explizite Angabe übereinstimmen (z. B. stimmt .gif nicht mit .a.gif überein, aber ..gif). Ein einfaches Beispiel: ***.txt entspricht jeder Datei, die nicht in "." beginnt und mit .txt im Aufgabenarbeitsverzeichnis oder einem Unterverzeichnis endet. Wenn der Dateiname ein Platzhalterzeichen enthält, kann er mithilfe von Klammern mit Escapezeichen (z. B. abc[] würde mit einer Datei namens abc übereinstimmen). Beachten Sie, dass sowohl \ als auch / als Verzeichnistrennzeichen auf Windows behandelt werden, aber nur / unter Linux ist. Umgebungsvariablen (%var% für Windows oder $var unter Linux) werden erweitert, bevor das Muster angewendet wird.

uploadOptions

Zusätzliche Optionen für den Uploadvorgang, z. B. unter welchen Bedingungen der Upload ausgeführt werden soll.

OutputFileBlobContainerDestination

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

Name Type Description
containerUrl
  • string

Die URL des Containers in Azure Blob Storage, in die die Dateien hochgeladen werden.
Wenn keine verwaltete Identität verwendet wird, muss die URL eine Shared Access Signature (SAS) enthalten, die Schreibberechtigungen für den Container erteilt.

identityReference

Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf Azure Blob Storage containerUrl angegeben wird.
Die Identität muss über Schreibzugriff auf den Azure Blob Storage verfügen.

path
  • string

Das Zielblob oder virtuelle Verzeichnis im Azure Storage Container.
Wenn filePattern auf eine bestimmte Datei verweist (d. h. keine Platzhalter enthält), ist path der Name des Blobs, in das diese Datei hochgeladen werden soll. Wenn filePattern einen oder mehrere Platzhalter enthält (und daher mit mehreren Dateien übereinstimmen kann), ist path der Name des virtuellen Blobverzeichnisses (das jedem Blobnamen vorgefertigt wird), in das die Datei(en) hochgeladen werden soll. Wenn sie nicht angegeben werden, werden Dateien in das Stammverzeichnis des Containers hochgeladen, und der Blobname entspricht dem Dateinamen.

OutputFileDestination

Das Ziel, in das eine Datei hochgeladen werden soll.

Name Type Description
container

Ein Speicherort in Azure Blob Storage, an den Dateien hochgeladen werden.

OutputFileUploadCondition

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

Name Type Description
taskcompletion
  • string

Hochladen datei(n) nach dem Beenden des Task-Prozesses, unabhängig davon, was der Exitcode war.

taskfailure
  • string

Hochladen datei(n) erst nach dem Beenden des Task-Prozesses mit einem Exitcode ungleich 0 (null) ab.

tasksuccess
  • string

Hochladen datei(n) erst nach Dem Beenden des Task-Prozesses mit dem Exitcode 0.

OutputFileUploadOptions

Details zum Uploadvorgang einer Ausgabedatei, einschließlich der Bedingungen für den Upload.

Name Type Description
uploadCondition

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 Type Description
inboundNATPools

Eine Liste eingehender NAT-Pools, die verwendet werden können, um bestimmte Ports auf einem einzelnen Computeknoten extern zu adressen.
Die maximale Anzahl eingehender NAT-Pools pro Batch-Pool beträgt 5. Wenn die maximale Anzahl eingehender NAT-Pools überschritten wird, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl. Dies kann nicht angegeben werden, wenn ipAddressProvisioningType NoPublicIPAddresses ist.

PoolInformation

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

Name Type Description
autoPoolSpecification

Merkmale für einen temporären "automatischen Pool". Der Batch-Dienst erstellt diesen automatischen Pool, wenn der Auftrag übermittelt wird.
Wenn bei der automatischen Poolerstellung ein Fehler auftritt, verschiebt der Batch-Dienst den Auftrag in den Status Abgeschlossen, und der Fehler bei der Poolerstellung wird in der Fehlereigenschaft Planungsfehler des Auftrags festgelegt. Der Batch-Dienst verwaltet die Lebensdauer (erstellung und, sofern keepAlive nicht angegeben ist, Löschung) des automatischen Pools. Alle Benutzeraktionen, die sich auf die Lebensdauer des automatischen Pools auswirken, während der Auftrag aktiv ist, führen zu unerwartetem Verhalten. Sie müssen entweder die Pool-ID oder die automatische Poolspezifikation 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 nicht vorhanden ist, zu dem der Batch-Dienst versucht, einen Auftrag zu planen, 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 ablehnt. Aufgaben werden einfach erst ausgeführt, wenn der Pool vorhanden ist. Sie müssen entweder die Pool-ID oder die automatische Poolspezifikation angeben, aber nicht beides.

PoolLifetimeOption

Die Mindestlebensdauer von erstellten automatischen Pools und die Zuweisung mehrerer Aufträge zu Pools nach einem Zeitplan.

Name Type Description
job
  • string

Der Pool ist für die Lebensdauer des Auftrags vorhanden, für den er de dedicated ist. Der Batch-Dienst erstellt den Pool beim Erstellen des Auftrags. 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 und nicht auf Aufträge anwenden.

PoolSpecification

Spezifikation zum Erstellen eines neuen Pools.

Name Type Description
applicationLicenses
  • string[]

Die Liste der Anwendungslizenzen, die der Batch-Dienst auf jedem Computeknoten im Pool verfügbar macht.
Die Liste der Anwendungslizenzen muss eine Teilmenge der verfügbaren Batch-Dienstanwendungslizenzen sein. Wenn eine Lizenz angefordert wird, die nicht unterstützt wird, kann der Pool nicht erstellt werden. Die im Pool verfügbaren zulässigen Lizenzen sind "maya", "vray", "3dsmax", "arnold". Für jede Anwendungslizenz, die dem Pool hinzugefügt wird, wird eine zusätzliche Gebühr berechnet.

applicationPackageReferences

Die Liste der Pakete, die auf jedem Computeknoten im Pool installiert werden sollen.
Ä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 Image erstellt wurden. Es gibt maximal 10 Paketverweise für jeden angegebenen Pool.

autoScaleEvaluationInterval
  • string

Das Zeitintervall, in dem die Poolgröße gemäß der Formel für die automatische Skalierung automatisch angepasst werden soll.
Der Standardwert beträgt 15 Minuten. Der Mindest- und Höchstwert beträgt 5 Minuten bzw. 168 Stunden. Wenn Sie einen Wert angeben, der weniger als 5 Minuten oder länger als 168 Stunden ist, lehnt der Batch-Dienst die Anforderung mit einem Ungültigen Eigenschaftswertfehler ab. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Bad Request).

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

Eine Liste der Zertifikate, die auf jedem Computeknoten im Pool installiert werden sollen.
Für Windows-Knoten installiert der Batch-Dienst die Zertifikate am angegebenen Zertifikatspeicher und Speicherort. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis im Arbeitsverzeichnis Task gespeichert, und eine Umgebungsvariable AZ_BATCH_CERTIFICATES_DIR wird für die Aufgabe bereitgestellt, um diesen Speicherort abfragt. Für Zertifikate mit Sichtbarkeit von "remoteUser" wird ein Verzeichnis "certs" im Startverzeichnis des Benutzers erstellt (z.B. /home/{Benutzername}/certs), und Zertifikate werden in diesem Verzeichnis platziert.

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 von beiden angegeben ist, gibt der Batch-Dienst einen Fehler zurück. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Bad Request). 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.
False gibt an, dass mindestens eine von targetDedicatedNodes und targetLowPriorityNodes angegeben werden muss. True gibt an, dass das autoScaleFormula-Element erforderlich ist. Die Größe des Pools wird automatisch gemäß der Formel geändert. Der Standardwert ist „FALSE“.

enableInterNodeCommunication
  • boolean

Gibt an, ob der Pool die direkte Kommunikation zwischen Computeknoten zu lässt.
Durch das Aktivieren der Kommunikation zwischen Knoten wird die maximale Größe des Pools aufgrund von Bereitstellungseinschränkungen auf den Computeknoten des Pools eingeschränkt. Dies kann dazu führen, dass der Pool die gewünschte Größe nicht erreicht. Der Standardwert ist „FALSE“.

metadata

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

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

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. Sie hat keine Auswirkungen, wenn enableAutoScale auf TRUE festgelegt ist. Der Standardwert beträgt 15 Minuten. Der Mindestwert beträgt 5 Minuten. Wenn Sie einen Wert angeben, der weniger als 5 Minuten beträgt, lehnt der Batch-Dienst die Anforderung mit einem Fehler ab. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Bad Request).

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 oder der Computeknoten neu gestartet wird.
Batch wird Tasks wiederholen, wenn ein Wiederherstellungsvorgang auf einem Knoten ausgelöst wird. Beispiele für Wiederherstellungsvorgänge sind (aber nicht darauf beschränkt), wenn ein fehlerhafter Knoten neu gestartet wird oder ein Computeknoten aufgrund eines Hostfehlers nicht mehr verfügbar ist. Wiederholungen aufgrund von Wiederherstellungsvorgängen sind unabhängig von und werden nicht für maxTaskRetryCount gezählt. Auch wenn maxTaskRetryCount 0 ist, kann aufgrund eines Wiederherstellungsvorgang ein interner Wiederholungsversuch durchgeführt werden. Aus diesem Grund sollten alle Tasks idempotent sein. Dies bedeutet, dass Tasks tolerieren müssen, dass sie unterbrochen und neu gestartet werden, ohne beschädigungs- oder dupliziert zu werden. Die bewährte Methode für Aufgaben mit langer Ausführungslauf ist die Verwendung einer Form der Prüfpunktierung. In einigen Fällen kann startTask erneut ausgeführt werden, obwohl der Computeknoten nicht neu gestartet wurde. Es sollte besonders darauf achten, StartTasks zu vermeiden, die einen breakaway-Prozess erstellen oder Dienste aus dem StartTask-Arbeitsverzeichnis installieren/starten, da batch dadurch daran verhindert wird, den StartTask erneut ausführen zu können.

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 niedriger Priorität im Pool.
Diese Eigenschaft darf nicht angegeben werden, wenn enableAutoScale auf TRUE festgelegt ist. Wenn enableAutoScale auf FALSE festgelegt ist, müssen Sie entweder targetDedicatedNodes, targetLowPriorityNodes oder beides festlegen.

taskSchedulingPolicy

Wie Tasks auf Computeknoten in einem Pool verteilt werden.
Wenn kein Wert angegeben wird, wird der Standardwert verteilt.

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 Höchstwert ist der kleinere der vierfachen Anzahl von Kernen des vmSize-Werts des Pools oder 256.

userAccounts

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

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 von beiden angegeben ist, gibt der Batch-Dienst einen Fehler zurück. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Bad Request).

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 Type Description
ipAddressIds
  • string[]

Die Liste der öffentlichen IP-Computer, die der Batch-Dienst beim Bereitstellen von Computeknoten verwendet.
Die hier angegebene Anzahl von IP-Adressen schränkt die maximale Größe des Pools ein– 100 dedizierte Knoten oder 100 Knoten mit niedriger Priorität können für jede öffentliche IP-Adresse zugeordnet werden. Für einen Pool, der 250 dedizierte VMs benötigt, sind beispielsweise mindestens drei öffentliche IP-Computer erforderlich. Jedes Element dieser Sammlung hat folgendes Format: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision

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

ResourceFile

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

Name Type Description
autoStorageContainerName
  • string

Der Name des Speichercontainers im Automatischen Speicherkonto.
Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden.

blobPrefix
  • string

Das Blobpräfix, das beim Herunterladen von Blobs aus einem Azure Storage 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 teilieller Dateiname oder ein Unterverzeichnis sein. Wenn kein Präfix angegeben wird, werden alle Dateien im Container heruntergeladen.

fileMode
  • string

Das Dateiberechtigungsmodusattribut im Oktalformat.
Diese Eigenschaft gilt nur für Dateien, die auf Linux-Computeknoten heruntergeladen werden. Sie wird ignoriert, wenn sie für eine resourceFile angegeben ist, die auf einen Windows Computeknoten heruntergeladen wird. Wenn diese Eigenschaft nicht für einen Linux-Computeknoten angegeben ist, wird der Standardwert 0770 auf die Datei angewendet.

filePath
  • string

Der Speicherort auf dem Computeknoten, an den die Dateien heruntergeladen werden sollen, relativ zum Arbeitsverzeichnis der Aufgabe.
Wenn die httpUrl-Eigenschaft angegeben wird, ist filePath erforderlich und beschreibt den Pfad, in den die Datei heruntergeladen wird, einschließlich des Dateinamens. Wenn die eigenschaft autoStorageContainerName oder storageContainerUrl angegeben ist, ist filePath optional und das Verzeichnis, in das die Dateien heruntergeladen werden sollen. Wenn filePath als Verzeichnis verwendet wird, wird jede Verzeichnisstruktur, die bereits den Eingabedaten zugeordnet ist, vollständig beibehalten und an das angegebene filePath-Verzeichnis angefügt. Der angegebene relative Pfad kann nicht aus dem Arbeitsverzeichnis des Tasks ausbrechen (z. B. mit "..").

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, muss sie von Computeknoten aus lesbar sein. Es gibt drei Möglichkeiten, eine solche URL für ein Blob in Azure Storage zu erhalten: eine Shared Access Signature (SAS), die Leseberechtigungen für das Blob erteilt, eine verwaltete Identität mit Leseberechtigung verwendet oder die Zugriffssteuerungsliste für das Blob oder seinen Container so festlegen, dass der öffentliche Zugriff zulässig ist.

identityReference

Der Verweis auf die vom Benutzer zugewiesene Identität für den Zugriff auf Azure Blob Storage angegeben durch storageContainerUrl oder httpUrl.
Der Verweis auf eine vom Benutzer 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 aus lesbar und auflistend sein. Es gibt drei Möglichkeiten, eine solche URL für einen Container in Azure Storage zu erhalten: Eine Shared Access Signature (SAS) gewährt Lese- und Listenberechtigungen für den Container, verwendet eine verwaltete Identität mit Lese- und Listenberechtigungen oder die Zugriffssteuerungsliste für den Container, um öffentlichen Zugriff zu ermöglichen.

StartTask

Ein Task, der ausgeführt wird, wenn ein Knoten einem Pool im Azure Batch beitritt oder wenn der Computeknoten neu gestartet oder ein Image erstellt wird.

Name Type Description
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 sich die Befehlszeile auf Dateipfade bezieht, sollte sie einen relativen Pfad (relativ zum Taskarbeitsverzeichnis) oder die von Batch bereitgestellte Umgebungsvariable ( https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) verwenden.

containerSettings

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

environmentSettings

Eine Liste der Umgebungsvariableneinstellungen für StartTask.

maxTaskRetryCount
  • integer

Die maximale Anzahl, mit der der Task wiederholt werden kann.
Der Batch-Dienst gibt einen Task erneut aus, wenn sein Exitcode ungleich 0 (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 viermal (ein erster Versuch und drei Wiederholungen). Wenn die maximale Wiederholungsanzahl 0 beträgt, wird der Task vom Batch-Dienst nicht erneut ausgeführt. Wenn die maximale Wiederholungsanzahl -1 beträgt, wird der Task vom Batch-Dienst ohne Beschränkung erneut ausgeführt.

resourceFiles

Eine Liste der Dateien, die der Batch-Dienst auf den Computeknoten herunterladt, 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, tritt bei der Anforderung ein Fehler auf, und der Antwortfehlercode ist RequestEntityTooLarge. In diesem Fall muss die Sammlung von ResourceFiles verkleinert werden. Dies kann mithilfe von .zip, Anwendungspaketen oder Docker-Containern erreicht werden.
Dateien, die unter diesem Element aufgelistet sind, befinden sich im Arbeitsverzeichnis der Aufgabe.

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 der StartTask erfolgreich abgeschlossen wurde (d. h. mit Exitcode 0 beendet wird), bevor Tasks auf dem Computeknoten geplant werden.
Wenn true und startTask auf einem Knoten fehlschlägt, versucht der Batch-Dienst den StartTask bis zur maximalen Wiederholungsanzahl (maxTaskRetryCount) erneut. Wenn der Task nach allen Wiederholungsversuche immer noch nicht erfolgreich abgeschlossen wurde, markiert der Batch-Dienst den Knoten als nicht verfügbar und plant keine Aufgaben. Diese Bedingung kann über die Status- und Fehlerinformationen des Computeknotens erkannt werden. False gibt an, dass der Batch-Dienst nicht auf den Abschluss des StartTask wartet. In diesem Fall können andere Tasks auf dem Computeknoten ausgeführt werden, während startTask noch ausgeführt wird. und selbst wenn der StartTask fehlschlägt, werden neue Tasks weiterhin auf dem Computeknoten geplant. Der Standardwert ist "True".

StorageAccountType

Der Speicherkontotyp für die Verwendung beim Erstellen von Datenträgern.

Name Type Description
premium_lrs
  • string

Der Datenträger sollte lokal redundanten Premium-Speicher verwenden.

standard_lrs
  • string

Der Datenträger sollte lokal redundanten Standardspeicher verwenden.

TaskConstraints

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

Name Type Description
maxTaskRetryCount
  • integer

Die maximale Anzahl, mit der der Task wiederholt werden kann. Der Batch-Dienst sucht einen Task erneut, wenn sein Exitcode ungleich 0 (null) ist.
Beachten Sie, dass dieser Wert speziell die Anzahl der Wiederholungen für die ausführbare Taskdatei aufgrund eines Exitcodes ungleich 0 steuert. 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 Task bis zu viermal (ein erster Versuch und drei Wiederholungen). Wenn die maximale Wiederholungsanzahl 0 beträgt, versucht der Batch-Dienst den Task nach dem ersten Versuch nicht erneut. Wenn die maximale Wiederholungsanzahl -1 beträgt, versucht der Batch-Dienst den Task ohne Beschränkung erneut.

maxWallClockTime
  • string

Die maximal verstrichene Zeit, die der Task ausgeführt werden kann, gemessen ab dem Start der Aufgabe. Wenn der Task nicht innerhalb des Zeitlimits abgeschlossen wird, beendet der Batch-Dienst ihn.
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 beträgt 7 Tage, d. h. das Aufgabenverzeichnis wird sieben Tage lang aufbewahrt, es sei denn, der Computeknoten wird entfernt oder der Auftrag wird gelöscht.

TaskContainerSettings

Die Containereinstellungen für einen Task.

Name Type Description
containerRunOptions
  • string

Zusätzliche Optionen für den Container create-Befehl.
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, der für "docker pull" angegeben wird. Wenn kein Tag als Teil des Imagenamens angegeben wird, wird das Tag ":latest" als Standard verwendet.

registry

Die private Registrierung, die das Containerimage enthält.
Diese Einstellung kann weggelassen werden, wenn bereits bei der Poolerstellung angegeben wurde.

workingDirectory

Der Speicherort des Arbeitsverzeichnisses der Containeraufgabe.
Der Standardwert ist "taskWorkingDirectory".

TaskSchedulingPolicy

Gibt an, wie Tasks auf Computeknoten verteilt werden sollen.

Name Type Description
nodeFillType

Wie Tasks auf Computeknoten in einem Pool verteilt werden.
Wenn kein Wert angegeben wird, wird der Standardwert verteilt.

UserAccount

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

Name Type Description
elevationLevel

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

linuxUserConfiguration

Die Linux-spezifische Benutzerkonfiguration für das Benutzerkonto.
Diese Eigenschaft wird ignoriert, wenn sie für einen Windows Pool angegeben wird. Wenn keine Angabe erfolgt, wird der Benutzer mit den Standardoptionen erstellt.

name
  • string

Der Name des Benutzerkontos.

password
  • string

Das Kennwort für das Benutzerkonto.

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, wird der Benutzer in einem Windows-Pool mit den Standardoptionen erstellt.

UserIdentity

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

Name Type Description
autoUser

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

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

VirtualMachineConfiguration

Die Konfiguration für Computeknoten in einem Pool, die auf der Azure Virtual Machines basiert.

Name Type Description
containerConfiguration

Die Containerkonfiguration für den Pool.
Wenn 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 containerSettings-Eigenschaft angeben, und alle anderen Tasks können sie angeben.

dataDisks

Die Konfiguration für Datenträger, die an die Computeknoten im Pool angefügt sind.
Diese Eigenschaft muss angegeben werden, wenn den Computeknoten im Pool leere Datenträger angefügt werden 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. Jeder angefügte Datenträger ist leer. Wenn der Computeknoten aus dem Pool entfernt wird, werden auch der Datenträger und alle ihm zugeordneten Daten gelöscht. Der Datenträger wird 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

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

extensions

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

imageReference

Ein Verweis auf das Azure Virtual Machines Marketplace-Image oder das zu verwendende benutzerdefinierte Image eines virtuellen Computers.

licenseType
  • string

Der Typ der lokalen Lizenz, die beim Bereitstellen des Betriebssystems verwendet werden soll.
Dies gilt nur für Images, die das Windows-Betriebssystem enthalten, und sollte nur verwendet werden, wenn Sie gültige lokale Lizenzen für die Computeknoten besitzen, die bereitgestellt werden. Wenn dies nicht angegeben wird, 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 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 bietet. Es gibt verschiedene Implementierungen des Computeknoten-Agents, die als SKUs bezeichnet werden, für verschiedene Betriebssysteme. Sie müssen eine Computeknoten-Agent-SKU angeben, die dem ausgewählten Imageverweis entspricht. Die Liste der unterstützten Computeknoten-Agent-SKUs sowie die Liste der überprüften Imageverweise finden Sie im Vorgang "List supported Compute Node agent SKUs" (Auflisten der unterstützten Computeknoten-Agent-SKUs).

nodePlacementConfiguration

Die Knotenplatzierungskonfiguration für den Pool.
Diese Konfiguration gibt Regeln an, wie Knoten im Pool physisch zugeordnet werden.

osDisk

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

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 Type Description
autoUpgradeMinorVersion
  • boolean

Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn eine zur Bereitstellungszeit verfügbar ist. Nach der Bereitstellung führt die Erweiterung jedoch kein Upgrade für Nebenversionen durch, es sei denn, sie wird erneut bereitgestellt, selbst wenn diese Eigenschaft auf TRUE festgelegt ist.

name
  • string

Der Name der VM-Erweiterung.

protectedSettings
  • object

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

provisionAfterExtensions
  • string[]

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

publisher
  • string

Der Name des Erweiterungshandlerherausgebers.

settings
  • object

Öffentliche Einstellungen im JSON-Format 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 Type Description
enableAutomaticUpdates
  • boolean

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

WindowsUserConfiguration

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

Name Type Description
loginMode

Der Anmeldemodus für den Benutzer
Der Standardwert für VirtualMachineConfiguration-Pools ist "batch" und für CloudServiceConfiguration-Pools "interactive".