Pool - Get
Hiermee haalt u informatie op over de opgegeven pool.
GET {batchUrl}/pools/{poolId}?api-version=2023-11-01.18.0
GET {batchUrl}/pools/{poolId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2023-11-01.18.0
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
batch
|
path | True |
string |
De basis-URL voor alle Azure Batch serviceaanvragen. |
pool
|
path | True |
string |
De id van de pool die moet worden opgehaald. |
api-version
|
query | True |
string |
Client-API-versie. |
$expand
|
query |
string |
Een OData $expand component. |
|
$select
|
query |
string |
Een OData $select component. |
|
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. |
Aanvraagkoptekst
Media Types: "application/json; odata=minimalmetadata"
Name | Vereist | Type | Description |
---|---|---|---|
client-request-id |
string uuid |
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 client-request-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 systeemkloktijd; stel dit expliciet in als u de REST API rechtstreeks aanroept. |
|
If-Match |
string |
Een ETag-waarde die is gekoppeld aan de versie van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de huidige ETag van de resource op de service exact overeenkomt met de waarde die is opgegeven door de client. |
|
If-None-Match |
string |
Een ETag-waarde die is gekoppeld aan de versie van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de huidige ETag van de resource op de service niet overeenkomt met de waarde die is opgegeven door de client. |
|
If-Modified-Since |
string date-time-rfc1123 |
Een tijdstempel die de laatste wijzigingstijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource op de service sinds de opgegeven tijd is gewijzigd. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
Een tijdstempel die de laatste wijzigingstijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource op de service sinds de opgegeven tijd niet is gewijzigd. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Een antwoord met de pool. 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
Add a VirtualMachineConfiguration pool with OS disk
Voorbeeldaanvraag
GET account.region.batch.azure.com/pools/mypool001?api-version=2023-11-01.18.0
Voorbeeldrespons
{
"id": "mypool001",
"url": "http://localhost:20302/testaccount1tls/pools/mypool001",
"eTag": "0x8DBA3B4E91CD7B7",
"lastModified": "2023-08-23T08:42:40.3479479Z",
"creationTime": "2023-08-23T08:42:40.3479479Z",
"state": "active",
"stateTransitionTime": "2023-08-23T08:42:40.3479479Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2023-08-23T08:42:53.8587829Z",
"vmSize": "standard_d2s_v3",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 1,
"targetDedicatedNodes": 1,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "0001-com-ubuntu-server-focal",
"sku": "20_04-lts",
"version": "latest"
},
"osDisk": {
"ephemeralOSDiskSettings": {
"placement": "CacheDisk"
},
"managedDisk": {
"storageAccountType": "standardssd_lrs"
},
"diskSizeGB": 100,
"caching": "readwrite"
},
"nodeAgentSKUId": "batch.node.ubuntu 20.04"
},
"currentNodeCommunicationMode": "classic"
}
Get a pool with AcceleratedNetworking
Voorbeeldaanvraag
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
Voorbeeldrespons
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8DB4792BE8566A2",
"lastModified": "2023-04-28T02:46:19.0268066Z",
"creationTime": "2023-04-28T02:46:19.0268066Z",
"state": "active",
"stateTransitionTime": "2023-04-28T02:46:19.0268066Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2023-04-28T02:47:17.9169655Z",
"vmSize": "standard_d1_v2",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 2,
"targetDedicatedNodes": 2,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2016-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.windows amd64"
},
"networkConfiguration": {
"dynamicVNetAssignmentScope": "none",
"enableAcceleratedNetworking": true
},
"currentNodeCommunicationMode": "classic"
}
Get a VirtualMachineConfiguration pool with extensions
Voorbeeldaanvraag
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
Voorbeeldrespons
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8D413091E739A56",
"lastModified": "2016-11-22T18:55:25.2608598Z",
"creationTime": "2016-11-22T18:55:24.2632496Z",
"state": "active",
"stateTransitionTime": "2016-11-22T18:55:24.2632496Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z",
"vmSize": "standard_a1",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 0,
"currentLowPriorityNodes": 0,
"targetDedicatedNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "0001-com-ubuntu-server-focal",
"sku": "20_04-lts",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.ubuntu 20.04",
"extensions": [
{
"name": "batchextension1",
"type": "KeyVaultForLinux",
"publisher": "Microsoft.Azure.KeyVault",
"typeHandlerVersion": "2.0",
"autoUpgradeMinorVersion": true,
"enableAutomaticUpgrade": true,
"settings": "{\"secretsManagementSettingsKey\":\"secretsManagementSettingsValue\",\"authenticationSettingsKey\":\"authenticationSettingsValue\"}"
}
]
},
"targetNodeCommunicationMode": "classic",
"currentNodeCommunicationMode": "classic"
}
Get a VirtualMachineConfiguration pool with SecurityProfile
Voorbeeldaanvraag
GET account.region.batch.azure.com/pools/mypool001?api-version=2023-11-01.18.0
Voorbeeldrespons
{
"id": "mypool001",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8DB6CA2DFF530D1",
"lastModified": "2023-06-14T06:45:00.0946897Z",
"creationTime": "2023-06-14T06:45:00.0946897Z",
"state": "active",
"stateTransitionTime": "2023-06-14T06:45:00.0946897Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2023-06-14T06:45:59.4770341Z",
"vmSize": "standard_dc2s_v2",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 1,
"targetDedicatedNodes": 1,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "UbuntuServer",
"sku": "18_04-lts-gen2",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.ubuntu 18.04",
"securityProfile": {
"securityType": "trustedLaunch",
"encryptionAtHost": true,
"uefiSettings": {
"secureBootEnabled": false
}
}
},
"currentNodeCommunicationMode": "classic"
}
Get a VirtualMachineConfiguration pool with ServiceArtifactReference
Voorbeeldaanvraag
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
Voorbeeldrespons
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8DB51F652DFC78F",
"lastModified": "2023-05-11T08:04:19.7259151Z",
"creationTime": "2023-05-11T08:04:19.7259151Z",
"state": "active",
"stateTransitionTime": "2023-05-11T08:04:19.7259151Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2023-05-11T08:05:22.0020052Z",
"vmSize": "standard_a1_v2",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 2,
"targetDedicatedNodes": 2,
"currentLowPriorityNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2016-datacenter-smalldisk",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.windows amd64",
"windowsConfiguration": {
"enableAutomaticUpdates": false
},
"serviceArtifactReference": {
"id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
}
},
"currentNodeCommunicationMode": "classic"
}
Pool get
Voorbeeldaanvraag
GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0
Voorbeeldrespons
{
"id": "pool",
"url": "https://account.region.batch.azure.com/pools/pool",
"eTag": "0x8D413091E739A56",
"lastModified": "2016-11-22T18:55:25.2608598Z",
"creationTime": "2016-11-22T18:55:24.2632496Z",
"state": "active",
"stateTransitionTime": "2016-11-22T18:55:24.2632496Z",
"allocationState": "steady",
"allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z",
"vmSize": "standard_a1",
"resizeTimeout": "PT15M",
"currentDedicatedNodes": 0,
"currentLowPriorityNodes": 0,
"targetDedicatedNodes": 0,
"targetLowPriorityNodes": 0,
"enableAutoScale": false,
"enableInterNodeCommunication": false,
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"taskSlotsPerNode": 1,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"virtualMachineConfiguration": {
"imageReference": {
"publisher": "Canonical",
"offer": "0001-com-ubuntu-server-focal",
"sku": "20_04-lts",
"version": "latest"
},
"nodeAgentSKUId": "batch.node.ubuntu 20.04"
}
}
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. |
Auto |
De resultaten en fouten van een uitvoering van een formule voor automatische schaalaanpassing van groepen. |
Auto |
Een fout die is opgetreden bij het uitvoeren of evalueren van een formule voor automatische schaalaanpassing van groepen. |
Auto |
Het bereik voor de automatische gebruiker |
Auto |
Hiermee geeft u de parameters voor de automatische gebruiker die een taak uitvoert op 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-bestandsshare. |
Batch |
Een foutbericht dat is 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 cache dat moet worden ingeschakeld voor de schijf. |
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 moeten toegang 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 |
De configuratie voor rekenknooppunten in een pool op basis van het Azure Cloud Services-platform. |
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 met container. |
Container |
Een privécontainerregister. |
Container |
De te gebruiken containertechnologie. |
Container |
De locatie van de werkmap van de 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 koppelen en formatteren vanuit een virtuele machine om ze te kunnen gebruiken. |
Diff |
Hiermee geeft u de tijdelijke schijfplaatsing op voor de 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 groep. De configuratie van schijfversleuteling wordt niet ondersteund in een Linux-pool die is gemaakt met azure Compute Gallery-installatiekopie. |
Disk |
De lijst met schijfdoelen 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 ontvangen in een Azure Batch antwoord. |
Image |
Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een installatiekopieën van een Azure Compute Gallery. Zie de bewerking Ondersteunde installatiekopieën weergeven voor een lijst met alle Azure Marketplace Afbeeldingsverwijzingen die door Azure Batch zijn geverifieerd. |
Inbound |
Het protocol van het eindpunt. |
Inbound |
Een binnenkomende NAT-pool die kan worden gebruikt om specifieke poorten op rekenknooppunten in een Batch-pool extern te adresseren. |
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 aan elk knooppunt moet worden gekoppeld. |
Name |
Vertegenwoordigt een naam-waardepaar. |
Network |
De netwerkconfiguratie voor een pool. |
Network |
Een netwerkbeveiligingsgroepregel 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 |
Configuratie van knooppuntplaatsing 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 |
Een fout die is 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. |
Security |
Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op. |
Security |
Hiermee geeft u het Beveiligingstype 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 om dezelfde versie van de installatiekopieën in te stellen voor alle virtuele machines in de schaalset bij het gebruik van de meest recente versie van de installatiekopieën. |
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 een nieuwe installatiekopie wordt gemaakt. |
Storage |
Het opslagaccounttype voor gebruik bij het maken van gegevensschijven of besturingssysteemschijven. |
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 bij het maken van de virtuele machine. |
Usage |
Statistieken met betrekking tot gebruiksgegevens voor groepen. |
User |
Eigenschappen die worden gebruikt om een gebruiker te maken die wordt gebruikt om taken uit te voeren op een Azure Batch-rekenknooppunt. |
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. |
VMExtension |
De configuratie voor extensies van virtuele machines. |
Windows |
Instellingen van het Windows-besturingssysteem die moeten worden toegepast 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 |
Het formaat 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 krijgt deze status wanneer deze wordt gemaakt en wanneer er geen bewerkingen worden uitgevoerd op 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. |
AutoScaleRun
De resultaten en fouten van een uitvoering van een formule voor automatische schaalaanpassing van groepen.
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 is mislukt. |
|
results |
string |
De uiteindelijke waarden van alle variabelen die worden gebruikt bij de evaluatie van de formule voor automatisch schalen. |
timestamp |
string |
Het tijdstip waarop de formule voor automatische schaalaanpassing voor het laatst is geëvalueerd. |
AutoScaleRunError
Een fout die is opgetreden bij het uitvoeren of evalueren van een formule voor automatische schaalaanpassing van groepen.
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 om te worden weergegeven 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 voor de automatische gebruiker die een taak uitvoert op 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 die moeten worden doorgegeven aan de koppelingsopdracht. |
containerName |
string |
De Azure Blob Storage containernaam. |
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 AZURE Storage SAS-token. |
AzureFileShareConfiguration
Informatie die wordt gebruikt om verbinding te maken met een Azure-bestandsshare.
Name | Type | Description |
---|---|---|
accountKey |
string |
De Azure Storage-accountsleutel. |
accountName |
string |
De naam van het Azure Storage-account. |
azureFileUrl |
string |
De URL van Azure Files. |
mountOptions |
string |
Aanvullende opdrachtregelopties die moeten worden doorgegeven aan de koppelingsopdracht. |
relativeMountPath |
string |
Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld |
BatchError
Een foutbericht dat is 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 details 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 Value aangeeft. |
value |
string |
De aanvullende informatie die is opgenomen in de foutreactie. |
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 cache dat moet worden ingeschakeld voor de schijf.
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 moeten toegang 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 LocalMachine-certificaatarchief. |
CertificateVisibility
Welke gebruikersaccounts op het rekenknooppunt moeten toegang 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 AutoUser-bereik 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 die moeten worden doorgegeven aan de koppelingsopdracht. |
password |
string |
Het wachtwoord dat moet worden gebruikt voor verificatie met het CIFS-bestandssysteem. |
relativeMountPath |
string |
Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld |
source |
string |
De URI van het bestandssysteem dat moet worden gekoppeld. |
username |
string |
De gebruiker die moet worden gebruikt voor verificatie met 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 bereikt. |
applicationLicenses |
string[] |
De lijst met toepassingslicenties die de Batch-service beschikbaar maakt op elk rekenknooppunt in de pool. |
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 aan 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 . |
|
cloudServiceConfiguration |
De cloudserviceconfiguratie voor de pool. |
|
creationTime |
string |
De aanmaaktijd van de pool. |
currentDedicatedNodes |
integer |
Het aantal toegewezen rekenknooppunten dat zich momenteel in de pool bevindt. |
currentLowPriorityNodes |
integer |
Het aantal spot-rekenknooppunten/rekenknooppunten met 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 het zwembad. |
enableAutoScale |
boolean |
Of de grootte van de pool automatisch moet worden aangepast in de loop van de tijd. |
enableInterNodeCommunication |
boolean |
Of de pool directe communicatie tussen rekenknooppunten toestaat. |
id |
string |
Een tekenreeks die de pool in het account uniek identificeert. |
identity |
De identiteit van de Batch-pool, indien geconfigureerd. |
|
lastModified |
string |
De laatste wijzigingstijd van de pool. |
metadata |
Een lijst met naam-waardeparen die als metagegevens zijn gekoppeld aan de pool. |
|
mountConfiguration |
Een lijst met bestandssystemen die aan elk knooppunt in de pool moeten worden gekoppeld. |
|
networkConfiguration |
De netwerkconfiguratie voor de pool. |
|
resizeErrors |
Een lijst met fouten die zijn 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 zijn gekoppeld aan de pool. |
startTask |
Een taak die is opgegeven om te worden uitgevoerd op elk rekenknooppunt wanneer het lid wordt van de pool. |
|
state |
De huidige status van de pool. |
|
stateTransitionTime |
string |
Het tijdstip waarop de pool de huidige status heeft bereikt. |
stats |
Statistieken over gebruik en resourcegebruik voor de hele levensduur van de pool. |
|
targetDedicatedNodes |
integer |
Het gewenste aantal toegewezen rekenknooppunten in de pool. |
targetLowPriorityNodes |
integer |
Het gewenste aantal spot-rekenknooppunten/rekenknooppunten met lage prioriteit in de pool. |
targetNodeCommunicationMode |
De gewenste knooppuntcommunicatiemodus 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. |
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. |
CloudServiceConfiguration
De configuratie voor rekenknooppunten in een pool op basis van het Azure Cloud Services-platform.
Name | Type | Description |
---|---|---|
osFamily |
string |
De Azure-gastbesturingssysteemfamilie die moet worden geïnstalleerd op de virtuele machines in de pool. |
osVersion |
string |
De versie van het Azure-gastbesturingssystemen die moet worden geïnstalleerd op de virtuele machines in de pool. |
ComputeNodeFillType
Hoe taken worden verdeeld over rekenknooppunten in een pool.
Name | Type | Description |
---|---|---|
pack |
string |
Er moeten zoveel mogelijk taken (taskSlotsPerNode) worden toegewezen aan elk rekenknooppunt in de pool voordat er 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 met container.
Name | Type | Description |
---|---|---|
containerImageNames |
string[] |
De verzameling containerinstallatiekopieën. |
containerRegistries |
Aanvullende privéregisters waaruit containers kunnen worden opgehaald. |
|
type |
De te gebruiken containertechnologie. |
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 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 te gebruiken containertechnologie.
Name | Type | Description |
---|---|---|
criCompatible |
string |
Er wordt een op CRI gebaseerde technologie 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 van de containertaak.
Name | Type | Description |
---|---|---|
containerImageDefault |
string |
Gebruik de werkmap die is gedefinieerd in de containerinstallatiekopieën. Deze map bevat niet de bronbestanden die door Batch zijn gedownload. |
taskWorkingDirectory |
string |
Gebruik de standaardwerkmap taak van de Batch-service, die de taakbronbestanden bevat die door Batch worden gevuld. |
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 koppelen en formatteren vanuit een virtuele machine 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 logische eenheidsnummer. |
storageAccountType |
Het type opslagaccount dat moet worden gebruikt voor de gegevensschijf. |
DiffDiskPlacement
Hiermee geeft u de tijdelijke schijfplaatsing op voor de 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 de besturingssysteemschijf voor alle VM's in de groep. |
DiskEncryptionConfiguration
De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de groep. De configuratie van schijfversleuteling wordt niet ondersteund in een Linux-pool die is gemaakt met azure Compute Gallery-installatiekopie.
Name | Type | Description |
---|---|---|
targets |
De lijst met schijfdoelen Batch Service wordt versleuteld op het rekenknooppunt. |
DiskEncryptionTarget
De lijst met schijfdoelen 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. In 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 ontvangen in een Azure Batch antwoord.
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 installatiekopieën van een Azure Compute Gallery. Zie de bewerking Ondersteunde installatiekopieën weergeven voor een lijst met alle Azure Marketplace Afbeeldingsverwijzingen die door Azure Batch zijn geverifieerd.
Name | Type | Description |
---|---|---|
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 alleen van 'versie' als de waarde die is opgegeven voor 'versie' toen de pool werd gemaakt, 'meest recente' was. |
offer |
string |
Het aanbiedingstype van de Azure Virtual Machines Marketplace-installatiekopieën. |
publisher |
string |
De uitgever van de Azure Virtual Machines Marketplace-installatiekopieën. |
sku |
string |
De SKU van de Azure Virtual Machines Marketplace-installatiekopieën. |
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 heeft de vorm /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} om altijd de meest recente versie van de installatiekopie te gebruiken. |
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 Batch-pool extern te adresseren.
Name | Type | Description |
---|---|---|
backendPort |
integer |
Het poortnummer op het rekenknooppunt. |
frontendPortRangeEnd |
integer |
Het laatste poortnummer in het bereik van externe poorten dat wordt gebruikt om binnenkomende toegang te bieden tot de backendPort op afzonderlijke rekenknooppunten. |
frontendPortRangeStart |
integer |
Het eerste poortnummer in het bereik van externe poorten dat wordt gebruikt om binnenkomende toegang te bieden tot de backendPort op afzonderlijke rekenknooppunten. |
name |
string |
De naam van het eindpunt. |
networkSecurityGroupRules |
Een lijst met netwerkbeveiligingsgroepsregels 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 modus batchaanmelding wordt aanbevolen voor langdurige parallelle processen. |
interactive |
string |
De LOGON32_LOGON_INTERACTIVE Win32-aanmeldingsmodus. UAC is ingeschakeld voor Windows VirtualMachineConfiguration Pools. Als deze optie wordt gebruikt met een verhoogde gebruikersidentiteit in een Windows VirtualMachineConfiguration-pool, wordt de gebruikerssessie niet verhoogd, tenzij de toepassing die wordt uitgevoerd door de taakopdrachtregel is geconfigureerd om altijd beheerdersbevoegdheden of om altijd maximale bevoegdheden te vereisen. |
ManagedDisk
Name | Type | Description |
---|---|---|
storageAccountType |
Het opslagaccounttype voor de 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 aan elk knooppunt moet worden gekoppeld.
Name | Type | Description |
---|---|---|
azureBlobFileSystemConfiguration |
De Azure Storage-container die moet worden gekoppeld met behulp van blob FUSE op elk knooppunt. |
|
azureFileShareConfiguration |
De Azure-bestandsshare die aan elk knooppunt moet worden gekoppeld. |
|
cifsMountConfiguration |
Het CIFS/SMB-bestandssysteem dat aan elk knooppunt moet worden gekoppeld. |
|
nfsMountConfiguration |
Het NFS-bestandssysteem dat aan 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 configuratie van het openbare IP-adres 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 gekoppeld. Dit heeft de vorm /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. |
NetworkSecurityGroupRule
Een netwerkbeveiligingsgroepregel 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 de tag die 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 die moeten worden doorgegeven aan de koppelingsopdracht. |
relativeMountPath |
string |
Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld |
source |
string |
De URI van het bestandssysteem dat moet worden gekoppeld. |
NodeCommunicationMode
Bepaalt hoe een pool communiceert met de Batch-service.
Name | Type | Description |
---|---|---|
classic |
string |
Voor knooppunten die de klassieke communicatiemodus gebruiken, is binnenkomende TCP-communicatie vereist op poorten 29876 en 29877 van batchnodemanagement. Servicetag {region} en uitgaande TCP-communicatie op poort 443 naar storage.region en BatchNodeManagement. {region}'-servicetags. |
default |
string |
De communicatiemodus voor het knooppunt wordt automatisch ingesteld door de Batch-service. |
simplified |
string |
Knooppunten die de vereenvoudigde communicatiemodus gebruiken, vereisen uitgaande TCP-communicatie op poort 443 naar batchnodemanagement. Servicetag {region}. Er zijn geen open binnenkomende poorten vereist. |
NodePlacementConfiguration
Configuratie van knooppuntplaatsing voor een pool.
Name | Type | Description |
---|---|---|
policy |
Type beleid voor knooppuntplaatsing 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 toegewezen in dezelfde regio. |
zonal |
string |
Knooppunten in de pool worden verdeeld over verschillende beschikbaarheidszones met een optimale taakverdeling. |
OSDisk
Instellingen voor de besturingssysteemschijf van het rekenknooppunt (VM).
Name | Type | Description |
---|---|---|
caching |
Hiermee geeft u de cachevereisten op. Mogelijke waarden zijn: None, ReadOnly, ReadWrite. De standaardwaarden zijn: Geen voor Standard-opslag. ReadOnly voor Premium-opslag. |
|
diskSizeGB |
integer |
De initiële 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 in- 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 |
Er is geen identiteit aan de Batch-pool gekoppeld. Als u de updategroep instelt |
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 om taken uit te voeren, afhankelijk van de beschikbaarheid van rekenknooppunten. |
deleting |
string |
De gebruiker heeft gevraagd 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
Een fout die is opgetreden bij het wijzigen van het formaat van een pool.
Name | Type | Description |
---|---|---|
code |
string |
Een id voor de fout Bij het wijzigen van de poolgrootte. 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, bedoeld om te worden weergegeven in een gebruikersinterface. |
values |
Een lijst met aanvullende foutdetails met betrekking tot de fout Bij het wijzigen van de poolgrootte. |
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 naam begint met het opgegeven voorvoegsel, worden gedownload. |
fileMode |
string |
Het kenmerk bestandsmachtigingsmodus in octale indeling. |
filePath |
string |
De locatie op het rekenknooppunt waarnaar het bestand(en) moet worden gedownload, 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 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 |
De 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 schijfleesbewerkingen voor alle rekenknooppunten in de pool. |
diskReadIOps |
integer |
Het totale aantal schijfleesbewerkingen voor alle rekenknooppunten in de groep. |
diskWriteGiB |
number |
De totale hoeveelheid gegevens in GiB van schijfschrijfbewerkingen op alle rekenknooppunten in de pool. |
diskWriteIOps |
integer |
Het totale aantal schrijfbewerkingen op alle rekenknooppunten in de groep. |
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 netwerkleesbewerkingen voor alle rekenknooppunten in de pool. |
networkWriteGiB |
number |
De totale hoeveelheid gegevens in GiB van netwerkschrijfbewerkingen op alle rekenknooppunten in de pool. |
peakDiskGiB |
number |
De piek gebruikte schijfruimte in GiB op 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. |
SecurityProfile
Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op.
Name | Type | Description |
---|---|---|
encryptionAtHost |
boolean |
Deze eigenschap kan door de gebruiker in de aanvraag worden gebruikt om hostversleuteling voor de virtuele machine of virtuele-machineschaalset in of uit te schakelen. Hiermee schakelt u de versleuteling in voor alle schijven, inclusief de resource-/tijdelijke schijf op de host zelf. |
securityType |
Hiermee geeft u het Beveiligingstype 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 bij het maken van de virtuele machine. |
SecurityTypes
Hiermee geeft u het Beveiligingstype van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen.
Name | Type | Description |
---|---|---|
trustedLaunch |
string |
Vertrouwde lancering beschermt tegen geavanceerde en permanente aanvalstechnieken. |
ServiceArtifactReference
Hiermee geeft u de referentie-id voor serviceartefacten op die wordt gebruikt om dezelfde versie van de installatiekopieën in te stellen voor alle virtuele machines in de schaalset bij het gebruik van de meest recente versie van de installatiekopieën.
Name | Type | Description |
---|---|---|
id |
string |
De serviceartefactreferentie-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 een nieuwe installatiekopie wordt gemaakt.
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 uitgevoerd. |
resourceFiles |
Een lijst met bestanden die de Batch-service naar het rekenknooppunt downloadt voordat de opdrachtregel wordt uitgevoerd. 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 gebeurt, moet de verzameling ResourceFiles worden verkleind. Dit kan worden bereikt met behulp van .zip-bestanden, toepassingspakketten of Docker-containers. |
|
userIdentity |
De gebruikersidentiteit waaronder de 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 opslagaccounttype voor gebruik bij het maken van gegevensschijven of besturingssysteemschijven.
Name | Type | Description |
---|---|---|
premium_lrs |
string |
De gegevensschijf/besturingssysteemschijf moet gebruikmaken van premium lokaal redundante opslag. |
standard_lrs |
string |
De gegevensschijf/besturingssysteemschijf moet gebruikmaken van standaard lokaal redundante opslag. |
standardssd_lrs |
string |
De gegevensschijf/besturingssysteemschijf moet gebruikmaken van standaard lokaal redundante SSD-opslag. |
TaskContainerSettings
De containerinstellingen voor een taak.
Name | Type | Description |
---|---|---|
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 van de 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 bij 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. |
UsageStatistics
Statistieken met betrekking tot gebruiksgegevens voor groepen.
Name | Type | Description |
---|---|---|
dedicatedCoreTime |
string |
De geaggregeerde kloktijd 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-rekenknooppunt.
Name | Type | Description |
---|---|---|
elevationLevel |
Het uitbreidingsniveau van het gebruikersaccount. |
|
linuxUserConfiguration |
De Linux-specifieke gebruikersconfiguratie voor het gebruikersaccount. |
|
name |
string |
De naam van het gebruikersaccount. Namen kunnen Unicode-tekens bevatten met 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 groep. |
diskEncryptionConfiguration |
De schijfversleutelingsconfiguratie voor de pool. |
|
extensions |
De virtuele-machine-extensie voor de pool. |
|
imageReference |
Een verwijzing naar de Azure Virtual Machines Marketplace-installatiekopieën of de aangepaste vm-installatiekopieën die moeten worden gebruikt. |
|
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 knooppuntplaatsing 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. |
|
serviceArtifactReference |
Hiermee geeft u de serviceartefactreferentie-id op die wordt gebruikt om dezelfde versie van de installatiekopieën in te stellen voor alle virtuele machines in de schaalset bij gebruik van de nieuwste versie van de installatiekopieën. |
|
windowsConfiguration |
Windows-besturingssysteeminstellingen op de virtuele machine. |
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 is geïmplementeerd, worden secundaire versies echter niet bijgewerkt, tenzij opnieuw geïmplementeerd, zelfs 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 bevatten of helemaal geen beveiligde instellingen bevatten. |
provisionAfterExtensions |
string[] |
De verzameling extensienamen. |
publisher |
string |
De naam van de uitgever van de extensie-handler. |
settings |
object |
Met JSON opgemaakte openbare instellingen voor de extensie. |
type |
string |
Het type van de extensie. |
typeHandlerVersion |
string |
De versie van scripthandler. |
WindowsConfiguration
Instellingen van het Windows-besturingssysteem die moeten worden toegepast 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 |