Job - Get

Hiermee haalt u informatie op over de opgegeven taak.

GET {batchUrl}/jobs/{jobId}?api-version=2023-11-01.18.0
GET {batchUrl}/jobs/{jobId}?$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.

jobId
path True

string

De id van de taak.

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

CloudJob

Een antwoord met de taak.

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

Job get

Sample Request

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


Sample Response

{
  "id": "jobId",
  "url": "https://account.region.batch.azure.com/jobs/jobId",
  "eTag": "0x8D4100FC49F0278",
  "lastModified": "2016-11-19T00:05:27.5391608Z",
  "creationTime": "2016-11-19T00:05:25.311915Z",
  "state": "completed",
  "stateTransitionTime": "2016-11-19T00:05:27.578581Z",
  "previousState": "active",
  "previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z",
  "priority": 0,
  "maxParallelTasks": -1,
  "allowTaskPreemption": false,
  "usesTaskDependencies": false,
  "constraints": {
    "maxWallClockTime": "P10675199DT2H48M5.4775807S",
    "maxTaskRetryCount": 0
  },
  "poolInfo": {
    "poolId": "poolId"
  },
  "executionInfo": {
    "startTime": "2016-11-19T00:05:25.3309105Z",
    "endTime": "2016-11-19T00:05:27.578581Z",
    "poolId": "poolId",
    "terminateReason": "UserTerminate"
  },
  "onAllTasksComplete": "noaction",
  "onTaskFailure": "noaction"
}

Definities

Name Description
AccessScope

De Batch-resources waaraan het token toegang verleent.

ApplicationPackageReference

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

AuthenticationTokenSettings

De instellingen voor een verificatietoken die de taak kan gebruiken om Batch-servicebewerkingen uit te voeren.

AutoPoolSpecification

Hiermee geeft u kenmerken voor een tijdelijke 'automatische pool'. De Batch-service maakt deze automatische pool wanneer de taak wordt verzonden.

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 FileShare.

BatchError

Een foutbericht ontvangen van de Azure Batch-service.

BatchErrorDetail

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

CachingType

Het type caching 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.

CloudJob

Een Azure Batch taak.

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 containertechnologie die moet worden gebruikt.

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 op 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 batchservice 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.

ErrorCategory

De categorie van de fout.

ErrorMessage

Een foutbericht ontvangen in een Azure Batch antwoord.

HttpHeader

Een http-headernaam-waardepaar

ImageReference

Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een Azure Compute Gallery-installatiekopieën. Zie de bewerking Ondersteunde installatiekopieën weergeven voor een lijst met alle Azure Marketplace Afbeeldingsverwijzingen die door Azure Batch zijn geverifieerd.

InboundEndpointProtocol

Het protocol van het eindpunt.

InboundNATPool

Een inkomende 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.

JobConstraints

De uitvoeringsbeperkingen voor een taak.

JobExecutionInformation

Bevat informatie over de uitvoering van een taak in de Azure Batch-service.

JobManagerTask

Hiermee geeft u de details van een Taakbeheertaak op.

JobNetworkConfiguration

De netwerkconfiguratie voor de taak.

JobPreparationTask

Een taakvoorbereidingstaak die moet worden uitgevoerd vóór taken van de taak op een bepaald rekenknooppunt.

JobReleaseTask

Een jobreleasetaak die moet worden uitgevoerd wanneer de taak is voltooid op een rekenknooppunt waarop de taak is uitgevoerd.

JobSchedulingError

Er is een fout opgetreden in de Batch-service bij het plannen van een taak.

JobState

De status van de taak.

JobStatistics

Statistieken over resourcegebruik voor een taak.

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.

OnAllTasksComplete

De actie die de Batch-service moet uitvoeren wanneer alle taken in de taak de status Voltooid hebben.

OnTaskFailure

De actie die de Batch-service moet uitvoeren wanneer een taak in de taak mislukt.

OSDisk

Instellingen voor de besturingssysteemschijf van het rekenknooppunt (VM).

OutputFile

Een specificatie voor het uploaden van bestanden van een Azure Batch-rekenknooppunt naar een andere locatie nadat de Batch-service klaar is met het uitvoeren van het taakproces.

OutputFileBlobContainerDestination

Hiermee geeft u een bestemming voor het uploaden van bestanden binnen een Azure Blob Storage-container.

OutputFileDestination

Het doel waarnaar een bestand moet worden geüpload.

OutputFileUploadCondition

De voorwaarden waaronder een taakuitvoerbestand of een set bestanden moet worden geüpload.

OutputFileUploadOptions

Details over een uploadbewerking voor uitvoerbestanden, waaronder onder welke voorwaarden het uploaden moet worden uitgevoerd.

PoolEndpointConfiguration

De eindpuntconfiguratie voor een pool.

PoolInformation

Hiermee geeft u op hoe een taak moet worden toegewezen aan een pool.

PoolLifetimeOption

De minimale levensduur van gemaakte automatische pools en de wijze waarop meerdere taken volgens een planning worden toegewezen aan pools.

PoolSpecification

Specificatie voor het maken van een nieuwe pool.

PublicIPAddressConfiguration

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

ResourceFile

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

SecurityProfile

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

SecurityTypes

Hiermee geeft u het SecurityType 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 opnieuw wordt geïnstalleerd.

StorageAccountType

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

TaskConstraints

Uitvoeringsbeperkingen die moeten worden toegepast op een taak.

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 tijdens het maken van de virtuele machine.

UserAccount

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

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.

AccessScope

De Batch-resources waaraan het token toegang verleent.

Name Type Description
job

string

Verleent toegang om alle bewerkingen uit te voeren op de taak die de taak bevat.

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.

AuthenticationTokenSettings

De instellingen voor een verificatietoken die de taak kan gebruiken om Batch-servicebewerkingen uit te voeren.

Name Type Description
access

AccessScope[]

De Batch-resources waaraan het token toegang verleent.
Het verificatietoken verleent toegang tot een beperkte set Batch-servicebewerkingen. Momenteel is de enige ondersteunde waarde voor de toegangseigenschap 'job', waarmee toegang wordt verleend aan alle bewerkingen die betrekking hebben op de taak die de taak bevat.

AutoPoolSpecification

Hiermee geeft u kenmerken voor een tijdelijke 'automatische pool'. De Batch-service maakt deze automatische pool wanneer de taak wordt verzonden.

Name Type Description
autoPoolIdPrefix

string

Een voorvoegsel dat moet worden toegevoegd aan de unieke id wanneer automatisch een pool wordt gemaakt.
De Batch-service wijst elke automatische pool een unieke id toe bij het maken. Als u onderscheid wilt maken tussen pools die voor verschillende doeleinden zijn gemaakt, kunt u dit element opgeven om een voorvoegsel toe te voegen aan de id die is toegewezen. Het voorvoegsel mag maximaal 20 tekens lang zijn.

