Pool - List
Een lijst met alle pools die worden gekoppeld
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-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
batch
|
path | True |
string |
De basis-URL voor alle Azure Batch-serviceaanvragen. |
api-version
|
query | True |
string |
Client-API-versie. |
$expand
|
query |
string |
Een OData-$expand-component. |
|
$filter
|
query |
string |
Een OData-$filter-component. Zie https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-poolsvoor meer informatie over het maken van dit filter. |
|
$select
|
query |
string |
Een OData-$select-component. |
|
maxresults
|
query |
integer int32 |
Het maximum aantal items dat moet worden geretourneerd in het antwoord. Er kunnen maximaal 1000 pools worden geretourneerd. |
|
timeout
|
query |
integer int32 |
De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. Als de waarde groter is dan 30, wordt in plaats daarvan de standaardwaarde gebruikt. |
Aanvraagkoptekst
Media Types: "application/json; odata=minimalmetadata"
Name | Vereist | Type | Description |
---|---|---|---|
client-request-id |
string uuid |
De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Of de server de clientaanvraag-id in het antwoord moet retourneren. |
|
ocp-date |
string date-time-rfc1123 |
Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze expliciet in als u de REST API rechtstreeks aanroept. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Een antwoord met de lijst met pools. Kopteksten
|
|
Other Status Codes |
De fout van de Batch-service. |
Beveiliging
azure_auth
Microsoft Entra OAuth 2.0-verificatiecodestroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Authorization
Type:
apiKey
In:
header
Voorbeelden
Pool list
Voorbeeldaanvraag
GET account.region.batch.azure.com/pools?api-version=2024-07-01.20.0
Voorbeeldrespons
{
"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"
}
}
]
}
Definities
Name | Description |
---|---|
Allocation |
Of de grootte van de pool wordt gewijzigd. |
Application |
Een verwijzing naar een pakket dat moet worden geïmplementeerd op rekenknooppunten. |
Automatic |
De configuratieparameters die worden gebruikt voor het uitvoeren van automatische upgrade van het besturingssysteem. |
Auto |
De resultaten en fouten van een uitvoering van een formule voor automatische schaalaanpassing van pools. |
Auto |
Er is een fout opgetreden bij het uitvoeren of evalueren van een formule voor automatische schaalaanpassing van pools. |
Auto |
Het bereik voor de automatische gebruiker |
Auto |
Hiermee geeft u de parameters op voor de automatische gebruiker die een taak uitvoert in de Batch-service. |
Azure |
Informatie die wordt gebruikt om verbinding te maken met een Azure Storage-container met behulp van Blobfuse. |
Azure |
Informatie die wordt gebruikt om verbinding te maken met een Azure Fileshare. |
Batch |
Er is een foutbericht ontvangen van de Azure Batch-service. |
Batch |
Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie. |
Batch |
De identiteit van de Batch-pool, indien geconfigureerd. |
Caching |
Het type caching dat voor de schijf moet worden ingeschakeld. |
Certificate |
Een verwijzing naar een certificaat dat moet worden geïnstalleerd op rekenknooppunten in een pool. |
Certificate |
De locatie van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd. |
Certificate |
Welke gebruikersaccounts op het rekenknooppunt toegang moeten hebben tot de persoonlijke gegevens van het certificaat. |
CIFSMount |
Informatie die wordt gebruikt om verbinding te maken met een CIFS-bestandssysteem. |
Cloud |
Een pool in de Azure Batch-service. |
Cloud |
Het resultaat van het weergeven van de pools in een account. |
Compute |
Hoe taken worden verdeeld over rekenknooppunten in een pool. |
Compute |
De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt. |
Container |
De configuratie voor pools waarvoor containers zijn ingeschakeld. |
Container |
De vermelding van het pad en de koppelingsmodus die u wilt koppelen aan de taakcontainer. |
Container |
De paden die worden gekoppeld aan de container van de containertaak. |
Container |
Een privécontainerregister. |
Container |
De containertechnologie die moet worden gebruikt. |
Container |
De locatie van de werkmap containertaak. |
Data |
Instellingen die worden gebruikt door de gegevensschijven die zijn gekoppeld aan rekenknooppunten in de pool. Wanneer u gekoppelde gegevensschijven gebruikt, moet u de schijven vanuit een virtuele machine koppelen en formatteren om ze te kunnen gebruiken. |
Diff |
Hiermee geeft u de tijdelijke schijfplaatsing voor besturingssysteemschijf voor alle rekenknooppunten (VM's) in de groep. |
Diff |
Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf die wordt gebruikt door het rekenknooppunt (VM). |
Disk |
De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de pool. Schijfversleutelingsconfiguratie wordt niet ondersteund in een Linux-pool die is gemaakt met de installatiekopie van de Azure Compute Gallery. |
Disk |
De lijst met schijfdoelen voor Batch Service wordt versleuteld op het rekenknooppunt. |
Dynamic |
Het bereik van dynamische vnet-toewijzing. |
Elevation |
Het hoogteniveau van de gebruiker. |
Environment |
Een omgevingsvariabele die moet worden ingesteld voor een taakproces. |
Error |
Een foutbericht dat is ontvangen in een Azure Batch-foutreactie. |
Image |
Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een Azure Compute Gallery-installatiekopieën. Zie de bewerking Ondersteunde installatiekopieën weergeven om de lijst met alle Azure Marketplace-installatiekopieën op te halen die zijn geverifieerd door Azure Batch. |
Inbound |
Het protocol van het eindpunt. |
Inbound |
Een binnenkomende NAT-pool die kan worden gebruikt om specifieke poorten op rekenknooppunten in een batchgroep extern aan te pakken. |
IPAddress |
Het inrichtingstype voor openbare IP-adressen voor de groep. |
Linux |
Eigenschappen die worden gebruikt voor het maken van een gebruikersaccount op een Linux-rekenknooppunt. |
Login |
De aanmeldingsmodus voor de gebruiker |
Managed |
|
Metadata |
Een naam-waardepaar dat is gekoppeld aan een Batch-serviceresource. |
Mount |
Het bestandssysteem dat op elk knooppunt moet worden gekoppeld. |
Name |
Vertegenwoordigt een naam-waardepaar. |
Network |
De netwerkconfiguratie voor een pool. |
Network |
Een regel voor een netwerkbeveiligingsgroep die moet worden toegepast op een binnenkomend eindpunt. |
Network |
De actie die moet worden uitgevoerd voor een opgegeven IP-adres, subnetbereik of tag. |
NFSMount |
Informatie die wordt gebruikt om verbinding te maken met een NFS-bestandssysteem. |
Node |
Bepaalt hoe een pool communiceert met de Batch-service. |
Node |
Knooppuntplaatsingsconfiguratie voor een pool. |
Node |
Het plaatsingsbeleid voor het toewijzen van knooppunten in de pool. |
OSDisk |
Instellingen voor de besturingssysteemschijf van het rekenknooppunt (VM). |
Pool |
De eindpuntconfiguratie voor een pool. |
Pool |
De identiteit van de Batch-pool, indien geconfigureerd. |
Pool |
De huidige status van de pool. |
Pool |
Bevat gebruiks- en resourcegebruiksstatistieken voor de levensduur van een pool. |
Public |
De configuratie van het openbare IP-adres van de netwerkconfiguratie van een pool. |
Resize |
Er is een fout opgetreden bij het wijzigen van het formaat van een pool. |
Resource |
Eén bestand of meerdere bestanden die moeten worden gedownload naar een rekenknooppunt. |
Resource |
Statistieken met betrekking tot resourceverbruik door rekenknooppunten in een pool. |
Rolling |
De configuratieparameters die worden gebruikt tijdens het uitvoeren van een rolling upgrade. |
Security |
Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor het niet behouden van de firmwarestatus in de VMGuestState-blob. Opmerking: deze kan alleen worden ingesteld voor vertrouwelijke VM's en is vereist bij het gebruik van vertrouwelijke VM's. |
Security |
Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op. |
Security |
Hiermee geeft u het SecurityType van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen. |
Service |
Hiermee geeft u de referentie-id voor serviceartefacten op die wordt gebruikt voor het instellen van dezelfde installatiekopieënversie voor alle virtuele machines in de schaalset wanneer u de meest recente installatiekopieënversie gebruikt. |
Start |
Een taak die wordt uitgevoerd wanneer een knooppunt lid wordt van een pool in de Azure Batch-service of wanneer het rekenknooppunt opnieuw wordt opgestart of opnieuw wordt hersteld. |
Storage |
Het type opslagaccount voor gebruik bij het maken van gegevensschijven of een besturingssysteemschijf. |
Task |
De containerinstellingen voor een taak. |
Task |
Hiermee geeft u op hoe taken moeten worden verdeeld over rekenknooppunten. |
Uefi |
Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine. |
Upgrade |
Hiermee geeft u de modus van een upgrade naar virtuele machines in de schaalset. |
Upgrade |
Beschrijft een upgradebeleid: automatisch, handmatig of rolling. |
Usage |
Statistieken met betrekking tot poolgebruiksgegevens. |
User |
Eigenschappen die worden gebruikt om een gebruiker te maken die wordt gebruikt om taken uit te voeren op een Azure Batch Compute-knooppunt. |
User |
De door de gebruiker toegewezen identiteit |
User |
De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd. |
Virtual |
De configuratie voor rekenknooppunten in een pool op basis van de Azure Virtual Machines-infrastructuur. |
VMDisk |
Hiermee geeft u de beveiligingsprofielinstellingen voor de beheerde schijf. Opmerking: deze kan alleen worden ingesteld voor vertrouwelijke VM's en vereist bij het gebruik van vertrouwelijke VM's. |
VMExtension |
De configuratie voor extensies van virtuele machines. |
Windows |
Windows-besturingssysteeminstellingen die van toepassing zijn op de virtuele machine. |
Windows |
Eigenschappen die worden gebruikt voor het maken van een gebruikersaccount op een Windows-rekenknooppunt. |
AllocationState
Of de grootte van de pool wordt gewijzigd.
Name | Type | Description |
---|---|---|
resizing |
string |
De grootte van de pool wordt gewijzigd; Dat wil gezegd, rekenknooppunten worden toegevoegd aan of verwijderd uit de pool. |
steady |
string |
De grootte van de pool wordt niet gewijzigd. Er zijn geen wijzigingen in het aantal rekenknooppunten in de pool die wordt uitgevoerd. Een pool voert deze status in wanneer deze wordt gemaakt en wanneer er geen bewerkingen worden uitgevoerd in de pool om het aantal rekenknooppunten te wijzigen. |
stopping |
string |
De grootte van de pool is gewijzigd, maar de gebruiker heeft gevraagd de grootte te stoppen, maar de stopaanvraag is nog niet voltooid. |
ApplicationPackageReference
Een verwijzing naar een pakket dat moet worden geïmplementeerd op rekenknooppunten.
Name | Type | Description |
---|---|---|
applicationId |
string |
De id van de toepassing die moet worden geïmplementeerd. |
version |
string |
De versie van de toepassing die moet worden geïmplementeerd. Als u dit weglaat, wordt de standaardversie geïmplementeerd. |
AutomaticOSUpgradePolicy
De configuratieparameters die worden gebruikt voor het uitvoeren van automatische upgrade van het besturingssysteem.
Name | Type | Description |
---|---|---|
disableAutomaticRollback |
boolean |
Of de functie voor terugdraaien van installatiekopieën van het besturingssysteem moet worden uitgeschakeld. |
enableAutomaticOSUpgrade |
boolean |
Hiermee wordt aangegeven of upgrades van het besturingssysteem automatisch moeten worden toegepast op exemplaren van schaalsets wanneer een nieuwere versie van de installatiekopie van het besturingssysteem beschikbaar wordt. |
osRollingUpgradeDeferral |
boolean |
Stel upgrades van het besturingssysteem uit op de TVM's als ze taken uitvoeren. |
useRollingUpgradePolicy |
boolean |
Hiermee wordt aangegeven of beleid voor rolling upgrades moet worden gebruikt tijdens de automatische upgrade van het besturingssysteem. Automatische upgrade van het besturingssysteem valt terug op het standaardbeleid als er geen beleid is gedefinieerd op de VMSS. |
AutoScaleRun
De resultaten en fouten van een uitvoering van een formule voor automatische schaalaanpassing van pools.
Name | Type | Description |
---|---|---|
error |
Details van de fout die is opgetreden bij het evalueren van de formule voor automatische schaalaanpassing in de pool, als de evaluatie mislukt is. |
|
results |
string |
De uiteindelijke waarden van alle variabelen die worden gebruikt bij de evaluatie van de formule voor automatische schaalaanpassing. |
timestamp |
string |
Het tijdstip waarop de formule voor automatische schaalaanpassing voor het laatst is geëvalueerd. |
AutoScaleRunError
Er is een fout opgetreden bij het uitvoeren of evalueren van een formule voor automatische schaalaanpassing van pools.
Name | Type | Description |
---|---|---|
code |
string |
Een id voor de fout bij automatisch schalen. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt. |
message |
string |
Een bericht met een beschrijving van de fout bij automatisch schalen, bedoeld voor weergave in een gebruikersinterface. |
values |
Een lijst met aanvullende foutdetails met betrekking tot de fout bij automatisch schalen. |
AutoUserScope
Het bereik voor de automatische gebruiker
Name | Type | Description |
---|---|---|
pool |
string |
Hiermee geeft u op dat de taak wordt uitgevoerd als het algemene automatische gebruikersaccount dat wordt gemaakt op elk rekenknooppunt in een pool. |
task |
string |
Hiermee geeft u op dat de service een nieuwe gebruiker voor de taak moet maken. |
AutoUserSpecification
Hiermee geeft u de parameters op voor de automatische gebruiker die een taak uitvoert in de Batch-service.
Name | Type | Description |
---|---|---|
elevationLevel |
Het hoogteniveau van de automatische gebruiker. |
|
scope |
Het bereik voor de automatische gebruiker |
AzureBlobFileSystemConfiguration
Informatie die wordt gebruikt om verbinding te maken met een Azure Storage-container met behulp van Blobfuse.
Name | Type | Description |
---|---|---|
accountKey |
string |
De sleutel van het Azure Storage-account. |
accountName |
string |
De naam van het Azure Storage-account. |
blobfuseOptions |
string |
Aanvullende opdrachtregelopties om door te geven aan de koppelingsopdracht. |
containerName |
string |
De naam van de Azure Blob Storage-container. |
identityReference |
De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot containerName |
|
relativeMountPath |
string |
Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld |
sasKey |
string |
Het SAS-token van Azure Storage. |
AzureFileShareConfiguration
Informatie die wordt gebruikt om verbinding te maken met een Azure Fileshare.
Name | Type | Description |
---|---|---|
accountKey |
string |
De sleutel van het Azure Storage-account. |
accountName |
string |
De naam van het Azure Storage-account. |
azureFileUrl |
string |
De URL van Azure Files. |
mountOptions |
string |
Aanvullende opdrachtregelopties om door te geven aan de koppelingsopdracht. |
relativeMountPath |
string |
Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld |
BatchError
Er is een foutbericht ontvangen van de Azure Batch-service.
Name | Type | Description |
---|---|---|
code |
string |
Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt. |
message |
Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface. |
|
values |
Een verzameling sleutel-waardeparen met aanvullende informatie over de fout. |
BatchErrorDetail
Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
Name | Type | Description |
---|---|---|
key |
string |
Een id die de betekenis van de eigenschap Waarde aangeeft. |
value |
string |
De aanvullende informatie die is opgenomen in het foutbericht. |
BatchPoolIdentity
De identiteit van de Batch-pool, indien geconfigureerd.
Name | Type | Description |
---|---|---|
type |
De identiteit van de Batch-pool, indien geconfigureerd. |
|
userAssignedIdentities |
De lijst met gebruikersidentiteiten die zijn gekoppeld aan het Batch-account. |
CachingType
Het type caching dat voor de schijf moet worden ingeschakeld.
Name | Type | Description |
---|---|---|
none |
string |
De cachemodus voor de schijf is niet ingeschakeld. |
readonly |
string |
De cachemodus voor de schijf is alleen-lezen. |
readwrite |
string |
De cachemodus voor de schijf is lezen en schrijven. |
CertificateReference
Een verwijzing naar een certificaat dat moet worden geïnstalleerd op rekenknooppunten in een pool.
Name | Type | Description |
---|---|---|
storeLocation |
De locatie van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd. |
|
storeName |
string |
De naam van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd. |
thumbprint |
string |
De vingerafdruk van het certificaat. |
thumbprintAlgorithm |
string |
Het algoritme waaraan de vingerafdruk is gekoppeld. Dit moet sha1 zijn. |
visibility |
Welke gebruikersaccounts op het rekenknooppunt toegang moeten hebben tot de persoonlijke gegevens van het certificaat. |
CertificateStoreLocation
De locatie van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd.
Name | Type | Description |
---|---|---|
currentuser |
string |
Certificaten moeten worden geïnstalleerd in het certificaatarchief currentuser. |
localmachine |
string |
Certificaten moeten worden geïnstalleerd in het Certificaatarchief van LocalMachine. |
CertificateVisibility
Welke gebruikersaccounts op het rekenknooppunt toegang moeten hebben tot de persoonlijke gegevens van het certificaat.
Name | Type | Description |
---|---|---|
remoteuser |
string |
Het certificaat moet zichtbaar zijn voor de gebruikersaccounts waaronder gebruikers extern toegang hebben tot het rekenknooppunt. |
starttask |
string |
Het certificaat moet zichtbaar zijn voor het gebruikersaccount waaronder de StartTask wordt uitgevoerd. Houd er rekening mee dat als het Bereik van AutoUser pool is voor zowel de StartTask als een taak, dit certificaat ook zichtbaar is voor de taak. |
task |
string |
Het certificaat moet zichtbaar zijn voor de gebruikersaccounts waaronder taaktaken worden uitgevoerd. |
CIFSMountConfiguration
Informatie die wordt gebruikt om verbinding te maken met een CIFS-bestandssysteem.
Name | Type | Description |
---|---|---|
mountOptions |
string |
Aanvullende opdrachtregelopties om door te geven aan de koppelingsopdracht. |
password |
string |
Het wachtwoord dat moet worden gebruikt voor verificatie op basis van het CIFS-bestandssysteem. |
relativeMountPath |
string |
Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld |
source |
string |
De URI van het bestandssysteem die moet worden gekoppeld. |
username |
string |
De gebruiker die moet worden gebruikt voor verificatie op basis van het CIFS-bestandssysteem. |
CloudPool
Een pool in de Azure Batch-service.
Name | Type | Description |
---|---|---|
allocationState |
Of de grootte van de pool wordt gewijzigd. |
|
allocationStateTransitionTime |
string |
Het tijdstip waarop de pool de huidige toewijzingsstatus heeft ingevoerd. |
applicationPackageReferences |
De lijst met pakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. |
|
autoScaleEvaluationInterval |
string |
Het tijdsinterval waarmee de poolgrootte automatisch moet worden aangepast volgens de formule voor automatische schaalaanpassing. |
autoScaleFormula |
string |
Een formule voor het gewenste aantal rekenknooppunten in de pool. |
autoScaleRun |
De resultaten en fouten van de laatste uitvoering van de formule voor automatische schaalaanpassing. |
|
certificateReferences |
De lijst met certificaten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. Waarschuwing: deze eigenschap is afgeschaft en wordt na februari 2024 verwijderd. Gebruik in plaats daarvan de Azure KeyVault-extensie. |
|
creationTime |
string |
De aanmaaktijd van de pool. |
currentDedicatedNodes |
integer |
Het aantal toegewezen rekenknooppunten dat zich momenteel in de pool bevindt. |
currentLowPriorityNodes |
integer |
Het aantal rekenknooppunten met spot-/lage prioriteit dat zich momenteel in de pool bevindt. |
currentNodeCommunicationMode |
De huidige status van de groepscommunicatiemodus. |
|
displayName |
string |
De weergavenaam voor de pool. |
eTag |
string |
De ETag van de pool. |
enableAutoScale |
boolean |
Of de grootte van de pool na verloop van tijd automatisch moet worden aangepast. |
enableInterNodeCommunication |
boolean |
Of de pool directe communicatie tussen rekenknooppunten toestaat. |
id |
string |
Een tekenreeks die de pool uniek identificeert binnen het account. |
identity |
De identiteit van de Batch-pool, indien geconfigureerd. |
|
lastModified |
string |
De laatste wijzigingstijd van de pool. |
metadata |
Een lijst met naam-waardeparen die zijn gekoppeld aan de pool als metagegevens. |
|
mountConfiguration |
Een lijst met bestandssystemen die op elk knooppunt in de pool moeten worden gekoppeld. |
|
networkConfiguration |
De netwerkconfiguratie voor de pool. |
|
resizeErrors |
Er is een lijst met fouten opgetreden tijdens het uitvoeren van de laatste grootte van de pool. |
|
resizeTimeout |
string |
De time-out voor de toewijzing van rekenknooppunten aan de pool. |
resourceTags |
object |
De door de gebruiker opgegeven tags die aan de pool zijn gekoppeld. |
startTask |
Een taak die moet worden uitgevoerd op elk rekenknooppunt terwijl deze lid wordt van de pool. |
|
state |
De huidige status van de pool. |
|
stateTransitionTime |
string |
Het tijdstip waarop de pool de huidige status heeft ingevoerd. |
stats |
Gebruiks- en resourcegebruiksstatistieken voor de gehele levensduur van de pool. |
|
targetDedicatedNodes |
integer |
Het gewenste aantal toegewezen rekenknooppunten in de pool. |
targetLowPriorityNodes |
integer |
Het gewenste aantal spot-/lage prioriteit rekenknooppunten in de pool. |
targetNodeCommunicationMode |
De gewenste communicatiemodus voor knooppunten voor de pool. |
|
taskSchedulingPolicy |
Hoe taken worden verdeeld over rekenknooppunten in een pool. |
|
taskSlotsPerNode |
integer |
Het aantal taaksites dat kan worden gebruikt om gelijktijdige taken uit te voeren op één rekenknooppunt in de pool. |
upgradePolicy |
Het upgradebeleid voor de pool. |
|
url |
string |
De URL van de pool. |
userAccounts |
De lijst met gebruikersaccounts die moeten worden gemaakt op elk rekenknooppunt in de pool. |
|
virtualMachineConfiguration |
De configuratie van de virtuele machine voor de pool. |
|
vmSize |
string |
De grootte van virtuele machines in de pool. Alle virtuele machines in een pool hebben dezelfde grootte. |
CloudPoolListResult
Het resultaat van het weergeven van de pools in een account.
Name | Type | Description |
---|---|---|
odata.nextLink |
string |
De URL voor het ophalen van de volgende set resultaten. |
value |
De lijst met pools. |
ComputeNodeFillType
Hoe taken worden verdeeld over rekenknooppunten in een pool.
Name | Type | Description |
---|---|---|
pack |
string |
Zo veel mogelijk taken (taskSlotsPerNode) moeten worden toegewezen aan elk rekenknooppunt in de pool voordat taken worden toegewezen aan het volgende rekenknooppunt in de pool. |
spread |
string |
Taken moeten gelijkmatig worden toegewezen aan alle rekenknooppunten in de pool. |
ComputeNodeIdentityReference
De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
Name | Type | Description |
---|---|---|
resourceId |
string |
De ARM-resource-id van de door de gebruiker toegewezen identiteit. |
ContainerConfiguration
De configuratie voor pools waarvoor containers zijn ingeschakeld.
Name | Type | Description |
---|---|---|
containerImageNames |
string[] |
De verzameling containerinstallatiekopieën. |
containerRegistries |
Aanvullende privéregisters waaruit containers kunnen worden opgehaald. |
|
type |
De containertechnologie die moet worden gebruikt. |
ContainerHostBatchBindMountEntry
De vermelding van het pad en de koppelingsmodus die u wilt koppelen aan de taakcontainer.
Name | Type | Description |
---|---|---|
isReadOnly |
boolean |
Koppel dit bronpad als alleen-lezenmodus of niet. De standaardwaarde is onwaar (lees-/schrijfmodus). |
source |
Het pad dat aan de containerklant wordt gekoppeld, kan worden geselecteerd. |
ContainerHostDataPath
De paden die worden gekoppeld aan de container van de containertaak.
Name | Type | Description |
---|---|---|
Applications |
string |
Het pad naar toepassingen. |
JobPrep |
string |
Het taakpad voor de taakvoorbereiding. |
Shared |
string |
Het pad voor de taak met meerdere exemplaren om hun bestanden te delen. |
Startup |
string |
Het pad voor de begintaak. |
Task |
string |
Het taakpad. |
VfsMounts |
string |
Het pad bevat alle virtuele bestandssystemen die op dit knooppunt zijn gekoppeld. |
ContainerRegistry
Een privécontainerregister.
Name | Type | Description |
---|---|---|
identityReference |
De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot een Azure Container Registry in plaats van een gebruikersnaam en wachtwoord. |
|
password |
string |
Het wachtwoord om u aan te melden bij de registerserver. |
registryServer |
string |
De register-URL. |
username |
string |
De gebruikersnaam om u aan te melden bij de registerserver. |
ContainerType
De containertechnologie die moet worden gebruikt.
Name | Type | Description |
---|---|---|
criCompatible |
string |
Een op CRI gebaseerde technologie wordt gebruikt om de containers te starten. |
dockerCompatible |
string |
Er wordt een docker-compatibele containertechnologie gebruikt om de containers te starten. |
ContainerWorkingDirectory
De locatie van de werkmap containertaak.
Name | Type | Description |
---|---|---|
containerImageDefault |
string |
Gebruik de werkmap die is gedefinieerd in de containerinstallatiekopieën. Let erop dat deze map niet de resourcebestanden bevat die door Batch zijn gedownload. |
taskWorkingDirectory |
string |
Gebruik de standaardwerkmap batchservicetaak, die de taakresourcebestanden bevat die door Batch zijn ingevuld. |
DataDisk
Instellingen die worden gebruikt door de gegevensschijven die zijn gekoppeld aan rekenknooppunten in de pool. Wanneer u gekoppelde gegevensschijven gebruikt, moet u de schijven vanuit een virtuele machine koppelen en formatteren om ze te kunnen gebruiken.
Name | Type | Description |
---|---|---|
caching |
Het type caching dat moet worden ingeschakeld voor de gegevensschijven. |
|
diskSizeGB |
integer |
De initiële schijfgrootte in gigabytes. |
lun |
integer |
Het nummer van de logische eenheid. |
storageAccountType |
Het type opslagaccount dat moet worden gebruikt voor de gegevensschijf. |
DiffDiskPlacement
Hiermee geeft u de tijdelijke schijfplaatsing voor besturingssysteemschijf voor alle rekenknooppunten (VM's) in de groep.
Name | Type | Description |
---|---|---|
CacheDisk |
string |
De tijdelijke besturingssysteemschijf wordt opgeslagen in de VM-cache. |
DiffDiskSettings
Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf die wordt gebruikt door het rekenknooppunt (VM).
Name | Type | Description |
---|---|---|
placement |
Hiermee geeft u de tijdelijke schijfplaatsing voor besturingssysteemschijf voor alle VM's in de groep. |
DiskEncryptionConfiguration
De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de pool. Schijfversleutelingsconfiguratie wordt niet ondersteund in een Linux-pool die is gemaakt met de installatiekopie van de Azure Compute Gallery.
Name | Type | Description |
---|---|---|
targets |
De lijst met schijfdoelen voor Batch Service wordt versleuteld op het rekenknooppunt. |
DiskEncryptionTarget
De lijst met schijfdoelen voor Batch Service wordt versleuteld op het rekenknooppunt.
Name | Type | Description |
---|---|---|
osdisk |
string |
De besturingssysteemschijf op het rekenknooppunt is versleuteld. |
temporarydisk |
string |
De tijdelijke schijf op het rekenknooppunt is versleuteld. Op Linux is deze versleuteling van toepassing op andere partities (zoals partities op gekoppelde gegevensschijven) wanneer versleuteling plaatsvindt tijdens het opstarten. |
DynamicVNetAssignmentScope
Het bereik van dynamische vnet-toewijzing.
Name | Type | Description |
---|---|---|
job |
string |
Dynamische VNet-toewijzing wordt per taak uitgevoerd. |
none |
string |
Er is geen dynamische VNet-toewijzing ingeschakeld. |
ElevationLevel
Het hoogteniveau van de gebruiker.
Name | Type | Description |
---|---|---|
admin |
string |
De gebruiker is een gebruiker met verhoogde toegang en werkt met volledige beheerdersmachtigingen. |
nonadmin |
string |
De gebruiker is een standaardgebruiker zonder verhoogde toegang. |
EnvironmentSetting
Een omgevingsvariabele die moet worden ingesteld voor een taakproces.
Name | Type | Description |
---|---|---|
name |
string |
De naam van de omgevingsvariabele. |
value |
string |
De waarde van de omgevingsvariabele. |
ErrorMessage
Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
Name | Type | Description |
---|---|---|
lang |
string |
De taalcode van het foutbericht |
value |
string |
De tekst van het bericht. |
ImageReference
Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een Azure Compute Gallery-installatiekopieën. Zie de bewerking Ondersteunde installatiekopieën weergeven om de lijst met alle Azure Marketplace-installatiekopieën op te halen die zijn geverifieerd door Azure Batch.
Name | Type | Description |
---|---|---|
communityGalleryImageId |
string |
De unieke id van de communitygalerieafbeelding |
exactVersion |
string |
De specifieke versie van de platforminstallatiekopieën of marketplace-installatiekopieën die worden gebruikt om het knooppunt te maken. Dit alleen-lezenveld verschilt van 'versie' alleen als de waarde die is opgegeven voor 'versie' toen de pool werd gemaakt 'latest' was. |
offer |
string |
Het aanbiedingstype van de Marketplace-installatiekopie van Azure Virtual Machines. |
publisher |
string |
De uitgever van de Azure Virtual Machines Marketplace-installatiekopieën. |
sharedGalleryImageId |
string |
De unieke id van de installatiekopieën van de gedeelde galerie |
sku |
string |
De SKU van de Marketplace-installatiekopieën van Azure Virtual Machines. |
version |
string |
De versie van de Azure Virtual Machines Marketplace-installatiekopieën. |
virtualMachineImageId |
string |
De ARM-resource-id van de installatiekopieën van de Azure Compute Gallery. Rekenknooppunten in de pool worden gemaakt met behulp van deze installatiekopieën-id. Dit is van het formulier /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} voor altijd de meest recente versie van de installatiekopie. |
InboundEndpointProtocol
Het protocol van het eindpunt.
Name | Type | Description |
---|---|---|
tcp |
string |
Gebruik TCP voor het eindpunt. |
udp |
string |
Gebruik UDP voor het eindpunt. |
InboundNATPool
Een binnenkomende NAT-pool die kan worden gebruikt om specifieke poorten op rekenknooppunten in een batchgroep extern aan te pakken.
Name | Type | Description |
---|---|---|
backendPort |
integer |
Het poortnummer op het rekenknooppunt. |
frontendPortRangeEnd |
integer |
Het laatste poortnummer in het bereik van externe poorten dat wordt gebruikt voor binnenkomende toegang tot de backendPort op afzonderlijke rekenknooppunten. |
frontendPortRangeStart |
integer |
Het eerste poortnummer in het bereik van externe poorten dat wordt gebruikt voor binnenkomende toegang tot de backendPort op afzonderlijke rekenknooppunten. |
name |
string |
De naam van het eindpunt. |
networkSecurityGroupRules |
Een lijst met regels voor netwerkbeveiligingsgroepen die worden toegepast op het eindpunt. |
|
protocol |
Het protocol van het eindpunt. |
IPAddressProvisioningType
Het inrichtingstype voor openbare IP-adressen voor de groep.
Name | Type | Description |
---|---|---|
batchmanaged |
string |
Er wordt een openbaar IP-adres gemaakt en beheerd door Batch. Er kunnen meerdere openbare IP-adressen zijn, afhankelijk van de grootte van de pool. |
nopublicipaddresses |
string |
Er wordt geen openbaar IP-adres gemaakt. |
usermanaged |
string |
Openbare IP-adressen worden geleverd door de gebruiker en worden gebruikt om de rekenknooppunten in te richten. |
LinuxUserConfiguration
Eigenschappen die worden gebruikt voor het maken van een gebruikersaccount op een Linux-rekenknooppunt.
Name | Type | Description |
---|---|---|
gid |
integer |
De groeps-id voor het gebruikersaccount. |
sshPrivateKey |
string |
De persoonlijke SSH-sleutel voor het gebruikersaccount. |
uid |
integer |
De gebruikers-id van het gebruikersaccount. |
LoginMode
De aanmeldingsmodus voor de gebruiker
Name | Type | Description |
---|---|---|
batch |
string |
De LOGON32_LOGON_BATCH Win32-aanmeldingsmodus. De batchaanmeldingsmodus wordt aanbevolen voor langdurige parallelle processen. |
interactive |
string |
De LOGON32_LOGON_INTERACTIVE Win32-aanmeldingsmodus. UAC is ingeschakeld voor Windows-pools. Als deze optie wordt gebruikt met een gebruikersidentiteit met verhoogde bevoegdheid in een Windows-pool, wordt de gebruikerssessie niet verhoogd, tenzij de toepassing die wordt uitgevoerd door de opdrachtregel Taak is geconfigureerd om altijd beheerdersbevoegdheden te vereisen of om altijd maximale bevoegdheden te vereisen. |
ManagedDisk
Name | Type | Description |
---|---|---|
securityProfile |
Hiermee geeft u de beveiligingsprofielinstellingen voor de beheerde schijf. |
|
storageAccountType |
Het type opslagaccount voor beheerde schijf. |
MetadataItem
Een naam-waardepaar dat is gekoppeld aan een Batch-serviceresource.
Name | Type | Description |
---|---|---|
name |
string |
De naam van het metagegevensitem. |
value |
string |
De waarde van het metagegevensitem. |
MountConfiguration
Het bestandssysteem dat op elk knooppunt moet worden gekoppeld.
Name | Type | Description |
---|---|---|
azureBlobFileSystemConfiguration |
De Azure Storage-container die moet worden gekoppeld met blob FUSE op elk knooppunt. |
|
azureFileShareConfiguration |
De Azure-bestandsshare die op elk knooppunt moet worden gekoppeld. |
|
cifsMountConfiguration |
Het CIFS-/SMB-bestandssysteem dat op elk knooppunt moet worden gekoppeld. |
|
nfsMountConfiguration |
Het NFS-bestandssysteem dat op elk knooppunt moet worden gekoppeld. |
NameValuePair
Vertegenwoordigt een naam-waardepaar.
Name | Type | Description |
---|---|---|
name |
string |
De naam in het naam-waardepaar. |
value |
string |
De waarde in het naam-waardepaar. |
NetworkConfiguration
De netwerkconfiguratie voor een pool.
Name | Type | Description |
---|---|---|
dynamicVNetAssignmentScope |
Het bereik van dynamische vnet-toewijzing. |
|
enableAcceleratedNetworking |
boolean |
Of deze pool versneld netwerken moet inschakelen. |
endpointConfiguration |
De configuratie voor eindpunten op rekenknooppunten in de Batch-pool. |
|
publicIPAddressConfiguration |
De openbare IPAddress-configuratie voor rekenknooppunten in de Batch-pool. |
|
subnetId |
string |
De ARM-resource-id van het subnet van het virtuele netwerk waaraan de rekenknooppunten van de pool worden toegevoegd. Dit is van het formulier /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnetten/{subnet}. |
NetworkSecurityGroupRule
Een regel voor een netwerkbeveiligingsgroep die moet worden toegepast op een binnenkomend eindpunt.
Name | Type | Description |
---|---|---|
access |
De actie die moet worden uitgevoerd voor een opgegeven IP-adres, subnetbereik of tag. |
|
priority |
integer |
De prioriteit voor deze regel. |
sourceAddressPrefix |
string |
Het bronadresvoorvoegsel of het label dat overeenkomt met de regel. |
sourcePortRanges |
string[] |
De bronpoortbereiken die overeenkomen met de regel. |
NetworkSecurityGroupRuleAccess
De actie die moet worden uitgevoerd voor een opgegeven IP-adres, subnetbereik of tag.
Name | Type | Description |
---|---|---|
allow |
string |
Toegang toestaan. |
deny |
string |
Toegang weigeren. |
NFSMountConfiguration
Informatie die wordt gebruikt om verbinding te maken met een NFS-bestandssysteem.
Name | Type | Description |
---|---|---|
mountOptions |
string |
Aanvullende opdrachtregelopties om door te geven aan de koppelingsopdracht. |
relativeMountPath |
string |
Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld |
source |
string |
De URI van het bestandssysteem die moet worden gekoppeld. |
NodeCommunicationMode
Bepaalt hoe een pool communiceert met de Batch-service.
Name | Type | Description |
---|---|---|
classic |
string |
Knooppunten die de klassieke communicatiemodus gebruiken, vereisen binnenkomende TCP-communicatie op poorten 29876 en 29877 van batchnodemanagement. {region}-servicetag en uitgaande TCP-communicatie op poort 443 naar storage.region en BatchNodeManagement. Servicetags van {region}. |
default |
string |
De communicatiemodus voor knooppunten wordt automatisch ingesteld door de Batch-service. |
simplified |
string |
Knooppunten die gebruikmaken van de vereenvoudigde communicatiemodus vereisen uitgaande TCP-communicatie op poort 443 naar BatchNodeManagement. Servicetag {region}. Er zijn geen geopende binnenkomende poorten vereist. |
NodePlacementConfiguration
Knooppuntplaatsingsconfiguratie voor een pool.
Name | Type | Description |
---|---|---|
policy |
Type plaatsingsbeleid voor knooppunten in Batch-pools. |
NodePlacementPolicyType
Het plaatsingsbeleid voor het toewijzen van knooppunten in de pool.
Name | Type | Description |
---|---|---|
regional |
string |
Alle knooppunten in de pool worden in dezelfde regio toegewezen. |
zonal |
string |
Knooppunten in de pool worden verdeeld over verschillende beschikbaarheidszones met best effort balancing. |
OSDisk
Instellingen voor de besturingssysteemschijf van het rekenknooppunt (VM).
Name | Type | Description |
---|---|---|
caching |
Hiermee geeft u de cachevereisten op. Mogelijke waarden zijn: Geen, ReadOnly, ReadWrite. De standaardwaarden zijn: Geen voor Standard-opslag. ReadOnly voor Premium-opslag. |
|
diskSizeGB |
integer |
De oorspronkelijke schijfgrootte in GB bij het maken van een nieuwe besturingssysteemschijf. |
ephemeralOSDiskSettings |
Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf die wordt gebruikt door het rekenknooppunt (VM). |
|
managedDisk |
De parameters van de beheerde schijf. |
|
writeAcceleratorEnabled |
boolean |
Hiermee geeft u op of writeAccelerator moet worden ingeschakeld of uitgeschakeld op de schijf. |
PoolEndpointConfiguration
De eindpuntconfiguratie voor een pool.
Name | Type | Description |
---|---|---|
inboundNATPools |
Een lijst met binnenkomende NAT-pools die kunnen worden gebruikt om specifieke poorten op een afzonderlijk rekenknooppunt extern aan te pakken. |
PoolIdentityType
De identiteit van de Batch-pool, indien geconfigureerd.
Name | Type | Description |
---|---|---|
None |
string |
Batch-pool heeft geen identiteit eraan gekoppeld. Als u |
UserAssigned |
string |
Batch-pool heeft door de gebruiker toegewezen identiteiten. |
PoolState
De huidige status van de pool.
Name | Type | Description |
---|---|---|
active |
string |
De pool is beschikbaar voor het uitvoeren van taken die afhankelijk zijn van de beschikbaarheid van rekenknooppunten. |
deleting |
string |
De gebruiker heeft gevraagd om de pool te verwijderen, maar de verwijderbewerking is nog niet voltooid. |
PoolStatistics
Bevat gebruiks- en resourcegebruiksstatistieken voor de levensduur van een pool.
Name | Type | Description |
---|---|---|
lastUpdateTime |
string |
Het tijdstip waarop de statistieken voor het laatst zijn bijgewerkt. Alle statistieken zijn beperkt tot het bereik tussen startTime en lastUpdateTime. |
resourceStats |
Statistieken met betrekking tot resourceverbruik door rekenknooppunten in de pool. |
|
startTime |
string |
De begintijd van het tijdsbereik waarop de statistieken betrekking hebben. |
url |
string |
De URL voor de statistieken. |
usageStats |
Statistieken met betrekking tot poolgebruik, zoals de hoeveelheid gebruikte kerntijd. |
PublicIPAddressConfiguration
De configuratie van het openbare IP-adres van de netwerkconfiguratie van een pool.
Name | Type | Description |
---|---|---|
ipAddressIds |
string[] |
De lijst met openbare IP-adressen die door de Batch-service worden gebruikt bij het inrichten van rekenknooppunten. |
provision |
Het inrichtingstype voor openbare IP-adressen voor de groep. |
ResizeError
Er is een fout opgetreden bij het wijzigen van het formaat van een pool.
Name | Type | Description |
---|---|---|
code |
string |
Een id voor de fout bij het wijzigen van het formaat van de pool. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt. |
message |
string |
Een bericht met een beschrijving van de fout bij het wijzigen van het formaat van de pool, die geschikt is voor weergave in een gebruikersinterface. |
values |
Een lijst met aanvullende foutdetails met betrekking tot de fout bij het wijzigen van het formaat van de pool. |
ResourceFile
Eén bestand of meerdere bestanden die moeten worden gedownload naar een rekenknooppunt.
Name | Type | Description |
---|---|---|
autoStorageContainerName |
string |
De naam van de opslagcontainer in het automatische opslagaccount. |
blobPrefix |
string |
Het blobvoorvoegsel dat moet worden gebruikt bij het downloaden van blobs uit een Azure Storage-container. Alleen de blobs waarvan de namen beginnen met het opgegeven voorvoegsel, worden gedownload. |
fileMode |
string |
Het kenmerk bestandsmachtigingsmodus in octale indeling. |
filePath |
string |
De locatie op het rekenknooppunt waarnaar u het bestand(en) wilt downloaden ten opzichte van de werkmap van de taak. |
httpUrl |
string |
De URL van het bestand dat u wilt downloaden. |
identityReference |
De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage die is opgegeven door storageContainerUrl of httpUrl |
|
storageContainerUrl |
string |
De URL van de blobcontainer in Azure Blob Storage. |
ResourceStatistics
Statistieken met betrekking tot resourceverbruik door rekenknooppunten in een pool.
Name | Type | Description |
---|---|---|
avgCPUPercentage |
number |
Het gemiddelde CPU-gebruik voor alle rekenknooppunten in de pool (percentage per knooppunt). |
avgDiskGiB |
number |
Het gemiddelde gebruikte schijfruimte in GiB voor alle rekenknooppunten in de pool. |
avgMemoryGiB |
number |
Het gemiddelde geheugengebruik in GiB voor alle rekenknooppunten in de pool. |
diskReadGiB |
number |
De totale hoeveelheid gegevens in GiB van de schijf leest over alle rekenknooppunten in de pool. |
diskReadIOps |
integer |
Het totale aantal schijfleesbewerkingen voor alle rekenknooppunten in de pool. |
diskWriteGiB |
number |
De totale hoeveelheid gegevens in GiB van schijf schrijft over alle rekenknooppunten in de pool. |
diskWriteIOps |
integer |
Het totale aantal schijfschrijfbewerkingen voor alle rekenknooppunten in de pool. |
lastUpdateTime |
string |
Het tijdstip waarop de statistieken voor het laatst zijn bijgewerkt. Alle statistieken zijn beperkt tot het bereik tussen startTime en lastUpdateTime. |
networkReadGiB |
number |
De totale hoeveelheid gegevens in GiB van het netwerk leest over alle rekenknooppunten in de pool. |
networkWriteGiB |
number |
De totale hoeveelheid gegevens in GiB van netwerk schrijft over alle rekenknooppunten in de pool. |
peakDiskGiB |
number |
De piek gebruikte schijfruimte in GiB voor alle rekenknooppunten in de pool. |
peakMemoryGiB |
number |
Het piekgeheugengebruik in GiB voor alle rekenknooppunten in de pool. |
startTime |
string |
De begintijd van het tijdsbereik waarop de statistieken betrekking hebben. |
RollingUpgradePolicy
De configuratieparameters die worden gebruikt tijdens het uitvoeren van een rolling upgrade.
Name | Type | Description |
---|---|---|
enableCrossZoneUpgrade |
boolean |
Toestaan dat VMSS AZ-grenzen negeert bij het maken van upgradebatches. Neem rekening met het updatedomein en maxBatchInstancePercent om de batchgrootte te bepalen. Dit veld kan alleen worden ingesteld op waar of onwaar wanneer u NodePlacementConfiguration als zonegebonden gebruikt. |
maxBatchInstancePercent |
integer |
Het maximumpercentage van het totale aantal exemplaren van virtuele machines dat tegelijkertijd wordt geüpgraded door de rolling upgrade in één batch. Omdat dit een maximum is, kunnen beschadigde exemplaren in eerdere of toekomstige batches ervoor zorgen dat het percentage exemplaren in een batch afneemt om een hogere betrouwbaarheid te garanderen. De waarde van dit veld moet tussen 5 en 100 liggen, inclusief. Als zowel maxBatchInstancePercent als maxUnhealthyInstancePercent aan waarde zijn toegewezen, mag de waarde van maxBatchInstancePercent niet meer zijn dan maxUnhealthyInstancePercent. |
maxUnhealthyInstancePercent |
integer |
Het maximumpercentage van het totale aantal exemplaren van virtuele machines in de schaalset dat tegelijkertijd beschadigd kan zijn, hetzij als gevolg van een upgrade of door de statuscontroles van de virtuele machine te worden aangetroffen voordat de rolling upgrade wordt afgebroken. Deze beperking wordt gecontroleerd voordat u een batch start. De waarde van dit veld moet tussen 5 en 100 liggen, inclusief. Als zowel maxBatchInstancePercent als maxUnhealthyInstancePercent aan waarde zijn toegewezen, mag de waarde van maxBatchInstancePercent niet meer zijn dan maxUnhealthyInstancePercent. |
maxUnhealthyUpgradedInstancePercent |
integer |
Het maximumpercentage van bijgewerkte exemplaren van virtuele machines die kunnen worden gevonden, hebben een slechte status. Deze controle vindt plaats nadat elke batch is bijgewerkt. Als dit percentage ooit wordt overschreden, wordt de rolling update afgebroken. De waarde van dit veld moet tussen 0 en 100, inclusief zijn. |
pauseTimeBetweenBatches |
string |
De wachttijd tussen het voltooien van de update voor alle virtuele machines in één batch en het starten van de volgende batch. De tijdsduur moet worden opgegeven in ISO 8601-indeling. |
prioritizeUnhealthyInstances |
boolean |
Werk alle beschadigde exemplaren in een schaalset bij voordat alle exemplaren in orde zijn. |
rollbackFailedInstancesOnPolicyBreach |
boolean |
Het terugdraaien van mislukte exemplaren naar het vorige model als het beleid voor rolling upgrades wordt geschonden. |
SecurityEncryptionTypes
Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor het niet behouden van de firmwarestatus in de VMGuestState-blob. Opmerking: deze kan alleen worden ingesteld voor vertrouwelijke VM's en is vereist bij het gebruik van vertrouwelijke VM's.
Name | Type | Description |
---|---|---|
NonPersistedTPM |
string |
|
VMGuestStateOnly |
string |
SecurityProfile
Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op.
Name | Type | Description |
---|---|---|
encryptionAtHost |
boolean |
Deze eigenschap kan worden gebruikt door de gebruiker in de aanvraag om hostversleuteling voor de virtuele machine of virtuele-machineschaalset in of uit te schakelen. Hierdoor wordt de versleuteling ingeschakeld voor alle schijven, inclusief resource-/tijdelijke schijf op de host zelf. Raadpleeg https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizesvoor meer informatie over versleuteling bij hostvereisten. |
securityType |
Hiermee geeft u het SecurityType van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen. |
|
uefiSettings |
Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine. |
SecurityTypes
Hiermee geeft u het SecurityType van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen.
Name | Type | Description |
---|---|---|
confidentialVM |
string |
Azure Confidential Computing biedt vertrouwelijke VM's voor tenants met hoge vereisten voor beveiliging en vertrouwelijkheid. Deze VM's bieden een sterke, hardware-afgedwongen grens om te voldoen aan uw beveiligingsbehoeften. U kunt vertrouwelijke VM's gebruiken voor migraties zonder wijzigingen aan te brengen in uw code, waarbij het platform dat de status van uw VIRTUELE machine beveiligt, niet kan worden gelezen of gewijzigd. |
trustedLaunch |
string |
Vertrouwde lancering beschermt tegen geavanceerde en permanente aanvalstechnieken. |
ServiceArtifactReference
Hiermee geeft u de referentie-id voor serviceartefacten op die wordt gebruikt voor het instellen van dezelfde installatiekopieënversie voor alle virtuele machines in de schaalset wanneer u de meest recente installatiekopieënversie gebruikt.
Name | Type | Description |
---|---|---|
id |
string |
De naslag-id van ServiceArtifactReference |
StartTask
Een taak die wordt uitgevoerd wanneer een knooppunt lid wordt van een pool in de Azure Batch-service of wanneer het rekenknooppunt opnieuw wordt opgestart of opnieuw wordt hersteld.
Name | Type | Description |
---|---|---|
commandLine |
string |
De opdrachtregel van de StartTask. |
containerSettings |
De instellingen voor de container waaronder de StartTask wordt uitgevoerd. |
|
environmentSettings |
Een lijst met omgevingsvariabele-instellingen voor de StartTask. |
|
maxTaskRetryCount |
integer |
Het maximum aantal keren dat de taak opnieuw kan worden geprobeerd. |
resourceFiles |
Een lijst met bestanden die de Batch-service naar het rekenknooppunt downloadt voordat u de opdrachtregel uitvoert. Er is een maximale grootte voor de lijst met resourcebestanden. Wanneer de maximale grootte wordt overschreden, mislukt de aanvraag en is de antwoordfoutcode RequestEntityTooLarge. Als dit het geval is, moet de verzameling ResourceFiles worden verkleind. Dit kan worden bereikt met behulp van .zip bestanden, toepassingspakketten of Docker-containers. |
|
userIdentity |
De gebruikersidentiteit waaronder StartTask wordt uitgevoerd. |
|
waitForSuccess |
boolean |
Of de Batch-service moet wachten tot de StartTask is voltooid (dat wil gezegd: afsluiten met afsluitcode 0) voordat taken op het rekenknooppunt worden gepland. |
StorageAccountType
Het type opslagaccount voor gebruik bij het maken van gegevensschijven of een besturingssysteemschijf.
Name | Type | Description |
---|---|---|
premium_lrs |
string |
De gegevensschijf/besturingssysteemschijf moet premium lokaal redundante opslag gebruiken. |
standard_lrs |
string |
De gegevensschijf/besturingssysteemschijf moet gebruikmaken van standaard lokaal redundante opslag. |
standardssd_lrs |
string |
De gegevensschijf/besturingssysteemschijf moet lokaal redundante standaard-SSD-opslag gebruiken. |
TaskContainerSettings
De containerinstellingen voor een taak.
Name | Type | Description |
---|---|---|
containerHostBatchBindMounts |
De paden die u aan de containertaak wilt koppelen. |
|
containerRunOptions |
string |
Aanvullende opties voor de opdracht container maken. |
imageName |
string |
De installatiekopieën die moeten worden gebruikt om de container te maken waarin de taak wordt uitgevoerd. |
registry |
Het privéregister dat de containerinstallatiekopieën bevat. |
|
workingDirectory |
De locatie van de werkmap containertaak. |
TaskSchedulingPolicy
Hiermee geeft u op hoe taken moeten worden verdeeld over rekenknooppunten.
Name | Type | Description |
---|---|---|
nodeFillType |
Hoe taken worden verdeeld over rekenknooppunten in een pool. |
UefiSettings
Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine.
Name | Type | Description |
---|---|---|
secureBootEnabled |
boolean |
Hiermee geeft u op of beveiligd opstarten moet worden ingeschakeld op de virtuele machine. |
vTpmEnabled |
boolean |
Hiermee geeft u op of vTPM moet worden ingeschakeld op de virtuele machine. |
UpgradeMode
Hiermee geeft u de modus van een upgrade naar virtuele machines in de schaalset.
Mogelijke waarden zijn:
Handmatige: u bepaalt de toepassing van updates voor virtuele machines in de schaalset. U doet dit met behulp van de manualUpgrade-actie.
Automatisch: alle virtuele machines in de schaalset worden automatisch tegelijkertijd bijgewerkt.
Rolling - Schaalset voert updates uit in batches met een optionele onderbrekingstijd ertussen.
Name | Type | Description |
---|---|---|
automatic |
string |
Alle virtuele machines in de schaalset worden automatisch tegelijkertijd bijgewerkt. |
manual |
string |
U bepaalt de toepassing van updates voor virtuele machines in de schaalset. U doet dit met behulp van de manualUpgrade-actie. |
rolling |
string |
De bestaande exemplaren in een schaalset worden neergezet in batches die moeten worden bijgewerkt. Zodra de bijgewerkte batch is voltooid, beginnen de exemplaren opnieuw met verkeer en wordt de volgende batch gestart. Dit gaat door totdat alle exemplaren up-to-date zijn gebracht. |
UpgradePolicy
Beschrijft een upgradebeleid: automatisch, handmatig of rolling.
Name | Type | Description |
---|---|---|
automaticOSUpgradePolicy |
Configuratieparameters die worden gebruikt voor het uitvoeren van automatische upgrade van het besturingssysteem. |
|
mode |
Hiermee geeft u de modus van een upgrade naar virtuele machines in de schaalset. |
|
rollingUpgradePolicy |
De configuratieparameters die worden gebruikt tijdens het uitvoeren van een rolling upgrade. |
UsageStatistics
Statistieken met betrekking tot poolgebruiksgegevens.
Name | Type | Description |
---|---|---|
dedicatedCoreTime |
string |
De geaggregeerde wandkloktijd van de toegewezen rekenknooppuntkernen die deel uitmaken van de pool. |
lastUpdateTime |
string |
Het tijdstip waarop de statistieken voor het laatst zijn bijgewerkt. Alle statistieken zijn beperkt tot het bereik tussen startTime en lastUpdateTime. |
startTime |
string |
De begintijd van het tijdsbereik waarop de statistieken betrekking hebben. |
UserAccount
Eigenschappen die worden gebruikt om een gebruiker te maken die wordt gebruikt om taken uit te voeren op een Azure Batch Compute-knooppunt.
Name | Type | Description |
---|---|---|
elevationLevel |
Het hoogteniveau van het gebruikersaccount. |
|
linuxUserConfiguration |
De Linux-specifieke gebruikersconfiguratie voor het gebruikersaccount. |
|
name |
string |
De naam van het gebruikersaccount. Namen kunnen Unicode-tekens bevatten tot een maximale lengte van 20. |
password |
string |
Het wachtwoord voor het gebruikersaccount. |
windowsUserConfiguration |
De windows-specifieke gebruikersconfiguratie voor het gebruikersaccount. |
UserAssignedIdentity
De door de gebruiker toegewezen identiteit
Name | Type | Description |
---|---|---|
clientId |
string |
De client-id van de door de gebruiker toegewezen identiteit. |
principalId |
string |
De principal-id van de door de gebruiker toegewezen identiteit. |
resourceId |
string |
De ARM-resource-id van de door de gebruiker toegewezen identiteit |
UserIdentity
De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd.
Name | Type | Description |
---|---|---|
autoUser |
De automatische gebruiker waaronder de taak wordt uitgevoerd. |
|
username |
string |
De naam van de gebruikersidentiteit waaronder de taak wordt uitgevoerd. |
VirtualMachineConfiguration
De configuratie voor rekenknooppunten in een pool op basis van de Azure Virtual Machines-infrastructuur.
Name | Type | Description |
---|---|---|
containerConfiguration |
De containerconfiguratie voor de pool. |
|
dataDisks |
Data |
De configuratie voor gegevensschijven die zijn gekoppeld aan de rekenknooppunten in de pool. |
diskEncryptionConfiguration |
De schijfversleutelingsconfiguratie voor de pool. |
|
extensions |
De extensie van de virtuele machine voor de pool. |
|
imageReference |
Een verwijzing naar de Marketplace-installatiekopieën van Azure Virtual Machines of de aangepaste vm-installatiekopieën die u wilt gebruiken. |
|
licenseType |
string |
Het type on-premises licentie dat moet worden gebruikt bij het implementeren van het besturingssysteem. Windows_Server: de on-premises licentie is voor Windows Server. Windows_Client: de on-premises licentie is voor Windows Client. |
nodeAgentSKUId |
string |
De SKU van de Batch Compute Node-agent die moet worden ingericht op rekenknooppunten in de pool. |
nodePlacementConfiguration |
De configuratie van de plaatsing van knooppunten voor de pool. |
|
osDisk |
Instellingen voor de besturingssysteemschijf van de virtuele machine. |
|
securityProfile |
Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op. |
|
serviceArtifactReference |
Hiermee geeft u de referentie-id voor serviceartefacten op die wordt gebruikt voor het instellen van dezelfde installatiekopieënversie voor alle virtuele machines in de schaalset wanneer u de meest recente installatiekopieënversie gebruikt. |
|
windowsConfiguration |
Windows-besturingssysteeminstellingen op de virtuele machine. |
VMDiskSecurityProfile
Hiermee geeft u de beveiligingsprofielinstellingen voor de beheerde schijf. Opmerking: deze kan alleen worden ingesteld voor vertrouwelijke VM's en vereist bij het gebruik van vertrouwelijke VM's.
Name | Type | Description |
---|---|---|
securityEncryptionType |
Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor het niet behouden van de firmwarestatus in de VMGuestState-blob. Opmerking: deze kan alleen worden ingesteld voor vertrouwelijke VM's en is vereist bij het gebruik van vertrouwelijke VM's. |
VMExtension
De configuratie voor extensies van virtuele machines.
Name | Type | Description |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Geeft aan of de extensie een nieuwere secundaire versie moet gebruiken als deze beschikbaar is tijdens de implementatie. Zodra de extensie eenmaal is geïmplementeerd, worden er echter geen secundaire versies bijgewerkt, tenzij deze opnieuw wordt geïmplementeerd, zelfs niet als deze eigenschap is ingesteld op true. |
enableAutomaticUpgrade |
boolean |
Geeft aan of de extensie automatisch moet worden bijgewerkt door het platform als er een nieuwere versie van de extensie beschikbaar is. |
name |
string |
De naam van de extensie van de virtuele machine. |
protectedSettings |
object |
De extensie kan protectedSettings of protectedSettingsFromKeyVault of helemaal geen beveiligde instellingen bevatten. |
provisionAfterExtensions |
string[] |
De verzameling extensienamen. |
publisher |
string |
De naam van de uitgever van de extensie-handler. |
settings |
object |
Openbare instellingen met JSON-indeling voor de extensie. |
type |
string |
Het type extensie. |
typeHandlerVersion |
string |
De versie van de scripthandler. |
WindowsConfiguration
Windows-besturingssysteeminstellingen die van toepassing zijn op de virtuele machine.
Name | Type | Description |
---|---|---|
enableAutomaticUpdates |
boolean |
Of automatische updates zijn ingeschakeld op de virtuele machine. |
WindowsUserConfiguration
Eigenschappen die worden gebruikt voor het maken van een gebruikersaccount op een Windows-rekenknooppunt.
Name | Type | Description |
---|---|---|
loginMode |
De aanmeldingsmodus voor de gebruiker |