Share via


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
batchUrl
path True

string

De basis-URL voor alle Azure Batch serviceaanvragen.

poolId
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

CloudPool

Een antwoord met de pool.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
Other Status Codes

BatchError

De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

Add a VirtualMachineConfiguration pool with OS disk
Get a pool with AcceleratedNetworking
Get a VirtualMachineConfiguration pool with extensions
Get a VirtualMachineConfiguration pool with SecurityProfile
Get a VirtualMachineConfiguration pool with ServiceArtifactReference
Pool get

Add a VirtualMachineConfiguration pool with OS disk

Sample Request

GET account.region.batch.azure.com/pools/mypool001?api-version=2023-11-01.18.0


Sample Response

{
  "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

Sample Request

GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0


Sample Response

{
  "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

Sample Request

GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0


Sample Response

{
  "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

Sample Request

GET account.region.batch.azure.com/pools/mypool001?api-version=2023-11-01.18.0


Sample Response

{
  "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

Sample Request

GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0


Sample Response

{
  "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

Sample Request

GET account.region.batch.azure.com/pools/pool?api-version=2023-11-01.18.0


Sample Response

{
  "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
AllocationState

Of de grootte van de pool wordt gewijzigd.

ApplicationPackageReference

Een verwijzing naar een pakket dat moet worden geïmplementeerd op rekenknooppunten.

AutoScaleRun

De resultaten en fouten van een uitvoering van een formule voor automatische schaalaanpassing van groepen.

AutoScaleRunError

Een fout die is opgetreden bij het uitvoeren of evalueren van een formule voor automatische schaalaanpassing van groepen.

AutoUserScope

Het bereik voor de automatische gebruiker

AutoUserSpecification

Hiermee geeft u de parameters voor de automatische gebruiker die een taak uitvoert op de Batch-service.

AzureBlobFileSystemConfiguration

Informatie die wordt gebruikt om verbinding te maken met een Azure Storage-container met behulp van Blobfuse.

AzureFileShareConfiguration

Informatie die wordt gebruikt om verbinding te maken met een Azure-bestandsshare.

BatchError

Een foutbericht dat is ontvangen van de Azure Batch-service.

BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

BatchPoolIdentity

De identiteit van de Batch-pool, indien geconfigureerd.

CachingType

Het type cache dat moet worden ingeschakeld voor de schijf.

CertificateReference

Een verwijzing naar een certificaat dat moet worden geïnstalleerd op rekenknooppunten in een pool.

CertificateStoreLocation

De locatie van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd.

CertificateVisibility

Welke gebruikersaccounts op het rekenknooppunt moeten toegang hebben tot de persoonlijke gegevens van het certificaat.

CIFSMountConfiguration

Informatie die wordt gebruikt om verbinding te maken met een CIFS-bestandssysteem.

CloudPool

Een pool in de Azure Batch-service.

CloudServiceConfiguration

De configuratie voor rekenknooppunten in een pool op basis van het Azure Cloud Services-platform.

ComputeNodeFillType

Hoe taken worden verdeeld over rekenknooppunten in een pool.

ComputeNodeIdentityReference

De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.

ContainerConfiguration

De configuratie voor pools met container.

ContainerRegistry

Een privécontainerregister.

ContainerType

De te gebruiken containertechnologie.

ContainerWorkingDirectory

De locatie van de werkmap van de containertaak.

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.

DiffDiskPlacement

Hiermee geeft u de tijdelijke schijfplaatsing op voor de besturingssysteemschijf voor alle rekenknooppunten (VM's) in de groep.

DiffDiskSettings

Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf die wordt gebruikt door het rekenknooppunt (VM).

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.

DiskEncryptionTarget

De lijst met schijfdoelen Batch Service wordt versleuteld op het rekenknooppunt.

DynamicVNetAssignmentScope

Het bereik van dynamische vnet-toewijzing.

ElevationLevel

Het hoogteniveau van de gebruiker.

EnvironmentSetting

Een omgevingsvariabele die moet worden ingesteld voor een taakproces.

ErrorMessage

Een foutbericht ontvangen in een Azure Batch antwoord.

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.

InboundEndpointProtocol

Het protocol van het eindpunt.

InboundNATPool

Een binnenkomende NAT-pool die kan worden gebruikt om specifieke poorten op rekenknooppunten in een Batch-pool extern te adresseren.

IPAddressProvisioningType

Het inrichtingstype voor openbare IP-adressen voor de groep.

LinuxUserConfiguration

Eigenschappen die worden gebruikt voor het maken van een gebruikersaccount op een Linux-rekenknooppunt.

LoginMode

De aanmeldingsmodus voor de gebruiker

ManagedDisk
MetadataItem

Een naam-waardepaar dat is gekoppeld aan een Batch-serviceresource.

MountConfiguration

Het bestandssysteem dat aan elk knooppunt moet worden gekoppeld.

NameValuePair

Vertegenwoordigt een naam-waardepaar.

NetworkConfiguration

De netwerkconfiguratie voor een pool.

NetworkSecurityGroupRule

Een netwerkbeveiligingsgroepregel die moet worden toegepast op een binnenkomend eindpunt.

NetworkSecurityGroupRuleAccess

De actie die moet worden uitgevoerd voor een opgegeven IP-adres, subnetbereik of tag.

NFSMountConfiguration

Informatie die wordt gebruikt om verbinding te maken met een NFS-bestandssysteem.

NodeCommunicationMode

Bepaalt hoe een pool communiceert met de Batch-service.

NodePlacementConfiguration

Configuratie van knooppuntplaatsing voor een pool.

NodePlacementPolicyType

Het plaatsingsbeleid voor het toewijzen van knooppunten in de pool.

OSDisk

Instellingen voor de besturingssysteemschijf van het rekenknooppunt (VM).

PoolEndpointConfiguration

De eindpuntconfiguratie voor een pool.

PoolIdentityType

De identiteit van de Batch-pool, indien geconfigureerd.

PoolState

De huidige status van de pool.

PoolStatistics

Bevat gebruiks- en resourcegebruiksstatistieken voor de levensduur van een pool.

PublicIPAddressConfiguration

De configuratie van het openbare IP-adres van de netwerkconfiguratie van een pool.

ResizeError

Een fout die is opgetreden bij het wijzigen van het formaat van een pool.

ResourceFile

Eén bestand of meerdere bestanden die moeten worden gedownload naar een rekenknooppunt.

ResourceStatistics

Statistieken met betrekking tot resourceverbruik door rekenknooppunten in een pool.

SecurityProfile

Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op.

SecurityTypes

Hiermee geeft u het Beveiligingstype van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen.

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.

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.

StorageAccountType

Het opslagaccounttype voor gebruik bij het maken van gegevensschijven of besturingssysteemschijven.

TaskContainerSettings

De containerinstellingen voor een taak.

TaskSchedulingPolicy

Hiermee geeft u op hoe taken moeten worden verdeeld over rekenknooppunten.

UefiSettings

Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt bij het maken van de virtuele machine.

UsageStatistics

Statistieken met betrekking tot gebruiksgegevens voor groepen.

UserAccount

Eigenschappen die worden gebruikt om een gebruiker te maken die wordt gebruikt om taken uit te voeren op een Azure Batch-rekenknooppunt.

UserAssignedIdentity

De door de gebruiker toegewezen identiteit

UserIdentity

De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd.

VirtualMachineConfiguration

De configuratie voor rekenknooppunten in een pool op basis van de Azure Virtual Machines-infrastructuur.

VMExtension

De configuratie voor extensies van virtuele machines.

WindowsConfiguration

Instellingen van het Windows-besturingssysteem die moeten worden toegepast op de virtuele machine.

WindowsUserConfiguration

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.
Wanneer u een groep maakt, moet de toepassings-id van het pakket volledig zijn gekwalificeerd (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).

version

string

De versie van de toepassing die moet worden geïmplementeerd. Als u dit weglaat, wordt de standaardversie geïmplementeerd.
Als dit wordt weggelaten in een pool en er geen standaardversie is opgegeven voor deze toepassing, mislukt de aanvraag met de foutcode InvalidApplicationPackageReferences en HTTP-statuscode 409. Als dit wordt weggelaten voor een taak en er geen standaardversie is opgegeven voor deze toepassing, mislukt de taak met een voorverwerkingsfout.

AutoScaleRun

De resultaten en fouten van een uitvoering van een formule voor automatische schaalaanpassing van groepen.

Name Type Description
error

AutoScaleRunError

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.
Elke variabelewaarde wordt geretourneerd in de vorm $variable=waarde en variabelen worden gescheiden door puntkomma's.

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

NameValuePair[]

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

ElevationLevel

Het hoogteniveau van de automatische gebruiker.
De standaardwaarde is nonAdmin.

scope

AutoUserScope

Het bereik voor de automatische gebruiker
De standaardwaarde is pool. Als op de groep Windows wordt uitgevoerd, moet een waarde van Taak worden opgegeven als striktere isolatie tussen taken is vereist. Bijvoorbeeld als de taak het register muteert op een manier die van invloed kan zijn op andere taken, of als er certificaten zijn opgegeven in de groep die niet toegankelijk moet zijn voor normale taken, maar toegankelijk moet zijn door StartTasks.

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.
Deze eigenschap is wederzijds exclusief met zowel sasKey als identiteit; Er moet precies één worden opgegeven.

accountName

string

De naam van het Azure Storage-account.

blobfuseOptions

string

Aanvullende opdrachtregelopties die moeten worden doorgegeven aan de koppelingsopdracht.
Dit zijn 'net use'-opties in Windows en 'koppelopties' in Linux.

containerName

string

De Azure Blob Storage containernaam.

identityReference

ComputeNodeIdentityReference

De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot containerName
Deze eigenschap is wederzijds exclusief met zowel accountKey als sasKey; Er moet precies één worden opgegeven.

relativeMountPath

string

Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld
Alle bestandssystemen worden gekoppeld ten opzichte van de Batch-koppelingsmap, toegankelijk via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.

sasKey

string

Het AZURE Storage SAS-token.
Deze eigenschap is wederzijds exclusief met zowel accountKey als identiteit; Er moet precies één worden opgegeven.

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.
Dit heeft de vorm 'https://{account}.file.core.windows.net/'.

mountOptions

string

Aanvullende opdrachtregelopties die moeten worden doorgegeven aan de koppelingsopdracht.
Dit zijn 'net use'-opties in Windows en 'koppelopties' in Linux.

relativeMountPath

string

Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld
Alle bestandssystemen worden gekoppeld ten opzichte van de Batch-koppelingsmap, toegankelijk via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.

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

ErrorMessage

Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.

values

BatchErrorDetail[]

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

PoolIdentityType

De identiteit van de Batch-pool, indien geconfigureerd.
De lijst met gebruikersidentiteiten die zijn gekoppeld aan de Batch-pool. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

userAssignedIdentities

UserAssignedIdentity[]

De lijst met gebruikersidentiteiten die zijn gekoppeld aan het Batch-account.
De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

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

CertificateStoreLocation

De locatie van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd.
De standaardwaarde is currentuser. Deze eigenschap is alleen van toepassing op pools die zijn geconfigureerd met Windows-rekenknooppunten (dat wil gezegd, gemaakt met cloudServiceConfiguration of met virtualMachineConfiguration met behulp van een Referentie voor Windows-installatiekopieën). Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap Taak en een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR wordt geleverd aan de taak om een query uit te voeren op deze locatie. Voor certificaten met zichtbaarheid van 'remoteUser' wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst.

storeName

string

De naam van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd.
Deze eigenschap is alleen van toepassing op pools die zijn geconfigureerd met Windows-rekenknooppunten (dat wil gezegd, gemaakt met cloudServiceConfiguration of met virtualMachineConfiguration met behulp van een Referentie voor Windows-installatiekopieën). Algemene winkelnamen zijn: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, maar elke aangepaste winkelnaam kan ook worden gebruikt. De standaardwaarde is Mijn.

thumbprint

string

De vingerafdruk van het certificaat.

thumbprintAlgorithm

string

Het algoritme waaraan de vingerafdruk is gekoppeld. Dit moet sha1 zijn.

visibility

CertificateVisibility[]

Welke gebruikersaccounts op het rekenknooppunt moeten toegang hebben tot de persoonlijke gegevens van het certificaat.
U kunt meer dan één zichtbaarheid in deze verzameling opgeven. De standaardwaarde is alle accounts.

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.
Dit zijn 'net use'-opties in Windows en 'koppelopties' in Linux.

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
Alle bestandssystemen worden gekoppeld ten opzichte van de Batch-koppelingsmap, toegankelijk via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.

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

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.
De lijst met toepassingslicenties moet een subset zijn van beschikbare licenties voor Batch-servicetoepassingen. Als er een licentie wordt aangevraagd die niet wordt ondersteund, mislukt het maken van de pool.

applicationPackageReferences

ApplicationPackageReference[]

De lijst met pakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool.
Wijzigingen in pakketverwijzingen zijn van invloed op alle nieuwe knooppunten die lid worden van de pool, maar hebben geen invloed op rekenknooppunten die zich al in de pool bevinden totdat ze opnieuw worden opgestart of opnieuw zijn geïnstalleerd. Er zijn maximaal 10 pakketverwijzingen voor een bepaalde pool.

autoScaleEvaluationInterval

string

Het tijdsinterval waarmee de poolgrootte automatisch moet worden aangepast aan de formule voor automatische schaalaanpassing.
Deze eigenschap wordt alleen ingesteld als de pool automatisch wordt geschaald, dat wil zeggen dat enableAutoScale true is.

autoScaleFormula

string

Een formule voor het gewenste aantal rekenknooppunten in de pool.
Deze eigenschap wordt alleen ingesteld als de pool automatisch wordt geschaald, dat wil zeggen dat enableAutoScale true is.

autoScaleRun

AutoScaleRun

De resultaten en fouten van de laatste uitvoering van de formule voor automatische schaalaanpassing.
Deze eigenschap wordt alleen ingesteld als de pool automatisch wordt geschaald, dat wil zeggen dat enableAutoScale true is.

certificateReferences

CertificateReference[]

De lijst met certificaten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool.
Voor Windows-knooppunten installeert de Batch-service de certificaten in het opgegeven certificaatarchief en de opgegeven locatie. Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap Taak en een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR wordt geleverd aan de taak om een query uit te voeren op deze locatie. Voor certificaten met zichtbaarheid van 'remoteUser' wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst.

Waarschuwing: deze eigenschap is afgeschaft en wordt na februari 2024 verwijderd. Gebruik in plaats daarvan de Azure KeyVault-extensie .

cloudServiceConfiguration

CloudServiceConfiguration

De cloudserviceconfiguratie voor de pool.
Deze eigenschap en virtualMachineConfiguration sluiten elkaar uit en een van de eigenschappen moet worden opgegeven. Deze eigenschap kan niet worden opgegeven als het Batch-account is gemaakt met de eigenschap poolAllocationMode ingesteld op UserSubscription.

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.
Spot-rekenknooppunten met lage prioriteit die zijn gepreempteerd, worden opgenomen in dit aantal.

currentNodeCommunicationMode

NodeCommunicationMode

De huidige status van de groepscommunicatiemodus.

displayName

string

De weergavenaam voor de pool.
De weergavenaam hoeft niet uniek te zijn en kan Unicode-tekens bevatten met een maximale lengte van 1024.

eTag

string

De ETag van het zwembad.
Dit is een ondoorzichtige tekenreeks. U kunt deze gebruiken om te detecteren of de pool is gewijzigd tussen aanvragen. U kunt met name de ETag doorgeven bij het bijwerken van een pool om op te geven dat uw wijzigingen alleen van kracht moeten worden als niemand anders de pool in de tussentijd heeft gewijzigd.

enableAutoScale

boolean

Of de grootte van de pool automatisch moet worden aangepast in de loop van de tijd.
Indien onwaar, moet ten minste één van de targetDedicatedNodes en targetLowPriorityNodes worden opgegeven. Als dit waar is, is de eigenschap autoScaleFormula vereist en wordt de grootte van de pool automatisch aangepast volgens de formule. De standaardwaarde is false.

enableInterNodeCommunication

boolean

Of de pool directe communicatie tussen rekenknooppunten toestaat.
Dit legt beperkingen op aan welke rekenknooppunten kunnen worden toegewezen aan de pool. Als u deze waarde opgeeft, kan de kans verkleinen dat het aangevraagde aantal rekenknooppunten in de pool wordt toegewezen.

id

string

Een tekenreeks die de pool in het account uniek identificeert.
De id kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 64 tekens bevatten. De id is hoofdletterbewaarbaar en niet hoofdlettergevoelig (dat wil gezegd, u hebt mogelijk geen twee id's binnen een account die alleen per geval verschillen).

identity

BatchPoolIdentity

De identiteit van de Batch-pool, indien geconfigureerd.
De lijst met gebruikersidentiteiten die zijn gekoppeld aan de Batch-pool. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

lastModified

string

De laatste wijzigingstijd van de pool.
Dit is de laatste keer dat de gegevens op poolniveau, zoals de instellingen targetDedicatedNodes of enableAutoscale, zijn gewijzigd. Er wordt geen rekening meege houden met wijzigingen op knooppuntniveau, zoals het wijzigen van de status van een rekenknooppunt.

metadata

MetadataItem[]

Een lijst met naam-waardeparen die als metagegevens zijn gekoppeld aan de pool.

mountConfiguration

MountConfiguration[]

Een lijst met bestandssystemen die aan elk knooppunt in de pool moeten worden gekoppeld.
Dit ondersteunt Azure Files, NFS, CIFS/SMB en Blobfuse.

networkConfiguration

NetworkConfiguration

De netwerkconfiguratie voor de pool.
De netwerkconfiguratie voor een pool.

resizeErrors

ResizeError[]

Een lijst met fouten die zijn opgetreden tijdens het uitvoeren van de laatste grootte van de pool.
Deze eigenschap wordt alleen ingesteld als er een of meer fouten zijn opgetreden tijdens de laatste poolgrootte en alleen wanneer pool allocationState Stabiel is.

resizeTimeout

string

De time-out voor de toewijzing van rekenknooppunten aan de pool.
Dit is de time-out voor de meest recente bewerking voor het wijzigen van de grootte. (De initiële groottebepaling wanneer de pool wordt gemaakt, telt als een formaat wijzigen.) De standaardwaarde is 15 minuten.

resourceTags

object

De door de gebruiker opgegeven tags die zijn gekoppeld aan de pool.
De door de gebruiker gedefinieerde tags die moeten worden gekoppeld aan de Azure Batch pool. Indien opgegeven, worden deze tags doorgegeven aan de back-up van Azure-resources die zijn gekoppeld aan de pool. Deze eigenschap kan alleen worden opgegeven wanneer het Batch-account is gemaakt met de eigenschap poolAllocationMode ingesteld op UserSubscription.

startTask

StartTask

Een taak die is opgegeven om te worden uitgevoerd op elk rekenknooppunt wanneer het lid wordt van de pool.
Batch voert taken opnieuw uit wanneer een herstelbewerking wordt geactiveerd op een knooppunt. Voorbeelden van herstelbewerkingen zijn (maar zijn niet beperkt tot) wanneer een beschadigd knooppunt opnieuw wordt opgestart of een rekenknooppunt is verdwenen vanwege een hostfout. Nieuwe pogingen vanwege herstelbewerkingen zijn onafhankelijk van en worden niet meegeteld voor de maxTaskRetryCount. Zelfs als de maxTaskRetryCount 0 is, kan er een interne nieuwe poging vanwege een herstelbewerking plaatsvinden. Daarom moeten alle taken idempotent zijn. Dit betekent dat taken moeten worden onderbroken en opnieuw worden opgestart zonder beschadiging of dubbele gegevens te veroorzaken. De best practice voor langlopende taken is om een vorm van controlepunten te gebruiken. In sommige gevallen kan de StartTask opnieuw worden uitgevoerd, zelfs als het rekenknooppunt niet opnieuw is opgestart. Wees voorzichtig met het vermijden van StartTasks die een breakaway-proces maken of services installeren/starten vanuit de werkmap StartTask, omdat dit voorkomt dat Batch de StartTask opnieuw kan uitvoeren.

state

PoolState

De huidige status van de pool.

stateTransitionTime

string

Het tijdstip waarop de pool de huidige status heeft bereikt.

stats

PoolStatistics

Statistieken over gebruik en resourcegebruik voor de hele levensduur van de pool.
Deze eigenschap wordt alleen ingevuld als de CloudPool is opgehaald met een uitbreidingscomponent, waaronder het kenmerk 'stats'; anders is het null. De statistieken zijn mogelijk niet onmiddellijk beschikbaar. De Batch-service voert periodiek samengetelde statistieken uit. De typische vertraging is ongeveer 30 minuten.

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

NodeCommunicationMode

De gewenste knooppuntcommunicatiemodus voor de pool.
Als u dit weglaat, is de standaardwaarde Standaard.

taskSchedulingPolicy

TaskSchedulingPolicy

Hoe taken worden verdeeld over rekenknooppunten in een pool.
Als dit niet is opgegeven, is de standaardwaarde spread.

taskSlotsPerNode

integer

Het aantal taaksites dat kan worden gebruikt om gelijktijdige taken uit te voeren op één rekenknooppunt in de pool.
De standaardwaarde is 1. De maximumwaarde is de kleinste van 4 keer het aantal kernen van de vmSize van de pool of 256.

url

string

De URL van de pool.

userAccounts

UserAccount[]

De lijst met gebruikersaccounts die moeten worden gemaakt op elk rekenknooppunt in de pool.

virtualMachineConfiguration

VirtualMachineConfiguration

De configuratie van de virtuele machine voor de pool.
Deze eigenschap en cloudServiceConfiguration sluiten elkaar uit en een van de eigenschappen moet worden opgegeven.

vmSize

string

De grootte van virtuele machines in de pool. Alle virtuele machines in een pool hebben dezelfde grootte.
Zie Een VM-grootte kiezen voor rekenknooppunten in een Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes) voor informatie over de beschikbare grootten van virtuele machines in pools.

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.
Mogelijke waarden zijn: 2 - OS-familie 2, gelijk aan Windows Server 2008 R2 SP1. 3 - OS-familie 3, gelijk aan Windows Server 2012. 4 - OS-familie 4, gelijk aan Windows Server 2012 R2. 5 - OS-familie 5, gelijk aan Windows Server 2016. 6 - Os-familie 6, gelijk aan Windows Server 2019. Zie Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases) voor meer informatie.

osVersion

string

De versie van het Azure-gastbesturingssystemen die moet worden geïnstalleerd op de virtuele machines in de pool.
De standaardwaarde is * waarmee de meest recente versie van het besturingssysteem voor de opgegeven besturingssysteemfamilie wordt opgegeven.

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.
Dit is de volledige installatiekopiereferentie, zoals wordt opgegeven bij 'docker pull'. Een installatiekopieën worden opgehaald uit het standaard Docker-register, tenzij de installatiekopieën volledig zijn gekwalificeerd met een alternatief register.

containerRegistries

ContainerRegistry[]

Aanvullende privéregisters waaruit containers kunnen worden opgehaald.
Als installatiekopieën moeten worden gedownload uit een privéregister waarvoor referenties zijn vereist, moeten deze referenties hier worden opgegeven.

type

ContainerType

De te gebruiken containertechnologie.

ContainerRegistry

Een privécontainerregister.

Name Type Description
identityReference

ComputeNodeIdentityReference

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.
De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.

password

string

Het wachtwoord om u aan te melden bij de registerserver.

registryServer

string

De register-URL.
Als u dit weglaat, is de standaardwaarde 'docker.io'.

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

CachingType

Het type caching dat moet worden ingeschakeld voor de gegevensschijven.
De standaardwaarde voor opslaan in cache is readwrite. Zie voor meer informatie over de cacheopties: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB

integer

De initiële schijfgrootte in gigabytes.

lun

integer

Het logische eenheidsnummer.
De lun wordt gebruikt om elke gegevensschijf uniek te identificeren. Als u meerdere schijven koppelt, moet elk een afzonderlijke lun hebben. De waarde moet tussen 0 en 63 liggen, inclusief.

storageAccountType

StorageAccountType

Het type opslagaccount dat moet worden gebruikt voor de gegevensschijf.
Als u dit weglaat, is de standaardwaarde 'standard_lrs'.

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

DiffDiskPlacement

Hiermee geeft u de tijdelijke schijfplaatsing voor de besturingssysteemschijf voor alle VM's in de groep.
Deze eigenschap kan door de gebruiker in de aanvraag worden gebruikt om de locatie te kiezen, bijvoorbeeld cacheschijfruimte voor het inrichten van tijdelijke besturingssysteemschijven. Raadpleeg Voor meer informatie over de vereisten voor tijdelijke besturingssysteemschijfgrootten de vereisten voor de schijfgrootte van kortstondige besturingssystemen voor Windows-VM's op https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements en Linux-VM's op https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

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

DiskEncryptionTarget[]

De lijst met schijfdoelen Batch Service wordt versleuteld op het rekenknooppunt.
Als u dit weglaat, worden er geen schijven op de rekenknooppunten in de pool versleuteld. In Een Linux-pool wordt alleen 'TemporaryDisk' ondersteund; op Windows-pool moeten 'OsDisk' en 'TemporaryDisk' worden opgegeven.

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.
Bijvoorbeeld UbuntuServer of WindowsServer.

publisher

string

De uitgever van de Azure Virtual Machines Marketplace-installatiekopieën.
Bijvoorbeeld Canonical of MicrosoftWindowsServer.

sku

string

De SKU van de Azure Virtual Machines Marketplace-installatiekopieën.
Bijvoorbeeld 18.04-LTS of 2019-Datacenter.

version

string

De versie van de Azure Virtual Machines Marketplace-installatiekopieën.
De waarde 'nieuwste' kan worden opgegeven om de nieuwste versie van een installatiekopieën te selecteren. Als u dit weglaat, is de standaardwaarde 'nieuwste'.

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.
Deze eigenschap is wederzijds exclusief met andere ImageReference-eigenschappen. De installatiekopieën van de Azure Compute Gallery moeten replica's in dezelfde regio hebben en moeten zich in hetzelfde abonnement bevinden als het Azure Batch-account. Als de versie van de installatiekopieën niet is opgegeven in de imageId, wordt de meest recente versie gebruikt. Zie voor informatie over de firewallinstellingen voor de Batch Compute Node-agent om te communiceren met de Batch-service https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

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.
Dit moet uniek zijn binnen een Batch-pool. Acceptabele waarden liggen tussen 1 en 65535, met uitzondering van 22, 3389, 29876 en 29877, omdat deze zijn gereserveerd. Als er gereserveerde waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.

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.
Acceptabele waarden liggen tussen 1 en 65534, met uitzondering van poorten van 50000 tot 55000 die zijn gereserveerd door de Batch-service. Alle bereiken binnen een pool moeten verschillend zijn en mogen elkaar niet overlappen. Elk bereik moet ten minste 40 poorten bevatten. Als er gereserveerde of overlappende waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.

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.
Acceptabele waarden liggen tussen 1 en 65534, met uitzondering van poorten van 50000 tot 55000 die zijn gereserveerd. Alle bereiken binnen een pool moeten verschillend zijn en mogen elkaar niet overlappen. Elk bereik moet ten minste 40 poorten bevatten. Als er gereserveerde of overlappende waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.

name

string

De naam van het eindpunt.
De naam moet uniek zijn binnen een Batch-pool en kan letters, cijfers, onderstrepingstekens, punten en afbreekstreepjes bevatten. Namen moeten beginnen met een letter of cijfer, moeten eindigen op een letter, cijfer of onderstrepingsteken en mogen niet langer zijn dan 77 tekens. Als er ongeldige waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.

networkSecurityGroupRules

NetworkSecurityGroupRule[]

Een lijst met netwerkbeveiligingsgroepsregels die worden toegepast op het eindpunt.
Het maximum aantal regels dat kan worden opgegeven voor alle eindpunten in een Batch-pool is 25. Als er geen regels voor netwerkbeveiligingsgroepen zijn opgegeven, wordt er een standaardregel gemaakt om binnenkomende toegang tot de opgegeven backendPort toe te staan. Als het maximum aantal regels voor netwerkbeveiligingsgroepen wordt overschreden, mislukt de aanvraag met HTTP-statuscode 400.

protocol

InboundEndpointProtocol

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.
De eigenschappen uid en gid moeten samen worden opgegeven of helemaal niet. Als dit niet is opgegeven, kiest het onderliggende besturingssysteem de gid.

sshPrivateKey

string

De persoonlijke SSH-sleutel voor het gebruikersaccount.
De persoonlijke sleutel mag niet met een wachtwoord zijn beveiligd. De persoonlijke sleutel wordt gebruikt voor het automatisch configureren van verificatie op basis van asymmetrische sleutels voor SSH tussen rekenknooppunten in een Linux-pool wanneer de eigenschap enableInterNodeCommunication van de pool waar is (deze wordt genegeerd als enableInterNodeCommunication onwaar is). Dit doet u door het sleutelpaar in de .ssh-map van de gebruiker te plaatsen. Als dit niet is opgegeven, wordt SSH zonder wachtwoord niet geconfigureerd tussen rekenknooppunten (er wordt geen wijziging van de .ssh-map van de gebruiker uitgevoerd).

uid

integer

De gebruikers-id van het gebruikersaccount.
De eigenschappen uid en gid moeten samen worden opgegeven of helemaal niet. Als dit niet is opgegeven, kiest het onderliggende besturingssysteem de uid.

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

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

AzureBlobFileSystemConfiguration

De Azure Storage-container die moet worden gekoppeld met behulp van blob FUSE op elk knooppunt.
Deze eigenschap is wederzijds exclusief met alle andere eigenschappen.

azureFileShareConfiguration

AzureFileShareConfiguration

De Azure-bestandsshare die aan elk knooppunt moet worden gekoppeld.
Deze eigenschap is wederzijds exclusief met alle andere eigenschappen.

cifsMountConfiguration

CIFSMountConfiguration

Het CIFS/SMB-bestandssysteem dat aan elk knooppunt moet worden gekoppeld.
Deze eigenschap is wederzijds exclusief met alle andere eigenschappen.

nfsMountConfiguration

NFSMountConfiguration

Het NFS-bestandssysteem dat aan elk knooppunt moet worden gekoppeld.
Deze eigenschap is wederzijds exclusief met alle andere eigenschappen.

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

DynamicVNetAssignmentScope

Het bereik van dynamische vnet-toewijzing.

enableAcceleratedNetworking

boolean

Of deze pool versneld netwerken moet inschakelen.
Versneld netwerken maakt I/O-virtualisatie met één hoofdmap (SR-IOV) voor een VM mogelijk, wat kan leiden tot verbeterde netwerkprestaties. Zie https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview voor meer informatie.

endpointConfiguration

PoolEndpointConfiguration

De configuratie voor eindpunten op rekenknooppunten in de Batch-pool.
Configuratie van pooleindpunten wordt alleen ondersteund in pools met de eigenschap virtualMachineConfiguration.

publicIPAddressConfiguration

PublicIPAddressConfiguration

De configuratie van het openbare IP-adres voor rekenknooppunten in de Batch-pool.
Openbare IP-configuratie-eigenschap wordt alleen ondersteund in pools met de eigenschap virtualMachineConfiguration.

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}.
Het virtuele netwerk moet zich in dezelfde regio en hetzelfde abonnement bevinden als het Azure Batch-account. Het opgegeven subnet moet voldoende vrije IP-adressen hebben voor het aantal rekenknooppunten in de pool. Als het subnet onvoldoende vrije IP-adressen heeft, wijst de groep gedeeltelijk knooppunten toe en treedt er een fout bij het wijzigen van het formaat op. De service-principal MicrosoftAzureBatch moet de rol Inzender voor klassieke virtuele machines Role-Based Access Control (RBAC) hebben voor het opgegeven VNet. Het opgegeven subnet moet communicatie van de Azure Batch-service toestaan om taken op de knooppunten te kunnen plannen. Dit kan worden gecontroleerd door te controleren of het opgegeven VNet gekoppelde netwerkbeveiligingsgroepen (NSG's) heeft. Als communicatie met de knooppunten in het opgegeven subnet wordt geweigerd door een NSG, stelt de Batch-service de status van de rekenknooppunten in op onbruikbaar. Voor pools die zijn gemaakt met virtualMachineConfiguration worden alleen virtuele ARM-netwerken ('Microsoft.Network/virtualNetworks') ondersteund, maar voor pools die zijn gemaakt met cloudServiceConfiguration worden zowel ARM- als klassieke virtuele netwerken ondersteund. Als aan het opgegeven VNet NSG’s (netwerkbeveiligingsgroepen) zijn gekoppeld, moeten een paar gereserveerde poorten worden ingeschakeld voor binnenkomende communicatie. Schakel voor pools die zijn gemaakt met een virtuele-machineconfiguratie poorten 29876 en 29877 in, evenals poort 22 voor Linux en poort 3389 voor Windows. Schakel voor pools die zijn gemaakt met een cloudserviceconfiguratie de poorten 10100, 20100 en 30100 in. Schakel ook uitgaande verbindingen met Azure Storage in op poort 443. Zie voor meer informatie: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Een netwerkbeveiligingsgroepregel die moet worden toegepast op een binnenkomend eindpunt.

Name Type Description
access

NetworkSecurityGroupRuleAccess

De actie die moet worden uitgevoerd voor een opgegeven IP-adres, subnetbereik of tag.

priority

integer

De prioriteit voor deze regel.
Prioriteiten binnen een pool moeten uniek zijn en worden geëvalueerd in volgorde van prioriteit. Hoe lager het getal, hoe hoger de prioriteit. Regels kunnen bijvoorbeeld worden opgegeven met ordernummers van 150, 250 en 350. De regel met het volgordenummer 150 heeft voorrang op de regel met een volgorde van 250. Toegestane prioriteiten zijn 150 tot 4096. Als gereserveerde of dubbele waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.

sourceAddressPrefix

string

Het bronadresvoorvoegsel of de tag die overeenkomt met de regel.
Geldige waarden zijn één IP-adres (dat wil zeggen 10.10.10.10), IP-subnet (bijvoorbeeld 192.168.1.0/24), standaardtag of * (voor alle adressen). Als er andere waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.

sourcePortRanges

string[]

De bronpoortbereiken die overeenkomen met de regel.
Geldige waarden zijn '' (voor alle poorten 0 - 65535), een specifieke poort (dat wil zeggen 22) of een poortbereik (bijvoorbeeld 100-200). De poorten moeten tussen 0 en 65535 liggen. Elke vermelding in deze verzameling mag geen andere vermeldingen overlappen (een bereik of een afzonderlijke poort). Als er andere waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400. De standaardwaarde is ''.

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.
Dit zijn 'net use'-opties in Windows en 'koppelopties' in Linux.

relativeMountPath

string

Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld
Alle bestandssystemen worden gekoppeld ten opzichte van de Batch-koppelingsmap, toegankelijk via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.

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

NodePlacementPolicyType

Type beleid voor knooppuntplaatsing in Batch-pools.
Toewijzingsbeleid dat door Batch Service wordt gebruikt om de knooppunten in te richten. Als dit niet is opgegeven, gebruikt Batch het regionale beleid.

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

CachingType

Hiermee geeft u de cachevereisten op. Mogelijke waarden zijn: None, ReadOnly, ReadWrite. De standaardwaarden zijn: Geen voor Standard-opslag. ReadOnly voor Premium-opslag.
De standaardwaarde voor opslaan in de cache is geen. Zie voor meer informatie over de cacheopties: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB

integer

De initiële schijfgrootte in GB bij het maken van een nieuwe besturingssysteemschijf.

ephemeralOSDiskSettings

DiffDiskSettings

Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf die wordt gebruikt door het rekenknooppunt (VM).

managedDisk

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

InboundNATPool[]

Een lijst met binnenkomende NAT-pools die kunnen worden gebruikt om specifieke poorten op een afzonderlijk rekenknooppunt extern aan te pakken.
Het maximum aantal binnenkomende NAT-pools per Batch-pool is 5. Als het maximum aantal binnenkomende NAT-pools wordt overschreden, mislukt de aanvraag met HTTP-statuscode 400. Dit kan niet worden opgegeven als het IPAddressProvisioningType NoPublicIPAddresses is.

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 None , worden bestaande identiteiten verwijderd.

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

ResourceStatistics

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

UsageStatistics

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.
Het aantal IP-adressen dat hier is opgegeven, beperkt de maximale grootte van de pool: 100 toegewezen knooppunten of 100 spot-/lage prioriteitsknooppunten kunnen worden toegewezen voor elk openbaar IP-adres. Een pool die bijvoorbeeld 250 toegewezen VM's nodig heeft, moet ten minste 3 openbare IP-adressen opgegeven hebben. Elk element van deze verzameling heeft de volgende vorm: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision

IPAddressProvisioningType

Het inrichtingstype voor openbare IP-adressen voor de groep.
De standaardwaarde is BatchManaged.

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

NameValuePair[]

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.
De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar uit en een van deze eigenschappen moet worden opgegeven.

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.
De eigenschap is alleen geldig wanneer autoStorageContainerName of storageContainerUrl wordt gebruikt. Dit voorvoegsel kan een gedeeltelijke bestandsnaam of een submap zijn. Als er geen voorvoegsel is opgegeven, worden alle bestanden in de container gedownload.

fileMode

string

Het kenmerk bestandsmachtigingsmodus in octale indeling.
Deze eigenschap is alleen van toepassing op bestanden die worden gedownload naar Linux-rekenknooppunten. Deze wordt genegeerd als deze is opgegeven voor een resourceFile die wordt gedownload naar een Windows-rekenknooppunt. Als deze eigenschap niet is opgegeven voor een Linux-rekenknooppunt, wordt de standaardwaarde 0770 toegepast op het bestand.

filePath

string

De locatie op het rekenknooppunt waarnaar het bestand(en) moet worden gedownload, ten opzichte van de werkmap van de taak.
Als de eigenschap httpUrl is opgegeven, is filePath vereist en wordt het pad beschreven waarnaar het bestand wordt gedownload, inclusief de bestandsnaam. Als de eigenschap autoStorageContainerName of storageContainerUrl is opgegeven, is filePath optioneel en de map waar de bestanden naar moeten worden gedownload. In het geval dat filePath wordt gebruikt als een map, wordt elke mapstructuur die al aan de invoergegevens is gekoppeld, volledig bewaard en toegevoegd aan de opgegeven filePath-map. Het opgegeven relatieve pad kan niet worden doorbroken uit de werkmap van de taak (bijvoorbeeld met behulp van '..').

httpUrl

string

De URL van het bestand dat u wilt downloaden.
De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar uit en een van deze eigenschappen moet worden opgegeven. Als de URL naar Azure Blob Storage verwijst, moet deze leesbaar zijn vanuit rekenknooppunten. Er zijn drie manieren om een dergelijke URL voor een blob in Azure Storage op te halen: voeg een Shared Access Signature (SAS) toe die leesmachtigingen verleent voor de blob, gebruik een beheerde identiteit met leesmachtiging of stel de ACL in voor de blob of de bijbehorende container om openbare toegang toe te staan.

identityReference

ComputeNodeIdentityReference

De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage opgegeven door storageContainerUrl of httpUrl
De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.

storageContainerUrl

string

De URL van de blobcontainer in Azure Blob Storage.
De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar uit en een van deze eigenschappen moet worden opgegeven. Deze URL moet kunnen worden gelezen en vermeld vanuit rekenknooppunten. Er zijn drie manieren om een dergelijke URL voor een container in Azure Storage op te halen: voeg een Sas (Shared Access Signature) toe die lees- en lijstmachtigingen verleent voor de container, gebruik een beheerde identiteit met lees- en lijstmachtigingen, of stel de ACL voor de container in om openbare toegang toe te staan.

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

SecurityTypes

Hiermee geeft u het Beveiligingstype van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen.

uefiSettings

UefiSettings

Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt bij het maken van de virtuele machine.
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
De serviceartefactreferentie-id in de vorm van /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

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.
De opdrachtregel wordt niet uitgevoerd onder een shell en kan daarom niet profiteren van shellfuncties zoals omgevingsvariabeleuitbreiding. Als u van dergelijke functies wilt profiteren, moet u de shell in de opdrachtregel aanroepen, bijvoorbeeld met behulp van 'cmd /c Mijnopdracht' in Windows of '/bin/sh -c MyCommand' in Linux. Als de opdrachtregel naar bestandspaden verwijst, moet deze een relatief pad gebruiken (ten opzichte van de taakwerkmap) of de door Batch opgegeven omgevingsvariabele (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) gebruiken.

containerSettings

TaskContainerSettings

De instellingen voor de container waaronder de StartTask wordt uitgevoerd.
Wanneer dit is opgegeven, worden alle mappen recursief onder de AZ_BATCH_NODE_ROOT_DIR (de hoofdmap van Azure Batch mappen op het knooppunt) toegewezen aan de container, worden alle taakomgevingsvariabelen toegewezen aan de container en wordt de taakopdrachtregel uitgevoerd in de container. Bestanden die buiten AZ_BATCH_NODE_ROOT_DIR in de container worden geproduceerd, worden mogelijk niet weergegeven op de hostschijf, wat betekent dat Batch-bestands-API's geen toegang hebben tot deze bestanden.

environmentSettings

EnvironmentSetting[]

Een lijst met omgevingsvariabele-instellingen voor de StartTask.

maxTaskRetryCount

integer

Het maximum aantal keren dat de taak opnieuw kan worden uitgevoerd.
De Batch-service probeert een taak opnieuw uit te voeren als de afsluitcode een andere is dan nul. Houd er rekening mee dat deze waarde specifiek het aantal nieuwe pogingen bepaalt. De Batch-service probeert de taak eenmaal en kan vervolgens opnieuw proberen tot deze limiet. Als het maximumaantal nieuwe pogingen bijvoorbeeld 3 is, probeert Batch de taak maximaal 4 keer (één initiële poging en 3 nieuwe pogingen). Als het maximumaantal nieuwe pogingen 0 is, voert de Batch-service de taak niet opnieuw uit. Als het maximumaantal nieuwe pogingen -1 is, probeert de Batch-service de taak opnieuw zonder limiet, maar dit wordt niet aanbevolen voor een starttaak of een taak. De standaardwaarde is 0 (geen nieuwe pogingen).

resourceFiles

ResourceFile[]

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.
Bestanden die onder dit element worden vermeld, bevinden zich in de werkmap van de taak.

userIdentity

UserIdentity

De gebruikersidentiteit waaronder de StartTask wordt uitgevoerd.
Als u dit weglaat, wordt de taak uitgevoerd als een gebruiker zonder beheerdersrechten die uniek is voor de taak.

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.
Als waar en de StartTask mislukt op een knooppunt, probeert de Batch-service de StartTask opnieuw tot het maximale aantal nieuwe pogingen (maxTaskRetryCount). Als de taak na alle nieuwe pogingen nog steeds niet is voltooid, markeert de Batch-service het knooppunt als onbruikbaar en worden er geen taken op gepland. Deze voorwaarde kan worden gedetecteerd via de details van de status van het rekenknooppunt en de foutgegevens. Als dit onwaar is, wacht de Batch-service niet totdat de StartTask is voltooid. In dit geval kunnen andere taken worden uitgevoerd op het rekenknooppunt terwijl de StartTask nog steeds wordt uitgevoerd; en zelfs als de StartTask mislukt, worden er nog steeds nieuwe taken gepland op het rekenknooppunt. De standaardwaarde is true.

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.
Deze extra opties worden geleverd als argumenten voor de opdracht 'docker maken', naast de opties die worden beheerd door de Batch-service.

imageName

string

De installatiekopieën die moeten worden gebruikt om de container te maken waarin de taak wordt uitgevoerd.
Dit is de volledige verwijzing naar de installatiekopie, zoals wordt opgegeven bij 'docker pull'. Als er geen tag wordt opgegeven als onderdeel van de naam van de installatiekopieën, wordt de tag ':latest' standaard gebruikt.

registry

ContainerRegistry

Het privéregister dat de containerinstallatiekopieën bevat.
Deze instelling kan worden weggelaten als deze al is opgegeven bij het maken van de pool.

workingDirectory

ContainerWorkingDirectory

De locatie van de werkmap van de containertaak.
De standaardwaarde is 'taskWorkingDirectory'.

TaskSchedulingPolicy

Hiermee geeft u op hoe taken moeten worden verdeeld over rekenknooppunten.

Name Type Description
nodeFillType

ComputeNodeFillType

Hoe taken worden verdeeld over rekenknooppunten in een pool.
Als dit niet is opgegeven, is de standaardwaarde spread.

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

ElevationLevel

Het uitbreidingsniveau van het gebruikersaccount.
De standaardwaarde is nonAdmin.

linuxUserConfiguration

LinuxUserConfiguration

De Linux-specifieke gebruikersconfiguratie voor het gebruikersaccount.
Deze eigenschap wordt genegeerd als deze is opgegeven in een Windows-groep. Als dit niet is opgegeven, wordt de gebruiker gemaakt met de standaardopties.

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

WindowsUserConfiguration

De Windows-specifieke gebruikersconfiguratie voor het gebruikersaccount.
Deze eigenschap kan alleen worden opgegeven als de gebruiker zich in een Windows-pool bevindt. Als dit niet is opgegeven en in een Windows-groep, wordt de gebruiker gemaakt met de standaardopties.

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

AutoUserSpecification

De automatische gebruiker waaronder de taak wordt uitgevoerd.
De eigenschappen userName en autoUser sluiten elkaar uit. u moet één, maar niet beide opgeven.

username

string

De naam van de gebruikersidentiteit waaronder de taak wordt uitgevoerd.
De eigenschappen userName en autoUser sluiten elkaar uit. u moet één, maar niet beide opgeven.

VirtualMachineConfiguration

De configuratie voor rekenknooppunten in een pool op basis van de Azure Virtual Machines-infrastructuur.

Name Type Description
containerConfiguration

ContainerConfiguration

De containerconfiguratie voor de pool.
Indien opgegeven, wordt de installatie uitgevoerd op elk rekenknooppunt in de pool, zodat taken in containers kunnen worden uitgevoerd. Alle normale taken en taakbeheertaken die in deze pool worden uitgevoerd, moeten de eigenschap containerSettings opgeven, en alle andere taken kunnen deze opgeven.

dataDisks

DataDisk[]

De configuratie voor gegevensschijven die zijn gekoppeld aan de rekenknooppunten in de groep.
Deze eigenschap moet worden opgegeven als aan de rekenknooppunten in de pool lege gegevensschijven moeten zijn gekoppeld. Dit kan niet worden bijgewerkt. Elk rekenknooppunt krijgt een eigen schijf (de schijf is geen bestandsshare). Bestaande schijven kunnen niet worden gekoppeld. Elke gekoppelde schijf is leeg. Wanneer het rekenknooppunt uit de pool wordt verwijderd, worden de schijf en alle bijbehorende gegevens ook verwijderd. De schijf is niet geformatteerd nadat deze is gekoppeld. Deze moet vóór gebruik worden geformatteerd. Zie en https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machinevoor meer informatie https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux .

diskEncryptionConfiguration

DiskEncryptionConfiguration

De schijfversleutelingsconfiguratie voor de pool.
Indien opgegeven, wordt versleuteling uitgevoerd op elk knooppunt in de pool tijdens het inrichten van knooppunten.

extensions

VMExtension[]

De virtuele-machine-extensie voor de pool.
Indien opgegeven, worden de extensies die in deze configuratie worden vermeld, op elk knooppunt geïnstalleerd.

imageReference

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.
Dit geldt alleen voor installatiekopieën die het Windows-besturingssysteem bevatten en mag alleen worden gebruikt wanneer u geldige on-premises licenties hebt voor de rekenknooppunten die worden geïmplementeerd. Als u dit weglaat, wordt er geen on-premises licentiekorting toegepast. Waarden zijn:

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.
De Batch Compute Node-agent is een programma dat wordt uitgevoerd op elk rekenknooppunt in de pool en biedt de command-and-control-interface tussen het rekenknooppunt en de Batch-service. Er zijn verschillende implementaties van de Compute Node-agent, ook wel SKU's genoemd, voor verschillende besturingssystemen. U moet een Compute Node-agent-SKU opgeven die overeenkomt met de geselecteerde afbeeldingsreferentie. Als u de lijst met ondersteunde SKU's van de Compute Node-agent wilt ophalen, samen met de bijbehorende lijst met geverifieerde installatiekopieën, raadpleegt u de bewerking 'SKU's van ondersteunde Compute Node-agent weergeven'.

nodePlacementConfiguration

NodePlacementConfiguration

De configuratie van de knooppuntplaatsing voor de pool.
Met deze configuratie worden regels opgegeven voor de wijze waarop knooppunten in de pool fysiek worden toegewezen.

osDisk

OSDisk

Instellingen voor de besturingssysteemschijf van de virtuele machine.

securityProfile

SecurityProfile

Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset.
Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset.

serviceArtifactReference

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.
De serviceartefactreferentie-id in de vorm van /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

windowsConfiguration

WindowsConfiguration

Windows-besturingssysteeminstellingen op de virtuele machine.
Deze eigenschap moet niet worden opgegeven als de eigenschap imageReference een Linux-besturingssysteeminstallatiekopie opgeeft.

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.
Verzameling extensienamen waarna deze extensie moet worden ingericht.

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.
Als u dit weglaat, is de standaardwaarde true.

WindowsUserConfiguration

Eigenschappen die worden gebruikt voor het maken van een gebruikersaccount op een Windows-rekenknooppunt.

Name Type Description
loginMode

LoginMode

De aanmeldingsmodus voor de gebruiker
De standaardwaarde voor VirtualMachineConfiguration-pools is 'batch' en voor CloudServiceConfiguration-pools is 'interactief'.