keepAlive

boolean

Of u een automatische pool in leven wilt houden nadat de levensduur is verlopen.
Indien onwaar, verwijdert de Batch-service de pool zodra de levensduur (zoals bepaald door de instelling poolLifetimeOption) is verlopen; dat wil gezegd, wanneer de taak of taakplanning is voltooid. Als dit waar is, verwijdert de Batch-service de pool niet automatisch. Het is aan de gebruiker om automatische pools te verwijderen die met deze optie zijn gemaakt.

pool

PoolSpecification

De poolspecificatie voor de automatische pool.

poolLifetimeOption

PoolLifetimeOption

De minimale levensduur van gemaakte automatische pools en de wijze waarop meerdere taken volgens een planning worden toegewezen aan pools.

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

Extra opdrachtregelopties om door te geven aan de koppelingsopdracht.
Dit zijn opties voor 'net use' 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-koppelmap, toegankelijk via de AZ_BATCH_NODE_MOUNTS_DIR omgevingsvariabele.

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 FileShare.

Name Type Description
accountKey

string

De sleutel van het Azure Storage-account.

accountName

string

De naam van het Azure Storage-account.

azureFileUrl

string

De URL van Azure Files.
Dit heeft de vorm 'https://{account}.file.core.windows.net/'.

mountOptions

string

Extra opdrachtregelopties om door te geven aan de koppelingsopdracht.
Dit zijn opties voor 'net use' 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-koppelmap, toegankelijk via de AZ_BATCH_NODE_MOUNTS_DIR omgevingsvariabele.

BatchError

Een foutbericht ontvangen van de Azure Batch-service.

Name Type Description
code

string

Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.

message

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 informatie over de fout.

BatchErrorDetail

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

Name Type Description
key

string

Een id die de betekenis van de eigenschap Value aangeeft.

value

string

De aanvullende informatie die is opgenomen in de foutreactie.

CachingType

Het type caching 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 Verwijzing naar windows-installatiekopieën). Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap Taak en wordt een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR opgegeven bij 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 Verwijzing naar 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

Extra opdrachtregelopties om door te geven aan de koppelingsopdracht.
Dit zijn opties voor 'net use' 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-koppelmap, toegankelijk via de AZ_BATCH_NODE_MOUNTS_DIR omgevingsvariabele.

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.

CloudJob

Een Azure Batch taak.

Name Type Standaardwaarde Description
allowTaskPreemption

boolean

Of taken in deze taak kunnen worden overgeslagen door andere taken met hoge prioriteit
Als de waarde is ingesteld op Waar, hebben andere taken met hoge prioriteit die naar het systeem worden verzonden voorrang en kunnen taken uit deze taak worden verwijderd. U kunt de allowTaskPreemption van een taak bijwerken nadat deze is gemaakt met behulp van de API voor de updatetaak.

commonEnvironmentSettings

EnvironmentSetting[]

De lijst met algemene instellingen voor omgevingsvariabelen. Deze omgevingsvariabelen worden ingesteld voor alle taken in de taak (inclusief jobbeheer, taakvoorbereiding en taakreleasetaken).
Afzonderlijke taken kunnen een omgevingsinstelling die hier is opgegeven overschrijven door dezelfde instellingsnaam met een andere waarde op te geven.

constraints

JobConstraints

De uitvoeringsbeperkingen voor de taak.

creationTime

string

De aanmaaktijd van de taak.

displayName

string

De weergavenaam voor de taak.

eTag

string

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

executionInfo

JobExecutionInformation

De uitvoeringsinformatie voor de taak.

id

string

