Job - List
Listet alle Aufträge im angegebenen Konto auf.
GET {batchUrl}/jobs?api-version=2024-07-01.20.0
GET {batchUrl}/jobs?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
batch
|
path | True |
string |
Die Basis-URL für alle Azure Batch-Dienstanforderungen. |
api-version
|
query | True |
string |
Client-API-Version. |
$expand
|
query |
string |
Eine OData-$expand-Klausel. |
|
$filter
|
query |
string |
Eine OData-$filter-Klausel. Weitere Informationen zum Erstellen dieses Filters finden Sie unter https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobs. |
|
$select
|
query |
string |
Eine OData-$select-Klausel. |
|
maxresults
|
query |
integer int32 |
Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Maximal 1000 Aufträge können zurückgegeben werden. |
|
timeout
|
query |
integer int32 |
Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Wenn der Wert größer als 30 ist, wird stattdessen der Standardwert verwendet. |
Anforderungsheader
Media Types: "application/json; odata=minimalmetadata"
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
client-request-id |
string uuid |
Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll. |
|
ocp-date |
string date-time-rfc1123 |
Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Eine Antwort, die die Liste der Aufträge enthält. Header
|
|
Other Status Codes |
Der Fehler vom Batchdienst. |
Sicherheit
azure_auth
Microsoft Entra OAuth 2.0-Authentifizierungscodefluss
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel ihres Benutzerkontos |
Authorization
Typ:
apiKey
In:
header
Beispiele
Job list
Beispielanforderung
GET account.region.batch.azure.com/jobs?api-version=2024-07-01.20.0
Beispiel für eine Antwort
{
"value": [
{
"id": "jobId",
"url": "https://account.region.batch.azure.com/jobs/jobId",
"eTag": "0x8D4100FC46D5BF4",
"lastModified": "2016-11-19T00:05:27.2137716Z",
"creationTime": "2016-11-19T00:05:25.311915Z",
"state": "active",
"stateTransitionTime": "2016-11-19T00:05:27.2137716Z",
"previousState": "disabled",
"previousStateTransitionTime": "2016-11-19T00:05:26.88777Z",
"priority": 0,
"maxParallelTasks": -1,
"allowTaskPreemption": false,
"usesTaskDependencies": false,
"constraints": {
"maxWallClockTime": "P10675199DT2H48M5.4775807S",
"maxTaskRetryCount": 0
},
"poolInfo": {
"poolId": "poolId"
},
"executionInfo": {
"startTime": "2016-11-19T00:05:25.3309105Z",
"poolId": "poolId"
},
"onAllTasksComplete": "noaction",
"onTaskFailure": "noaction"
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Access |
Die Batchressourcen, auf die das Token Zugriff gewährt. |
Application |
Ein Verweis auf ein Paket, das auf Computeknoten bereitgestellt werden soll. |
Authentication |
Die Einstellungen für ein Authentifizierungstoken, das von der Aufgabe zum Ausführen von Batchdienstvorgängen verwendet werden kann. |
Automatic |
Die Konfigurationsparameter, die zum Ausführen eines automatischen Betriebssystemupgrades verwendet werden. |
Auto |
Gibt Merkmale für einen temporären "automatischen Pool" an. Der Batchdienst erstellt diesen automatischen Pool, wenn der Auftrag übermittelt wird. |
Auto |
Der Bereich für den automatischen Benutzer |
Auto |
Gibt die Parameter für den automatischen Benutzer an, der eine Aufgabe im Batchdienst ausführt. |
Azure |
Informationen, die zum Herstellen einer Verbindung mit einem Azure Storage-Container mithilfe von Blobfuse verwendet werden. |
Azure |
Informationen, die zum Herstellen einer Verbindung mit einer Azure Fileshare verwendet werden. |
Batch |
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort. |
Batch |
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind. |
Caching |
Der Typ der Zwischenspeicherung, die für den Datenträger aktiviert werden soll. |
Certificate |
Ein Verweis auf ein Zertifikat, das auf Computeknoten in einem Pool installiert werden soll. |
Certificate |
Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in den das Zertifikat installiert werden soll. |
Certificate |
Welche Benutzerkonten auf dem Computeknoten Zugriff auf die privaten Daten des Zertifikats haben sollen. |
CIFSMount |
Informationen, die zum Herstellen einer Verbindung mit einem CIFS-Dateisystem verwendet werden. |
Cloud |
Ein Azure-Batchauftrag. |
Cloud |
Das Ergebnis der Auflistung der Aufträge in einem Konto. |
Compute |
Wie Aufgaben über Computeknoten in einem Pool verteilt werden. |
Compute |
Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet. |
Container |
Die Konfiguration für containerfähige Pools. |
Container |
Der Eintrag des Pfad- und Bereitstellungsmodus, den Sie in Aufgabencontainer bereitstellen möchten. |
Container |
Die Pfade, die im Container der Containeraufgabe bereitgestellt werden. |
Container |
Eine private Containerregistrierung. |
Container |
Die zu verwendende Containertechnologie. |
Container |
Der Speicherort des Arbeitsverzeichnisses für containeraufgaben. |
Data |
Einstellungen, die von den Datenträgern verwendet werden, die Computeknoten im Pool zugeordnet sind. Wenn Sie angefügte Datenträger verwenden, müssen Sie die Datenträger innerhalb einer VM bereitstellen und formatieren, um sie zu verwenden. |
Diff |
Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger für alle Computeknoten (VMs) im Pool an. |
Diff |
Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom Computeknoten (VM) verwendet wird. |
Disk |
Die Auf Computeknoten im Pool angewendete Datenträgerverschlüsselungskonfiguration. Die Datenträgerverschlüsselungskonfiguration wird im Linux-Pool, der mit dem Azure Compute Gallery Image erstellt wurde, nicht unterstützt. |
Disk |
Die Liste der Datenträgerziele für den Batchdienst wird auf dem Computeknoten verschlüsselt. |
Dynamic |
Der Umfang der dynamischen vnet-Zuordnung. |
Elevation |
Die Höhe des Benutzers. |
Environment |
Eine Umgebungsvariable, die für einen Vorgangsprozess festgelegt werden soll. |
Error |
Die Kategorie des Fehlers. |
Error |
Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde. |
Http |
Ein HTTP-Headernamen-Wert-Paar |
Image |
Ein Verweis auf ein Azure Virtual Machines Marketplace Image oder ein Azure Compute Gallery Image. Informationen zum Abrufen der Liste aller azure Marketplace-Imageverweise, die von Azure Batch überprüft wurden, finden Sie im Vorgang "Unterstützte Bilder auflisten". |
Inbound |
Das Protokoll des Endpunkts. |
Inbound |
Ein eingehender NAT-Pool, der verwendet werden kann, um bestimmte Ports auf Computeknoten in einem Batchpool extern zu adressieren. |
IPAddress |
Der Bereitstellungstyp für öffentliche IP-Adressen für den Pool. |
Job |
Die Ausführungseinschränkungen für einen Auftrag. |
Job |
Enthält Informationen zur Ausführung eines Auftrags im Azure Batch-Dienst. |
Job |
Gibt Details einer Auftrags-Manager-Aufgabe an. |
Job |
Die Netzwerkkonfiguration für den Auftrag. |
Job |
Eine Aufgabe zur Auftragsvorbereitung, die vor allen Aufgaben des Auftrags auf einem beliebigen Computeknoten ausgeführt werden soll. |
Job |
Eine Auftragsfreigabeaufgabe, die bei Abschluss des Auftrags auf einem beliebigen Computeknoten ausgeführt werden soll, auf dem der Auftrag ausgeführt wurde. |
Job |
Fehler beim Planen eines Auftrags durch den Batchdienst. |
Job |
Der Status des Auftrags. |
Job |
Ressourcennutzungsstatistiken für einen Auftrag. |
Linux |
Eigenschaften, die zum Erstellen eines Benutzerkontos auf einem Linux-Computeknoten verwendet werden. |
Login |
Der Anmeldemodus für den Benutzer |
Managed |
|
Metadata |
Ein Name-Wert-Paar, das einer Batchdienstressource zugeordnet ist. |
Mount |
Das Dateisystem, das auf jedem Knoten bereitgestellt werden soll. |
Name |
Stellt ein Name-Wert-Paar dar. |
Network |
Die Netzwerkkonfiguration für einen Pool. |
Network |
Eine Netzwerksicherheitsgruppenregel, die auf einen eingehenden Endpunkt angewendet werden soll. |
Network |
Die Aktion, die für eine angegebene IP-Adresse, einen Subnetzbereich oder ein Bestimmtes Tag ausgeführt werden soll. |
NFSMount |
Informationen, die zum Herstellen einer Verbindung mit einem NFS-Dateisystem verwendet werden. |
Node |
Bestimmt, wie ein Pool mit dem Batchdienst kommuniziert. |
Node |
Knotenplatzierungskonfiguration für einen Pool. |
Node |
Die Platzierungsrichtlinie zum Zuordnen von Knoten im Pool. |
On |
Die Aktion, die der Batchdienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden. |
On |
Die Aktion, die der Batchdienst ausführen soll, wenn eine Aufgabe im Auftrag fehlschlägt. |
OSDisk |
Einstellungen für den Betriebssystemdatenträger des Computeknotens (VM). |
Output |
Eine Spezifikation zum Hochladen von Dateien von einem Azure Batch Compute Node an einen anderen Speicherort, nachdem der Batchdienst die Ausführung des Aufgabenvorgangs abgeschlossen hat. |
Output |
Gibt ein Dateiuploadziel in einem Azure Blob Storage-Container an. |
Output |
Das Ziel, in das eine Datei hochgeladen werden soll. |
Output |
Die Bedingungen, unter denen eine Aufgabenausgabedatei oder eine Gruppe von Dateien hochgeladen werden soll. |
Output |
Details zu einem Uploadvorgang einer Ausgabedatei, einschließlich der Bedingungen, unter denen der Upload ausgeführt werden soll. |
Pool |
Die Endpunktkonfiguration für einen Pool. |
Pool |
Gibt an, wie ein Auftrag einem Pool zugewiesen werden soll. |
Pool |
Die mindeste Lebensdauer der erstellten automatischen Pools und wie mehreren Aufträgen in einem Zeitplan Pools zugewiesen werden. |
Pool |
Spezifikation zum Erstellen eines neuen Pools. |
Public |
Die konfiguration der öffentlichen IP-Adresse der Netzwerkkonfiguration eines Pools. |
Resource |
Eine einzelne Datei oder mehrere Dateien, die in einen Computeknoten heruntergeladen werden sollen. |
Rolling |
Die Konfigurationsparameter, die beim Ausführen eines rollierenden Upgrades verwendet werden. |
Security |
Gibt den EncryptionType des verwalteten Datenträgers an. Sie ist für die Verschlüsselung nur des VMGuestState-Blobs auf "VMGuestStateOnly" und "NonPersistedTPM" festgelegt, damit der Firmwarestatus im VMGuestState-Blob nicht beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden und ist bei Verwendung vertraulicher VMs erforderlich. |
Security |
Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers an. |
Security |
Gibt den SecurityType des virtuellen Computers an. Sie muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren. |
Service |
Gibt die Dienstartefaktereferenz-ID an, die zum Festlegen derselben Imageversion für alle virtuellen Computer im Skalierungssatz bei Verwendung der neuesten Imageversion verwendet wird. |
Start |
Eine Aufgabe, die ausgeführt wird, wenn ein Knoten einem Pool im Azure Batch-Dienst beitritt oder wenn der Computeknoten neu gestartet oder umimages erstellt wird. |
Storage |
Der Speicherkontotyp zum Erstellen von Datenträgern oder Betriebssystemdatenträgern. |
Task |
Ausführungseinschränkungen, die auf einen Vorgang angewendet werden sollen. |
Task |
Die Containereinstellungen für eine Aufgabe. |
Task |
Gibt an, wie Aufgaben über Computeknoten verteilt werden sollen. |
Uefi |
Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden. |
Upgrade |
Gibt den Modus eines Upgrades auf virtuelle Computer im Skalierungssatz an. |
Upgrade |
Beschreibt eine Upgraderichtlinie – automatisch, manuell oder rolliert. |
User |
Eigenschaften zum Erstellen eines Benutzers, der zum Ausführen von Aufgaben auf einem Azure Batch Compute Node verwendet wird. |
User |
Die Definition der Benutzeridentität, unter der die Aufgabe ausgeführt wird. |
Virtual |
Die Konfiguration für Computeknoten in einem Pool basierend auf der Azure Virtual Machines-Infrastruktur. |
VMDisk |
Gibt die Sicherheitsprofileinstellungen für den verwalteten Datenträger an. Hinweis: Sie kann nur für vertrauliche virtuelle Computer festgelegt werden und ist bei verwendung vertraulicher VMs erforderlich. |
VMExtension |
Die Konfiguration für Erweiterungen virtueller Computer. |
Windows |
Windows-Betriebssystemeinstellungen, die auf den virtuellen Computer angewendet werden sollen. |
Windows |
Eigenschaften, die zum Erstellen eines Benutzerkontos auf einem Windows-Computeknoten verwendet werden. |
AccessScope
Die Batchressourcen, auf die das Token Zugriff gewährt.
Name | Typ | Beschreibung |
---|---|---|
job |
string |
Gewährt Zugriff auf alle Vorgänge für den Auftrag, der die Aufgabe enthält. |
ApplicationPackageReference
Ein Verweis auf ein Paket, das auf Computeknoten bereitgestellt werden soll.
Name | Typ | Beschreibung |
---|---|---|
applicationId |
string |
Die ID der bereitzustellenden Anwendung. |
version |
string |
Die Version der bereitzustellenden Anwendung. Wenn sie weggelassen wird, wird die Standardversion bereitgestellt. |
AuthenticationTokenSettings
Die Einstellungen für ein Authentifizierungstoken, das von der Aufgabe zum Ausführen von Batchdienstvorgängen verwendet werden kann.
Name | Typ | Beschreibung |
---|---|---|
access |
Die Batchressourcen, auf die das Token Zugriff gewährt. |
AutomaticOSUpgradePolicy
Die Konfigurationsparameter, die zum Ausführen eines automatischen Betriebssystemupgrades verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
disableAutomaticRollback |
boolean |
Gibt an, ob das Rollbackfeature des Betriebssystemimages deaktiviert werden soll. |
enableAutomaticOSUpgrade |
boolean |
Gibt an, ob Betriebssystemupgrades automatisch auf Skalierungssatzinstanzen angewendet werden sollen, wenn eine neuere Version des Betriebssystemimages verfügbar wird. |
osRollingUpgradeDeferral |
boolean |
Verzögern Sie Betriebssystemupgrades auf tvMs, wenn sie Aufgaben ausführen. |
useRollingUpgradePolicy |
boolean |
Gibt an, ob die Rollupgraderichtlinie während des Automatischen Betriebssystemupgrades verwendet werden soll. Das automatische Betriebssystemupgrade wird auf die Standardrichtlinie zurückfallen, wenn keine Richtlinie für vmSS definiert ist. |
AutoPoolSpecification
Gibt Merkmale für einen temporären "automatischen Pool" an. Der Batchdienst erstellt diesen automatischen Pool, wenn der Auftrag übermittelt wird.
Name | Typ | Beschreibung |
---|---|---|
autoPoolIdPrefix |
string |
Ein Präfix, das dem eindeutigen Bezeichner hinzugefügt werden soll, wenn automatisch ein Pool erstellt wird. |
keepAlive |
boolean |
Gibt an, ob ein automatischer Pool nach Ablauf der Lebensdauer aktiv bleibt. |
pool |
Die Poolspezifikation für den automatischen Pool. |
|
poolLifetimeOption |
Die mindeste Lebensdauer der erstellten automatischen Pools und wie mehreren Aufträgen in einem Zeitplan Pools zugewiesen werden. |
AutoUserScope
Der Bereich für den automatischen Benutzer
Name | Typ | Beschreibung |
---|---|---|
pool |
string |
Gibt an, dass die Aufgabe als allgemeines automatisches Benutzerkonto ausgeführt wird, das auf jedem Computeknoten in einem Pool erstellt wird. |
task |
string |
Gibt an, dass der Dienst einen neuen Benutzer für die Aufgabe erstellen soll. |
AutoUserSpecification
Gibt die Parameter für den automatischen Benutzer an, der eine Aufgabe im Batchdienst ausführt.
Name | Typ | Beschreibung |
---|---|---|
elevationLevel |
Die Höhenstufe des automatischen Benutzers. |
|
scope |
Der Bereich für den automatischen Benutzer |
AzureBlobFileSystemConfiguration
Informationen, die zum Herstellen einer Verbindung mit einem Azure Storage-Container mithilfe von Blobfuse verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
accountKey |
string |
Der Azure Storage-Kontoschlüssel. |
accountName |
string |
Der Name des Azure Storage-Kontos. |
blobfuseOptions |
string |
Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen. |
containerName |
string |
Der Name des Azure Blob Storage-Containers. |
identityReference |
Der Verweis auf die vom Benutzer zugewiesene Identität für den Zugriff auf containerName |
|
relativeMountPath |
string |
Der relative Pfad auf dem Computeknoten, in dem das Dateisystem bereitgestellt wird |
sasKey |
string |
Das Azure Storage SAS-Token. |
AzureFileShareConfiguration
Informationen, die zum Herstellen einer Verbindung mit einer Azure Fileshare verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
accountKey |
string |
Der Azure Storage-Kontoschlüssel. |
accountName |
string |
Der Name des Azure Storage-Kontos. |
azureFileUrl |
string |
Die Azure Files-URL. |
mountOptions |
string |
Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen. |
relativeMountPath |
string |
Der relative Pfad auf dem Computeknoten, in dem das Dateisystem bereitgestellt wird |
BatchError
Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden. |
message |
Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist. |
|
values |
Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten. |
BatchErrorDetail
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt. |
value |
string |
Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind. |
CachingType
Der Typ der Zwischenspeicherung, die für den Datenträger aktiviert werden soll.
Name | Typ | Beschreibung |
---|---|---|
none |
string |
Der Cachemodus für den Datenträger ist nicht aktiviert. |
readonly |
string |
Der Cachemodus für den Datenträger ist schreibgeschützt. |
readwrite |
string |
Der Cachemodus für den Datenträger ist lese- und schreibgeschützt. |
CertificateReference
Ein Verweis auf ein Zertifikat, das auf Computeknoten in einem Pool installiert werden soll.
Name | Typ | Beschreibung |
---|---|---|
storeLocation |
Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in den das Zertifikat installiert werden soll. |
|
storeName |
string |
Der Name des Zertifikatspeichers auf dem Computeknoten, in den das Zertifikat installiert werden soll. |
thumbprint |
string |
Der Fingerabdruck des Zertifikats. |
thumbprintAlgorithm |
string |
Der Algorithmus, dem der Fingerabdruck zugeordnet ist. Dies muss sha1 sein. |
visibility |
Welche Benutzerkonten auf dem Computeknoten Zugriff auf die privaten Daten des Zertifikats haben sollen. |
CertificateStoreLocation
Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in den das Zertifikat installiert werden soll.
Name | Typ | Beschreibung |
---|---|---|
currentuser |
string |
Zertifikate sollten im CurrentUser-Zertifikatspeicher installiert werden. |
localmachine |
string |
Zertifikate sollten im LocalMachine-Zertifikatspeicher installiert werden. |
CertificateVisibility
Welche Benutzerkonten auf dem Computeknoten Zugriff auf die privaten Daten des Zertifikats haben sollen.
Name | Typ | Beschreibung |
---|---|---|
remoteuser |
string |
Das Zertifikat sollte für die Benutzerkonten sichtbar sein, unter denen Benutzer remote auf den Computeknoten zugreifen. |
starttask |
string |
Das Zertifikat sollte für das Benutzerkonto sichtbar sein, unter dem startTask ausgeführt wird. Beachten Sie, dass dieses Zertifikat auch für die Aufgabe sichtbar ist, wenn der Bereich "AutoUser" sowohl für den StartTask als auch für einen Vorgang vorhanden ist. |
task |
string |
Das Zertifikat sollte für die Benutzerkonten sichtbar sein, unter denen Auftragsaufgaben ausgeführt werden. |
CIFSMountConfiguration
Informationen, die zum Herstellen einer Verbindung mit einem CIFS-Dateisystem verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
mountOptions |
string |
Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen. |
password |
string |
Das Kennwort, das für die Authentifizierung im CIFS-Dateisystem verwendet werden soll. |
relativeMountPath |
string |
Der relative Pfad auf dem Computeknoten, in dem das Dateisystem bereitgestellt wird |
source |
string |
Der URI des zu mountden Dateisystems. |
username |
string |
Der Benutzer, der für die Authentifizierung gegen das CIFS-Dateisystem verwendet werden soll. |
CloudJob
Ein Azure-Batchauftrag.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
allowTaskPreemption |
boolean |
Ob Aufgaben in diesem Auftrag von anderen Aufträgen mit hoher Priorität vorgebeutet werden können |
|
commonEnvironmentSettings |
Die Liste der allgemeinen Umgebungsvariableneinstellungen. Diese Umgebungsvariablen werden für alle Aufgaben im Auftrag festgelegt (einschließlich job manager, Job Preparation and Job Release Tasks). |
||
constraints |
Die Ausführungseinschränkungen für den Auftrag. |
||
creationTime |
string |
Die Erstellungszeit des Auftrags. |
|
displayName |
string |
Der Anzeigename für den Auftrag. |
|
eTag |
string |
Das ETag des Auftrags. |
|
executionInfo |
Die Ausführungsinformationen für den Auftrag. |
||
id |
string |
Eine Zeichenfolge, die den Auftrag innerhalb des Kontos eindeutig identifiziert. |
|
jobManagerTask |
Details zu einer Job Manager-Aufgabe, die gestartet werden soll, wenn der Auftrag gestartet wird. |
||
jobPreparationTask |
Der Vorgang zur Auftragsvorbereitung. |
||
jobReleaseTask |
Die Aufgabe "Auftragsfreigabe". |
||
lastModified |
string |
Der Zeitpunkt der letzten Änderung des Auftrags. |
|
maxParallelTasks |
integer |
-1 |
Die maximale Anzahl von Vorgängen, die parallel für den Auftrag ausgeführt werden können. |
metadata |
Eine Liste von Name-Wert-Paaren, die dem Auftrag als Metadaten zugeordnet sind. |
||
networkConfiguration |
Die Netzwerkkonfiguration für den Auftrag. |
||
onAllTasksComplete |
Die Aktion, die der Batchdienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden. |
||
onTaskFailure |
Die Aktion, die der Batchdienst ausführen soll, wenn eine Aufgabe im Auftrag fehlschlägt. |
||
poolInfo |
Die Pooleinstellungen, die dem Auftrag zugeordnet sind. |
||
previousState |
Der vorherige Status des Auftrags. |
||
previousStateTransitionTime |
string |
Die Zeit, zu der der Auftrag seinen vorherigen Zustand eingegeben hat. |
|
priority |
integer |
Die Priorität des Auftrags. |
|
state |
Der aktuelle Status des Auftrags. |
||
stateTransitionTime |
string |
Die Zeit, zu der der Auftrag seinen aktuellen Zustand eingegeben hat. |
|
stats |
Ressourcennutzungsstatistiken für die gesamte Lebensdauer des Auftrags. |
||
url |
string |
Die URL des Auftrags. |
|
usesTaskDependencies |
boolean |
Gibt an, ob Aufgaben im Auftrag Abhängigkeiten voneinander definieren können. Der Standardwert ist FALSE. |
CloudJobListResult
Das Ergebnis der Auflistung der Aufträge in einem Konto.
Name | Typ | Beschreibung |
---|---|---|
odata.nextLink |
string |
Die URL, um den nächsten Satz von Ergebnissen abzurufen. |
value |
Cloud |
Die Liste der Aufträge. |
ComputeNodeFillType
Wie Aufgaben über Computeknoten in einem Pool verteilt werden.
Name | Typ | Beschreibung |
---|---|---|
pack |
string |
So viele Aufgaben wie möglich (taskSlotsPerNode) sollten jedem Computeknoten im Pool zugewiesen werden, bevor vorgänge dem nächsten Computeknoten im Pool zugewiesen werden. |
spread |
string |
Vorgänge sollten gleichmäßig auf allen Computeknoten im Pool zugewiesen werden. |
ComputeNodeIdentityReference
Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.
Name | Typ | Beschreibung |
---|---|---|
resourceId |
string |
Die ARM-Ressourcen-ID der vom Benutzer zugewiesenen Identität. |
ContainerConfiguration
Die Konfiguration für containerfähige Pools.
Name | Typ | Beschreibung |
---|---|---|
containerImageNames |
string[] |
Die Auflistung der Containerimagenamen. |
containerRegistries |
Zusätzliche private Register, aus denen Container abgerufen werden können. |
|
type |
Die zu verwendende Containertechnologie. |
ContainerHostBatchBindMountEntry
Der Eintrag des Pfad- und Bereitstellungsmodus, den Sie in Aufgabencontainer bereitstellen möchten.
Name | Typ | Beschreibung |
---|---|---|
isReadOnly |
boolean |
Stellen Sie diesen Quellpfad als schreibgeschützten Modus ein oder nicht. Der Standardwert ist false (Lese-/Schreibmodus). |
source |
Der Pfad, der für containerkunden bereitgestellt werden kann. |
ContainerHostDataPath
Die Pfade, die im Container der Containeraufgabe bereitgestellt werden.
Name | Typ | Beschreibung |
---|---|---|
Applications |
string |
Der Anwendungspfad. |
JobPrep |
string |
Der Auftragsvorstellungsvorgangspfad. |
Shared |
string |
Der Pfad für die Aufgabe mit mehreren Instanzen, um ihre Dateien freigegeben zu haben. |
Startup |
string |
Der Pfad für die Startaufgabe. |
Task |
string |
Der Vorgangspfad. |
VfsMounts |
string |
Der Pfad enthält alle virtuellen Dateisysteme, die auf diesem Knoten bereitgestellt werden. |
ContainerRegistry
Eine private Containerregistrierung.
Name | Typ | Beschreibung |
---|---|---|
identityReference |
Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf eine Azure-Containerregistrierung anstelle von Benutzername und Kennwort verwendet werden soll. |
|
password |
string |
Das Kennwort für die Anmeldung beim Registrierungsserver. |
registryServer |
string |
Die Registrierungs-URL. |
username |
string |
Der Benutzername, der sich beim Registrierungsserver anmeldet. |
ContainerType
Die zu verwendende Containertechnologie.
Name | Typ | Beschreibung |
---|---|---|
criCompatible |
string |
Eine CRI-basierte Technologie wird verwendet, um die Container zu starten. |
dockerCompatible |
string |
Eine Docker-kompatible Containertechnologie wird verwendet, um die Container zu starten. |
ContainerWorkingDirectory
Der Speicherort des Arbeitsverzeichnisses für containeraufgaben.
Name | Typ | Beschreibung |
---|---|---|
containerImageDefault |
string |
Verwenden Sie das im Containerimage definierte Arbeitsverzeichnis. Achten Sie darauf, dass dieses Verzeichnis die von Batch heruntergeladenen Ressourcendateien nicht enthält. |
taskWorkingDirectory |
string |
Verwenden Sie das standardmäßige Arbeitsverzeichnis "Batchdienstaufgaben", das die Vorgangsressourcendateien enthält, die von Batch aufgefüllt werden. |
DataDisk
Einstellungen, die von den Datenträgern verwendet werden, die Computeknoten im Pool zugeordnet sind. Wenn Sie angefügte Datenträger verwenden, müssen Sie die Datenträger innerhalb einer VM bereitstellen und formatieren, um sie zu verwenden.
Name | Typ | Beschreibung |
---|---|---|
caching |
Der Typ der Zwischenspeicherung, die für die Datenträger aktiviert werden soll. |
|
diskSizeGB |
integer |
Die anfängliche Datenträgergröße in Gigabyte. |
lun |
integer |
Die wahrheitslogische Einheitsnummer. |
storageAccountType |
Der Speicherkontotyp, der für den Datenträger verwendet werden soll. |
DiffDiskPlacement
Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger für alle Computeknoten (VMs) im Pool an.
Name | Typ | Beschreibung |
---|---|---|
CacheDisk |
string |
Der ephemerale Betriebssystemdatenträger wird im VM-Cache gespeichert. |
DiffDiskSettings
Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom Computeknoten (VM) verwendet wird.
Name | Typ | Beschreibung |
---|---|---|
placement |
Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger für alle virtuellen Computer im Pool an. |
DiskEncryptionConfiguration
Die Auf Computeknoten im Pool angewendete Datenträgerverschlüsselungskonfiguration. Die Datenträgerverschlüsselungskonfiguration wird im Linux-Pool, der mit dem Azure Compute Gallery Image erstellt wurde, nicht unterstützt.
Name | Typ | Beschreibung |
---|---|---|
targets |
Die Liste der Datenträgerziele für den Batchdienst wird auf dem Computeknoten verschlüsselt. |
DiskEncryptionTarget
Die Liste der Datenträgerziele für den Batchdienst wird auf dem Computeknoten verschlüsselt.
Name | Typ | Beschreibung |
---|---|---|
osdisk |
string |
Der Betriebssystemdatenträger auf dem Computeknoten ist verschlüsselt. |
temporarydisk |
string |
Der temporäre Datenträger auf dem Computeknoten ist verschlüsselt. Unter Linux gilt diese Verschlüsselung für andere Partitionen (z. B. auf bereitgestellten Datenträgern), wenn die Verschlüsselung zur Startzeit auftritt. |
DynamicVNetAssignmentScope
Der Umfang der dynamischen vnet-Zuordnung.
Name | Typ | Beschreibung |
---|---|---|
job |
string |
Die dynamische VNet-Zuordnung erfolgt pro Auftrag. |
none |
string |
Es ist keine dynamische VNet-Zuweisung aktiviert. |
ElevationLevel
Die Höhe des Benutzers.
Name | Typ | Beschreibung |
---|---|---|
admin |
string |
Der Benutzer ist ein Benutzer mit erhöhtem Zugriff und arbeitet mit vollständigen Administratorberechtigungen. |
nonadmin |
string |
Der Benutzer ist ein Standardbenutzer ohne erhöhten Zugriff. |
EnvironmentSetting
Eine Umgebungsvariable, die für einen Vorgangsprozess festgelegt werden soll.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name der Umgebungsvariable. |
value |
string |
Der Wert der Umgebungsvariable. |
ErrorCategory
Die Kategorie des Fehlers.
Name | Typ | Beschreibung |
---|---|---|
servererror |
string |
Der Fehler ist auf ein internes Serverproblem zurückzuführen. |
usererror |
string |
Der Fehler ist auf ein Benutzerproblem zurückzuführen, z. B. eine Fehlkonfiguration. |
ErrorMessage
Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
Name | Typ | Beschreibung |
---|---|---|
lang |
string |
Der Sprachcode der Fehlermeldung |
value |
string |
Der Text der Nachricht. |
HttpHeader
Ein HTTP-Headernamen-Wert-Paar
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name der Kopfzeile, die beim Hochladen von Ausgabedateien verwendet werden soll, wobei die Groß-/Kleinschreibung nicht beachtet wird. |
value |
string |
Der Wert des Headers, der beim Hochladen von Ausgabedateien verwendet werden soll |
ImageReference
Ein Verweis auf ein Azure Virtual Machines Marketplace Image oder ein Azure Compute Gallery Image. Informationen zum Abrufen der Liste aller azure Marketplace-Imageverweise, die von Azure Batch überprüft wurden, finden Sie im Vorgang "Unterstützte Bilder auflisten".
Name | Typ | Beschreibung |
---|---|---|
communityGalleryImageId |
string |
Eindeutiger Bezeichner des Communitykatalogbilds |
exactVersion |
string |
Die spezifische Version des Plattformimages oder Marketplace-Images, das zum Erstellen des Knotens verwendet wird. Dieses schreibgeschützte Feld unterscheidet sich nur dann von "Version", wenn der für "Version" angegebene Wert beim Erstellen des Pools "latest" lautet. |
offer |
string |
Der Angebotstyp des Azure Virtual Machines Marketplace-Images. |
publisher |
string |
Der Herausgeber des Azure Virtual Machines Marketplace-Images. |
sharedGalleryImageId |
string |
Eindeutiger Bezeichner des freigegebenen Katalogbilds |
sku |
string |
Die SKU des Azure Virtual Machines Marketplace-Images. |
version |
string |
Die Version des Azure Virtual Machines Marketplace-Images. |
virtualMachineImageId |
string |
Der ARM-Ressourcenbezeichner des Azure Compute Gallery Image. Computeknoten im Pool werden mithilfe dieser Image-ID erstellt. Dies ist das Formular /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} oder /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} für immer die neueste Bildversion. |
InboundEndpointProtocol
Das Protokoll des Endpunkts.
Name | Typ | Beschreibung |
---|---|---|
tcp |
string |
Verwenden Sie TCP für den Endpunkt. |
udp |
string |
Verwenden Sie UDP für den Endpunkt. |
InboundNATPool
Ein eingehender NAT-Pool, der verwendet werden kann, um bestimmte Ports auf Computeknoten in einem Batchpool extern zu adressieren.
Name | Typ | Beschreibung |
---|---|---|
backendPort |
integer |
Die Portnummer auf dem Computeknoten. |
frontendPortRangeEnd |
integer |
Die letzte Portnummer im Bereich externer Ports, die verwendet werden, um eingehenden Zugriff auf den Back-EndPort auf einzelnen Computeknoten bereitzustellen. |
frontendPortRangeStart |
integer |
Die erste Portnummer im Bereich externer Ports, die verwendet werden, um eingehenden Zugriff auf den Back-EndPort auf einzelnen Computeknoten bereitzustellen. |
name |
string |
Der Name des Endpunkts. |
networkSecurityGroupRules |
Eine Liste der Regeln für Netzwerksicherheitsgruppen, die auf den Endpunkt angewendet werden. |
|
protocol |
Das Protokoll des Endpunkts. |
IPAddressProvisioningType
Der Bereitstellungstyp für öffentliche IP-Adressen für den Pool.
Name | Typ | Beschreibung |
---|---|---|
batchmanaged |
string |
Eine öffentliche IP wird von Batch erstellt und verwaltet. Je nach Größe des Pools können mehrere öffentliche IPs vorhanden sein. |
nopublicipaddresses |
string |
Es wird keine öffentliche IP-Adresse erstellt. |
usermanaged |
string |
Öffentliche IPs werden vom Benutzer bereitgestellt und zum Bereitstellen der Computeknoten verwendet. |
JobConstraints
Die Ausführungseinschränkungen für einen Auftrag.
Name | Typ | Beschreibung |
---|---|---|
maxTaskRetryCount |
integer |
Die maximale Anzahl von Wiederholungsversuchen für jeden Vorgang. Der Batchdienst ruft eine Aufgabe erneut auf, wenn der Beendigungscode nicht null ist. |
maxWallClockTime |
string |
Die maximale verstrichene Zeit, die der Auftrag ausführen kann, gemessen vom Zeitpunkt der Erstellung des Auftrags. |
JobExecutionInformation
Enthält Informationen zur Ausführung eines Auftrags im Azure Batch-Dienst.
Name | Typ | Beschreibung |
---|---|---|
endTime |
string |
Die Fertigstellungszeit des Auftrags. |
poolId |
string |
Die ID des Pools, dem dieser Auftrag zugewiesen ist. |
schedulingError |
Details zu einem Fehler, der vom Dienst beim Starten des Auftrags aufgetreten ist. |
|
startTime |
string |
Die Startzeit des Auftrags. |
terminateReason |
string |
Eine Zeichenfolge, die den Grund beschreibt, warum der Auftrag beendet wurde. |
JobManagerTask
Gibt Details einer Auftrags-Manager-Aufgabe an.
Name | Typ | Beschreibung |
---|---|---|
allowLowPriorityNode |
boolean |
Gibt an, ob die Auftrags-Manager-Aufgabe auf einem Computeknoten mit niedriger Priorität ausgeführt werden kann. |
applicationPackageReferences |
Eine Liste der Anwendungspakete, die der Batchdienst vor dem Ausführen der Befehlszeile auf dem Computeknoten bereitstellen wird. |
|
authenticationTokenSettings |
Die Einstellungen für ein Authentifizierungstoken, das von der Aufgabe zum Ausführen von Batchdienstvorgängen verwendet werden kann. |
|
commandLine |
string |
Die Befehlszeile der Auftrags-Manager-Aufgabe. |
constraints |
Einschränkungen, die für den Auftrags-Manager-Vorgang gelten. |
|
containerSettings |
Die Einstellungen für den Container, unter dem die Auftrags-Manager-Aufgabe ausgeführt wird. |
|
displayName |
string |
Der Anzeigename der Auftrags-Manager-Aufgabe. |
environmentSettings |
Eine Liste der Umgebungsvariableneinstellungen für die Auftrags-Manager-Aufgabe. |
|
id |
string |
Eine Zeichenfolge, die die Auftrags-Manager-Aufgabe innerhalb des Auftrags eindeutig identifiziert. |
killJobOnCompletion |
boolean |
Gibt an, ob der Abschluss der Auftrags-Manager-Aufgabe den Abschluss des gesamten Auftrags bedeutet. |
outputFiles |
Eine Liste der Dateien, die der Batchdienst nach dem Ausführen der Befehlszeile vom Computeknoten hochladen wird. |
|
requiredSlots |
integer |
Die Anzahl der Zeitplanungsplätze, die der Vorgang ausführen muss. |
resourceFiles |
Eine Liste der Dateien, die der Batchdienst vor dem Ausführen der Befehlszeile auf den Computeknoten herunterladen wird. |
|
runExclusive |
boolean |
Gibt an, ob für die Auftrags-Manager-Aufgabe die exklusive Verwendung des Computeknotens erforderlich ist, in dem er ausgeführt wird. |
userIdentity |
Die Benutzeridentität, unter der die Auftrags-Manager-Aufgabe ausgeführt wird. |
JobNetworkConfiguration
Die Netzwerkkonfiguration für den Auftrag.
Name | Typ | Beschreibung |
---|---|---|
skipWithdrawFromVNet |
boolean |
Gibt an, ob Computeknoten vom virtuellen Netzwerk an DNC zurückgenommen werden sollen, wenn der Auftrag beendet oder gelöscht wird. |
subnetId |
string |
Der ARM-Ressourcenbezeichner des virtuellen Netzwerksubnetz, in dem Computerknoten ausgeführt werden, die Vorgänge aus dem Auftrag ausführen, werden für die Dauer des Vorgangs verknüpft. |
JobPreparationTask
Eine Aufgabe zur Auftragsvorbereitung, die vor allen Aufgaben des Auftrags auf einem beliebigen Computeknoten ausgeführt werden soll.
Name | Typ | Beschreibung |
---|---|---|
commandLine |
string |
Die Befehlszeile des Auftragsvorbereitungsvorgangs. |
constraints |
Einschränkungen, die für den Auftragsvorbereitungsvorgang gelten. |
|
containerSettings |
Die Einstellungen für den Container, unter dem die Auftragsvorbereitungsaufgabe ausgeführt wird. |
|
environmentSettings |
Eine Liste der Umgebungsvariableneinstellungen für den Auftragsvorbereitungsvorgang. |
|
id |
string |
Eine Zeichenfolge, die den Auftragsvorbereitungsvorgang innerhalb des Auftrags eindeutig identifiziert. |
rerunOnNodeRebootAfterSuccess |
boolean |
Gibt an, ob der Batchdienst die Auftragsvorbereitungsaufgabe nach einem Neustart des Computeknotens erneut ausführen soll. |
resourceFiles |
Eine Liste der Dateien, die der Batchdienst vor dem Ausführen der Befehlszeile auf den Computeknoten herunterladen wird. |
|
userIdentity |
Die Benutzeridentität, unter der die Auftragsvorbereitungsaufgabe ausgeführt wird. |
|
waitForSuccess |
boolean |
Gibt an, ob der Batchdienst auf den Erfolgreichen Abschluss des Auftragsvorbereitungsvorgangs warten soll, bevor andere Aufgaben des Auftrags auf dem Computeknoten geplant werden. Eine Auftragsvorbereitungsaufgabe wurde erfolgreich abgeschlossen, wenn sie mit dem Beendigungscode 0 beendet wird. |
JobReleaseTask
Eine Auftragsfreigabeaufgabe, die bei Abschluss des Auftrags auf einem beliebigen Computeknoten ausgeführt werden soll, auf dem der Auftrag ausgeführt wurde.
Name | Typ | Beschreibung |
---|---|---|
commandLine |
string |
Die Befehlszeile der Auftragsfreigabeaufgabe. |
containerSettings |
Die Einstellungen für den Container, unter dem die Auftragsfreigabeaufgabe ausgeführt wird. |
|
environmentSettings |
Eine Liste der Umgebungsvariableneinstellungen für die Auftragsfreigabeaufgabe. |
|
id |
string |
Eine Zeichenfolge, die die Auftragsfreigabeaufgabe innerhalb des Auftrags eindeutig identifiziert. |
maxWallClockTime |
string |
Die maximale verstrichene Zeit, die die Auftragsfreigabeaufgabe auf einem bestimmten Computeknoten ausgeführt werden kann, gemessen von dem Zeitpunkt, zu dem die Aufgabe gestartet wird. Wenn der Vorgang nicht innerhalb des Zeitlimits abgeschlossen wird, beendet der Batchdienst ihn. Der Standardwert beträgt 15 Minuten. Sie können kein Timeout angeben, das länger als 15 Minuten ist. Wenn Sie dies tun, lehnt der Batchdienst ihn 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 Batchdienst vor dem Ausführen der Befehlszeile auf den Computeknoten herunterladen wird. Es gibt eine maximale Größe für die Liste der Ressourcendateien. Wenn die maximale Größe überschritten wird, schlägt die Anforderung fehl, und der Antwortfehlercode lautet "RequestEntityTooLarge". Wenn dies der Fall ist, muss die Sammlung von ResourceFiles in der Größe reduziert werden. Dies kann mithilfe von .zip Dateien, Anwendungspaketen oder Docker-Containern erreicht werden. |
|
retentionTime |
string |
Die mindeste Zeit, um das Aufgabenverzeichnis für die Auftragsfreigabeaufgabe auf dem Computeknoten beizubehalten. Nach diesem Zeitpunkt kann der Batchdienst das Aufgabenverzeichnis und alle zugehörigen Inhalte löschen. |
userIdentity |
Die Benutzeridentität, unter der die Auftragsfreigabeaufgabe ausgeführt wird. |
JobSchedulingError
Fehler beim Planen eines Auftrags durch den Batchdienst.
Name | Typ | Beschreibung |
---|---|---|
category |
Die Kategorie des Auftragsplanungsfehlers. |
|
code |
string |
Ein Bezeichner für den Auftragsplanungsfehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden. |
details |
Eine Liste mit zusätzlichen Fehlerdetails im Zusammenhang mit dem Terminplanungsfehler. |
|
message |
string |
Eine Meldung, die den Auftragsplanungsfehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist. |
JobState
Der Status des Auftrags.
Name | Typ | Beschreibung |
---|---|---|
active |
string |
Der Auftrag ist verfügbar, damit Vorgänge geplant sind. |
completed |
string |
Alle Aufgaben wurden beendet, und das System akzeptiert keine weiteren Aufgaben oder weitere Änderungen am Auftrag. |
deleting |
string |
Ein Benutzer hat angefordert, dass der Auftrag gelöscht wird, der Löschvorgang wird jedoch noch ausgeführt (z. B. weil das System die Ausführung von Aufgaben noch beendet). |
disabled |
string |
Ein Benutzer hat den Auftrag deaktiviert. Es werden keine Aufgaben ausgeführt, und es werden keine neuen Vorgänge geplant. |
disabling |
string |
Ein Benutzer hat angefordert, dass der Auftrag deaktiviert ist, aber der Deaktivierungsvorgang wird noch ausgeführt (z. B. warten, bis Aufgaben beendet werden). |
enabling |
string |
Ein Benutzer hat angefordert, dass der Auftrag aktiviert ist, aber der Aktivierungsvorgang wird noch ausgeführt. |
terminating |
string |
Der Auftrag wird abgeschlossen, entweder weil eine Auftrags-Manager-Aufgabe abgeschlossen wurde oder weil der Benutzer den Auftrag beendet hat, aber der Beendigungsvorgang noch ausgeführt wird (z. B. weil Job Release Tasks ausgeführt werden). |
JobStatistics
Ressourcennutzungsstatistiken für einen Auftrag.
Name | Typ | Beschreibung |
---|---|---|
kernelCPUTime |
string |
Die cpu-Gesamtzeit des Kernelmodus (summiert über alle Kerne und alle Computeknoten), die von allen Aufgaben im Auftrag verbraucht werden. |
lastUpdateTime |
string |
Die Uhrzeit, zu der die Statistiken zuletzt aktualisiert wurden. Alle Statistiken sind auf den Bereich zwischen startTime und lastUpdateTime beschränkt. |
numFailedTasks |
integer |
Die Gesamtzahl der Vorgänge im Auftrag, die während des angegebenen Zeitraums fehlgeschlagen sind. |
numSucceededTasks |
integer |
Die Gesamtzahl der Aufgaben, die im Auftrag während des angegebenen Zeitraums erfolgreich abgeschlossen wurden. |
numTaskRetries |
integer |
Die Gesamtzahl der Wiederholungen für alle Vorgänge im Auftrag während des angegebenen Zeitraums. |
readIOGiB |
number |
Die Gesamtmenge der Daten in GiB, die von einem Datenträger von allen Aufgaben im Auftrag gelesen werden. |
readIOps |
integer |
Die Gesamtzahl der Datenträgerlesevorgänge, die von allen Vorgängen im Auftrag vorgenommen wurden. |
startTime |
string |
Die Startzeit des zeitraums, der von den Statistiken abgedeckt wird. |
url |
string |
Die URL der Statistik. |
userCPUTime |
string |
Die cpu-Gesamtzeit des Benutzermodus (summiert über alle Kerne und alle Computeknoten), die von allen Aufgaben im Auftrag verbraucht werden. |
waitTime |
string |
Die Gesamtwartezeit aller Vorgänge im Auftrag. |
wallClockTime |
string |
Die Gesamtwanduhrzeit aller Vorgänge im Auftrag. |
writeIOGiB |
number |
Die Gesamtmenge der Daten in GiB, die von allen Aufgaben im Auftrag auf den Datenträger geschrieben wurden. |
writeIOps |
integer |
Die Gesamtanzahl der Datenträgerschreibvorgänge, die von allen Vorgängen im Auftrag vorgenommen wurden. |
LinuxUserConfiguration
Eigenschaften, die zum Erstellen eines Benutzerkontos auf einem Linux-Computeknoten verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
gid |
integer |
Die Gruppen-ID für das Benutzerkonto. |
sshPrivateKey |
string |
Der private SSH-Schlüssel für das Benutzerkonto. |
uid |
integer |
Die Benutzer-ID des Benutzerkontos. |
LoginMode
Der Anmeldemodus für den Benutzer
Name | Typ | Beschreibung |
---|---|---|
batch |
string |
Der LOGON32_LOGON_BATCH Win32-Anmeldemodus. Der Batchanmeldungsmodus wird für lange ausgeführte parallele Prozesse empfohlen. |
interactive |
string |
Der LOGON32_LOGON_INTERACTIVE Win32-Anmeldemodus. UAC ist für Windows-Pools aktiviert. Wenn diese Option mit einer erhöhten Benutzeridentität in einem Windows-Pool verwendet wird, wird die Benutzersitzung nicht erhöht, es sei denn, die Anwendung, die von der Befehlszeile "Aufgabe" ausgeführt wird, ist so konfiguriert, dass immer Administratorrechte erforderlich sind oder immer maximale Berechtigungen erforderlich sind. |
ManagedDisk
Name | Typ | Beschreibung |
---|---|---|
securityProfile |
Gibt die Sicherheitsprofileinstellungen für den verwalteten Datenträger an. |
|
storageAccountType |
Der Speicherkontotyp für verwaltete Datenträger. |
MetadataItem
Ein Name-Wert-Paar, das einer Batchdienstressource zugeordnet ist.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name des Metadatenelements. |
value |
string |
Der Wert des Metadatenelements. |
MountConfiguration
Das Dateisystem, das auf jedem Knoten bereitgestellt werden soll.
Name | Typ | Beschreibung |
---|---|---|
azureBlobFileSystemConfiguration |
Der Azure Storage-Container, der mithilfe von BLOB-FUSE auf jedem Knoten bereitgestellt werden soll. |
|
azureFileShareConfiguration |
Die Azure-Dateifreigabe, die auf jedem Knoten bereitgestellt werden soll. |
|
cifsMountConfiguration |
Das CIFS/SMB-Dateisystem, das auf jedem Knoten bereitgestellt werden soll. |
|
nfsMountConfiguration |
Das NFS-Dateisystem, das auf jedem Knoten bereitgestellt werden soll. |
NameValuePair
Stellt ein Name-Wert-Paar dar.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name im Name-Wert-Paar. |
value |
string |
Der Wert im Name-Wert-Paar. |
NetworkConfiguration
Die Netzwerkkonfiguration für einen Pool.
Name | Typ | Beschreibung |
---|---|---|
dynamicVNetAssignmentScope |
Der Umfang der dynamischen vnet-Zuordnung. |
|
enableAcceleratedNetworking |
boolean |
Gibt an, ob dieser Pool beschleunigte Netzwerke aktivieren soll. |
endpointConfiguration |
Die Konfiguration für Endpunkte auf Computeknoten im Batchpool. |
|
publicIPAddressConfiguration |
Die Öffentliche IPAddress-Konfiguration für Computeknoten im Batchpool. |
|
subnetId |
string |
Der ARM-Ressourcenbezeichner des virtuellen Netzwerksubnetz, dem die Computeknoten des Pools beitreten. Dies ist das Format "/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}". |
NetworkSecurityGroupRule
Eine Netzwerksicherheitsgruppenregel, die auf einen eingehenden Endpunkt angewendet werden soll.
Name | Typ | Beschreibung |
---|---|---|
access |
Die Aktion, die für eine angegebene IP-Adresse, einen Subnetzbereich oder ein Bestimmtes Tag ausgeführt werden soll. |
|
priority |
integer |
Die Priorität für diese Regel. |
sourceAddressPrefix |
string |
Das Quelladressenpräfix oder -tag, das für die Regel übereinstimmen soll. |
sourcePortRanges |
string[] |
Die Quellportbereiche, die für die Regel übereinstimmen sollen. |
NetworkSecurityGroupRuleAccess
Die Aktion, die für eine angegebene IP-Adresse, einen Subnetzbereich oder ein Bestimmtes Tag ausgeführt werden soll.
Name | Typ | Beschreibung |
---|---|---|
allow |
string |
Zugriff zulassen. |
deny |
string |
Zugriff verweigern. |
NFSMountConfiguration
Informationen, die zum Herstellen einer Verbindung mit einem NFS-Dateisystem verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
mountOptions |
string |
Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen. |
relativeMountPath |
string |
Der relative Pfad auf dem Computeknoten, in dem das Dateisystem bereitgestellt wird |
source |
string |
Der URI des zu mountden Dateisystems. |
NodeCommunicationMode
Bestimmt, wie ein Pool mit dem Batchdienst kommuniziert.
Name | Typ | Beschreibung |
---|---|---|
classic |
string |
Knoten, die den klassischen Kommunikationsmodus verwenden, erfordern eingehende TCP-Kommunikation an den Ports 29876 und 29877 aus dem "BatchNodeManagement". {region}" -Diensttag und ausgehende TCP-Kommunikation am Port 443 zu "Storage.region" und "BatchNodeManagement". {region}"-Diensttags. |
default |
string |
Der Knotenkommunikationsmodus wird automatisch vom Batchdienst festgelegt. |
simplified |
string |
Knoten, die den vereinfachten Kommunikationsmodus verwenden, erfordern ausgehende TCP-Kommunikation an Port 443 zum "BatchNodeManagement". {region}" -Diensttag. Es sind keine offenen eingehenden Ports erforderlich. |
NodePlacementConfiguration
Knotenplatzierungskonfiguration für einen Pool.
Name | Typ | Beschreibung |
---|---|---|
policy |
Knotenplatzierungsrichtlinientyp in Batchpools. |
NodePlacementPolicyType
Die Platzierungsrichtlinie zum Zuordnen von Knoten im Pool.
Name | Typ | Beschreibung |
---|---|---|
regional |
string |
Alle Knoten im Pool werden in derselben Region zugewiesen. |
zonal |
string |
Knoten im Pool werden über verschiedene Verfügbarkeitszonen verteilt, wobei der Best-Effort-Ausgleich gewährleistet ist. |
OnAllTasksComplete
Die Aktion, die der Batchdienst ausführen soll, wenn sich alle Aufgaben im Auftrag im Abgeschlossenen Zustand befinden.
Name | Typ | Beschreibung |
---|---|---|
noaction |
string |
Sie unternehmen nichts. Der Auftrag bleibt aktiv, es sei denn, er wird mit anderen Mitteln beendet oder deaktiviert. |
terminatejob |
string |
Beenden Sie den Auftrag. Der "terminateReason" des Auftrags ist auf "AllTasksComplete" festgelegt. |
OnTaskFailure
Die Aktion, die der Batchdienst ausführen soll, wenn eine Aufgabe im Auftrag fehlschlägt.
Name | Typ | Beschreibung |
---|---|---|
noaction |
string |
Sie unternehmen nichts. Der Auftrag bleibt aktiv, es sei denn, er wird mit anderen Mitteln beendet oder deaktiviert. |
performexitoptionsjobaction |
string |
Führen Sie die Aktion aus, die der Beendigungsbedingung "Aufgabe" in der ExitConditions-Auflistung der Aufgabe zugeordnet ist. (Dies kann dennoch dazu führen, dass keine Aktion ausgeführt wird, wenn dies der Vorgang angibt.) |
OSDisk
Einstellungen für den Betriebssystemdatenträger des Computeknotens (VM).
Name | Typ | Beschreibung |
---|---|---|
caching |
Gibt die Zwischenspeicherungsanforderungen an. Mögliche Werte sind: None, ReadOnly, ReadWrite. Die Standardwerte sind: Keine für den Standardspeicher. ReadOnly für Premium-Speicher. |
|
diskSizeGB |
integer |
Die anfängliche Datenträgergröße in GB beim Erstellen eines neuen Betriebssystemdatenträgers. |
ephemeralOSDiskSettings |
Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom Computeknoten (VM) verwendet wird. |
|
managedDisk |
Die Parameter des verwalteten Datenträgers. |
|
writeAcceleratorEnabled |
boolean |
Gibt an, ob writeAccelerator auf dem Datenträger aktiviert oder deaktiviert werden soll. |
OutputFile
Eine Spezifikation zum Hochladen von Dateien von einem Azure Batch Compute Node an einen anderen Speicherort, nachdem der Batchdienst die Ausführung des Aufgabenvorgangs abgeschlossen hat.
Name | Typ | Beschreibung |
---|---|---|
destination |
Das Ziel für die Ausgabedatei(n). |
|
filePattern |
string |
Ein Muster, das angibt, welche Datei(en) hochgeladen werden soll. |
uploadOptions |
Zusätzliche Optionen für den Uploadvorgang, einschließlich der Bedingungen, unter denen der Upload ausgeführt werden soll. |
OutputFileBlobContainerDestination
Gibt ein Dateiuploadziel in einem Azure Blob Storage-Container an.
Name | Typ | Beschreibung |
---|---|---|
containerUrl |
string |
Die URL des Containers in Azure Blob Storage, in den die Datei(en) hochgeladen werden soll. |
identityReference |
Der Verweis auf die vom Benutzer zugewiesene Identität für den Zugriff auf Azure Blob Storage, der durch containerUrl angegeben wird |
|
path |
string |
Das Ziel-BLOB oder virtuelle Verzeichnis im Azure Storage-Container. |
uploadHeaders |
Eine Liste von Namen-Wert-Paaren für Kopfzeilen, die beim Hochladen von Ausgabedateien verwendet werden sollen |
OutputFileDestination
Das Ziel, in das eine Datei hochgeladen werden soll.
Name | Typ | Beschreibung |
---|---|---|
container |
Ein Speicherort im Azure Blob Storage, in den Dateien hochgeladen werden. |
OutputFileUploadCondition
Die Bedingungen, unter denen eine Aufgabenausgabedatei oder eine Gruppe von Dateien hochgeladen werden soll.
Name | Typ | Beschreibung |
---|---|---|
taskcompletion |
string |
Laden Sie die Dateien nach dem Beenden des Aufgabenvorgangs hoch, unabhängig davon, was der Ausgangscode war. |
taskfailure |
string |
Laden Sie die Datei(n) erst hoch, nachdem der Vorgangsvorgang mit einem Nichtzero-Ausgangscode beendet wurde. |
tasksuccess |
string |
Laden Sie die Datei(n) erst hoch, nachdem der Vorgangsvorgang mit einem Exitcode von 0 beendet wurde. |
OutputFileUploadOptions
Details zu einem Uploadvorgang einer Ausgabedatei, einschließlich der Bedingungen, unter denen der Upload ausgeführt werden soll.
Name | Typ | Beschreibung |
---|---|---|
uploadCondition |
Die Bedingungen, unter denen die Task-Ausgabedatei oder -gruppe von Dateien hochgeladen werden soll. |
PoolEndpointConfiguration
Die Endpunktkonfiguration für einen Pool.
Name | Typ | Beschreibung |
---|---|---|
inboundNATPools |
Eine Liste der eingehenden NAT-Pools, die verwendet werden können, um bestimmte Ports für einen einzelnen Computeknoten extern zu adressieren. |
PoolInformation
Gibt an, wie ein Auftrag einem Pool zugewiesen werden soll.
Name | Typ | Beschreibung |
---|---|---|
autoPoolSpecification |
Merkmale für einen temporären "automatischen Pool". Der Batchdienst erstellt diesen automatischen Pool, wenn der Auftrag übermittelt wird. |
|
poolId |
string |
Die ID eines vorhandenen Pools. Alle Aufgaben des Auftrags werden im angegebenen Pool ausgeführt. |
PoolLifetimeOption
Die mindeste Lebensdauer der erstellten automatischen Pools und wie mehreren Aufträgen in einem Zeitplan Pools zugewiesen werden.
Name | Typ | Beschreibung |
---|---|---|
job |
string |
Der Pool ist für die Lebensdauer des Auftrags vorhanden, dem er zugeordnet ist. Der Batchdienst erstellt den Pool, wenn er den Auftrag erstellt. Wenn die Option "Auftrag" auf einen Auftragsplan angewendet wird, erstellt der Batchdienst einen neuen automatischen Pool für jeden Auftrag, der im Zeitplan erstellt wurde. |
jobschedule |
string |
Der Pool ist für die Lebensdauer des Auftragsplans vorhanden. Der Batchdienst erstellt den Pool, wenn er den ersten Auftrag im Zeitplan erstellt. Sie können diese Option nur auf Auftragspläne und nicht auf Aufträge anwenden. |
PoolSpecification
Spezifikation zum Erstellen eines neuen Pools.
Name | Typ | Beschreibung |
---|---|---|
applicationPackageReferences |
Die Liste der Pakete, die auf jedem Computeknoten im Pool installiert werden sollen. |
|
autoScaleEvaluationInterval |
string |
Das Zeitintervall, in dem die Poolgröße automatisch entsprechend der Autoskalenformel angepasst werden soll. |
autoScaleFormula |
string |
Die Formel für die gewünschte Anzahl von Computeknoten im Pool. |
certificateReferences |
Eine Liste der Zertifikate, die auf jedem Computeknoten im Pool installiert werden sollen. Warnung: Diese Eigenschaft ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung. |
|
displayName |
string |
Der Anzeigename für den Pool. |
enableAutoScale |
boolean |
Gibt an, ob die Poolgröße im Laufe der Zeit automatisch angepasst werden soll. |
enableInterNodeCommunication |
boolean |
Gibt an, ob der Pool die direkte Kommunikation zwischen Computeknoten zulässt. |
metadata |
Eine Liste von Name-Wert-Paaren, die dem Pool als Metadaten zugeordnet sind. |
|
mountConfiguration |
Eine Liste der Dateisysteme, die auf jedem Knoten im Pool bereitgestellt werden sollen. |
|
networkConfiguration |
Die Netzwerkkonfiguration für den Pool. |
|
resizeTimeout |
string |
Das Timeout für die Zuordnung von Computeknoten zum Pool. |
resourceTags |
object |
Die vom Benutzer angegebenen Tags, die dem Pool zugeordnet sind. |
startTask |
Eine Aufgabe, die auf jedem Computeknoten ausgeführt werden soll, während er dem Pool beitritt. Die Aufgabe wird ausgeführt, wenn der Computeknoten dem Pool hinzugefügt wird oder wenn der Computeknoten neu gestartet wird. |
|
targetDedicatedNodes |
integer |
Die gewünschte Anzahl dedizierter Computeknoten im Pool. |
targetLowPriorityNodes |
integer |
Die gewünschte Anzahl von Computeknoten mit Spot-/Niedriger Priorität im Pool. |
targetNodeCommunicationMode |
Der gewünschte Knotenkommunikationsmodus für den Pool. |
|
taskSchedulingPolicy |
Wie Aufgaben über Computeknoten in einem Pool verteilt werden. |
|
taskSlotsPerNode |
integer |
Die Anzahl der Aufgabenplätze, die zum Ausführen gleichzeitiger Aufgaben auf einem einzelnen Computeknoten im Pool verwendet werden können. |
upgradePolicy |
Die Upgraderichtlinie für den Pool. |
|
userAccounts |
Die Liste der Benutzerkonten, die auf jedem Computeknoten im Pool erstellt werden sollen. |
|
virtualMachineConfiguration |
Die Konfiguration des virtuellen Computers für den Pool. |
|
vmSize |
string |
Die Größe der virtuellen Computer im Pool. Alle virtuellen Computer in einem Pool haben die gleiche Größe. |
PublicIPAddressConfiguration
Die konfiguration der öffentlichen IP-Adresse der Netzwerkkonfiguration eines Pools.
Name | Typ | Beschreibung |
---|---|---|
ipAddressIds |
string[] |
Die Liste der öffentlichen IPs, die der Batchdienst beim Bereitstellen von Computeknoten verwendet. |
provision |
Der Bereitstellungstyp für öffentliche IP-Adressen für den Pool. |
ResourceFile
Eine einzelne Datei oder mehrere Dateien, die in einen Computeknoten heruntergeladen werden sollen.
Name | Typ | Beschreibung |
---|---|---|
autoStorageContainerName |
string |
Der Name des Speichercontainers im automatischen Speicherkonto. |
blobPrefix |
string |
Das Blobpräfix, das beim Herunterladen von Blobs aus einem Azure Storage-Container verwendet werden soll. Nur die Blobs, deren Namen mit dem angegebenen Präfix beginnen, werden heruntergeladen. |
fileMode |
string |
Das Attribut für den Dateiberechtigungsmodus im oktalen Format. |
filePath |
string |
Der Speicherort auf dem Computeknoten, in den die Datei(n) heruntergeladen werden soll, relativ zum Arbeitsverzeichnis der Aufgabe. |
httpUrl |
string |
Die URL der herunterzuladenden Datei. |
identityReference |
Der Verweis auf die vom Benutzer zugewiesene Identität für den Zugriff auf Azure Blob Storage, der durch "storageContainerUrl" oder "httpUrl" angegeben wird |
|
storageContainerUrl |
string |
Die URL des Blobcontainers in Azure Blob Storage. |
RollingUpgradePolicy
Die Konfigurationsparameter, die beim Ausführen eines rollierenden Upgrades verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
enableCrossZoneUpgrade |
boolean |
Zulassen, dass VMSS AZ-Grenzen beim Erstellen von Upgradebatches ignoriert. Berücksichtigen Sie die Updatedomäne und maxBatchInstancePercent, um die Batchgröße zu ermitteln. Dieses Feld kann nur bei Verwendung von NodePlacementConfiguration als Zonal auf "true" oder "false" festgelegt werden. |
maxBatchInstancePercent |
integer |
Der maximale Prozentsatz der gesamten Instanzen des virtuellen Computers, die gleichzeitig durch das rollierende Upgrade in einem Batch aktualisiert werden. Da dies ein Maximum ist, können fehlerhafte Instanzen in früheren oder zukünftigen Batches dazu führen, dass der Prozentsatz der Instanzen in einem Batch verringert wird, um eine höhere Zuverlässigkeit sicherzustellen. Der Wert dieses Felds sollte zwischen 5 und 100 (einschließlich) liegen. Wenn "maxBatchInstancePercent" und "maxUnhealthyInstancePercent" mit dem Wert zugewiesen sind, sollte der Wert von "maxBatchInstancePercent" nicht größer als "maxUnhealthyInstancePercent" sein. |
maxUnhealthyInstancePercent |
integer |
Der maximale Prozentsatz der Instanzen des virtuellen Computers im Skalierungssatz, der gleichzeitig fehlerhaft sein kann, entweder aufgrund eines Upgrades oder durch die Integritätsprüfungen des virtuellen Computers in einem fehlerhaften Zustand gefunden wird, bevor das Rollupgrade abgebrochen wird. Diese Einschränkung wird vor dem Starten eines Batches überprüft. Der Wert dieses Felds sollte zwischen 5 und 100 (einschließlich) liegen. Wenn "maxBatchInstancePercent" und "maxUnhealthyInstancePercent" mit dem Wert zugewiesen sind, sollte der Wert von "maxBatchInstancePercent" nicht größer als "maxUnhealthyInstancePercent" sein. |
maxUnhealthyUpgradedInstancePercent |
integer |
Der maximale Prozentsatz der aktualisierten Virtuellen Computerinstanzen, die sich in einem fehlerhaften Zustand befinden. Diese Überprüfung erfolgt, nachdem jeder Batch aktualisiert wurde. Wenn dieser Prozentsatz jemals überschritten wird, wird das rollierende Update abgebrochen. Der Wert dieses Felds sollte zwischen 0 und 100 (einschließlich) liegen. |
pauseTimeBetweenBatches |
string |
Die Wartezeit zwischen Abschluss des Updates für alle virtuellen Computer in einem Batch und starten den nächsten Batch. Die Zeitdauer sollte im ISO 8601-Format angegeben werden. |
prioritizeUnhealthyInstances |
boolean |
Aktualisieren Sie alle fehlerhaften Instanzen in einem Skalierungssatz, bevor alle fehlerfreien Instanzen auftreten. |
rollbackFailedInstancesOnPolicyBreach |
boolean |
Fehler bei Rollbackinstanzen beim vorherigen Modell, wenn die Richtlinie für das Rollupgrade verletzt wird. |
SecurityEncryptionTypes
Gibt den EncryptionType des verwalteten Datenträgers an. Sie ist für die Verschlüsselung nur des VMGuestState-Blobs auf "VMGuestStateOnly" und "NonPersistedTPM" festgelegt, damit der Firmwarestatus im VMGuestState-Blob nicht beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden und ist bei Verwendung vertraulicher VMs erforderlich.
Name | Typ | Beschreibung |
---|---|---|
NonPersistedTPM |
string |
|
VMGuestStateOnly |
string |
SecurityProfile
Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers an.
Name | Typ | Beschreibung |
---|---|---|
encryptionAtHost |
boolean |
Diese Eigenschaft kann vom Benutzer in der Anforderung verwendet werden, um die Hostverschlüsselung für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers zu aktivieren oder zu deaktivieren. Dadurch wird die Verschlüsselung für alle Datenträger einschließlich Ressourcen-/Temp-Datenträger auf dem Host selbst aktiviert. Weitere Informationen zur Verschlüsselung bei Hostanforderungen finden Sie unter https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. |
securityType |
Gibt den SecurityType des virtuellen Computers an. Sie muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren. |
|
uefiSettings |
Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden. |
SecurityTypes
Gibt den SecurityType des virtuellen Computers an. Sie muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren.
Name | Typ | Beschreibung |
---|---|---|
confidentialVM |
string |
Azure Vertraulich Computing bietet vertrauliche VMs für Mandanten mit hohen Sicherheits- und Vertraulichkeitsanforderungen. Diese virtuellen Computer bieten eine starke, hardwaregezwungene Grenze, um Ihre Sicherheitsanforderungen zu erfüllen. Sie können vertrauliche VMs für Migrationen verwenden, ohne Änderungen an Ihrem Code vorzunehmen, wobei die Plattform, die den Status Ihrer VM schützt, nicht gelesen oder geändert wird. |
trustedLaunch |
string |
Der vertrauenswürdige Start schützt vor erweiterten und beständigen Angriffstechniken. |
ServiceArtifactReference
Gibt die Dienstartefaktereferenz-ID an, die zum Festlegen derselben Imageversion für alle virtuellen Computer im Skalierungssatz bei Verwendung der neuesten Imageversion verwendet wird.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Die Dienstartefaktereferenz-ID von ServiceArtifactReference |
StartTask
Eine Aufgabe, die ausgeführt wird, wenn ein Knoten einem Pool im Azure Batch-Dienst beitritt oder wenn der Computeknoten neu gestartet oder umimages erstellt wird.
Name | Typ | Beschreibung |
---|---|---|
commandLine |
string |
Die Befehlszeile des StartTask. |
containerSettings |
Die Einstellungen für den Container, unter dem der StartTask ausgeführt wird. |
|
environmentSettings |
Eine Liste der Umgebungsvariableneinstellungen für den StartTask. |
|
maxTaskRetryCount |
integer |
Die maximale Anzahl der Wiederholungsversuche des Vorgangs. |
resourceFiles |
Eine Liste der Dateien, die der Batchdienst vor dem Ausführen der Befehlszeile auf den Computeknoten herunterladen wird. Es gibt eine maximale Größe für die Liste der Ressourcendateien. Wenn die maximale Größe überschritten wird, schlägt die Anforderung fehl, und der Antwortfehlercode lautet "RequestEntityTooLarge". Wenn dies der Fall ist, muss die Sammlung von ResourceFiles in der Größe reduziert werden. Dies kann mithilfe von .zip Dateien, Anwendungspaketen oder Docker-Containern erreicht werden. |
|
userIdentity |
Die Benutzeridentität, unter der der StartTask ausgeführt wird. |
|
waitForSuccess |
boolean |
Gibt an, ob der Batchdienst warten soll, bis der StartTask erfolgreich abgeschlossen wurde (d. h. zum Beenden mit Beendigungscode 0), bevor Aufgaben auf dem Computeknoten geplant werden. |
StorageAccountType
Der Speicherkontotyp zum Erstellen von Datenträgern oder Betriebssystemdatenträgern.
Name | Typ | Beschreibung |
---|---|---|
premium_lrs |
string |
Der Datenträger/Betriebssystemdatenträger sollte einen lokal redundanten Premiumspeicher verwenden. |
standard_lrs |
string |
Der Datenträger/Betriebssystemdatenträger sollte standardmäßigen lokal redundanten Speicher verwenden. |
standardssd_lrs |
string |
Der Datenträger/Betriebssystemdatenträger sollte standardmäßigen SSD lokal redundanten Speicher verwenden. |
TaskConstraints
Ausführungseinschränkungen, die auf einen Vorgang angewendet werden sollen.
Name | Typ | Beschreibung |
---|---|---|
maxTaskRetryCount |
integer |
Die maximale Anzahl der Wiederholungsversuche des Vorgangs. Der Batchdienst ruft eine Aufgabe erneut auf, wenn der Beendigungscode nicht null ist. |
maxWallClockTime |
string |
Die maximale verstrichene Zeit, die der Vorgang ausführen kann, gemessen von dem Zeitpunkt, zu dem der Vorgang gestartet wird. Wenn der Vorgang nicht innerhalb des Zeitlimits abgeschlossen wird, beendet der Batchdienst ihn. |
retentionTime |
string |
Die minimale Zeit, um das Aufgabenverzeichnis auf dem Computeknoten beizubehalten, in dem er ausgeführt wurde, ab dem Zeitpunkt, zu dem die Ausführung abgeschlossen ist. Nach diesem Zeitpunkt kann der Batchdienst das Aufgabenverzeichnis und alle zugehörigen Inhalte löschen. |
TaskContainerSettings
Die Containereinstellungen für eine Aufgabe.
Name | Typ | Beschreibung |
---|---|---|
containerHostBatchBindMounts |
Die Pfade, die Sie an containeraufgaben bereitstellen möchten. |
|
containerRunOptions |
string |
Zusätzliche Optionen für den Befehl "Container erstellen". |
imageName |
string |
Das Image, das zum Erstellen des Containers verwendet werden soll, in dem die Aufgabe ausgeführt wird. |
registry |
Die private Registrierung, die das Containerimage enthält. |
|
workingDirectory |
Der Speicherort des Arbeitsverzeichnisses für containeraufgaben. |
TaskSchedulingPolicy
Gibt an, wie Aufgaben über Computeknoten verteilt werden sollen.
Name | Typ | Beschreibung |
---|---|---|
nodeFillType |
Wie Aufgaben über Computeknoten in einem Pool verteilt werden. |
UefiSettings
Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
secureBootEnabled |
boolean |
Gibt an, ob der sichere Start auf dem virtuellen Computer aktiviert werden soll. |
vTpmEnabled |
boolean |
Gibt an, ob vTPM auf dem virtuellen Computer aktiviert werden soll. |
UpgradeMode
Gibt den Modus eines Upgrades auf virtuelle Computer im Skalierungssatz an.
Dabei sind folgende Werte möglich:
manuelle – Sie steuern die Anwendung von Updates auf virtuelle Computer im Skalierungssatz. Dazu verwenden Sie die ManualUpgrade-Aktion.
Automatische – Alle virtuellen Computer im Skalierungssatz werden automatisch gleichzeitig aktualisiert.
Roll- – Skalierungssatz führt Aktualisierungen in Batches mit einer optionalen Pausenzeit dazwischen durch.
Name | Typ | Beschreibung |
---|---|---|
automatic |
string |
Alle virtuellen Computer im Skalierungssatz werden automatisch gleichzeitig aktualisiert. |
manual |
string |
Sie steuern die Anwendung von Updates auf virtuelle Computer im Skalierungssatz. Dazu verwenden Sie die ManualUpgrade-Aktion. |
rolling |
string |
Die vorhandenen Instanzen in einem Skalierungssatz werden in Batches heruntergesetzt, um aktualisiert zu werden. Sobald der aktualisierte Batch abgeschlossen ist, beginnen die Instanzen erneut mit dem Datenverkehr, und der nächste Batch beginnt. Dies wird fortgesetzt, bis alle Instanzen up-to-date gebracht wurden. |
UpgradePolicy
Beschreibt eine Upgraderichtlinie – automatisch, manuell oder rolliert.
Name | Typ | Beschreibung |
---|---|---|
automaticOSUpgradePolicy |
Konfigurationsparameter, die zum Ausführen des automatischen Betriebssystemupgrades verwendet werden. |
|
mode |
Gibt den Modus eines Upgrades auf virtuelle Computer im Skalierungssatz an. |
|
rollingUpgradePolicy |
Die Konfigurationsparameter, die beim Ausführen eines rollierenden Upgrades verwendet werden. |
UserAccount
Eigenschaften zum Erstellen eines Benutzers, der zum Ausführen von Aufgaben auf einem Azure Batch Compute Node verwendet wird.
Name | Typ | Beschreibung |
---|---|---|
elevationLevel |
Die Höhe des Benutzerkontos. |
|
linuxUserConfiguration |
Die Linux-spezifische Benutzerkonfiguration für das Benutzerkonto. |
|
name |
string |
Der Name des Benutzerkontos. Namen können bis zu einer maximalen Länge von 20 Unicode-Zeichen enthalten. |
password |
string |
Das Kennwort für das Benutzerkonto. |
windowsUserConfiguration |
Die Windows-spezifische Benutzerkonfiguration für das Benutzerkonto. |
UserIdentity
Die Definition der Benutzeridentität, unter der die Aufgabe ausgeführt wird.
Name | Typ | Beschreibung |
---|---|---|
autoUser |
Der automatische Benutzer, unter dem die Aufgabe ausgeführt wird. |
|
username |
string |
Der Name der Benutzeridentität, unter der die Aufgabe ausgeführt wird. |
VirtualMachineConfiguration
Die Konfiguration für Computeknoten in einem Pool basierend auf der Azure Virtual Machines-Infrastruktur.
Name | Typ | Beschreibung |
---|---|---|
containerConfiguration |
Die Containerkonfiguration für den Pool. |
|
dataDisks |
Data |
Die Konfiguration für Datenträger, die an die Computeknoten im Pool angefügt sind. |
diskEncryptionConfiguration |
Die Datenträgerverschlüsselungskonfiguration für den Pool. |
|
extensions |
Die Erweiterung des virtuellen Computers für den Pool. |
|
imageReference |
Ein Verweis auf das Azure Virtual Machines Marketplace-Image oder das zu verwendende benutzerdefinierte Virtuelle Computerimage. |
|
licenseType |
string |
Der Typ der lokalen Lizenz, die beim Bereitstellen des Betriebssystems verwendet werden soll. Windows_Server – Die lokale Lizenz gilt für Windows Server. Windows_Client – Die lokale Lizenz ist für Windows Client. |
nodeAgentSKUId |
string |
Die SKU des Batch-Computeknoten-Agents, der auf Computeknoten im Pool bereitgestellt werden soll. |
nodePlacementConfiguration |
Die Knotenplatzierungskonfiguration für den Pool. |
|
osDisk |
Einstellungen für den Betriebssystemdatenträger des virtuellen Computers. |
|
securityProfile |
Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers an. |
|
serviceArtifactReference |
Gibt die Dienstartefaktereferenz-ID an, die zum Festlegen derselben Imageversion für alle virtuellen Computer im Skalierungssatz bei Verwendung der neuesten Imageversion verwendet wird. |
|
windowsConfiguration |
Windows-Betriebssystemeinstellungen auf dem virtuellen Computer. |
VMDiskSecurityProfile
Gibt die Sicherheitsprofileinstellungen für den verwalteten Datenträger an. Hinweis: Sie kann nur für vertrauliche virtuelle Computer festgelegt werden und ist bei verwendung vertraulicher VMs erforderlich.
Name | Typ | Beschreibung |
---|---|---|
securityEncryptionType |
Gibt den EncryptionType des verwalteten Datenträgers an. Sie ist für die Verschlüsselung nur des VMGuestState-Blobs auf "VMGuestStateOnly" und "NonPersistedTPM" festgelegt, damit der Firmwarestatus im VMGuestState-Blob nicht beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden und ist bei Verwendung vertraulicher VMs erforderlich. |
VMExtension
Die Konfiguration für Erweiterungen virtueller Computer.
Name | Typ | Beschreibung |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zur Bereitstellungszeit verfügbar ist. Nach der Bereitstellung aktualisiert die Erweiterung jedoch keine Nebenversionen, es sei denn, sie werden erneut bereitgestellt, auch wenn diese Eigenschaft auf "true" festgelegt ist. |
enableAutomaticUpgrade |
boolean |
Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist. |
name |
string |
Der Name der Erweiterung des virtuellen Computers. |
protectedSettings |
object |
Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten. |
provisionAfterExtensions |
string[] |
Die Sammlung von Erweiterungsnamen. |
publisher |
string |
Der Name des Herausgebers des Erweiterungshandlers. |
settings |
object |
JSON-formatierte öffentliche Einstellungen für die Erweiterung. |
type |
string |
Der Typ der Erweiterung. |
typeHandlerVersion |
string |
Die Version des Skripthandlers. |
WindowsConfiguration
Windows-Betriebssystemeinstellungen, die auf den virtuellen Computer angewendet werden sollen.
Name | Typ | Beschreibung |
---|---|---|
enableAutomaticUpdates |
boolean |
Gibt an, ob automatische Updates auf dem virtuellen Computer aktiviert sind. |
WindowsUserConfiguration
Eigenschaften, die zum Erstellen eines Benutzerkontos auf einem Windows-Computeknoten verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
loginMode |
Der Anmeldemodus für den Benutzer |