Pool - List
Listet alle Pools im angegebenen Konto auf.
GET {batchUrl}/pools?api-version=2023-11-01.18.0
GET {batchUrl}/pools?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.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/en-us/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. Es können maximal 1.000 Pools zurückgegeben werden. |
|
timeout
|
query |
integer int32 |
Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden aufwenden kann. Der Standardwert ist 30 Sekunden. |
Anforderungsheader
Media Types: "application/json; odata=minimalmetadata"
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
client-request-id |
string uuid |
Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Gibt an, ob der Server die client-request-ID in der Antwort zurückgeben soll. |
|
ocp-date |
string date-time-rfc1123 |
Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Eine Antwort, die die Liste der Pools enthält. Headers
|
|
Other Status Codes |
Der Fehler vom Batch-Dienst. |
Sicherheit
azure_auth
Microsoft Entra OAuth 2.0-Authentifizierungscodeflow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Authorization
Type:
apiKey
In:
header
Beispiele
Pool list
Sample Request
GET account.region.batch.azure.com/pools?api-version=2023-11-01.18.0
Sample Response
{
"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"
},
"cloudServiceConfiguration": {
"osFamily": "4",
"osVersion": "*"
}
}
]
}
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. |
Auto |
Die Ergebnisse und Fehler bei der Ausführung einer Formel für die automatische Skalierung des Pools. |
Auto |
Ein Fehler, der beim Ausführen oder Auswerten einer Poolautoskalierungsformel aufgetreten ist. |
Auto |
Der Bereich für den automatischen Benutzer |
Auto |
Gibt die Parameter für den automatischen Benutzer an, der einen Task im Batch-Dienst 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-Dateifreigabe 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 Batch-Pools, sofern 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 dem 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 Batch-Dienst. |
Cloud |
Das Ergebnis der Auflistung der Pools in einem Konto. |
Cloud |
Die Konfiguration für Computeknoten in einem Pool basierend auf der Azure Cloud Services-Plattform. |
Compute |
Wie Aufgaben auf Computeknoten in einem Pool verteilt werden. |
Compute |
Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet. |
Container |
Die Konfiguration für containerfähige Pools. |
Container |
Eine private Containerregistrierung. |
Container |
Die zu verwendende Containertechnologie. |
Container |
Der Speicherort des Aufgabenarbeitsverzeichnisses des Containers. |
Data |
Einstellungen, die von den Datenträgern verwendet werden, die Computeknoten im Pool zugeordnet sind. Wenn Sie die angefügten Datenträger verwenden, müssen Sie sie innerhalb eines virtuellen Computers einbinden und formatieren, um sie zu verwenden. |
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 Datenträgerverschlüsselungskonfiguration, die auf Computeknoten im Pool angewendet wird. Die Konfiguration der Datenträgerverschlüsselung wird in einem Linux-Pool, der mit dem Azure Compute Gallery-Image erstellt wurde, nicht unterstützt. |
Disk |
Die Liste der Datenträgerziele Der Batch-Dienst verschlüsselt auf dem Computeknoten. |
Dynamic |
Der Bereich der dynamischen VNET-Zuweisung. |
Elevation |
Die Höhenstufe des Benutzers. |
Environment |
Eine Umgebungsvariable, die für einen Taskprozess 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-Katalogimage. Informationen zum Abrufen der Liste aller von Azure Batch überprüften Azure Marketplace Imageverweise finden Sie im Vorgang "Unterstützte Images auflisten". |
Inbound |
Das Protokoll des Endpunkts. |
Inbound |
Ein NAT-Pool für eingehenden Datenverkehr, 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 Batch-Dienstressource 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 subnetzspezifischen Bereich oder ein 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 Batch-Dienst kommuniziert. |
Node |
Knotenplatzierungskonfiguration für einen Pool. |
Node |
Die Platzierungsrichtlinie zum Zuweisen 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 Batch-Pools, sofern konfiguriert. |
Pool |
Der aktuelle Zustand 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 |
Ein Fehler, der beim Ändern der Größe eines Pools aufgetreten ist. |
Resource |
Eine einzelne Datei oder mehrere Dateien, die auf einen Computeknoten heruntergeladen werden sollen. |
Resource |
Statistiken im Zusammenhang mit dem Ressourcenverbrauch durch Computeknoten in einem Pool. |
Security |
Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die VM-Skalierungsgruppe an. |
Security |
Gibt den SecurityType des virtuellen Computers an. Es muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren. |
Service |
Gibt die Referenz-ID des Dienstartefakts an, die verwendet wird, um dieselbe Imageversion für alle virtuellen Computer in der Skalierungsgruppe festzulegen, wenn die neueste Imageversion verwendet wird. |
Start |
Eine Aufgabe, die ausgeführt wird, wenn ein Knoten einen Pool im Azure Batch-Dienst hinzuschließt oder wenn der Computeknoten neu gestartet oder ein neuer Image erstellt wird. |
Storage |
Der Speicherkontotyp zum Erstellen von Datenträgern oder Betriebssystemdatenträgern. |
Task |
Die Containereinstellungen für einen Task. |
Task |
Gibt an, wie Tasks auf Computeknoten verteilt werden sollen. |
Uefi |
Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden. |
Usage |
Statistiken im Zusammenhang mit Poolnutzungsinformationen. |
User |
Eigenschaften, die zum Erstellen eines Benutzers zum Ausführen von Aufgaben auf einem Azure Batch Computeknoten verwendet werden. |
User |
Die vom Benutzer zugewiesene Identität |
User |
Die Definition der Benutzeridentität, unter der der Task ausgeführt wird. |
Virtual |
Die Konfiguration für Computeknoten in einem Pool basierend auf der Azure Virtual Machines-Infrastruktur. |
VMExtension |
Die Konfiguration für VM-Erweiterungen. |
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 Pool, die ausgeführt werden. Ein Pool wechselt in diesen Zustand, wenn er erstellt wird und wenn keine Vorgänge für den Pool ausgeführt werden, um die Anzahl der Computeknoten zu ändern. |
stopping |
string |
Die Größe des Pools wurde geändert, aber der Benutzer hat angefordert, dass die Größenänderung beendet wird, aber die Beendigungsanforderung wurde 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 nicht angegeben wird, wird die Standardversion bereitgestellt. |
AutoScaleRun
Die Ergebnisse und Fehler bei der Ausführung einer Formel für die automatische Skalierung des Pools.
Name | Typ | Beschreibung |
---|---|---|
error |
Details zum Fehler beim Auswerten der Formel für die automatische Skalierung im Pool, wenn die Auswertung nicht erfolgreich war. |
|
results |
string |
Die Endwerte aller Variablen, die bei der Auswertung der Formel für die autoskalierte Skalierung verwendet werden. |
timestamp |
string |
Der Zeitpunkt, zu dem die Formel für die automatische Skalierung zuletzt ausgewertet wurde. |
AutoScaleRunError
Ein Fehler, der beim Ausführen oder Auswerten einer Poolautoskalierungsformel aufgetreten ist.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Ein Bezeichner für den Fehler bei der automatischen Skalierung. Codes sind unveränderlich und sollten programmgesteuert verwendet werden. |
message |
string |
Eine Meldung, die den Fehler bei der automatischen Skalierung beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
values |
Eine Liste mit zusätzlichen Fehlerdetails im Zusammenhang mit dem Fehler bei der automatischen Skalierung. |
AutoUserScope
Der Bereich für den automatischen Benutzer
Name | Typ | Beschreibung |
---|---|---|
pool |
string |
Gibt an, dass der Task als allgemeines automatisches Benutzerkonto ausgeführt wird, das auf jedem Computeknoten in einem Pool erstellt wird. |
task |
string |
Gibt an, dass der Dienst einen neuen Benutzer für den Task erstellen soll. |
AutoUserSpecification
Gibt die Parameter für den automatischen Benutzer an, der einen Task im Batch-Dienst ausführt.
Name | Typ | Beschreibung |
---|---|---|
elevationLevel |
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 Schlüssel des Azure-Speicherkontos. |
accountName |
string |
Der Name des Azure Storage-Kontos. |
blobfuseOptions |
string |
Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen. |
containerName |
string |
Der Azure Blob Storage Containername. |
identityReference |
Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf containerName verwendet werden soll. |
|
relativeMountPath |
string |
Der relative Pfad auf dem Computeknoten, auf dem das Dateisystem eingebunden wird. |
sasKey |
string |
Das Azure Storage-SAS-Token. |
AzureFileShareConfiguration
Informationen, die zum Herstellen einer Verbindung mit einer Azure-Dateifreigabe verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
accountKey |
string |
Der Azure Storage-Kontoschlüssel |
accountName |
string |
Der Name des Azure Storage-Kontos. |
azureFileUrl |
string |
Die Azure Files-URL. |
mountOptions |
string |
Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen. |
relativeMountPath |
string |
Der relative Pfad auf dem Computeknoten, auf dem das Dateisystem eingebunden 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 sollten programmgesteuert verwendet werden. |
message |
Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
|
values |
Eine Auflistung von Schlüssel-Wert-Paaren mit zusätzlichen Details zum Fehler. |
BatchErrorDetail
Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.
Name | Typ | Beschreibung |
---|---|---|
key |
string |
Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt. |
value |
string |
Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind. |
BatchPoolIdentity
Die Identität des Batch-Pools, sofern konfiguriert.
Name | Typ | Beschreibung |
---|---|---|
type |
Die Identität des Batch-Pools, sofern konfiguriert. |
|
userAssignedIdentities |
Die Liste der Benutzeridentitäten, die dem Batch-Konto zugeordnet sind. |
CachingType
Der Typ der Zwischenspeicherung, die für den Datenträger aktiviert werden soll.
Name | Typ | Beschreibung |
---|---|---|
none |
string |
Der Zwischenspeichermodus für den Datenträger ist nicht aktiviert. |
readonly |
string |
Der Cachemodus für den Datenträger ist schreibgeschützter. |
readwrite |
string |
Der Zwischenspeichermodus für den Datenträger ist Lese- und Schreibzugriff. |
CertificateReference
Ein Verweis auf ein Zertifikat, das auf Computeknoten in einem Pool installiert werden soll.
Name | Typ | Beschreibung |
---|---|---|
storeLocation |
Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in dem das Zertifikat installiert werden soll. |
|
storeName |
string |
Der Name des Zertifikatspeichers auf dem Computeknoten, in dem 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 dem das Zertifikat installiert werden soll.
Name | Typ | Beschreibung |
---|---|---|
currentuser |
string |
Zertifikate sollten im CurrentUser-Zertifikatspeicher installiert werden. |
localmachine |
string |
Zertifikate sollten im LocalMachine-Zertifikatspeicher installiert werden. |
CertificateVisibility
Welche Benutzerkonten auf dem Computeknoten Zugriff auf die privaten Daten des Zertifikats haben sollen.
Name | Typ | Beschreibung |
---|---|---|
remoteuser |
string |
Das Zertifikat sollte für die Benutzerkonten sichtbar sein, unter denen Benutzer remote auf den Computeknoten zugreifen. |
starttask |
string |
Das Zertifikat sollte für das Benutzerkonto sichtbar sein, unter dem der StartTask ausgeführt wird. Beachten Sie, dass dieses Zertifikat auch für den Task sichtbar ist, wenn der AutoUser-Bereich sowohl für startTask als auch für einen Task pool ist. |
task |
string |
Das Zertifikat sollte für die Benutzerkonten sichtbar sein, unter denen Auftragsaufgaben ausgeführt werden. |
CIFSMountConfiguration
Informationen, die zum Herstellen einer Verbindung mit einem CIFS-Dateisystem verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
mountOptions |
string |
Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen. |
password |
string |
Das Kennwort, das für die Authentifizierung beim CIFS-Dateisystem verwendet werden soll. |
relativeMountPath |
string |
Der relative Pfad auf dem Computeknoten, auf dem das Dateisystem eingebunden wird. |
source |
string |
Der URI des dateisystems, das eingebunden werden soll. |
username |
string |
Der Benutzer, der für die Authentifizierung beim CIFS-Dateisystem verwendet werden soll. |
CloudPool
Ein Pool im Azure Batch-Dienst.
Name | Typ | Beschreibung |
---|---|---|
allocationState |
Gibt an, ob die Größe des Pools geändert wird. |
|
allocationStateTransitionTime |
string |
Der Zeitpunkt, zu dem der Pool in seinen aktuellen Zuordnungsstatus gelangt ist. |
applicationLicenses |
string[] |
Die Liste der Anwendungslizenzen, die der Batch-Dienst auf jedem Computeknoten im Pool zur Verfügung stellt. |
applicationPackageReferences |
Die Liste der Pakete, die auf jedem Computeknoten im Pool installiert werden sollen. |
|
autoScaleEvaluationInterval |
string |
Das Zeitintervall, in dem die Poolgröße gemäß der Formel für die autoskalierte Skalierung automatisch angepasst werden soll. |
autoScaleFormula |
string |
Eine Formel für die gewünschte Anzahl von Computeknoten im Pool. |
autoScaleRun |
Die Ergebnisse und Fehler der letzten Ausführung der Formel für die autoskalierte Skalierung. |
|
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 . |
|
cloudServiceConfiguration |
Die Clouddienstkonfiguration für den Pool. |
|
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/low-priority, die sich derzeit im Pool befinden. |
currentNodeCommunicationMode |
Der aktuelle Zustand 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 Batch-Pools, sofern 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 benutzerdefinierten Tags, die dem Pool zugeordnet sind. |
startTask |
Ein Task, der auf jedem Computeknoten ausgeführt werden soll, wenn er dem Pool beitritt. |
|
state |
Der aktuelle Zustand des Pools. |
|
stateTransitionTime |
string |
Der Zeitpunkt, zu dem der Pool in seinen aktuellen Zustand gelangt ist. |
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/low-priority im Pool. |
targetNodeCommunicationMode |
Der kommunikationsmodus für den gewünschten Knoten für den Pool. |
|
taskSchedulingPolicy |
Wie Aufgaben auf Computeknoten in einem Pool verteilt werden. |
|
taskSlotsPerNode |
integer |
Die Anzahl von Taskslots, die verwendet werden können, um gleichzeitige Tasks auf einem einzelnen Computeknoten im Pool auszuführen. |
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 der virtuellen 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 zum Abrufen des nächsten Resultsets. |
value |
Die Liste der Pools. |
CloudServiceConfiguration
Die Konfiguration für Computeknoten in einem Pool basierend auf der Azure Cloud Services-Plattform.
Name | Typ | Beschreibung |
---|---|---|
osFamily |
string |
Die Azure-Gastbetriebssystemfamilie, die auf den virtuellen Computern im Pool installiert werden soll. |
osVersion |
string |
Die Version des Azure-Gastbetriebssystems, die auf den virtuellen Computern im Pool installiert werden soll. |
ComputeNodeFillType
Wie Aufgaben auf Computeknoten in einem Pool verteilt werden.
Name | Typ | Beschreibung |
---|---|---|
pack |
string |
Jedem Computeknoten im Pool sollten so viele Aufgaben wie möglich (taskSlotsPerNode) zugewiesen werden, bevor Aufgaben dem nächsten Computeknoten im Pool zugewiesen werden. |
spread |
string |
Aufgaben sollten gleichmäßig auf allen Computeknoten im Pool zugewiesen werden. |
ComputeNodeIdentityReference
Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.
Name | Typ | Beschreibung |
---|---|---|
resourceId |
string |
Die ARM-Ressourcen-ID der vom Benutzer zugewiesenen Identität. |
ContainerConfiguration
Die Konfiguration für containerfähige Pools.
Name | Typ | Beschreibung |
---|---|---|
containerImageNames |
string[] |
Die Auflistung von Containerimagenamen. |
containerRegistries |
Zusätzliche private Registrierungen, aus denen Container abgerufen werden können. |
|
type |
Die zu verwendende Containertechnologie. |
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 Container Registry 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 beim Registrierungsserver angemeldet werden soll. |
ContainerType
Die zu verwendende Containertechnologie.
Name | Typ | Beschreibung |
---|---|---|
criCompatible |
string |
Zum Starten der Container wird eine CRI-basierte Technologie verwendet. |
dockerCompatible |
string |
Zum Starten der Container wird eine Docker-kompatible Containertechnologie verwendet. |
ContainerWorkingDirectory
Der Speicherort des Aufgabenarbeitsverzeichnisses des Containers.
Name | Typ | Beschreibung |
---|---|---|
containerImageDefault |
string |
Verwenden Sie das im Containerimage definierte Arbeitsverzeichnis. Beachten Sie, dass dieses Verzeichnis nicht die von Batch heruntergeladenen Ressourcendateien enthält. |
taskWorkingDirectory |
string |
Verwenden Sie das Standardmäßige Batch-Dienstarbeitsverzeichnis Task, das die Aufgabenressourcendateien enthält, die von Batch aufgefüllt werden. |
DataDisk
Einstellungen, die von den Datenträgern verwendet werden, die Computeknoten im Pool zugeordnet sind. Wenn Sie die angefügten Datenträger verwenden, müssen Sie sie innerhalb eines virtuellen Computers einbinden und formatieren, um sie zu verwenden.
Name | Typ | Beschreibung |
---|---|---|
caching |
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 Nummer der logischen Einheit. |
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 kurzlebige Betriebssystemdatenträger wird im VM-Cache gespeichert. |
DiffDiskSettings
Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom Computeknoten (VM) verwendet wird.
Name | Typ | Beschreibung |
---|---|---|
placement |
Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger für alle VMs im Pool an. |
DiskEncryptionConfiguration
Die Datenträgerverschlüsselungskonfiguration, die auf Computeknoten im Pool angewendet wird. Die Konfiguration der Datenträgerverschlüsselung wird in einem Linux-Pool, der mit dem Azure Compute Gallery-Image erstellt wurde, nicht unterstützt.
Name | Typ | Beschreibung |
---|---|---|
targets |
Die Liste der Datenträgerziele Batch Service verschlüsselt auf dem Computeknoten. |
DiskEncryptionTarget
Die Liste der Datenträgerziele Der Batch-Dienst verschlüsselt auf dem Computeknoten.
Name | Typ | Beschreibung |
---|---|---|
osdisk |
string |
Der Betriebssystemdatenträger auf dem Computeknoten ist verschlüsselt. |
temporarydisk |
string |
Der temporäre Datenträger auf dem Computeknoten wird verschlüsselt. Unter Linux gilt diese Verschlüsselung für andere Partitionen (z. B. auf eingebundenen Datenträgern), wenn die Verschlüsselung zum Startzeitpunkt erfolgt. |
DynamicVNetAssignmentScope
Der Bereich der dynamischen VNET-Zuweisung.
Name | Typ | Beschreibung |
---|---|---|
job |
string |
Die dynamische VNET-Zuweisung erfolgt auftragsbezogen. |
none |
string |
Es ist keine dynamische VNET-Zuweisung aktiviert. |
ElevationLevel
Die Höhenstufe des Benutzers.
Name | Typ | Beschreibung |
---|---|---|
admin |
string |
Der Benutzer ist ein Benutzer mit erhöhtem Zugriff und arbeitet mit vollständigen Administratorberechtigungen. |
nonadmin |
string |
Der Benutzer ist ein Standardbenutzer ohne erhöhten Zugriff. |
EnvironmentSetting
Eine Umgebungsvariable, die für einen Taskprozess festgelegt werden soll.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name der Umgebungsvariablen. |
value |
string |
Der Wert der Umgebungsvariablen. |
ErrorMessage
Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde.
Name | Typ | Beschreibung |
---|---|---|
lang |
string |
Der Sprachcode der Fehlermeldung |
value |
string |
Der Text der Meldung. |
ImageReference
Ein Verweis auf ein Azure Virtual Machines Marketplace-Image oder ein Azure Compute-Katalogimage. Informationen zum Abrufen der Liste aller von Azure Batch überprüften Azure Marketplace Imageverweise finden Sie im Vorgang "Unterstützte Images auflisten".
Name | Typ | Beschreibung |
---|---|---|
exactVersion |
string |
Die spezifische Version des Plattformimages oder Marketplace-Images, das zum Erstellen des Knotens verwendet wird. Dieses schreibgeschützte Feld unterscheidet sich von "version" nur, wenn der für "version" angegebene Wert bei der Erstellung des Pools "neueste" war. |
offer |
string |
Der Angebotstyp des Azure Virtual Machines Marketplace-Images. |
publisher |
string |
Der Herausgeber des Azure Virtual Machines Marketplace-Images. |
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-Katalogimages. Computeknoten im Pool werden mithilfe dieser Image-ID erstellt. Dies hat das Format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} oder /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} für immer die neueste Imageversion. |
InboundEndpointProtocol
Das Protokoll des Endpunkts.
Name | Typ | Beschreibung |
---|---|---|
tcp |
string |
Verwenden Sie TCP für den Endpunkt. |
udp |
string |
Verwenden Sie UDP für den Endpunkt. |
InboundNATPool
Ein NAT-Pool für eingehenden Datenverkehr, der verwendet werden kann, um bestimmte Ports auf Computeknoten in einem Batchpool extern zu adressieren.
Name | Typ | Beschreibung |
---|---|---|
backendPort |
integer |
Die Portnummer auf dem Computeknoten. |
frontendPortRangeEnd |
integer |
Die letzte Portnummer im Bereich externer Ports, die verwendet wird, um eingehenden Zugriff auf den back-EndPort auf einzelnen Computeknoten zu ermöglichen. |
frontendPortRangeStart |
integer |
Die erste Portnummer im Bereich der externen Ports, die verwendet wird, um eingehenden Zugriff auf den back-EndPort auf einzelnen Computeknoten zu ermöglichen. |
name |
string |
Der Name des Endpunkts. |
networkSecurityGroupRules |
Eine Liste der Netzwerksicherheitsgruppenregeln, 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-Adresse wird von Batch erstellt und verwaltet. Abhängig von der Größe des Pools können mehrere öffentliche IP-Adressen vorhanden sein. |
nopublicipaddresses |
string |
Es wird keine öffentliche IP-Adresse erstellt. |
usermanaged |
string |
Öffentliche IP-Adressen werden vom Benutzer bereitgestellt und zum Bereitstellen der Computeknoten verwendet. |
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 lang andauernde parallele Prozesse empfohlen. |
interactive |
string |
Der LOGON32_LOGON_INTERACTIVE Win32-Anmeldemodus. Die UAC ist für Windows VirtualMachineConfiguration-Pools aktiviert. Wenn diese Option mit einer Benutzeridentität mit erhöhten Rechten in einem Windows VirtualMachineConfiguration-Pool verwendet wird, wird die Benutzersitzung nur dann erhöht, wenn die von der Task-Befehlszeile ausgeführte Anwendung so konfiguriert ist, dass immer Administratorrechte erforderlich sind oder immer maximale Berechtigungen erforderlich sind. |
ManagedDisk
Name | Typ | Beschreibung |
---|---|---|
storageAccountType |
Der Speicherkontotyp für verwaltete Datenträger. |
MetadataItem
Ein Name-Wert-Paar, das einer Batch-Dienstressource zugeordnet ist.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name des Metadatenelements. |
value |
string |
Der Wert des Metadatenelements. |
MountConfiguration
Das Dateisystem, das auf jedem Knoten bereitgestellt werden soll.
Name | Typ | Beschreibung |
---|---|---|
azureBlobFileSystemConfiguration |
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 Bereich der dynamischen VNET-Zuweisung. |
|
enableAcceleratedNetworking |
boolean |
Gibt an, ob dieser Pool beschleunigten Netzwerkbetrieb 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 Subnetzes des virtuellen Netzwerks, dem die Computeknoten des Pools beitreten. Dies hat die Form /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 subnetzspezifischen Bereich oder ein Tag ausgeführt werden soll. |
|
priority |
integer |
Die Priorität für diese Regel. |
sourceAddressPrefix |
string |
Das Quelladresspräfix oder -tag, das bzw. 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 subnetzspezifischen Bereich oder ein Tag ausgeführt werden soll.
Name | Typ | Beschreibung |
---|---|---|
allow |
string |
Zugriff zulassen. |
deny |
string |
Zugriff verweigern. |
NFSMountConfiguration
Informationen, die zum Herstellen einer Verbindung mit einem NFS-Dateisystem verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
mountOptions |
string |
Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen. |
relativeMountPath |
string |
Der relative Pfad auf dem Computeknoten, auf dem das Dateisystem eingebunden wird. |
source |
string |
Der URI des dateisystems, das eingebunden werden soll. |
NodeCommunicationMode
Bestimmt, wie ein Pool mit dem Batch-Dienst kommuniziert.
Name | Typ | Beschreibung |
---|---|---|
classic |
string |
Knoten, die den klassischen Kommunikationsmodus verwenden, erfordern eingehende TCP-Kommunikation an den Ports 29876 und 29877 aus dem BatchNodeManagement. {region}" Diensttag und ausgehende TCP-Kommunikation an Port 443 zu "Storage.region" und "BatchNodeManagement. {region}"-Diensttags. |
default |
string |
Der Knotenkommunikationsmodus wird automatisch vom Batch-Dienst festgelegt. |
simplified |
string |
Knoten, die den vereinfachten Kommunikationsmodus verwenden, erfordern ausgehende TCP-Kommunikation an Port 443 an "BatchNodeManagement. {region}"-Diensttag. Es sind keine offenen eingehenden Ports erforderlich. |
NodePlacementConfiguration
Knotenplatzierungskonfiguration für einen Pool.
Name | Typ | Beschreibung |
---|---|---|
policy |
Knotenplatzierungsrichtlinientyp für Batchpools. |
NodePlacementPolicyType
Die Platzierungsrichtlinie zum Zuweisen von Knoten im Pool.
Name | Typ | Beschreibung |
---|---|---|
regional |
string |
Alle Knoten im Pool werden in derselben Region zugeordnet. |
zonal |
string |
Knoten im Pool werden auf verschiedene Verfügbarkeitszonen verteilt, wobei ein Optimalaufwand ausgeglichen wird. |
OSDisk
Einstellungen für den Betriebssystemdatenträger des Computeknotens (VM).
Name | Typ | Beschreibung |
---|---|---|
caching |
Gibt die Cacheanforderungen an. Mögliche Werte sind: None, ReadOnly, ReadWrite. Die Standardwerte sind: Keine für Standardspeicher. ReadOnly für Storage Premium. |
|
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 eingehender NAT-Pools, die verwendet werden können, um bestimmte Ports auf einem einzelnen Computeknoten extern zu adressieren. |
PoolIdentityType
Die Identität des Batch-Pools, sofern konfiguriert.
Name | Typ | Beschreibung |
---|---|---|
None |
string |
Dem Batchpool ist keine Identität zugeordnet. Durch die Einstellung |
UserAssigned |
string |
Der Batch-Pool verfügt über benutzerseitig zugewiesene Identitäten. |
PoolState
Der aktuelle Zustand 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, aber der Löschvorgang wurde noch nicht abgeschlossen. |
PoolStatistics
Enthält Nutzungs- und Ressourcennutzungsstatistiken für die Lebensdauer eines Pools.
Name | Typ | Beschreibung |
---|---|---|
lastUpdateTime |
string |
Der Zeitpunkt, zu dem die Statistiken zuletzt aktualisiert wurden. Alle Statistiken sind auf den Bereich zwischen startTime und lastUpdateTime beschränkt. |
resourceStats |
Statistiken im Zusammenhang mit dem Ressourcenverbrauch nach Computeknoten im Pool. |
|
startTime |
string |
Die Startzeit des von der Statistik abgedeckten Zeitbereichs. |
url |
string |
Die URL für die Statistiken. |
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 IP-Adressen, die der Batch-Dienst bei der Bereitstellung von Computeknoten verwendet. |
provision |
Der Bereitstellungstyp für öffentliche IP-Adressen für den Pool. |
ResizeError
Ein Fehler, der beim Ändern der Größe eines Pools aufgetreten ist.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Ein Bezeichner für den Fehler beim Ändern der Größe des Pools. Codes sind unveränderlich und sollten programmgesteuert verwendet werden. |
message |
string |
Eine Meldung, die den Fehler beim Ändern der Größe des Pools beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll. |
values |
Eine Liste mit zusätzlichen Fehlerdetails im Zusammenhang mit dem Fehler beim Ändern der Größe des Pools. |
ResourceFile
Eine einzelne Datei oder mehrere Dateien, die auf einen Computeknoten heruntergeladen werden sollen.
Name | Typ | Beschreibung |
---|---|---|
autoStorageContainerName |
string |
Der Name des Speichercontainers im Auto Storage-Konto. |
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 des Dateiberechtigungsmodus im oktalen Format. |
filePath |
string |
Der Speicherort auf dem Computeknoten, in den die Datei(en) heruntergeladen werden sollen, relativ zum Arbeitsverzeichnis des Tasks. |
httpUrl |
string |
Die URL der herunterzuladenden Bilds. |
identityReference |
Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf Azure Blob Storage verwendet werden soll, der durch storageContainerUrl oder httpUrl angegeben ist. |
|
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 für alle Computeknoten im Pool (Prozentsatz pro Knoten). |
avgDiskGiB |
number |
Der durchschnittliche belegte Speicherplatz in GiB für alle Computeknoten im Pool. |
avgMemoryGiB |
number |
Die durchschnittliche Arbeitsspeicherauslastung in GiB für alle Computeknoten im Pool. |
diskReadGiB |
number |
Die Gesamtdatenmenge in GiB der Datenträgerlesevorgänge auf allen Computeknoten im Pool. |
diskReadIOps |
integer |
Die Gesamtanzahl der Datenträgerlesevorgänge für alle Computeknoten im Pool. |
diskWriteGiB |
number |
Die Gesamtdatenmenge in GiB der Datenträgerschreibvorgänge auf allen Computeknoten im Pool. |
diskWriteIOps |
integer |
Die Gesamtanzahl der Datenträgerschreibvorgänge für alle Computeknoten im Pool. |
lastUpdateTime |
string |
Der Zeitpunkt, zu dem die Statistiken zuletzt aktualisiert wurden. Alle Statistiken sind auf den Bereich zwischen startTime und lastUpdateTime beschränkt. |
networkReadGiB |
number |
Die Gesamtdatenmenge in GiB der Netzwerklesevorgänge über alle Computeknoten im Pool hinweg. |
networkWriteGiB |
number |
Die Gesamtdatenmenge in GiB der Netzwerkschreibvorgänge auf allen Computeknoten im Pool. |
peakDiskGiB |
number |
Der spitzen belegte Speicherplatz in GiB für alle Computeknoten im Pool. |
peakMemoryGiB |
number |
Die Spitzenauslastung des Arbeitsspeichers in GiB für alle Computeknoten im Pool. |
startTime |
string |
Die Startzeit des von der Statistik abgedeckten Zeitbereichs. |
SecurityProfile
Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die VM-Skalierungsgruppe an.
Name | Typ | Beschreibung |
---|---|---|
encryptionAtHost |
boolean |
Diese Eigenschaft kann vom Benutzer in der Anforderung verwendet werden, um die Hostverschlüsselung für den virtuellen Computer oder die VM-Skalierungsgruppe zu aktivieren oder zu deaktivieren. Dadurch wird die Verschlüsselung für alle Datenträger aktiviert, einschließlich ressourcen-/temporärer Datenträger auf dem Host selbst. |
securityType |
Gibt den SecurityType des virtuellen Computers an. Es 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. Es muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren.
Name | Typ | Beschreibung |
---|---|---|
trustedLaunch |
string |
Der vertrauenswürdige Start bietet Schutz vor komplexen und permanenten Angriffstechniken. |
ServiceArtifactReference
Gibt die Referenz-ID des Dienstartefakts an, die verwendet wird, um dieselbe Imageversion für alle virtuellen Computer in der Skalierungsgruppe festzulegen, wenn die neueste Imageversion verwendet wird.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Die Referenz-ID des Dienstartefakts von ServiceArtifactReference |
StartTask
Eine Aufgabe, die ausgeführt wird, wenn ein Knoten einen Pool im Azure Batch-Dienst hinzuschließt oder wenn der Computeknoten neu gestartet oder ein neuer Image erstellt wird.
Name | Typ | Beschreibung |
---|---|---|
commandLine |
string |
Die Befehlszeile von StartTask. |
containerSettings |
Die Einstellungen für den Container, unter dem startTask ausgeführt wird. |
|
environmentSettings |
Eine Liste der Umgebungsvariableneinstellungen für startTask. |
|
maxTaskRetryCount |
integer |
Die maximale Anzahl von Wiederholungsversuchen für den Task. |
resourceFiles |
Eine Liste der Dateien, die vom Batch-Dienst auf den Computeknoten heruntergeladen werden, bevor die Befehlszeile ausgeführt wird. Es gibt eine maximale Größe für die Liste der Ressourcendateien. Wenn die maximale Größe überschritten wird, schlägt die Anforderung fehl, und der Antwortfehlercode lautet RequestEntityTooLarge. In diesem Fall muss die Sammlung von ResourceFiles verkleinert werden. Dies kann mithilfe von .zip-Dateien, Anwendungspaketen oder Docker-Containern erreicht werden. |
|
userIdentity |
Die Benutzeridentität, unter der startTask ausgeführt wird. |
|
waitForSuccess |
boolean |
Gibt an, ob der Batch-Dienst warten soll, bis die StartTask erfolgreich abgeschlossen wurde (d. h. das Beenden mit Exitcode 0), bevor Aufgaben auf dem Computeknoten geplant werden. |
StorageAccountType
Der Speicherkontotyp zum Erstellen von Datenträgern oder Betriebssystemdatenträgern.
Name | Typ | Beschreibung |
---|---|---|
premium_lrs |
string |
Der Datenträger/Betriebssystemdatenträger sollte lokal redundanten Premium-Speicher verwenden. |
standard_lrs |
string |
Der Datenträger/Betriebssystemdatenträger sollte lokal redundanten Standardspeicher verwenden. |
standardssd_lrs |
string |
Der Datenträger/Betriebssystemdatenträger sollte lokal redundanten SSD-Standardspeicher verwenden. |
TaskContainerSettings
Die Containereinstellungen für einen Task.
Name | Typ | Beschreibung |
---|---|---|
containerRunOptions |
string |
Zusätzliche Optionen für den Befehl zum Erstellen von Containern. |
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 Aufgabenarbeitsverzeichnisses des Containers. |
TaskSchedulingPolicy
Gibt an, wie Tasks auf Computeknoten verteilt werden sollen.
Name | Typ | Beschreibung |
---|---|---|
nodeFillType |
Wie Aufgaben auf 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. |
UsageStatistics
Statistiken im Zusammenhang mit Poolnutzungsinformationen.
Name | Typ | Beschreibung |
---|---|---|
dedicatedCoreTime |
string |
Die aggregierte Wanduhrzeit der dedizierten Computeknotenkerne, die Teil des Pools sind. |
lastUpdateTime |
string |
Der Zeitpunkt, zu dem die Statistiken zuletzt aktualisiert wurden. Alle Statistiken sind auf den Bereich zwischen startTime und lastUpdateTime beschränkt. |
startTime |
string |
Die Startzeit des von der Statistik abgedeckten Zeitbereichs. |
UserAccount
Eigenschaften, die zum Erstellen eines Benutzers zum Ausführen von Aufgaben auf einem Azure Batch Computeknoten verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
elevationLevel |
Die Höhenstufe des Benutzerkontos. |
|
linuxUserConfiguration |
Die Linux-spezifische Benutzerkonfiguration für das Benutzerkonto. |
|
name |
string |
Der Name des Benutzerkontos. Namen können beliebige Unicode-Zeichen bis zu einer maximalen Länge von 20 enthalten. |
password |
string |
Das Kennwort für das Benutzerkonto. |
windowsUserConfiguration |
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 der Task ausgeführt wird.
Name | Typ | Beschreibung |
---|---|---|
autoUser |
Der automatische Benutzer, unter dem der Task ausgeführt wird. |
|
username |
string |
Der Name der Benutzeridentität, unter der der Task ausgeführt wird. |
VirtualMachineConfiguration
Die Konfiguration für Computeknoten in einem Pool basierend auf der Azure Virtual Machines-Infrastruktur.
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 Konfiguration der Datenträgerverschlüsselung für den Pool. |
|
extensions |
Die VM-Erweiterung für den Pool. |
|
imageReference |
Ein Verweis auf das Azure Virtual Machines Marketplace-Image oder das zu verwendende benutzerdefinierte VM-Image. |
|
licenseType |
string |
Der Typ der lokalen Lizenz, die bei der Bereitstellung des Betriebssystems verwendet werden soll. Windows_Server: Die lokale Lizenz gilt für Windows Server. Windows_Client: Die lokale Lizenz gilt für Den Windows-Client. |
nodeAgentSKUId |
string |
Die SKU des Batch Compute Node-Agents, der auf Computeknoten im Pool bereitgestellt werden soll. |
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 VM-Skalierungsgruppe an. |
|
serviceArtifactReference |
Gibt die Dienstartefaktverweis-ID an, die verwendet wird, um dieselbe Imageversion für alle virtuellen Computer in der Skalierungsgruppe festzulegen, wenn die neueste Imageversion verwendet wird. |
|
windowsConfiguration |
Windows-Betriebssystemeinstellungen auf dem virtuellen Computer. |
VMExtension
Die Konfiguration für VM-Erweiterungen.
Name | Typ | Beschreibung |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zur Bereitstellungszeit verfügbar ist. Abgesehen von erneuten Bereitstellungen führt die Erweiterung nach der Bereitstellung jedoch keine Upgrades für Nebenversionen aus, selbst wenn diese Eigenschaft auf „true“ festgelegt ist. |
enableAutomaticUpgrade |
boolean |
Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist. |
name |
string |
Der Name der VM-Erweiterung. |
protectedSettings |
object |
Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder überhaupt keine geschützten Einstellungen enthalten. |
provisionAfterExtensions |
string[] |
Die Auflistung der Erweiterungsnamen. |
publisher |
string |
Der Name des Erweiterungshandlerherausgebers. |
settings |
object |
JSON-formatierte öffentliche Einstellungen für die Erweiterung. |
type |
string |
Der Typ der Erweiterung. |
typeHandlerVersion |
string |
Die Version des Skripthandlers. |
WindowsConfiguration
Windows-Betriebssystemeinstellungen, die auf den virtuellen Computer angewendet werden sollen.
Name | Typ | Beschreibung |
---|---|---|
enableAutomaticUpdates |
boolean |
Gibt an, ob automatische Updates auf dem virtuellen Computer aktiviert sind. |
WindowsUserConfiguration
Eigenschaften, die zum Erstellen eines Benutzerkontos auf einem Windows-Computeknoten verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
loginMode |
Der Anmeldemodus für den Benutzer |