Een tekenreeks die de taak in het account uniek identificeert.
De id is hoofdletterbewaarbaar en niet hoofdlettergevoelig (dat wil dat u mogelijk geen twee id's binnen een account hebt die alleen per geval verschillen).

jobManagerTask

JobManagerTask

Details van een Taakbeheertaak die moet worden gestart wanneer de taak wordt gestart.
De taak Jobbeheer wordt automatisch gestart wanneer de taak wordt gemaakt. De Batch-service probeert de taak Job Manager te plannen vóór andere taken in de taak. Bij het verkleinen van een pool probeert de Batch-service knooppunten waarop Job Manager-taken worden uitgevoerd zo lang mogelijk te behouden (dat wil gezegd dat rekenknooppunten met 'normale' taken worden verwijderd voordat rekenknooppunten Job Manager-taken uitvoeren). Wanneer een Job Manager-taak mislukt en opnieuw moet worden gestart, probeert het systeem deze met de hoogste prioriteit te plannen. Als er geen niet-actieve rekenknooppunten beschikbaar zijn, kan het systeem een van de actieve taken in de pool beëindigen en deze terugbrengen naar de wachtrij om ruimte vrij te maken voor de Taakbeheertaak om opnieuw op te starten. Houd er rekening mee dat een Taakbeheertaak in de ene taak geen prioriteit heeft boven taken in andere taken. Voor alle taken worden alleen prioriteiten op taakniveau in acht genomen. Als een Job Manager in een taak met prioriteit 0 bijvoorbeeld opnieuw moet worden gestart, worden taken van een taak met prioriteit 1 niet verplaatst. 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 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 gestart zonder beschadiging of dubbele gegevens te veroorzaken. De best practice voor langlopende taken is om een vorm van controlepunten te gebruiken.

jobPreparationTask

JobPreparationTask

De taak voor het voorbereiden van de taak.
De taak voor taakvoorbereiding is een speciale taak die op elk rekenknooppunt wordt uitgevoerd vóór een andere taak van de taak.

jobReleaseTask

JobReleaseTask

De taak voor het vrijgeven van de taak.
De taak voor taakrelease is een speciale taakuitvoering aan het einde van de taak op elk rekenknooppunt waarop een andere taak van de taak is uitgevoerd.

lastModified

string

De laatste wijzigingstijd van de taak.
Dit is de laatste keer dat de gegevens op taakniveau, zoals de taakstatus of prioriteit, zijn gewijzigd. Het houdt geen rekening met wijzigingen op taakniveau, zoals het toevoegen van nieuwe taken of taken die de status wijzigen.

maxParallelTasks

integer

-1

Het maximum aantal taken dat parallel voor de taak kan worden uitgevoerd.
De waarde van maxParallelTasks moet -1 of groter zijn dan 0 indien opgegeven. Als u niet opgeeft, is de standaardwaarde -1, wat betekent dat er geen limiet is voor het aantal taken dat in één keer kan worden uitgevoerd. U kunt de maxParallelTasks van een taak bijwerken nadat deze is gemaakt met behulp van de API voor de updatetaak.

metadata

MetadataItem[]

Een lijst met naam-waardeparen die als metagegevens aan de taak zijn gekoppeld.
De Batch-service wijst geen betekenis toe aan metagegevens; het is uitsluitend voor het gebruik van gebruikerscode.

networkConfiguration

JobNetworkConfiguration

De netwerkconfiguratie voor de taak.

onAllTasksComplete

OnAllTasksComplete

De actie die de Batch-service moet uitvoeren wanneer alle taken in de taak de status Voltooid hebben.
De standaardwaarde is noaction.

onTaskFailure

OnTaskFailure

De actie die de Batch-service moet uitvoeren wanneer een taak in de taak mislukt.
Een taak wordt beschouwd als mislukt als het een failureInfo heeft. Een failureInfo wordt ingesteld als de taak wordt voltooid met een afsluitcode die niet nul is nadat het aantal nieuwe pogingen is uitgeput, of als er een fout is opgetreden bij het starten van de taak, bijvoorbeeld vanwege een fout bij het downloaden van een resourcebestand. De standaardwaarde is noaction.

poolInfo

PoolInformation

De poolinstellingen die zijn gekoppeld aan de taak.

previousState

JobState

De vorige status van de taak.
Deze eigenschap is niet ingesteld als de taak de oorspronkelijke status Actief heeft.

previousStateTransitionTime

string

Het tijdstip waarop de taak de vorige status heeft bereikt.
Deze eigenschap is niet ingesteld als de taak de oorspronkelijke status Actief heeft.

priority

integer

De prioriteit van de taak.
Prioriteitswaarden kunnen variëren van -1000 tot 1000, waarbij -1000 de laagste prioriteit is en 1000 de hoogste prioriteit. De standaardwaarde is 0.

state

JobState

De huidige status van de taak.

stateTransitionTime

string

Het tijdstip waarop de taak de huidige status heeft bereikt.

stats

JobStatistics

Statistieken over resourcegebruik voor de gehele levensduur van de taak.
Deze eigenschap wordt alleen ingevuld als de CloudJob 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.

url

string

De URL van de taak.

usesTaskDependencies

boolean

Of taken in de taak afhankelijkheden van elkaar kunnen definiëren. De standaardwaarde is false.

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 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 containertechnologie die moet worden gebruikt.

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 op 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 tijdelijke inrichting van besturingssysteemschijven. Raadpleeg voor meer informatie over de vereisten voor de schijfgrootte van een kortstondige besturingssysteemschijf 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 batchservice wordt versleuteld op het rekenknooppunt.

Name Type Description
osdisk

string

De besturingssysteemschijf op het rekenknooppunt is versleuteld.

temporarydisk

string

De tijdelijke schijf op het rekenknooppunt is versleuteld. Op Linux is deze versleuteling van toepassing op andere partities (zoals partities op gekoppelde gegevensschijven) wanneer versleuteling plaatsvindt tijdens het opstarten.

DynamicVNetAssignmentScope

Het bereik van dynamische vnet-toewijzing.

Name Type Description
job

string

Dynamische VNet-toewijzing wordt per taak uitgevoerd.

none

string

Er is geen dynamische VNet-toewijzing ingeschakeld.

ElevationLevel

Het hoogteniveau van de gebruiker.

Name Type Description
admin

string

De gebruiker is een gebruiker met verhoogde toegang en werkt met volledige beheerdersmachtigingen.

nonadmin

string

De gebruiker is een standaardgebruiker zonder verhoogde toegang.

EnvironmentSetting

Een omgevingsvariabele die moet worden ingesteld voor een taakproces.

Name Type Description
name

string

De naam van de omgevingsvariabele.

value

string

De waarde van de omgevingsvariabele.

ErrorCategory

De categorie van de fout.

Name Type Description
servererror

string

De fout wordt veroorzaakt door een intern serverprobleem.

usererror

string

De fout wordt veroorzaakt door een gebruikersprobleem, zoals een onjuiste configuratie.

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.

HttpHeader

Een http-headernaam-waardepaar

Name Type Description
name

string

De hoofdlettergevoelige naam van de header die moet worden gebruikt tijdens het uploaden van uitvoerbestanden

value

string

De waarde van de header die moet worden gebruikt tijdens het uploaden van uitvoerbestanden

ImageReference

Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een Azure Compute Gallery-installatiekopieën. Zie de bewerking Ondersteunde installatiekopieën weergeven 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 inkomende 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, aangezien deze zijn gereserveerd. Als 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 inkomende toegang te bieden tot de backendPort op afzonderlijke rekenknooppunten.
Acceptabele waarden variëren 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 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 inkomende toegang te bieden tot de backendPort op afzonderlijke rekenknooppunten.
Acceptabele waarden variëren 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 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 mag 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 regels voor netwerkbeveiligingsgroepen 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.

JobConstraints

De uitvoeringsbeperkingen voor een taak.

Name Type Description
maxTaskRetryCount

integer

Het maximum aantal keren dat elke taak opnieuw kan worden geprobeerd. De Batch-service probeert een taak opnieuw 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 elke taak eenmaal uit te voeren en kan het vervolgens opnieuw proberen tot deze limiet. Als het maximumaantal nieuwe pogingen bijvoorbeeld 3 is, probeert Batch maximaal vier keer een taak uit te voeren (één eerste poging en drie nieuwe pogingen). Als het maximumaantal nieuwe pogingen 0 is, voert de Batch-service taken niet opnieuw uit. Als het maximumaantal nieuwe pogingen -1 is, probeert de Batch-service taken opnieuw zonder limiet. De standaardwaarde is 0 (geen nieuwe pogingen).

maxWallClockTime

string

De maximaal verstreken tijd die de taak mag uitvoeren, gemeten vanaf het moment dat de taak wordt gemaakt.
Als de taak niet binnen de tijdslimiet wordt voltooid, beëindigt de Batch-service deze en eventuele taken die nog worden uitgevoerd. In dit geval is de reden voor beëindiging MaxWallClockTimeExpiry. Als deze eigenschap niet is opgegeven, is er geen tijdslimiet voor hoe lang de taak kan worden uitgevoerd.

JobExecutionInformation

Bevat informatie over de uitvoering van een taak in de Azure Batch-service.

Name Type Description
endTime

string

De voltooiingstijd van de taak.
Deze eigenschap wordt alleen ingesteld als de taak de status Voltooid heeft.

poolId

string

De id van de pool waaraan deze taak is toegewezen.
Dit element bevat de werkelijke pool waaraan de taak is toegewezen. Wanneer u taakgegevens van de service krijgt, bevatten deze ook het element poolInfo, dat de poolconfiguratiegegevens bevat van toen de taak werd toegevoegd of bijgewerkt. Dat element poolInfo kan ook een poolId-element bevatten. Als dit het geval is, zijn de twee id's hetzelfde. Als dit niet het geval is, betekent dit dat de taak is uitgevoerd op een automatische pool en dat deze eigenschap de id van die automatische groep bevat.

schedulingError

JobSchedulingError

Details van eventuele fouten die door de service zijn aangetroffen bij het starten van de taak.
Deze eigenschap is niet ingesteld als er geen fout is opgetreden bij het starten van de taak.

startTime

string

De begintijd van de taak.
Dit is het tijdstip waarop de taak is gemaakt.

terminateReason

string

Een tekenreeks die de reden beschrijft waarom de taak is beëindigd.
Deze eigenschap wordt alleen ingesteld als de taak de status Voltooid heeft. Als de Batch-service de taak beëindigt, wordt de reden als volgt ingesteld: JMComplete - de Taak van Job Manager voltooid en killJobOnCompletion is ingesteld op true. MaxWallClockTimeExpiry: de taak heeft de beperking maxWallClockTime bereikt. TerminateJobSchedule: de taak is uitgevoerd als onderdeel van een planning en de planning is beëindigd. AllTasksComplete: het kenmerk onAllTasksComplete van de taak is ingesteld op terminatejob en alle taken in de taak zijn voltooid. TaskFailed: het kenmerk onTaskFailure van de taak is ingesteld op performExitOptionsJobAction en een taak in de taak is mislukt met een afsluitvoorwaarde die een jobActie van beëindigingstaak opgeeft. Een andere tekenreeks is een door de gebruiker gedefinieerde reden die is opgegeven in een aanroep van de bewerking 'Een taak beëindigen'.

JobManagerTask

Hiermee geeft u de details van een Taakbeheertaak op.

Name Type Description
allowLowPriorityNode

boolean

Of de Taakbeheertaak kan worden uitgevoerd op een spot-rekenknooppunt met lage prioriteit.
De standaardwaarde is waar.

applicationPackageReferences

ApplicationPackageReference[]

Een lijst met toepassingspakketten die door de Batch-service worden geïmplementeerd op het rekenknooppunt voordat de opdrachtregel wordt uitgevoerd.
Toepassingspakketten worden gedownload en geïmplementeerd in een gedeelde map, niet de taakwerkmap. Als een toepassingspakket waarnaar wordt verwezen, zich al op het rekenknooppunt bevindt en up-to-date is, wordt het niet opnieuw gedownload; de bestaande kopie op het rekenknooppunt wordt gebruikt. Als een toepassingspakket waarnaar wordt verwezen, niet kan worden geïnstalleerd, bijvoorbeeld omdat het pakket is verwijderd of omdat het downloaden is mislukt, mislukt de taak.

authenticationTokenSettings

AuthenticationTokenSettings

De instellingen voor een verificatietoken die de taak kan gebruiken om Batch-servicebewerkingen uit te voeren.
Als deze eigenschap is ingesteld, biedt de Batch-service de taak een verificatietoken dat kan worden gebruikt om Batch-servicebewerkingen te verifiëren zonder dat hiervoor een accounttoegangssleutel nodig is. Het token wordt geleverd via de omgevingsvariabele AZ_BATCH_AUTHENTICATION_TOKEN. De bewerkingen die de taak kan uitvoeren met behulp van het token, zijn afhankelijk van de instellingen. Een taak kan bijvoorbeeld taakmachtigingen aanvragen om andere taken toe te voegen aan de taak, of de status van de taak of van andere taken onder de taak controleren.

commandLine

string

De opdrachtregel van de taak Taakbeheer.
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.

constraints

TaskConstraints

Beperkingen die van toepassing zijn op de taak Taakbeheer.

containerSettings

TaskContainerSettings

De instellingen voor de container waaronder de Taakbeheertaak wordt uitgevoerd.
Als voor de pool die deze taak uitvoert, containerConfiguration is ingesteld, moet dit ook worden ingesteld. Als voor de pool die deze taak uitvoert, geen containerConfiguration is ingesteld, moet dit niet worden ingesteld. 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.

displayName

string

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

environmentSettings

EnvironmentSetting[]

Een lijst met omgevingsvariabele-instellingen voor de taak Job Manager.

id

string

Een tekenreeks die de taak Job Manager in de taak uniek identificeert.
De id kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 64 tekens bevatten.

killJobOnCompletion

boolean

Hiermee geeft u aan of het voltooien van de Taakbeheertaak betekent dat de volledige taak is voltooid.
Als dit waar is, markeert de Batch-service de taak als voltooid wanneer de Taakbeheertaak is voltooid. Als er op dit moment nog taken worden uitgevoerd (behalve Job Release), worden deze taken beëindigd. Indien onwaar, heeft de voltooiing van de Taakbeheertaak geen invloed op de taakstatus. In dit geval moet u het kenmerk onAllTasksComplete gebruiken om de taak te beëindigen of een client of gebruiker de taak expliciet laten beëindigen. Een voorbeeld hiervan is als Job Manager een set taken maakt, maar vervolgens geen rol meer speelt bij de uitvoering ervan. De standaardwaarde is waar. Als u de kenmerken onAllTasksComplete en onTaskFailure gebruikt om de levensduur van de taak te beheren en de taak Taakbeheer alleen gebruikt om de taken voor de taak te maken (niet om de voortgang te bewaken), is het belangrijk om killJobOnCompletion in te stellen op false.

outputFiles

OutputFile[]

Een lijst met bestanden die door de Batch-service worden geüpload vanaf het rekenknooppunt nadat de opdrachtregel is uitgevoerd.
Voor taken met meerdere exemplaren worden de bestanden alleen geüpload vanaf het rekenknooppunt waarop de primaire taak wordt uitgevoerd.

requiredSlots

integer

Het aantal planningssites dat nodig is om de taak uit te voeren.
De standaardwaarde is 1. Een taak kan alleen worden gepland om te worden uitgevoerd op een rekenknooppunt als voor het knooppunt voldoende vrije planningssites beschikbaar zijn. Voor taken met meerdere exemplaren wordt deze eigenschap niet ondersteund en moet deze niet worden opgegeven.

resourceFiles

ResourceFile[]

Een lijst met bestanden die de Batch-service naar het rekenknooppunt downloadt voordat de opdrachtregel wordt uitgevoerd.
Bestanden die onder dit element worden vermeld, bevinden zich in de werkmap van de taak. 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.

runExclusive

boolean

Of de Taakbeheertaak exclusief gebruik vereist van het rekenknooppunt waarop deze wordt uitgevoerd.
Als dit waar is, worden er geen andere taken uitgevoerd op hetzelfde knooppunt zolang jobbeheer wordt uitgevoerd. Als dit onwaar is, kunnen andere taken tegelijkertijd met taakbeheer op een rekenknooppunt worden uitgevoerd. De Taakbeheerder telt normaal mee voor de limiet voor gelijktijdige taken van het rekenknooppunt, dus dit is alleen relevant als het rekenknooppunt meerdere gelijktijdige taken toestaat. De standaardwaarde is waar.

userIdentity

UserIdentity

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

JobNetworkConfiguration

De netwerkconfiguratie voor de taak.

Name Type Description
subnetId

string

De ARM-resource-id van het subnet van het virtuele netwerk waaraan rekenknooppunten waarop taken vanuit de taak worden uitgevoerd, worden toegevoegd voor de duur van de taak. Dit werkt alleen met een VirtualMachineConfiguration-pool.
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 waarop taken vanuit de taak worden uitgevoerd. Dit kan maximaal het aantal rekenknooppunten in de pool zijn. De service-principal 'MicrosoftAzureBatch' moet de rol 'Inzender voor klassieke virtuele machines' Role-Based Access Control (RBAC) hebben voor het opgegeven VNet, zodat Azure Batch service taken op de knooppunten kan 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. Dit heeft de vorm /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Als het opgegeven VNet een gekoppelde netwerkbeveiligingsgroep (NSG) heeft, moeten enkele gereserveerde systeempoorten worden ingeschakeld voor inkomende communicatie van de Azure Batch-service. 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. Poort 443 moet ook zijn geopend voor uitgaande verbindingen voor communicatie met Azure Storage. Zie voor meer informatie: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPreparationTask

Een taakvoorbereidingstaak die moet worden uitgevoerd vóór taken van de taak op een bepaald rekenknooppunt.

Name Type Description
commandLine

string

De opdrachtregel van de taakvoorbereidingstaak.
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.

constraints

TaskConstraints

Beperkingen die van toepassing zijn op de taakvoorbereidingstaak.

containerSettings

TaskContainerSettings

De instellingen voor de container waaronder de taakvoorbereidingstaak 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 taakvoorbereidingstaak.

id

string

Een tekenreeks die de taakvoorbereidingstaak in de taak uniek identificeert.
De id kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 64 tekens bevatten. Als u deze eigenschap niet opgeeft, wijst de Batch-service de standaardwaarde 'jobvoorbereiding' toe. Geen enkele andere taak in de taak kan dezelfde id hebben als de taak voor het voorbereiden van de taak. Als u een taak met dezelfde id probeert te verzenden, weigert de Batch-service de aanvraag met foutcode TaskIdSameAsJobPreparationTask; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 409 (conflict).

rerunOnNodeRebootAfterSuccess

boolean

Of de Batch-service de taakvoorbereidingstaak opnieuw moet uitvoeren nadat een rekenknooppunt opnieuw is opgestart.
De taak voor taakvoorbereiding wordt altijd opnieuw uitgevoerd als er een nieuwe installatiekopie van een rekenknooppunt wordt gemaakt of als de taakvoorbereidingstaak niet is voltooid (bijvoorbeeld omdat het opnieuw opstarten is opgetreden terwijl de taak werd uitgevoerd). Daarom moet u een taakvoorbereidingstaak altijd schrijven om idempotent te zijn en om zich correct te gedragen als deze meerdere keren wordt uitgevoerd. De standaardwaarde is waar.

resourceFiles

ResourceFile[]

Een lijst met bestanden die de Batch-service naar het rekenknooppunt downloadt voordat de opdrachtregel wordt uitgevoerd.
Bestanden die onder dit element worden vermeld, bevinden zich in de werkmap van de taak. Er is een maximale grootte voor de lijst met resourcebestanden. Wanneer de maximale grootte wordt overschreden, mislukt de aanvraag en is de antwoordfoutcode RequestEntityTooLarge. Als dit gebeurt, moet de verzameling ResourceFiles worden verkleind. Dit kan worden bereikt met behulp van .zip-bestanden, toepassingspakketten of Docker-containers.

userIdentity

UserIdentity

De gebruikersidentiteit waaronder de taakvoorbereidingstaak wordt uitgevoerd.
Als u dit weglaat, wordt de taak uitgevoerd als een niet-beheerdersgebruiker die uniek is voor de taak op Windows-rekenknooppunten, of als een gebruiker zonder beheerdersrechten die uniek is voor de pool op Linux-rekenknooppunten.

waitForSuccess

boolean

Of de Batch-service moet wachten totdat de taakvoorbereidingstaak is voltooid voordat andere taken van de taak op het rekenknooppunt worden gepland. Een taakvoorbereidingstaak is voltooid als deze wordt afgesloten met afsluitcode 0.
Als waar is en de taakvoorbereidingstaak mislukt op een knooppunt, voert de Batch-service de taakvoorbereidingstaak opnieuw uit tot het maximale aantal nieuwe pogingen (zoals opgegeven in het element beperkingen). Als de taak na alle nieuwe pogingen nog steeds niet is voltooid, plant de Batch-service de taken van de taak niet in het knooppunt. Het knooppunt blijft actief en komt in aanmerking voor het uitvoeren van taken van andere taken. Indien onwaar, wacht de Batch-service niet totdat de taakvoorbereidingstaak is voltooid. In dit geval kunnen andere taken van de taak worden uitgevoerd op het rekenknooppunt terwijl de taakvoorbereidingstaak nog steeds wordt uitgevoerd; en zelfs als de taakvoorbereiding mislukt, worden er nog steeds nieuwe taken gepland op het rekenknooppunt. De standaardwaarde is waar.

JobReleaseTask

Een jobreleasetaak die moet worden uitgevoerd wanneer de taak is voltooid op een rekenknooppunt waarop de taak is uitgevoerd.

Name Type Description
commandLine

string

De opdrachtregel van de taak release taak.
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 taak voor het vrijgeven van de taak 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 taak voor het vrijgeven van de taak.

id

string

Een tekenreeks die de taak voor het vrijgeven van de taak in de taak uniek identificeert.
De id kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 64 tekens bevatten. Als u deze eigenschap niet opgeeft, wijst de Batch-service een standaardwaarde toe van 'jobrelease'. Geen enkele andere taak in de taak kan dezelfde id hebben als de taak voor het vrijgeven van de taak. Als u een taak met dezelfde id probeert te verzenden, weigert de Batch-service de aanvraag met foutcode TaskIdSameAsJobReleaseTask; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 409 (conflict).

maxWallClockTime

string

De maximaal verstreken tijd die de taak voor het vrijgeven van de taak mag worden uitgevoerd op een bepaald rekenknooppunt, gemeten vanaf het moment dat de taak wordt gestart. Als de taak niet binnen de tijdslimiet wordt voltooid, wordt deze door de Batch-service beëindigd. De standaardwaarde is 15 minuten. U mag geen time-out opgeven die langer is dan 15 minuten. Als u dit doet, weigert de Batch-service deze met een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).

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.

