Pool - List
Listet alle Pools auf, die bereitgestellt werden
GET {batchUrl}/pools?api-version=2024-07-01.20.0
GET {batchUrl}/pools?$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-pools. |
|
$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 Pools 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 Pools 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
Pool list
Beispielanforderung
GET account.region.batch.azure.com/pools?api-version=2024-07-01.20.0
Beispiel für eine Antwort
{
"value": [
{
"id": "testPool",
"url": "https://accountname.region.batch.azure.com/pools/testPool",
"eTag": "0x8D4123BEF87D233",
"lastModified": "2016-11-21T18:26:39.7108787Z",
"creationTime": "2016-11-21T18:26:39.7108787Z",
"state": "active",
"stateTransitionTime": "2016-11-21T18:26:39.7108787Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2016-11-21T18:27:40.287803Z",
"vmSize": "small",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 3,
"currentLowPriorityNodes": 0,
"targetDedicatedNodes": 3,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"startTask": {
"commandLine": "cmd /c echo hello",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2016-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.windows amd64"
}
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Allocation |
Gibt an, ob die Größe des Pools geändert wird. |
Application |
Ein Verweis auf ein Paket, das auf Computeknoten bereitgestellt werden soll. |
Automatic |
Die Konfigurationsparameter, die zum Ausführen eines automatischen Betriebssystemupgrades verwendet werden. |
Auto |
Die Ergebnisse und Fehler aus einer Ausführung einer Autoskalenformel des Pools. |
Auto |
Fehler beim Ausführen oder Auswerten einer Autoskalierungsformel des Pools. |
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. |
Batch |
Die Identität des Batchpools, falls konfiguriert. |
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 Pool im Azure-Batchdienst. |
Cloud |
Das Ergebnis der Auflistung der Pools 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 |
Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde. |
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. |
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. |
OSDisk |
Einstellungen für den Betriebssystemdatenträger des Computeknotens (VM). |
Pool |
Die Endpunktkonfiguration für einen Pool. |
Pool |
Die Identität des Batchpools, falls konfiguriert. |
Pool |
Der aktuelle Status des Pools. |
Pool |
Enthält Nutzungs- und Ressourcennutzungsstatistiken für die Lebensdauer eines Pools. |
Public |
Die konfiguration der öffentlichen IP-Adresse der Netzwerkkonfiguration eines Pools. |
Resize |
Fehler beim Ändern der Größe eines Pools. |
Resource |
Eine einzelne Datei oder mehrere Dateien, die in einen Computeknoten heruntergeladen werden sollen. |
Resource |
Statistiken im Zusammenhang mit dem Ressourcenverbrauch durch Computeknoten in einem Pool. |
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 |
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. |
Usage |
Statistiken im Zusammenhang mit Poolnutzungsinformationen. |
User |
Eigenschaften zum Erstellen eines Benutzers, der zum Ausführen von Aufgaben auf einem Azure Batch Compute Node verwendet wird. |
User |
Die vom Benutzer zugewiesene Identität |
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. |
AllocationState
Gibt an, ob die Größe des Pools geändert wird.
Name | Typ | Beschreibung |
---|---|---|
resizing |
string |
Die Größe des Pools wird geändert; Das heißt, Computeknoten werden dem Pool hinzugefügt oder daraus entfernt. |
steady |
string |
Die Größe des Pools wird nicht geändert. Es gibt keine Änderungen an der Anzahl der Computeknoten im Laufenden Pool. Ein Pool gibt diesen Zustand ein, wenn er erstellt wird und wenn im Pool keine Vorgänge ausgeführt werden, um die Anzahl der Computeknoten zu ändern. |
stopping |
string |
Die Größe des Pools wurde geändert, der Benutzer hat jedoch angefordert, dass die Größenänderung beendet wurde, die Beendigungsanforderung wurde jedoch noch nicht abgeschlossen. |
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. |
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. |
AutoScaleRun
Die Ergebnisse und Fehler aus einer Ausführung einer Autoskalenformel des Pools.
Name | Typ | Beschreibung |
---|---|---|
error |
Details zum Fehler beim Auswerten der Autoskalenformel im Pool, wenn die Auswertung nicht erfolgreich war. |
|
results |
string |
Die Endwerte aller Variablen, die bei der Auswertung der Autoskalenformel verwendet werden. |
timestamp |
string |
Die Zeit, zu der die Autoskalenformel zuletzt ausgewertet wurde. |
AutoScaleRunError
Fehler beim Ausführen oder Auswerten einer Autoskalierungsformel des Pools.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Ein Bezeichner für den Autoskalenfehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden. |
message |
string |
Eine Meldung, die den Autoskalenfehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist. |
values |
Eine Liste zusätzlicher Fehlerdetails im Zusammenhang mit dem AutoScale-Fehler. |
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. |
BatchPoolIdentity
Die Identität des Batchpools, falls konfiguriert.
Name | Typ | Beschreibung |
---|---|---|
type |
Die Identität des Batchpools, falls konfiguriert. |
|
userAssignedIdentities |
Die Liste der Benutzeridentitäten, die dem Batchkonto zugeordnet 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. |
CloudPool
Ein Pool im Azure-Batchdienst.
Name | Typ | Beschreibung |
---|---|---|
allocationState |
Gibt an, ob die Größe des Pools geändert wird. |
|
allocationStateTransitionTime |
string |
Der Zeitpunkt, zu dem der Pool seinen aktuellen Zuordnungsstatus eingegeben hat. |
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 |
Eine Formel für die gewünschte Anzahl von Computeknoten im Pool. |
autoScaleRun |
Die Ergebnisse und Fehler aus der letzten Ausführung der Autoskalenformel. |
|
certificateReferences |
Die 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. |
|
creationTime |
string |
Die Erstellungszeit des Pools. |
currentDedicatedNodes |
integer |
Die Anzahl der dedizierten Computeknoten, die sich derzeit im Pool befinden. |
currentLowPriorityNodes |
integer |
Die Anzahl der Computeknoten mit Spot-/Niedriger Priorität, die sich derzeit im Pool befinden. |
currentNodeCommunicationMode |
Der aktuelle Status des Poolkommunikationsmodus. |
|
displayName |
string |
Der Anzeigename für den Pool. |
eTag |
string |
Das ETag des Pools. |
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. |
id |
string |
Eine Zeichenfolge, die den Pool innerhalb des Kontos eindeutig identifiziert. |
identity |
Die Identität des Batchpools, falls konfiguriert. |
|
lastModified |
string |
Der Zeitpunkt der letzten Änderung des Pools. |
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. |
|
resizeErrors |
Eine Liste der Fehler, die beim Ausführen der letzten Größenänderung im Pool aufgetreten sind. |
|
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 für jeden Computeknoten ausgeführt werden soll, während er dem Pool beitritt. |
|
state |
Der aktuelle Status des Pools. |
|
stateTransitionTime |
string |
Die Uhrzeit, zu der der Pool seinen aktuellen Zustand eingegeben hat. |
stats |
Nutzungs- und Ressourcennutzungsstatistiken für die gesamte Lebensdauer des Pools. |
|
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. |
|
url |
string |
Die URL des Pools. |
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 virtueller Computer im Pool. Alle virtuellen Computer in einem Pool haben die gleiche Größe. |
CloudPoolListResult
Das Ergebnis der Auflistung der Pools in einem Konto.
Name | Typ | Beschreibung |
---|---|---|
odata.nextLink |
string |
Die URL, um den nächsten Satz von Ergebnissen abzurufen. |
value |
Die Liste der Pools. |
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. |
ErrorMessage
Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
Name | Typ | Beschreibung |
---|---|---|
lang |
string |
Der Sprachcode der Fehlermeldung |
value |
string |
Der Text der Nachricht. |
ImageReference
Ein Verweis auf ein Azure Virtual Machines Marketplace Image oder ein Azure Compute Gallery Image. Informationen zum Abrufen der Liste aller azure Marketplace-Imageverweise, die von Azure Batch überprüft wurden, finden Sie im Vorgang "Unterstützte Bilder auflisten".
Name | Typ | Beschreibung |
---|---|---|
communityGalleryImageId |
string |
Eindeutiger Bezeichner des Communitykatalogbilds |
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. |
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. |
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. |
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. |
PoolIdentityType
Die Identität des Batchpools, falls konfiguriert.
Name | Typ | Beschreibung |
---|---|---|
None |
string |
Dem Batchpool ist keine Identität zugeordnet. Wenn Sie |
UserAssigned |
string |
Der Batchpool hat ihm Benutzeridentitäten zugewiesen. |
PoolState
Der aktuelle Status des Pools.
Name | Typ | Beschreibung |
---|---|---|
active |
string |
Der Pool ist verfügbar, um Aufgaben auszuführen, die der Verfügbarkeit von Computeknoten unterliegen. |
deleting |
string |
Der Benutzer hat angefordert, dass der Pool gelöscht wird, der Löschvorgang wurde jedoch noch nicht abgeschlossen. |
PoolStatistics
Enthält Nutzungs- und Ressourcennutzungsstatistiken für die Lebensdauer eines Pools.
Name | Typ | Beschreibung |
---|---|---|
lastUpdateTime |
string |
Die Uhrzeit, zu der die Statistiken zuletzt aktualisiert wurden. Alle Statistiken sind auf den Bereich zwischen startTime und lastUpdateTime beschränkt. |
resourceStats |
Statistiken im Zusammenhang mit dem Ressourcenverbrauch durch Computeknoten im Pool. |
|
startTime |
string |
Die Startzeit des zeitraums, der von den Statistiken abgedeckt wird. |
url |
string |
Die URL für die Statistik. |
usageStats |
Statistiken im Zusammenhang mit der Poolnutzung, z. B. die Menge der verwendeten Kernzeit. |
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. |
ResizeError
Fehler beim Ändern der Größe eines Pools.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Ein Bezeichner für den Pool-Größenänderungsfehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden. |
message |
string |
Eine Meldung, die den Fehler beim Ändern der Größe des Pools beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet ist. |
values |
Eine Liste mit zusätzlichen Fehlerdetails im Zusammenhang mit dem Pool-Größenänderungsfehler. |
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. |
ResourceStatistics
Statistiken im Zusammenhang mit dem Ressourcenverbrauch durch Computeknoten in einem Pool.
Name | Typ | Beschreibung |
---|---|---|
avgCPUPercentage |
number |
Die durchschnittliche CPU-Auslastung über alle Computeknoten im Pool (Prozentsatz pro Knoten). |
avgDiskGiB |
number |
Der durchschnittliche verwendete Speicherplatz in GiB über alle Computeknoten im Pool hinweg. |
avgMemoryGiB |
number |
Die durchschnittliche Speicherauslastung in GiB über alle Computeknoten im Pool hinweg. |
diskReadGiB |
number |
Die Gesamtmenge der Daten in GiB des Datenträgers wird über alle Computeknoten im Pool gelesen. |
diskReadIOps |
integer |
Die Gesamtanzahl der Datenträgerlesevorgänge über alle Computeknoten im Pool hinweg. |
diskWriteGiB |
number |
Die Gesamtmenge der Daten in GiB des Datenträgers schreibt über alle Computeknoten im Pool. |
diskWriteIOps |
integer |
Die Gesamtanzahl der Datenträgerschreibvorgänge über alle Computeknoten im Pool hinweg. |
lastUpdateTime |
string |
Die Uhrzeit, zu der die Statistiken zuletzt aktualisiert wurden. Alle Statistiken sind auf den Bereich zwischen startTime und lastUpdateTime beschränkt. |
networkReadGiB |
number |
Die Gesamtmenge der Daten in GiB des Netzwerks liest sich über alle Computeknoten im Pool. |
networkWriteGiB |
number |
Die Gesamtmenge der Daten in GiB des Netzwerks schreibt über alle Computeknoten im Pool. |
peakDiskGiB |
number |
Der höchst verwendete Speicherplatz in GiB über alle Computeknoten im Pool hinweg. |
peakMemoryGiB |
number |
Die spitzen Speicherauslastung in GiB über alle Computeknoten im Pool hinweg. |
startTime |
string |
Die Startzeit des zeitraums, der von den Statistiken abgedeckt wird. |
RollingUpgradePolicy
Die Konfigurationsparameter, die beim Ausführen eines rollierenden Upgrades verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
enableCrossZoneUpgrade |
boolean |
Zulassen, dass VMSS AZ-Grenzen beim Erstellen von Upgradebatches ignoriert. Berücksichtigen Sie die Updatedomäne und maxBatchInstancePercent, um die Batchgröße zu ermitteln. Dieses Feld kann nur bei Verwendung von NodePlacementConfiguration als Zonal auf "true" oder "false" festgelegt werden. |
maxBatchInstancePercent |
integer |
Der maximale Prozentsatz der gesamten Instanzen des virtuellen Computers, die gleichzeitig durch das rollierende Upgrade in einem Batch aktualisiert werden. Da dies ein Maximum ist, können fehlerhafte Instanzen in früheren oder zukünftigen Batches dazu führen, dass der Prozentsatz der Instanzen in einem Batch verringert wird, um eine höhere Zuverlässigkeit sicherzustellen. Der Wert dieses Felds sollte zwischen 5 und 100 (einschließlich) liegen. Wenn "maxBatchInstancePercent" und "maxUnhealthyInstancePercent" mit dem Wert zugewiesen sind, sollte der Wert von "maxBatchInstancePercent" nicht größer als "maxUnhealthyInstancePercent" sein. |
maxUnhealthyInstancePercent |
integer |
Der maximale Prozentsatz der Instanzen des virtuellen Computers im Skalierungssatz, der gleichzeitig fehlerhaft sein kann, entweder aufgrund eines Upgrades oder durch die Integritätsprüfungen des virtuellen Computers in einem fehlerhaften Zustand gefunden wird, bevor das Rollupgrade abgebrochen wird. Diese Einschränkung wird vor dem Starten eines Batches überprüft. Der Wert dieses Felds sollte zwischen 5 und 100 (einschließlich) liegen. Wenn "maxBatchInstancePercent" und "maxUnhealthyInstancePercent" mit dem Wert zugewiesen sind, sollte der Wert von "maxBatchInstancePercent" nicht größer als "maxUnhealthyInstancePercent" sein. |
maxUnhealthyUpgradedInstancePercent |
integer |
Der maximale Prozentsatz der aktualisierten Virtuellen Computerinstanzen, die sich in einem fehlerhaften Zustand befinden. Diese Überprüfung erfolgt, nachdem jeder Batch aktualisiert wurde. Wenn dieser Prozentsatz jemals überschritten wird, wird das rollierende Update abgebrochen. Der Wert dieses Felds sollte zwischen 0 und 100 (einschließlich) liegen. |
pauseTimeBetweenBatches |
string |
Die Wartezeit zwischen Abschluss des Updates für alle virtuellen Computer in einem Batch und starten den nächsten Batch. Die Zeitdauer sollte im ISO 8601-Format angegeben werden. |
prioritizeUnhealthyInstances |
boolean |
Aktualisieren Sie alle fehlerhaften Instanzen in einem Skalierungssatz, bevor alle fehlerfreien Instanzen auftreten. |
rollbackFailedInstancesOnPolicyBreach |
boolean |
Fehler bei Rollbackinstanzen beim vorherigen Modell, wenn die Richtlinie für das Rollupgrade verletzt wird. |
SecurityEncryptionTypes
Gibt den EncryptionType des verwalteten Datenträgers an. Sie ist für die Verschlüsselung nur des VMGuestState-Blobs auf "VMGuestStateOnly" und "NonPersistedTPM" festgelegt, damit der Firmwarestatus im VMGuestState-Blob nicht beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden und ist bei Verwendung vertraulicher VMs erforderlich.
Name | Typ | Beschreibung |
---|---|---|
NonPersistedTPM |
string |
|
VMGuestStateOnly |
string |
SecurityProfile
Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers an.
Name | Typ | Beschreibung |
---|---|---|
encryptionAtHost |
boolean |
Diese Eigenschaft kann vom Benutzer in der Anforderung verwendet werden, um die Hostverschlüsselung für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers zu aktivieren oder zu deaktivieren. Dadurch wird die Verschlüsselung für alle Datenträger einschließlich Ressourcen-/Temp-Datenträger auf dem Host selbst aktiviert. Weitere Informationen zur Verschlüsselung bei Hostanforderungen finden Sie unter https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. |
securityType |
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. |
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.
Mögliche Werte sind:
manuelle – Sie steuern die Anwendung von Updates auf virtuelle Computer im Skalierungssatz. Dazu verwenden Sie die ManualUpgrade-Aktion.
Automatische – Alle virtuellen Computer im Skalierungssatz werden automatisch gleichzeitig aktualisiert.
Roll- – Skalierungssatz führt Aktualisierungen in Batches mit einer optionalen Pausenzeit dazwischen durch.
Name | Typ | Beschreibung |
---|---|---|
automatic |
string |
Alle virtuellen Computer im Skalierungssatz werden automatisch gleichzeitig aktualisiert. |
manual |
string |
Sie steuern die Anwendung von Updates auf virtuelle Computer im Skalierungssatz. Dazu verwenden Sie die ManualUpgrade-Aktion. |
rolling |
string |
Die vorhandenen Instanzen in einem Skalierungssatz werden in Batches heruntergesetzt, um aktualisiert zu werden. Sobald der aktualisierte Batch abgeschlossen ist, beginnen die Instanzen erneut mit dem Datenverkehr, und der nächste Batch beginnt. Dies wird fortgesetzt, bis alle Instanzen up-to-date gebracht wurden. |
UpgradePolicy
Beschreibt eine Upgraderichtlinie – automatisch, manuell oder rolliert.
Name | Typ | Beschreibung |
---|---|---|
automaticOSUpgradePolicy |
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. |
UsageStatistics
Statistiken im Zusammenhang mit Poolnutzungsinformationen.
Name | Typ | Beschreibung |
---|---|---|
dedicatedCoreTime |
string |
Die aggregierte Wanduhrzeit der dedizierten Computeknotenkerne, die Teil des Pools sind. |
lastUpdateTime |
string |
Die Uhrzeit, zu der die Statistiken zuletzt aktualisiert wurden. Alle Statistiken sind auf den Bereich zwischen startTime und lastUpdateTime beschränkt. |
startTime |
string |
Die Startzeit des zeitraums, der von den Statistiken abgedeckt wird. |
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. |
UserAssignedIdentity
Die vom Benutzer zugewiesene Identität
Name | Typ | Beschreibung |
---|---|---|
clientId |
string |
Die Client-ID der vom Benutzer zugewiesenen Identität. |
principalId |
string |
Die Prinzipal-ID der vom Benutzer zugewiesenen Identität. |
resourceId |
string |
Die ARM-Ressourcen-ID der vom Benutzer zugewiesenen Identität |
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 |