retentionTime

string

De minimale tijd voor het bewaren van de taakmap voor de taakreleasetaak op het rekenknooppunt. Na deze tijd kan de Batch-service de taakmap en alle inhoud ervan verwijderen.
De standaardwaarde is 7 dagen, dat wil zeggen dat de taakmap zeven dagen wordt bewaard, tenzij het rekenknooppunt wordt verwijderd of de taak wordt verwijderd.

userIdentity

UserIdentity

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

JobSchedulingError

Er is een fout opgetreden in de Batch-service bij het plannen van een taak.

Name Type Description
category

ErrorCategory

De categorie van de taakplanningsfout.

code

string

Een id voor de taakplanningsfout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.

details

NameValuePair[]

Een lijst met aanvullende foutdetails met betrekking tot de planningsfout.

message

string

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

JobState

De status van de taak.

Name Type Description
active

string

De taak is beschikbaar om taken te plannen.

completed

string

Alle taken zijn beëindigd en het systeem accepteert geen taken meer of verdere wijzigingen in de taak.

deleting

string

Een gebruiker heeft gevraagd de taak te verwijderen, maar de verwijderbewerking wordt nog steeds uitgevoerd (bijvoorbeeld omdat het systeem nog steeds actieve taken beëindigt).

disabled

string

Een gebruiker heeft de taak uitgeschakeld. Er worden geen taken uitgevoerd en er worden geen nieuwe taken gepland.

disabling

string

Een gebruiker heeft gevraagd de taak uit te schakelen, maar de bewerking uitschakelen wordt nog steeds uitgevoerd (bijvoorbeeld wachten tot taken zijn beëindigd).

enabling

string

Een gebruiker heeft gevraagd om de taak in te schakelen, maar de inschakelingsbewerking wordt nog uitgevoerd.

terminating

string

De taak staat op het punt om te voltooien, omdat een Taakbeheertaak is voltooid of omdat de gebruiker de taak heeft beëindigd, maar de beëindigingsbewerking nog steeds wordt uitgevoerd (bijvoorbeeld omdat jobreleasetaken worden uitgevoerd).

JobStatistics

Statistieken over resourcegebruik voor een taak.

Name Type Description
kernelCPUTime

string

De totale CPU-tijd van de kernelmodus (opgeteld voor alle kernen en alle rekenknooppunten) die door alle taken in de taak wordt verbruikt.

lastUpdateTime

string

Het tijdstip waarop de statistieken voor het laatst zijn bijgewerkt. Alle statistieken zijn beperkt tot het bereik tussen startTime en lastUpdateTime.

numFailedTasks

integer

Het totale aantal taken in de taak dat is mislukt tijdens het opgegeven tijdsbereik.
Een taak mislukt als het maximale aantal nieuwe pogingen wordt uitgeput zonder afsluitcode 0 te retourneren.

numSucceededTasks

integer

Het totale aantal taken dat in de taak is voltooid gedurende het opgegeven tijdsbereik.
Een taak wordt voltooid als deze afsluitcode 0 retourneert.

numTaskRetries

integer

Het totale aantal nieuwe pogingen voor alle taken in de taak gedurende het opgegeven tijdsbereik.

readIOGiB

number

De totale hoeveelheid gegevens in GiB die van schijf wordt gelezen door alle taken in de taak.

readIOps

integer

Het totale aantal schijfleesbewerkingen dat door alle taken in de taak is uitgevoerd.

startTime

string

De begintijd van het tijdsbereik waarop de statistieken betrekking hebben.

url

string

De URL van de statistieken.

userCPUTime

string

De totale CPU-tijd in de gebruikersmodus (opgeteld voor alle kernen en alle rekenknooppunten) die wordt verbruikt door alle taken in de taak.

waitTime

string

De totale wachttijd van alle taken in de taak.
De wachttijd voor een taak wordt gedefinieerd als de verstreken tijd tussen het maken van de taak en het begin van de taakuitvoering. (Als de taak opnieuw wordt geprobeerd vanwege fouten, is de wachttijd de tijd tot de meest recente taakuitvoering.) Deze waarde wordt alleen gerapporteerd in de levensduurstatistieken van het account; het is niet opgenomen in de taakstatistieken.

wallClockTime

string

De totale kloktijd van alle taken in de taak.
De kloktijd van de wand is de verstreken tijd vanaf het moment dat de taak werd uitgevoerd op een rekenknooppunt tot het moment waarop de taak is voltooid (of tot de laatste keer dat de statistieken zijn bijgewerkt, als de taak op dat moment nog niet was voltooid). Als een taak opnieuw is geprobeerd, omvat dit de kloktijd van alle nieuwe pogingen van de taak.

writeIOGiB

number

De totale hoeveelheid gegevens in GiB die door alle taken in de taak naar de schijf worden geschreven.

writeIOps

integer

Het totale aantal schijfschrijfbewerkingen dat door alle taken in de taak is gemaakt.

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) mogelijk voor een VM, wat kan leiden tot betere 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.
De eigenschap Openbare IP-configuratie 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 toegevoegd. 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 groep. 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 de 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

Extra opdrachtregelopties om door te geven aan de koppelingsopdracht.
Dit zijn opties voor 'net use' 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-koppelmap, toegankelijk via de AZ_BATCH_NODE_MOUNTS_DIR omgevingsvariabele.

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

Knooppunten die de klassieke communicatiemodus gebruiken, vereisen binnenkomende TCP-communicatie 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 van het knooppunt wordt automatisch ingesteld door de Batch-service.

simplified

string

Knooppunten die gebruikmaken van de vereenvoudigde communicatiemodus vereisen uitgaande TCP-communicatie op poort 443 naar batchnodemanagement. Servicetag {region}. Er zijn geen 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 best effort balancing.

OnAllTasksComplete

De actie die de Batch-service moet uitvoeren wanneer alle taken in de taak de status Voltooid hebben.

Name Type Description
noaction

string

Geen actie uitvoeren. De taak blijft actief, tenzij deze op een andere wijze wordt beëindigd of uitgeschakeld.

terminatejob

string

De taak beëindigen. De terminateReason van de taak is ingesteld op 'AllTasksComplete'.

OnTaskFailure

De actie die de Batch-service moet uitvoeren wanneer een taak in de taak mislukt.

Name Type Description
noaction

string

Geen actie uitvoeren. De taak blijft actief, tenzij deze op een andere wijze wordt beëindigd of uitgeschakeld.

performexitoptionsjobaction

string

Voer de actie uit die is gekoppeld aan de voorwaarde Taak afsluiten in de verzameling exitConditions van de taak. (Dit kan er nog steeds toe leiden dat er geen actie wordt ondernomen, als dat is wat de taak aangeeft.)

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.

OutputFile

Een specificatie voor het uploaden van bestanden van een Azure Batch-rekenknooppunt naar een andere locatie nadat de Batch-service klaar is met het uitvoeren van het taakproces.

Name Type Description
destination

OutputFileDestination

Het doel voor de uitvoerbestanden.

filePattern

string

Een patroon dat aangeeft welk bestand(en) moet(en) worden geüpload.
Zowel relatieve als absolute paden worden ondersteund. Relatieve paden zijn relatief ten opzichte van de werkmap Taak. De volgende jokertekens worden ondersteund: * komt overeen met 0 of meer tekens (bijvoorbeeld patroon abc* komt overeen met abc of abcdef), ** komt overeen met een willekeurige map, ? komt overeen met een willekeurig teken, [abc] komt overeen met één teken tussen haakjes en [a-c] komt overeen met één teken in het bereik. Vierkante haken kunnen een negatie bevatten die overeenkomt met een teken dat niet is opgegeven (bijvoorbeeld [!abc] komt overeen met een willekeurig teken, maar met a, b of c). Als een bestandsnaam begint met '', wordt deze standaard genegeerd, maar kan deze worden vergeleken door deze expliciet op te geven ( bijvoorbeeld.gif komt niet overeen met .a.gif, maar ..gif wel). Een eenvoudig voorbeeld: ***.txt komt overeen met elk bestand dat niet begint met '.' en eindigt met .txt in de werkmap Taak of een submap. Als de bestandsnaam een jokerteken bevat, kan deze worden ge escaped met behulp van vierkante haken (bijvoorbeeld abc[] komt overeen met een bestand met de naam abc). Houd er rekening mee dat zowel \ als / worden behandeld als mapscheidingstekens in Windows, maar alleen / is op Linux. Omgevingsvariabelen (%var% in Windows of $var op Linux) worden uitgebreid voordat het patroon wordt toegepast.

uploadOptions

OutputFileUploadOptions

Aanvullende opties voor de uploadbewerking, waaronder onder welke voorwaarden de upload moet worden uitgevoerd.

OutputFileBlobContainerDestination

Hiermee geeft u een bestemming voor het uploaden van bestanden binnen een Azure Blob Storage-container.

Name Type Description
containerUrl

string

De URL van de container in Azure Blob Storage waarnaar de bestanden moeten worden geüpload.
Als u geen beheerde identiteit gebruikt, moet de URL een Shared Access Signature (SAS) bevatten die schrijfmachtigingen voor de container verleent.

identityReference

ComputeNodeIdentityReference

De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage opgegeven door containerUrl
De identiteit moet schrijftoegang hebben tot de Azure Blob Storage-container

path

string

De doel-blob of virtuele map in de Azure Storage-container.
Als filePattern verwijst naar een specifiek bestand (dat wil zeggen dat er geen jokertekens zijn), is pad de naam van de blob waarnaar dat bestand moet worden geüpload. Als filePattern een of meer jokertekens bevat (en dus kan overeenkomen met meerdere bestanden), is pad de naam van de virtuele blobmap (die wordt voorafgegaan door elke blobnaam) waarnaar de bestanden moeten worden geüpload. Als u dit weglaat, worden bestanden geüpload naar de hoofdmap van de container met een blobnaam die overeenkomt met de bestandsnaam.

uploadHeaders

HttpHeader[]

Een lijst met naam-waardeparen voor headers die moeten worden gebruikt bij het uploaden van uitvoerbestanden
Deze headers worden opgegeven bij het uploaden van bestanden naar Azure Storage. Officieel document over toegestane headers bij het uploaden van blobs: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

Het doel waarnaar een bestand moet worden geüpload.

Name Type Description
container

OutputFileBlobContainerDestination

Een locatie in Azure Blob Storage waarnaar bestanden worden geüpload.

OutputFileUploadCondition

De voorwaarden waaronder een taakuitvoerbestand of een set bestanden moet worden geüpload.

Name Type Description
taskcompletion

string

Upload de bestanden nadat het taakproces is afgesloten, ongeacht de afsluitcode.

taskfailure

string

Upload de bestanden pas nadat het taakproces is afgesloten met een niet-nul afsluitcode.

tasksuccess

string

Upload de bestanden pas nadat het taakproces is afgesloten met afsluitcode 0.

OutputFileUploadOptions

Details over een uploadbewerking voor uitvoerbestanden, waaronder onder welke voorwaarden het uploaden moet worden uitgevoerd.

Name Type Description
uploadCondition

OutputFileUploadCondition

De voorwaarden waaronder het taakuitvoerbestand of de set bestanden moet worden geüpload.
De standaardwaarde is taskcompletion.

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.

PoolInformation

Hiermee geeft u op hoe een taak moet worden toegewezen aan een pool.

Name Type Description
autoPoolSpecification

AutoPoolSpecification

Kenmerken voor een tijdelijke 'autopool'. De Batch-service maakt deze automatische pool wanneer de taak wordt verzonden.
Als het automatisch maken van een pool mislukt, verplaatst de Batch-service de taak naar een voltooide status en wordt de fout bij het maken van de pool ingesteld in de eigenschap Planningsfout van de taak. De Batch-service beheert de levensduur (zowel het maken als, tenzij keepAlive is opgegeven, verwijderen) van de automatische pool. Alle gebruikersacties die van invloed zijn op de levensduur van de automatische pool terwijl de taak actief is, leiden tot onverwacht gedrag. U moet de pool-id of de autogroepspecificatie opgeven, maar niet beide.

poolId

string

De id van een bestaande pool. Alle taken van de taak worden uitgevoerd in de opgegeven pool.
U moet ervoor zorgen dat de pool waarnaar wordt verwezen door deze eigenschap bestaat. Als de pool niet bestaat op het moment dat de Batch-service een taak probeert te plannen, worden er geen taken voor de taak uitgevoerd totdat u een pool met die id maakt. Houd er rekening mee dat de Batch-service de taakaanvraag niet weigert; Taken worden niet uitgevoerd totdat de pool bestaat. U moet de pool-id of de autogroepspecificatie opgeven, maar niet beide.

PoolLifetimeOption

De minimale levensduur van gemaakte automatische pools en de wijze waarop meerdere taken volgens een planning worden toegewezen aan pools.

Name Type Description
job

string

De pool bestaat voor de levensduur van de taak waaraan deze is toegewezen. De Batch-service maakt de pool wanneer deze de taak maakt. Als de optie 'taak' wordt toegepast op een taakplanning, maakt de Batch-service een nieuwe automatische pool voor elke taak die volgens de planning wordt gemaakt.

jobschedule

string

De pool bestaat voor de levensduur van de taakplanning. De Batch-service maakt de pool wanneer de eerste taak in de planning wordt gemaakt. U kunt deze optie alleen toepassen op taakplanningen, niet op taken.

PoolSpecification

Specificatie voor het maken van een nieuwe pool.

Name Type Description
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. De toegestane licenties die beschikbaar zijn in de pool zijn 'maya', 'vray', '3dsmax', 'arnold'. Er worden extra kosten in rekening gebracht voor elke toepassingslicentie die aan de pool wordt toegevoegd.

applicationPackageReferences

ApplicationPackageReference[]

De lijst met pakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool.
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}). 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.
De standaardwaarde is 15 minuten. De minimum- en maximumwaarde zijn respectievelijk 5 minuten en 168 uur. Als u een waarde opgeeft die minder dan 5 minuten of langer is dan 168 uur, weigert de Batch-service de aanvraag met een fout met een ongeldige eigenschapswaarde. Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).

autoScaleFormula

string

De formule voor het gewenste aantal rekenknooppunten in de pool.
Deze eigenschap moet niet worden opgegeven als enableAutoScale is ingesteld op false. Dit is vereist als enableAutoScale is ingesteld op true. De formule wordt gecontroleerd op geldigheid voordat de pool wordt gemaakt. Als de formule ongeldig is, weigert de Batch-service de aanvraag met gedetailleerde foutinformatie.

certificateReferences

CertificateReference[]

Een 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 moet worden opgegeven als de pool moet worden gemaakt met Azure PaaS-VM's. Deze eigenschap en virtualMachineConfiguration sluiten elkaar uit en een van de eigenschappen moet worden opgegeven. Als geen van beide is opgegeven, retourneert de Batch-service een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag). Deze eigenschap kan niet worden opgegeven als het Batch-account is gemaakt met de eigenschap poolAllocationMode ingesteld op UserSubscription.

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.

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 het element autoScaleFormula vereist. De grootte van de pool wordt automatisch aangepast aan de formule. De standaardwaarde is false.

enableInterNodeCommunication

boolean

Of de pool directe communicatie tussen rekenknooppunten toestaat.
Als u communicatie tussen knooppunten inschakelt, wordt de maximale grootte van de pool beperkt vanwege implementatiebeperkingen op de rekenknooppunten van de pool. Dit kan ertoe leiden dat de pool niet de gewenste grootte bereikt. De standaardwaarde is false.

metadata

MetadataItem[]

Een lijst met naam-waardeparen die als metagegevens zijn gekoppeld aan de pool.
De Batch-service wijst geen betekenis toe aan metagegevens; het is uitsluitend voor het gebruik van gebruikerscode.

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.

resizeTimeout

string

De time-out voor de toewijzing van rekenknooppunten aan de pool.
Deze time-out is alleen van toepassing op handmatig schalen; dit heeft geen effect wanneer enableAutoScale is ingesteld op true. De standaardwaarde is 15 minuten. De minimumwaarde is 5 minuten. Als u een waarde van minder dan 5 minuten opgeeft, weigert de Batch-service de aanvraag met een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).

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 moet worden uitgevoerd op elk rekenknooppunt wanneer het lid wordt van de pool. De taak wordt uitgevoerd wanneer het rekenknooppunt wordt toegevoegd aan de pool of wanneer het rekenknooppunt opnieuw wordt gestart.
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.

targetDedicatedNodes

integer

Het gewenste aantal toegewezen rekenknooppunten in de pool.
Deze eigenschap moet niet worden opgegeven als enableAutoScale is ingesteld op true. Als enableAutoScale is ingesteld op false, moet u targetDedicatedNodes, targetLowPriorityNodes of beide instellen.

targetLowPriorityNodes

integer

Het gewenste aantal spot-rekenknooppunten/rekenknooppunten met lage prioriteit in de pool.
Deze eigenschap moet niet worden opgegeven als enableAutoScale is ingesteld op true. Als enableAutoScale is ingesteld op false, moet u targetDedicatedNodes, targetLowPriorityNodes of beide instellen.

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.

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 moet worden opgegeven als de pool moet worden gemaakt met Azure IaaS-VM's. Deze eigenschap en cloudServiceConfiguration sluiten elkaar uit en een van de eigenschappen moet worden opgegeven. Als geen van beide is opgegeven, retourneert de Batch-service een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).

vmSize

string

De grootte van de 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.

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.

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.

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 SecurityType 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 opnieuw wordt geïnstalleerd.

Name Type Description
commandLine

string

De opdrachtregel van de StartTask.
De opdrachtregel wordt niet uitgevoerd onder een shell en kan daarom niet profiteren van shell-functies zoals uitbreiding van omgevingsvariabelen. Als u van dergelijke functies wilt profiteren, moet u de shell in de opdrachtregel aanroepen, bijvoorbeeld met 'cmd /c MyCommand' 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 () gebruiken.https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables

containerSettings

TaskContainerSettings

De instellingen voor de container waaronder 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 zijn geproduceerd in de container buiten AZ_BATCH_NODE_ROOT_DIR worden mogelijk niet weergegeven op de hostschijf, wat betekent dat Api's van Batch-bestanden geen toegang hebben tot deze bestanden.

environmentSettings

EnvironmentSetting[]

Een lijst met omgevingsvariabeleinstellingen voor de StartTask.

maxTaskRetryCount

integer

Het maximum aantal keren dat de taak opnieuw kan worden geprobeerd.
De Batch-service probeert een taak opnieuw 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 uit te voeren en kan het vervolgens opnieuw proberen tot deze limiet. Als het maximumaantal nieuwe pogingen bijvoorbeeld 3 is, probeert Batch de taak maximaal vier keer (één eerste 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 begintaak of een willekeurige taak. De standaardwaarde is 0 (geen nieuwe pogingen).

resourceFiles

ResourceFile[]

Een lijst met bestanden die door de Batch-service worden gedownload naar het rekenknooppunt 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 true 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 foutgegevens. Indien onwaar, wacht de Batch-service niet tot 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 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 standaard lokaal redundante opslag gebruiken.

standardssd_lrs

string

De gegevensschijf/besturingssysteemschijf moet gebruikmaken van lokaal redundante standaard-SSD-opslag.

TaskConstraints

Uitvoeringsbeperkingen die moeten worden toegepast op een taak.

Name Type Description
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 voor het uitvoerbare bestand Taak vanwege een niet-nul afsluitcode. 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 na de eerste poging. 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).

maxWallClockTime

string

De maximaal verstreken tijd die de taak mag uitvoeren, gemeten vanaf het moment dat de taak wordt gestart. Als de taak niet binnen de tijdslimiet wordt voltooid, wordt deze door de Batch-service beëindigd.
Als dit niet is opgegeven, is er geen tijdslimiet voor hoe lang de taak mag worden uitgevoerd.

retentionTime

string

De minimale tijd voor het bewaren van de taakmap op het rekenknooppunt waar het is uitgevoerd, vanaf het moment dat de uitvoering is voltooid. Na deze tijd kan de Batch-service de taakmap en alle inhoud ervan verwijderen.
De standaardwaarde is 7 dagen, dat wil zeggen dat de taakmap zeven dagen wordt bewaard, tenzij het rekenknooppunt wordt verwijderd of de taak wordt verwijderd.

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 tijdens het maken van de virtuele machine.

Name Type Description
secureBootEnabled

boolean

Hiermee geeft u op of beveiligd opstarten moet worden ingeschakeld op de virtuele machine.

vTpmEnabled

boolean

Hiermee geeft u op of vTPM moet worden ingeschakeld op de virtuele machine.

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-pool. Als deze 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.

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 op.
Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op.

serviceArtifactReference

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.
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'.