Delen via


Job - List

Een lijst met alle taken in het opgegeven account.

GET {batchUrl}/jobs?api-version=2024-07-01.20.0
GET {batchUrl}/jobs?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI-parameters

Name In Vereist Type Description
batchUrl
path True

string

De basis-URL voor alle Azure Batch-serviceaanvragen.

api-version
query True

string

Client-API-versie.

$expand
query

string

Een OData-$expand-component.

$filter
query

string

Een OData-$filter-component. Zie https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobsvoor meer informatie over het maken van dit filter.

$select
query

string

Een OData-$select-component.

maxresults
query

integer

int32

Het maximum aantal items dat moet worden geretourneerd in het antwoord. Er kunnen maximaal 1000 taken worden geretourneerd.

timeout
query

integer

int32

De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. Als de waarde groter is dan 30, wordt in plaats daarvan de standaardwaarde gebruikt.

Aanvraagkoptekst

Media Types: "application/json; odata=minimalmetadata"

Name Vereist Type Description
client-request-id

string

uuid

De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Of de server de clientaanvraag-id in het antwoord moet retourneren.

ocp-date

string

date-time-rfc1123

Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze expliciet in als u de REST API rechtstreeks aanroept.

Antwoorden

Name Type Description
200 OK

CloudJobListResult

Een antwoord met de lijst met taken.

Kopteksten

  • 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
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

Job list

Voorbeeldaanvraag

GET account.region.batch.azure.com/jobs?api-version=2024-07-01.20.0


Voorbeeldrespons

{
  "value": [
    {
      "id": "jobId",
      "url": "https://account.region.batch.azure.com/jobs/jobId",
      "eTag": "0x8D4100FC46D5BF4",
      "lastModified": "2016-11-19T00:05:27.2137716Z",
      "creationTime": "2016-11-19T00:05:25.311915Z",
      "state": "active",
      "stateTransitionTime": "2016-11-19T00:05:27.2137716Z",
      "previousState": "disabled",
      "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z",
      "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",
        "poolId": "poolId"
      },
      "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 dat de taak kan gebruiken om Batch-servicebewerkingen uit te voeren.

AutomaticOSUpgradePolicy

De configuratieparameters die worden gebruikt voor het uitvoeren van automatische upgrade van het besturingssysteem.

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 op voor de automatische gebruiker die een taak uitvoert in 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

Er is 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 voor de schijf moet worden ingeschakeld.

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 toegang moeten 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.

CloudJobListResult

Het resultaat van het weergeven van de taken in een account.

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 waarvoor containers zijn ingeschakeld.

ContainerHostBatchBindMountEntry

De vermelding van het pad en de koppelingsmodus die u wilt koppelen aan de taakcontainer.

ContainerHostDataPath

De paden die worden gekoppeld aan de container van de containertaak.

ContainerRegistry

Een privécontainerregister.

ContainerType

De containertechnologie die moet worden gebruikt.

ContainerWorkingDirectory

De locatie van de werkmap 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 vanuit een virtuele machine koppelen en formatteren om ze te kunnen gebruiken.

DiffDiskPlacement

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

DiffDiskSettings

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

DiskEncryptionConfiguration

De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de pool. Schijfversleutelingsconfiguratie wordt niet ondersteund in een Linux-pool die is gemaakt met de installatiekopie van de Azure Compute Gallery.

DiskEncryptionTarget

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

DynamicVNetAssignmentScope

Het bereik van dynamische vnet-toewijzing.

ElevationLevel

Het hoogteniveau van de gebruiker.

EnvironmentSetting

Een omgevingsvariabele die moet worden ingesteld voor een taakproces.

ErrorCategory

De categorie van de fout.

ErrorMessage

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.

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 om de lijst met alle Azure Marketplace-installatiekopieën op te halen die zijn geverifieerd door Azure Batch.

InboundEndpointProtocol

Het protocol van het eindpunt.

InboundNATPool

Een binnenkomende NAT-pool die kan worden gebruikt om specifieke poorten op rekenknooppunten in een batchgroep extern aan te pakken.

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 details van een Job Manager-taak.

JobNetworkConfiguration

De netwerkconfiguratie voor de taak.

JobPreparationTask

Een taakvoorbereidingstaak die moet worden uitgevoerd voordat taken van de taak op een bepaald rekenknooppunt worden uitgevoerd.

JobReleaseTask

Een jobreleasetaak die moet worden uitgevoerd op taakvoltooiing op elk rekenknooppunt waarop de taak is uitgevoerd.

JobSchedulingError

Er is een fout opgetreden door 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 op elk knooppunt moet worden gekoppeld.

NameValuePair

Vertegenwoordigt een naam-waardepaar.

NetworkConfiguration

De netwerkconfiguratie voor een pool.

NetworkSecurityGroupRule

Een regel voor een netwerkbeveiligingsgroep 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

Knooppuntplaatsingsconfiguratie 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 Compute-knooppunt naar een andere locatie nadat de Batch-service klaar is met het uitvoeren van het taakproces.

OutputFileBlobContainerDestination

Hiermee geeft u een doel voor het uploaden van bestanden in een Azure Blob Storage-container op.

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 een uitvoerbestand, waaronder onder welke voorwaarden de upload 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 hoe 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.

RollingUpgradePolicy

De configuratieparameters die worden gebruikt tijdens het uitvoeren van een rolling upgrade.

SecurityEncryptionTypes

Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor het niet behouden van de firmwarestatus in de VMGuestState-blob. Opmerking: deze kan alleen worden ingesteld voor vertrouwelijke VM's en is vereist bij het gebruik van vertrouwelijke VM's.

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 voor het instellen van dezelfde installatiekopieënversie voor alle virtuele machines in de schaalset wanneer u de meest recente installatiekopieënversie gebruikt.

StartTask

Een taak die wordt uitgevoerd wanneer een knooppunt lid wordt van een pool in de Azure Batch-service of wanneer het rekenknooppunt opnieuw wordt opgestart of opnieuw wordt hersteld.

StorageAccountType

Het type opslagaccount voor gebruik bij het maken van gegevensschijven of een besturingssysteemschijf.

TaskConstraints

Uitvoeringsbeperkingen die van toepassing zijn 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.

UpgradeMode

Hiermee geeft u de modus van een upgrade naar virtuele machines in de schaalset.

Mogelijke waarden zijn:

Handmatige: u bepaalt de toepassing van updates voor virtuele machines in de schaalset. U doet dit met behulp van de manualUpgrade-actie.

Automatisch: alle virtuele machines in de schaalset worden automatisch tegelijkertijd bijgewerkt.

Rolling - Schaalset voert updates uit in batches met een optionele onderbrekingstijd ertussen.

UpgradePolicy

Beschrijft een upgradebeleid: automatisch, handmatig of rolling.

UserAccount

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

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.

VMDiskSecurityProfile

Hiermee geeft u de beveiligingsprofielinstellingen voor de beheerde schijf. Opmerking: deze kan alleen worden ingesteld voor vertrouwelijke VM's en vereist bij het gebruik van vertrouwelijke VM's.

VMExtension

De configuratie voor extensies van virtuele machines.

WindowsConfiguration

Windows-besturingssysteeminstellingen die van toepassing zijn 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.
Bij het maken van een pool 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 bij een taak en er geen standaardversie is opgegeven voor deze toepassing, mislukt de taak met een fout vóór de verwerking.

AuthenticationTokenSettings

De instellingen voor een verificatietoken dat 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', die toegang verleent tot alle bewerkingen die betrekking hebben op de taak die de taak bevat.

AutomaticOSUpgradePolicy

De configuratieparameters die worden gebruikt voor het uitvoeren van automatische upgrade van het besturingssysteem.

Name Type Description
disableAutomaticRollback

boolean

Of de functie voor terugdraaien van installatiekopieën van het besturingssysteem moet worden uitgeschakeld.

enableAutomaticOSUpgrade

boolean

Hiermee wordt aangegeven of upgrades van het besturingssysteem automatisch moeten worden toegepast op exemplaren van schaalsets wanneer een nieuwere versie van de installatiekopie van het besturingssysteem beschikbaar wordt.

Als dit is ingesteld op waar voor Windows-pools, kan WindowsConfiguration.enableAutomaticUpdates niet worden ingesteld op true.

osRollingUpgradeDeferral

boolean

Stel upgrades van het besturingssysteem uit op de TVM's als ze taken uitvoeren.

useRollingUpgradePolicy

boolean

Hiermee wordt aangegeven of beleid voor rolling upgrades moet worden gebruikt tijdens de automatische upgrade van het besturingssysteem. Automatische upgrade van het besturingssysteem valt terug op het standaardbeleid als er geen beleid is gedefinieerd op de VMSS.

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 een automatische pool actief blijft nadat de levensduur is verlopen.
Indien onwaar, verwijdert de Batch-service de pool na de levensduur (zoals bepaald door de instelling poolLifetimeOption) verloopt; dat wil gezegd, wanneer de taak of taakplanning is voltooid. Indien waar, 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 hoe 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 op voor de automatische gebruiker die een taak uitvoert in de Batch-service.

Name Type Description
elevationLevel

ElevationLevel

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

scope

AutoUserScope

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

AzureBlobFileSystemConfiguration

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

Name Type Description
accountKey

string

De sleutel van het Azure Storage-account.
Deze eigenschap is wederzijds exclusief met zowel sasKey als identiteit; er moet precies één worden opgegeven.

accountName

string

De naam van het Azure Storage-account.

blobfuseOptions

string

Aanvullende opdrachtregelopties om door te geven aan de koppelingsopdracht.
Dit zijn opties voor 'net use' in Windows en opties voor koppelen in Linux.

containerName

string

De naam van de Azure Blob Storage-container.

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 map batchkoppelingen, die toegankelijk zijn via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.

sasKey

string

Het SAS-token van Azure Storage.
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 is de vorm 'https://{account}.file.core.windows.net/'.

mountOptions

string

Aanvullende opdrachtregelopties om door te geven aan de koppelingsopdracht.
Dit zijn opties voor 'net use' in Windows en opties voor koppelen in Linux.

relativeMountPath

string

Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld
Alle bestandssystemen worden gekoppeld ten opzichte van de map batchkoppelingen, die toegankelijk zijn via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.

BatchError

Er is een foutbericht ontvangen van de Azure Batch-service.

Name Type Description
code

string

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

message

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 Waarde aangeeft.

value

string

De aanvullende informatie die is opgenomen in het foutbericht.

CachingType

Het type caching dat voor de schijf moet worden ingeschakeld.

Name Type Description
none

string

De cachemodus voor de schijf is niet ingeschakeld.

readonly

string

De cachemodus voor de schijf is alleen-lezen.

readwrite

string

De cachemodus voor de schijf is lezen en schrijven.

CertificateReference

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

Name Type Description
storeLocation

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. Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap Taak en wordt een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR aan de taak verstrekt 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 certificaten worden 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. 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 toegang moeten 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 Certificaatarchief van LocalMachine.

CertificateVisibility

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

Name Type Description
remoteuser

string

Het certificaat moet zichtbaar zijn voor de gebruikersaccounts waaronder gebruikers extern toegang hebben tot het rekenknooppunt.

starttask

string

Het certificaat moet zichtbaar zijn voor het gebruikersaccount waaronder de StartTask wordt uitgevoerd. Houd er rekening mee dat als het Bereik van AutoUser pool is voor zowel de StartTask als een taak, dit certificaat ook zichtbaar is voor de taak.

task

string

Het certificaat moet zichtbaar zijn voor de gebruikersaccounts waaronder taaktaken worden uitgevoerd.

CIFSMountConfiguration

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

Name Type Description
mountOptions

string

Aanvullende opdrachtregelopties om door te geven aan de koppelingsopdracht.
Dit zijn opties voor 'net use' in Windows en opties voor koppelen in Linux.

password

string

Het wachtwoord dat moet worden gebruikt voor verificatie op basis van het CIFS-bestandssysteem.

relativeMountPath

string

Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld
Alle bestandssystemen worden gekoppeld ten opzichte van de map batchkoppelingen, die toegankelijk zijn via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.

source

string

De URI van het bestandssysteem die moet worden gekoppeld.

username

string

De gebruiker die moet worden gebruikt voor verificatie op basis van het CIFS-bestandssysteem.

CloudJob

Een Azure Batch-taak.

Name Type Default value Description
allowTaskPreemption

boolean

Of taken in deze taak kunnen worden verschoven door andere taken met hoge prioriteit
Als de waarde is ingesteld op True, hebben andere taken met hoge prioriteit die naar het systeem worden verzonden voorrang en kunnen taken van deze taak opnieuw worden weergegeven. 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 omgevingsvariabeleinstellingen. Deze omgevingsvariabelen worden ingesteld voor alle taken in de taak (inclusief jobbeheer, jobvoorbereiding en jobreleasetaken).
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 is gewijzigd tussen aanvragen. In het bijzonder kunt u de ETag doorgeven wanneer u een taak bijwerkt om op 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 waarmee de taak in het account uniek wordt geïdentificeerd.
De id is niet hoofdlettergevoelig en niet hoofdlettergevoelig (u hebt mogelijk geen twee id's binnen een account die alleen per geval verschillen).

jobManagerTask

JobManagerTask

Details van een Job Manager-taak die moet worden gestart wanneer de taak wordt gestart.
De Job Manager-taak wordt automatisch gestart wanneer de taak wordt gemaakt. De Batch-service probeert de Job Manager-taak te plannen vóór andere taken in de taak. Wanneer u een pool verkleint, probeert de Batch-service knooppunten te behouden waarop Job Manager-taken zo lang mogelijk worden uitgevoerd (rekenknooppunten waarop normale taken worden uitgevoerd, worden verwijderd voordat rekenknooppunten jobbeheertaken worden uitgevoerd). Wanneer een Job Manager-taak mislukt en opnieuw moet worden opgestart, probeert het systeem deze op 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 terugkeren naar de wachtrij om ruimte te maken voor de Taakbeheertaak om opnieuw te starten. Houd er rekening mee dat een Job Manager-taak in de ene taak geen prioriteit heeft ten opzichte van taken in andere taken. In alle taken worden alleen prioriteiten op taakniveau waargenomen. 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 maxTaskRetryCount. Zelfs als maxTaskRetryCount 0 is, kan er een interne nieuwe poging worden uitgevoerd vanwege een herstelbewerking. Daarom moeten alle taken idempotent zijn. Dit betekent dat taken moeten worden onderbroken en opnieuw moeten worden gestart zonder beschadiging of dubbele gegevens te veroorzaken. De aanbevolen procedure voor langlopende taken is om een vorm van controlepunten te gebruiken.

jobPreparationTask

JobPreparationTask

De jobvoorbereidingstaak.
De taakvoorbereidingstaak is een speciale taak die op elk rekenknooppunt wordt uitgevoerd voordat een andere taak van de taak wordt uitgevoerd.

jobReleaseTask

JobReleaseTask

De taak voor het vrijgeven van de taak.
De jobreleasetaak is een speciale taakuitvoering aan het einde van de taak op elk rekenknooppunt dat een andere taak van de taak heeft 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 het wijzigen van de status Taken.

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 dit niet is opgegeven, is de standaardwaarde -1, wat betekent dat er geen limiet is voor het aantal taken dat tegelijk 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 zijn gekoppeld aan de taak als metagegevens.
De Batch-service wijst geen betekenis toe aan metagegevens; deze is uitsluitend bedoeld 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 er een failureInfo is. Er wordt een failureInfo ingesteld als de taak is voltooid met een afsluitcode die niet nul is voltooid 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 aan de taak zijn gekoppeld.

previousState

JobState

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

previousStateTransitionTime

string

Het tijdstip waarop de taak de vorige status heeft ingevoerd.
Deze eigenschap is niet ingesteld als de taak de oorspronkelijke actieve status 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 is. De standaardwaarde is 0.

state

JobState

De huidige status van de taak.

stateTransitionTime

string

Het tijdstip waarop de taak de huidige status heeft ingevoerd.

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, inclusief het kenmerk statistieken; anders is het null. De statistieken zijn mogelijk niet onmiddellijk beschikbaar. De Batch-service voert periodieke samenteling van statistieken uit. De typische vertraging is ongeveer 30 minuten.

url

string

De URL van de taak.

usesTaskDependencies

boolean

Of taken in de taak afhankelijkheden op elkaar kunnen definiëren. De standaardwaarde is onwaar.

CloudJobListResult

Het resultaat van het weergeven van de taken in een account.

Name Type Description
odata.nextLink

string

De URL voor het ophalen van de volgende set resultaten.

value

CloudJob[]

De lijst met taken.

ComputeNodeFillType

Hoe taken worden verdeeld over rekenknooppunten in een pool.

Name Type Description
pack

string

Zo veel mogelijk taken (taskSlotsPerNode) moeten worden toegewezen aan elk rekenknooppunt in de pool voordat taken worden toegewezen aan het volgende rekenknooppunt in de pool.

spread

string

Taken moeten gelijkmatig worden toegewezen aan alle rekenknooppunten in de pool.

ComputeNodeIdentityReference

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

Name Type Description
resourceId

string

De ARM-resource-id van de door de gebruiker toegewezen identiteit.

ContainerConfiguration

De configuratie voor pools waarvoor containers zijn ingeschakeld.

Name Type Description
containerImageNames

string[]

De verzameling containerinstallatiekopieën.
Dit is de volledige verwijzing naar de installatiekopie, zoals wordt opgegeven voor 'docker pull'. Een installatiekopieën worden afkomstig 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 persoonlijk register waarvoor referenties zijn vereist, moeten deze referenties hier worden opgegeven.

type

ContainerType

De containertechnologie die moet worden gebruikt.

ContainerHostBatchBindMountEntry

De vermelding van het pad en de koppelingsmodus die u wilt koppelen aan de taakcontainer.

Name Type Description
isReadOnly

boolean

Koppel dit bronpad als alleen-lezenmodus of niet. De standaardwaarde is onwaar (lees-/schrijfmodus).
Als u voor Linux dit pad koppelt als een lees-/schrijfmodus, betekent dit niet dat alle gebruikers in de container de lees-/schrijftoegang voor het pad hebben, afhankelijk van de toegang in de host-VM. Als dit pad is gekoppeld met het kenmerk Alleen-lezen, kunnen alle gebruikers in de container het pad niet wijzigen.

source

ContainerHostDataPath

Het pad dat aan de containerklant wordt gekoppeld, kan worden geselecteerd.

ContainerHostDataPath

De paden die worden gekoppeld aan de container van de containertaak.

Name Type Description
Applications

string

Het pad naar toepassingen.

JobPrep

string

Het taakpad voor de taakvoorbereiding.

Shared

string

Het pad voor de taak met meerdere exemplaren om hun bestanden te delen.

Startup

string

Het pad voor de begintaak.

Task

string

Het taakpad.

VfsMounts

string

Het pad bevat alle virtuele bestandssystemen die op dit knooppunt zijn gekoppeld.

ContainerRegistry

Een privécontainerregister.

Name Type Description
identityReference

ComputeNodeIdentityReference

De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot een Azure Container Registry in plaats van een gebruikersnaam en wachtwoord.
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

Een op CRI gebaseerde technologie wordt gebruikt om de containers te starten.

dockerCompatible

string

Er wordt een docker-compatibele containertechnologie gebruikt om de containers te starten.

ContainerWorkingDirectory

De locatie van de werkmap containertaak.

Name Type Description
containerImageDefault

string

Gebruik de werkmap die is gedefinieerd in de containerinstallatiekopieën. Let erop dat deze map niet de resourcebestanden bevat die door Batch zijn gedownload.

taskWorkingDirectory

string

Gebruik de standaardwerkmap batchservicetaak, die de taakresourcebestanden bevat die door Batch zijn ingevuld.

DataDisk

Instellingen die worden gebruikt door de gegevensschijven die zijn gekoppeld aan rekenknooppunten in de pool. Wanneer u gekoppelde gegevensschijven gebruikt, moet u de schijven vanuit een virtuele machine koppelen en formatteren om ze te kunnen gebruiken.

Name Type Description
caching

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 nummer van de logische eenheid.
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 voor besturingssysteemschijf voor alle rekenknooppunten (VM's) in de groep.

Name Type Description
CacheDisk

string

De tijdelijke besturingssysteemschijf wordt opgeslagen in de VM-cache.

DiffDiskSettings

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

Name Type Description
placement

DiffDiskPlacement

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

DiskEncryptionConfiguration

De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de pool. Schijfversleutelingsconfiguratie wordt niet ondersteund in een Linux-pool die is gemaakt met de installatiekopie van de Azure Compute Gallery.

Name Type Description
targets

DiskEncryptionTarget[]

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

DiskEncryptionTarget

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

Name Type Description
osdisk

string

De besturingssysteemschijf op het rekenknooppunt is versleuteld.

temporarydisk

string

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

DynamicVNetAssignmentScope

Het bereik van dynamische vnet-toewijzing.

Name Type Description
job

string

Dynamische VNet-toewijzing wordt per taak uitgevoerd.

none

string

Er is geen dynamische VNet-toewijzing ingeschakeld.

ElevationLevel

Het hoogteniveau van de gebruiker.

Name Type Description
admin

string

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

nonadmin

string

De gebruiker is een standaardgebruiker zonder verhoogde toegang.

EnvironmentSetting

Een omgevingsvariabele die moet worden ingesteld voor een taakproces.

Name Type Description
name

string

De naam van de omgevingsvariabele.

value

string

De waarde van de omgevingsvariabele.

ErrorCategory

De categorie van de fout.

Name Type Description
servererror

string

De fout wordt veroorzaakt door een probleem met de interne server.

usererror

string

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

ErrorMessage

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.

Name Type Description
lang

string

De taalcode van het foutbericht

value

string

De tekst van het bericht.

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 om de lijst met alle Azure Marketplace-installatiekopieën op te halen die zijn geverifieerd door Azure Batch.

Name Type Description
communityGalleryImageId

string

De unieke id van de communitygalerieafbeelding
Deze eigenschap is wederzijds exclusief met andere eigenschappen en kan worden opgehaald uit de get-aanroep van de communitygalerieafbeelding.

exactVersion

string

De specifieke versie van de platforminstallatiekopieën of marketplace-installatiekopieën die worden gebruikt om het knooppunt te maken. Dit alleen-lezenveld verschilt van 'versie' alleen als de waarde die is opgegeven voor 'versie' toen de pool werd gemaakt 'latest' was.

offer

string

Het aanbiedingstype van de Marketplace-installatiekopie van Azure Virtual Machines.
Bijvoorbeeld UbuntuServer of WindowsServer.

publisher

string

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

sharedGalleryImageId

string

De unieke id van de installatiekopieën van de gedeelde galerie
Deze eigenschap is wederzijds exclusief met andere eigenschappen en kan worden opgehaald uit de get-aanroep van de installatiekopieën in de gedeelde galerie.

sku

string

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

version

string

De versie van de Azure Virtual Machines Marketplace-installatiekopieën.
Een waarde van 'latest' 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 is van het formulier /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} voor altijd de meest recente versie van de installatiekopie.
Deze eigenschap is wederzijds exclusief met andere ImageReference-eigenschappen. De installatiekopieën van de Azure Compute Gallery moeten replica's hebben in dezelfde regio 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 nieuwste versie gebruikt. Zie https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configurationvoor informatie over de firewallinstellingen voor de Batch Compute Node-agent om te communiceren met de Batch-service.

InboundEndpointProtocol

Het protocol van het eindpunt.

Name Type Description
tcp

string

Gebruik TCP voor het eindpunt.

udp

string

Gebruik UDP voor het eindpunt.

InboundNATPool

Een binnenkomende NAT-pool die kan worden gebruikt om specifieke poorten op rekenknooppunten in een batchgroep extern aan te pakken.

Name Type Description
backendPort

integer

Het poortnummer op het rekenknooppunt.
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 er gereserveerde waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.

frontendPortRangeEnd

integer

Het laatste poortnummer in het bereik van externe poorten dat wordt gebruikt voor binnenkomende toegang tot de backendPort op afzonderlijke rekenknooppunten.
Acceptabele waarden variëren tussen 1 en 65534, behalve poorten van 50000 tot 55000, die zijn gereserveerd door de Batch-service. Alle bereiken binnen een pool moeten uniek zijn en mogen niet overlappen. Elk bereik moet ten minste 40 poorten bevatten. Als er gereserveerde of overlappende waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.

frontendPortRangeStart

integer

Het eerste poortnummer in het bereik van externe poorten dat wordt gebruikt voor binnenkomende toegang 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 uniek zijn en mogen niet overlappen. Elk bereik moet ten minste 40 poorten bevatten. Als er gereserveerde of overlappende waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.

name

string

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

networkSecurityGroupRules

NetworkSecurityGroupRule[]

Een lijst met 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 uit te voeren als de afsluitcode niet-nul is.
Houd er rekening mee dat deze waarde specifiek het aantal nieuwe pogingen bepaalt. De Batch-service probeert elke taak eenmaal uit en probeert vervolgens opnieuw tot deze limiet. Als het maximumaantal nieuwe pogingen bijvoorbeeld 3 is, probeert Batch een taak maximaal 4 keer (éé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 maximale verstreken tijd die de taak kan uitvoeren, gemeten vanaf het moment dat de taak wordt gemaakt.
Als de taak niet binnen de tijdslimiet is voltooid, beëindigt de Batch-service deze en alle taken die nog steeds worden uitgevoerd. In dit geval is de beëindigingsreden 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 ze ook een poolInfo-element, dat de poolconfiguratiegegevens bevat van het moment waarop de taak is toegevoegd of bijgewerkt. Dat poolInfo-element kan ook een poolId-element bevatten. Als dat het geval is, zijn de twee id's hetzelfde. Als dit niet het geval is, betekent dit dat de taak is uitgevoerd in een automatische pool en deze eigenschap de id van die automatische pool bevat.

schedulingError

JobSchedulingError

Details van eventuele fouten die door de service zijn opgetreden 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 jobbeheer voltooid en killJobOnCompletion is ingesteld op true. MaxWallClockTimeExpiry - de job heeft de maxWallClockTime-beperking bereikt. TerminateJobSchedule : de taak is uitgevoerd als onderdeel van een planning en het schema is beëindigd. AllTasksComplete: het kenmerk Job onAllTasksComplete 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 jobAction van de beëindigingstaak heeft opgegeven. Een andere tekenreeks is een door de gebruiker gedefinieerde reden die is opgegeven in een aanroep naar de bewerking 'Een taak beëindigen'.

JobManagerTask

Hiermee geeft u details van een Job Manager-taak.

Name Type Description
allowLowPriorityNode

boolean

Of de Job Manager-taak kan worden uitgevoerd op een rekenknooppunt met een spot-/lage prioriteit.
De standaardwaarde is waar.

applicationPackageReferences

ApplicationPackageReference[]

Een lijst met toepassingspakketten die door de Batch-service worden geïmplementeerd in het rekenknooppunt voordat u de opdrachtregel uitvoert.
Toepassingspakketten worden gedownload en geïmplementeerd in een gedeelde map, niet in de werkmap Taak. 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 dat 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 voor het verifiëren van Batch-servicebewerkingen zonder dat hiervoor een accounttoegangssleutel is vereist. 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 aan de taak toe te voegen of de status van de taak of van andere taken onder de taak te controleren.

commandLine

string

De opdrachtregel van de jobbeheertaak.
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 aanroepen op de opdrachtregel, bijvoorbeeld met 'cmd /c MyCommand' in Windows of '/bin/sh -c MyCommand' in Linux. Als de opdrachtregel verwijst naar bestandspaden, moet deze een relatief pad gebruiken (ten opzichte van de werkmap Taak) of de door Batch geleverde omgevingsvariabele (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).

constraints

TaskConstraints

Beperkingen die van toepassing zijn op de Job Manager-taak.

containerSettings

TaskContainerSettings

De instellingen voor de container waaronder de Job Manager-taak wordt uitgevoerd.
Als voor de pool die deze taak wordt uitgevoerd, een containerconfiguratieset is ingesteld, moet dit ook worden ingesteld. Als de pool die deze taak uitvoert, geen containerConfiguration-set heeft, mag 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 omgevingsvariabelen van de taak toegewezen aan de container en wordt de opdrachtregel Taak uitgevoerd in de container. Bestanden die worden geproduceerd in de container buiten AZ_BATCH_NODE_ROOT_DIR 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 jobbeheertaak.
Het hoeft niet uniek te zijn en mag unicode-tekens bevatten tot een maximale lengte van 1024.

environmentSettings

EnvironmentSetting[]

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

id

string

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

killJobOnCompletion

boolean

Of de voltooiing van de jobbeheertaak de voltooiing van de volledige taak aangeeft.
Indien waar, markeert de Batch-service de taak als voltooid wanneer de Taakbeheertaak is voltooid. Als er op dit moment nog taken worden uitgevoerd (anders dan jobrelease), worden deze taken beëindigd. Als dit onwaar is, heeft de voltooiing van de Job Manager-taak 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 jobbeheer een set taken maakt, maar vervolgens geen verdere rol neemt in de uitvoering. De standaardwaarde is waar. Als u de kenmerken onAllTasksComplete en onTaskFailure gebruikt om de levensduur van taken te beheren en de Job Manager-taak alleen gebruikt om de taken voor de taak te maken (niet om de voortgang te controleren), is het belangrijk om killJobOnCompletion in te stellen op false.

outputFiles

OutputFile[]

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

requiredSlots

integer

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

resourceFiles

ResourceFile[]

Een lijst met bestanden die de Batch-service naar het rekenknooppunt downloadt voordat u de opdrachtregel uitvoert.
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 het geval is, moet de verzameling ResourceFiles worden verkleind. Dit kan worden bereikt met behulp van .zip bestanden, toepassingspakketten of Docker-containers.

runExclusive

boolean

Of de Job Manager-taak exclusief gebruik vereist van het rekenknooppunt waarop deze wordt uitgevoerd.
Indien waar, worden er geen andere taken uitgevoerd op hetzelfde knooppunt zolang jobbeheer wordt uitgevoerd. Als dit onwaar is, kunnen andere taken tegelijk worden uitgevoerd met Job Manager op een rekenknooppunt. De taak van Job Manager telt normaal gesproken op basis van de limiet voor gelijktijdige taken van het rekenknooppunt. Dit is dus alleen relevant als het rekenknooppunt meerdere gelijktijdige taken toestaat. De standaardwaarde is waar.

userIdentity

UserIdentity

De gebruikersidentiteit waaronder de Job Manager-taak wordt uitgevoerd.
Als u dit weglaat, wordt de taak uitgevoerd als een niet-gebruiker met beheerdersrechten die uniek is voor de taak.

JobNetworkConfiguration

De netwerkconfiguratie voor de taak.

Name Type Description
skipWithdrawFromVNet

boolean

Of u rekenknooppunten wilt intrekken van het virtuele netwerk naar DNC wanneer de taak wordt beëindigd of verwijderd.
Indien waar, blijven knooppunten gekoppeld aan het virtuele netwerk aan DNC. Als dit onwaar is, worden knooppunten automatisch ingetrokken wanneer de taak wordt beëindigd. De standaardwaarde is onwaar.

subnetId

string

De ARM-resource-id van het subnet van het virtuele netwerk waaraan rekenknooppunten waarop taken van de taak worden uitgevoerd, worden toegevoegd voor de duur van de taak.
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 om tegemoet te komen aan het aantal rekenknooppunten dat taken van de taak uitvoert. Dit kan maximaal het aantal rekenknooppunten in de pool zijn. De service-principal MicrosoftAzureBatch moet de rol 'Inzender voor klassieke virtuele machines' hebben Role-Based RBAC-rol (Access Control) voor het opgegeven VNet, zodat de Azure Batch-service taken op de knooppunten kan plannen. Dit kan worden gecontroleerd door te controleren of het opgegeven VNet gekoppelde netwerkbeveiligingsgroepen (NSG' 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 is van het formulier /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnetten/{subnet}. Als het opgegeven VNet gekoppelde netwerkbeveiligingsgroepen (NSG) heeft, moeten enkele gereserveerde systeempoorten zijn ingeschakeld voor binnenkomende communicatie vanuit de Azure Batch-service. Voor pools die zijn gemaakt met een configuratie van een virtuele machine, schakelt u poorten 29876 en 29877, evenals poort 22 voor Linux en poort 3389 voor Windows in. Poort 443 moet ook open zijn voor uitgaande verbindingen voor communicatie met Azure Storage. Zie voor meer informatie: https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPreparationTask

Een taakvoorbereidingstaak die moet worden uitgevoerd voordat taken van de taak op een bepaald rekenknooppunt worden uitgevoerd.

Name Type Description
commandLine

string

De opdrachtregel van de jobvoorbereidingstaak.
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 aanroepen op de opdrachtregel, bijvoorbeeld met 'cmd /c MyCommand' in Windows of '/bin/sh -c MyCommand' in Linux. Als de opdrachtregel verwijst naar bestandspaden, moet deze een relatief pad gebruiken (ten opzichte van de werkmap Taak) of de door Batch geleverde omgevingsvariabele (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).

constraints

TaskConstraints

Beperkingen die van toepassing zijn op de jobvoorbereidingstaak.

containerSettings

TaskContainerSettings

De instellingen voor de container waaronder de jobvoorbereidingstaak 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 omgevingsvariabelen van de taak toegewezen aan de container en wordt de opdrachtregel Taak uitgevoerd in de container. Bestanden die worden geproduceerd in de container buiten AZ_BATCH_NODE_ROOT_DIR 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 omgevingsvariabeleinstellingen voor de jobvoorbereidingstaak.

id

string

Een tekenreeks die de jobvoorbereidingstaak uniek identificeert binnen de taak.
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 van jobpreparation toe. Er kan geen andere taak in de taak dezelfde id hebben als de jobvoorbereidingstaak. Als u een taak met dezelfde id probeert in te dienen, 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 taakvoorbereidingstaak wordt altijd opnieuw uitgevoerd als er een installatiekopie van een rekenknooppunt wordt gemaakt of als de taakvoorbereidingstaak niet is voltooid (bijvoorbeeld omdat het opnieuw opstarten is opgetreden tijdens het uitvoeren van de taak). Daarom moet u altijd een taakvoorbereidingstaak schrijven om idempotent te zijn en 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 u de opdrachtregel uitvoert.
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 het geval is, 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 jobvoorbereidingstaak 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 niet-beheerdersgebruiker die uniek is voor de pool op Linux-rekenknooppunten.

waitForSuccess

boolean

Of de Batch-service moet wachten tot de taakvoorbereidingstaak is voltooid voordat u andere taken van de taak op het rekenknooppunt plant. Een taakvoorbereidingstaak is voltooid als deze wordt afgesloten met afsluitcode 0.
Als waar is en de taakvoorbereidingstaak op een knooppunt mislukt, probeert de Batch-service de jobvoorbereidingstaak opnieuw uit te voeren tot het maximumaantal nieuwe pogingen (zoals opgegeven in het beperkingselement). Als de taak na alle nieuwe pogingen nog steeds niet is voltooid, plant de Batch-service geen taken van de taak naar het knooppunt. Het knooppunt blijft actief en komt in aanmerking voor het uitvoeren van taken van andere taken. Als dit onwaar is, wacht de Batch-service niet tot 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, blijven nieuwe taken gepland op het rekenknooppunt. De standaardwaarde is waar.

JobReleaseTask

Een jobreleasetaak die moet worden uitgevoerd op taakvoltooiing op elk rekenknooppunt waarop de taak is uitgevoerd.

Name Type Description
commandLine

string

De opdrachtregel van de taak jobrelease.
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 aanroepen op de opdrachtregel, bijvoorbeeld met 'cmd /c MyCommand' in Windows of '/bin/sh -c MyCommand' in Linux. Als de opdrachtregel verwijst naar bestandspaden, moet deze een relatief pad gebruiken (ten opzichte van de werkmap Taak) of de door Batch geleverde omgevingsvariabele (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).

containerSettings

TaskContainerSettings

De instellingen voor de container waaronder de jobreleasetaak 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 omgevingsvariabelen van de taak toegewezen aan de container en wordt de opdrachtregel Taak uitgevoerd in de container. Bestanden die worden geproduceerd in de container buiten AZ_BATCH_NODE_ROOT_DIR 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 omgevingsvariabeleinstellingen voor de taak voor taakrelease.

id

string

Een tekenreeks die de taak jobrelease uniek identificeert binnen de taak.
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 van jobrelease toe. Er kan geen andere taak in de taak dezelfde id hebben als de taak voor het vrijgeven van de taak. Als u een taak met dezelfde id probeert in te dienen, 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 maximale verstreken tijd die door de taakreleasetaak kan worden uitgevoerd op een bepaald rekenknooppunt, gemeten vanaf het moment dat de taak wordt gestart. Als de taak niet binnen de tijdslimiet is voltooid, beëindigt de Batch-service deze. De standaardwaarde is 15 minuten. U mag geen time-out opgeven die langer is dan 15 minuten. Als u dit wel 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 u de opdrachtregel uitvoert. Er is een maximale grootte voor de lijst met resourcebestanden. Wanneer de maximale grootte wordt overschreden, mislukt de aanvraag en is de antwoordfoutcode RequestEntityTooLarge. Als dit het geval is, moet de verzameling ResourceFiles worden verkleind. Dit kan worden bereikt met behulp van .zip bestanden, toepassingspakketten of Docker-containers.
Bestanden die onder dit element worden vermeld, bevinden zich in de werkmap van de taak.

retentionTime

string

De minimale tijd voor het behouden van de taakmap voor de taakreleasetaak op het rekenknooppunt. Na deze tijd kan de Batch-service de map Taak en alle inhoud ervan verwijderen.
De standaardwaarde is 7 dagen, d.w. de map Taak wordt 7 dagen bewaard, tenzij het rekenknooppunt wordt verwijderd of de taak wordt verwijderd.

userIdentity

UserIdentity

De gebruikersidentiteit waaronder de jobreleasetaak wordt uitgevoerd.
Als u dit weglaat, wordt de taak uitgevoerd als een niet-gebruiker met beheerdersrechten die uniek is voor de taak.

JobSchedulingError

Er is een fout opgetreden door 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 laten plannen.

completed

string

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

deleting

string

Een gebruiker heeft gevraagd om de taak te verwijderen, maar de verwijderbewerking wordt nog 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 om de taak uit te schakelen, maar de uitschakeling wordt nog uitgevoerd (bijvoorbeeld wachten tot taken zijn beëindigd).

enabling

string

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

terminating

string

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

JobStatistics

Statistieken over resourcegebruik voor een taak.

Name Type Description
kernelCPUTime

string

De totale CPU-tijd in de kernelmodus (opgeteld voor alle kernen en alle rekenknooppunten) die door alle taken in de taak worden 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 maximumaantal 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 van de gebruikersmodus (opgeteld voor alle kernen en alle rekenknooppunten) die door alle taken in de taak worden verbruikt.

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 statistieken van de levensduur van het account; deze is niet opgenomen in de taakstatistieken.

wallClockTime

string

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

writeIOGiB

number

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

writeIOps

integer

Het totale aantal schrijfbewerkingen op de schijf dat door alle taken in de taak is uitgevoerd.

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 uid- en gid-eigenschappen moeten samen worden opgegeven of helemaal niet. Als het onderliggende besturingssysteem niet is opgegeven, kiest u 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 map .ssh van de gebruiker te plaatsen. Als dit niet is opgegeven, is 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 uid- en gid-eigenschappen moeten samen worden opgegeven of helemaal niet. Als het onderliggende besturingssysteem niet is opgegeven, wordt de uid gekozen.

LoginMode

De aanmeldingsmodus voor de gebruiker

Name Type Description
batch

string

De LOGON32_LOGON_BATCH Win32-aanmeldingsmodus. De batchaanmeldingsmodus wordt aanbevolen voor langdurige parallelle processen.

interactive

string

De LOGON32_LOGON_INTERACTIVE Win32-aanmeldingsmodus. UAC is ingeschakeld voor Windows-pools. Als deze optie wordt gebruikt met een gebruikersidentiteit met verhoogde bevoegdheid in een Windows-pool, wordt de gebruikerssessie niet verhoogd, tenzij de toepassing die wordt uitgevoerd door de opdrachtregel Taak is geconfigureerd om altijd beheerdersbevoegdheden te vereisen of om altijd maximale bevoegdheden te vereisen.

ManagedDisk

Name Type Description
securityProfile

VMDiskSecurityProfile

Hiermee geeft u de beveiligingsprofielinstellingen voor de beheerde schijf.
Hiermee geeft u de beveiligingsprofielinstellingen voor de beheerde schijf. Opmerking: deze kan alleen worden ingesteld voor vertrouwelijke VM's en vereist bij het gebruik van vertrouwelijke VM's.

storageAccountType

StorageAccountType

Het type opslagaccount voor beheerde schijf.

MetadataItem

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

Name Type Description
name

string

De naam van het metagegevensitem.

value

string

De waarde van het metagegevensitem.

MountConfiguration

Het bestandssysteem dat op elk knooppunt moet worden gekoppeld.

Name Type Description
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

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

azureFileShareConfiguration

AzureFileShareConfiguration

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

cifsMountConfiguration

CIFSMountConfiguration

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

nfsMountConfiguration

NFSMountConfiguration

Het NFS-bestandssysteem dat op 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 maken I/O-virtualisatie met één hoofdmap (SR-IOV) mogelijk voor een VIRTUELE machine, wat kan leiden tot verbeterde netwerkprestaties. Zie voor meer informatie: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.

endpointConfiguration

PoolEndpointConfiguration

De configuratie voor eindpunten op rekenknooppunten in de Batch-pool.

publicIPAddressConfiguration

PublicIPAddressConfiguration

De openbare IPAddress-configuratie voor rekenknooppunten in de Batch-pool.
De configuratie van het openbare IP-adres van de netwerkconfiguratie van een pool.

subnetId

string

De ARM-resource-id van het subnet van het virtuele netwerk waaraan de rekenknooppunten van de pool worden toegevoegd. Dit is van het formulier /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnetten/{subnet}.
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 om het aantal rekenknooppunten in de pool te kunnen gebruiken. Als het subnet niet voldoende vrije IP-adressen heeft, wijst de pool gedeeltelijk knooppunten toe en treedt er een fout op bij het wijzigen van de grootte. De service-principal 'MicrosoftAzureBatch' moet de rol 'Inzender voor klassieke virtuele machines' hebben Role-Based RBAC-rol (Access Control) 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' 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. Alleen virtuele ARM-netwerken ('Microsoft.Network/virtualNetworks') worden ondersteund. Als het opgegeven VNet gekoppelde netwerkbeveiligingsgroepen (NSG) heeft, moeten enkele gereserveerde systeempoorten zijn ingeschakeld voor binnenkomende communicatie. Schakel poorten 29876 en 29877 in, evenals poort 22 voor Linux en poort 3389 voor Windows. Schakel ook uitgaande verbindingen met Azure Storage in op poort 443. Zie voor meer informatie: https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Een regel voor een netwerkbeveiligingsgroep 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 er gereserveerde of dubbele waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.

sourceAddressPrefix

string

Het bronadresvoorvoegsel of het label dat overeenkomt met de regel.
Geldige waarden zijn één IP-adres (bijvoorbeeld 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 (bijvoorbeeld 22) of een poortbereik (bijvoorbeeld 100-200). De poorten moeten binnen het bereik van 0 tot 65535 liggen. Elke vermelding in deze verzameling mag geen andere vermelding overlappen (een bereik of een afzonderlijke poort). Als er andere waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400. De standaardwaarde is ''.

NetworkSecurityGroupRuleAccess

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

Name Type Description
allow

string

Toegang toestaan.

deny

string

Toegang weigeren.

NFSMountConfiguration

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

Name Type Description
mountOptions

string

Aanvullende opdrachtregelopties om door te geven aan de koppelingsopdracht.
Dit zijn opties voor 'net use' in Windows en opties voor koppelen in Linux.

relativeMountPath

string

Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld
Alle bestandssystemen worden gekoppeld ten opzichte van de map batchkoppelingen, die toegankelijk zijn via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.

source

string

De URI van het bestandssysteem die moet worden gekoppeld.

NodeCommunicationMode

Bepaalt hoe een pool communiceert met de Batch-service.

Name Type Description
classic

string

Knooppunten die de klassieke communicatiemodus gebruiken, vereisen binnenkomende TCP-communicatie op poorten 29876 en 29877 van batchnodemanagement. {region}-servicetag en uitgaande TCP-communicatie op poort 443 naar storage.region en BatchNodeManagement. Servicetags van {region}.

default

string

De communicatiemodus voor knooppunten wordt automatisch ingesteld door de Batch-service.

simplified

string

Knooppunten die gebruikmaken van de vereenvoudigde communicatiemodus vereisen uitgaande TCP-communicatie op poort 443 naar BatchNodeManagement. Servicetag {region}. Er zijn geen geopende binnenkomende poorten vereist.

NodePlacementConfiguration

Knooppuntplaatsingsconfiguratie voor een pool.

Name Type Description
policy

NodePlacementPolicyType

Type plaatsingsbeleid voor knooppunten 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 in dezelfde regio toegewezen.

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

Doe niets. De taak blijft actief, tenzij de taak op een andere wijze wordt beëindigd of uitgeschakeld.

terminatejob

string

Beëindig de taak. 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

Doe niets. De taak blijft actief, tenzij de taak op een andere wijze wordt beëindigd of uitgeschakeld.

performexitoptionsjobaction

string

Voer de actie uit die is gekoppeld aan de voorwaarde Taakafsluiten 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: Geen, ReadOnly, ReadWrite. De standaardwaarden zijn: Geen voor Standard-opslag. ReadOnly voor Premium-opslag.
De standaardwaarde voor opslaan in 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 oorspronkelijke 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 ingeschakeld of uitgeschakeld op de schijf.

OutputFile

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

Name Type Description
destination

OutputFileDestination

De bestemming voor de uitvoerbestand(en).

filePattern

string

Een patroon dat aangeeft welke bestanden moeten 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 map? komt overeen met één teken, [abc] komt overeen met één teken tussen de haken en [a-c] komt overeen met één teken in het bereik. Vierkante haken kunnen een negatie bevatten die overeenkomt met een willekeurig teken dat niet is opgegeven (bijvoorbeeld [!abc] komt overeen met een willekeurig teken, maar een, b of c). Als een bestandsnaam begint met '.' wordt deze standaard genegeerd, maar kan 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 in '.' en eindigt met .txt in de werkmap Taak of een submap. Als de bestandsnaam een jokerteken bevat, kan deze worden ontsnapt 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 / zich op Linux bevindt. 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 doel voor het uploaden van bestanden in een Azure Blob Storage-container op.

Name Type Description
containerUrl

string

De URL van de container in Azure Blob Storage waarnaar u het bestand(en) wilt uploaden.
Als u geen beheerde identiteit gebruikt, moet de URL een SAS (Shared Access Signature) bevatten die schrijfmachtigingen verleent aan de container.

identityReference

ComputeNodeIdentityReference

De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage die is 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 gezegd geen jokertekens bevat), is het pad de naam van de blob waarnaar het bestand moet worden geüpload. Als filePattern een of meer jokertekens bevat (en dus mogelijk overeenkomt met meerdere bestanden), is het pad de naam van de virtuele blobmap (die is voorafgegaan aan 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/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 het bestand(en) nadat het taakproces is afgesloten, ongeacht wat de afsluitcode was.

taskfailure

string

Upload het bestand(en) pas nadat het taakproces is afgesloten met een niet-nul-afsluitcode.

tasksuccess

string

Upload het bestand(en) pas nadat het taakproces is afgesloten met een afsluitcode van 0.

OutputFileUploadOptions

Details over een uploadbewerking voor een uitvoerbestand, waaronder onder welke voorwaarden de upload moet worden uitgevoerd.

Name Type Description
uploadCondition

OutputFileUploadCondition

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

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 batchgroep 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 'automatische pool'. 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. 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 specificatie van de automatische pool 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 pas uitgevoerd als de pool bestaat. U moet de pool-id of de specificatie van de automatische pool opgeven, maar niet beide.

PoolLifetimeOption

De minimale levensduur van gemaakte automatische pools en hoe 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 deze de eerste taak volgens de planning maakt. U kunt deze optie alleen toepassen op jobplanningen, niet op taken.

PoolSpecification

Specificatie voor het maken van een nieuwe pool.

Name Type Description
applicationPackageReferences

ApplicationPackageReference[]

De lijst met pakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool.
Bij het maken van een pool 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 zijn van de pool, maar hebben geen invloed op rekenknooppunten die zich al in de pool bevinden totdat ze opnieuw worden opgestart of opnieuw worden hersteld. Er zijn maximaal 10 pakketverwijzingen voor een bepaalde groep.

autoScaleEvaluationInterval

string

Het tijdsinterval waarmee de poolgrootte automatisch moet worden aangepast volgens 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 ongeldige eigenschapswaardefout; 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 mag 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 niet geldig is, weigert de Batch-service de aanvraag met gedetailleerde foutinformatie.

certificateReferences

CertificateReference[]

Een lijst met certificaten die op elk rekenknooppunt in de pool moeten worden geïnstalleerd.
Voor Windows-knooppunten installeert de Batch-service de certificaten op het opgegeven certificaatarchief en de opgegeven locatie. Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap Taak en wordt een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR aan de taak verstrekt 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 certificaten worden in die map geplaatst.

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

displayName

string

De weergavenaam voor de pool.
De weergavenaam hoeft niet uniek te zijn en mag unicode-tekens bevatten tot een maximale lengte van 1024.

enableAutoScale

boolean

Of de grootte van de pool na verloop van tijd automatisch moet worden aangepast.
Als dit onwaar is, moeten ten minste één van targetDedicatedNodes en targetLowPriorityNodes worden opgegeven. Indien waar, is het element autoScaleFormula vereist. De grootte van de pool wordt automatisch aangepast aan de formule. De standaardwaarde is onwaar.

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 de gewenste grootte niet bereikt. De standaardwaarde is onwaar.

metadata

MetadataItem[]

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

mountConfiguration

MountConfiguration[]

Een lijst met bestandssystemen die op 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 opgeeft die minder dan 5 minuten duurt, 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 aan de pool zijn gekoppeld.
De door de gebruiker gedefinieerde tags die moeten worden gekoppeld aan de Azure Batch-pool. Wanneer deze tags zijn 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 terwijl deze lid wordt van de pool. De taak wordt uitgevoerd wanneer het rekenknooppunt wordt toegevoegd aan de pool of wanneer het rekenknooppunt opnieuw wordt opgestart.
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 maxTaskRetryCount. Zelfs als maxTaskRetryCount 0 is, kan er een interne nieuwe poging worden uitgevoerd vanwege een herstelbewerking. Daarom moeten alle taken idempotent zijn. Dit betekent dat taken moeten worden onderbroken en opnieuw moeten worden gestart zonder beschadiging of dubbele gegevens te veroorzaken. De aanbevolen procedure voor langlopende taken is om een vorm van controlepunten te gebruiken. In sommige gevallen kan de StartTask opnieuw worden uitgevoerd, ook al is het rekenknooppunt niet opnieuw opgestart. Er moet speciale aandacht worden besteed aan het voorkomen van StartTasks die een breakaway-proces maken of services installeren/starten vanuit de werkmap StartTask, omdat hierdoor Batch niet meer in staat is om de StartTask opnieuw uit te voeren.

targetDedicatedNodes

integer

Het gewenste aantal toegewezen rekenknooppunten in de pool.
Deze eigenschap mag 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-/lage prioriteit rekenknooppunten in de pool.
Deze eigenschap mag 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 communicatiemodus voor knooppunten 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, wordt de standaardwaarde verspreid.

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.

upgradePolicy

UpgradePolicy

Het upgradebeleid voor de pool.
Beschrijft een upgradebeleid: automatisch, handmatig of rolling.

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.

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, heeft ten minste 3 openbare IP-adressen nodig. 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 wederzijds uit en een van deze 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 namen beginnen 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 Compute-knooppunt. Als deze eigenschap niet is opgegeven voor een Linux-rekenknooppunt, wordt een standaardwaarde van 0770 toegepast op het bestand.

filePath

string

De locatie op het rekenknooppunt waarnaar u het bestand(en) wilt downloaden ten opzichte van de werkmap van de taak.
Als de eigenschap httpUrl is opgegeven, is het filePath vereist en wordt het pad beschreven waarnaar het bestand wordt gedownload, inclusief de bestandsnaam. Als anders de eigenschap autoStorageContainerName of storageContainerUrl is opgegeven, is filePath optioneel en is het de map waarin de bestanden moeten worden gedownload. In het geval dat filePath wordt gebruikt als 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 uitgesplitsd uit de werkmap van de taak (bijvoorbeeld met '..').

httpUrl

string

De URL van het bestand dat u wilt downloaden.
De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar wederzijds uit en een van deze moet worden opgegeven. Als de URL verwijst naar Azure Blob Storage, moet deze leesbaar zijn vanuit rekenknooppunten. Er zijn drie manieren om een dergelijke URL op te halen voor een blob in Azure Storage: neem een SAS (Shared Access Signature) die leesmachtigingen voor de blob verleent, gebruik een beheerde identiteit met leesmachtigingen of stel de ACL voor de blob of de container in 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 die is 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 wederzijds uit en een van deze moet worden opgegeven. Deze URL moet kunnen worden gelezen en vermeld vanuit rekenknooppunten. Er zijn drie manieren om een dergelijke URL op te halen voor een container in Azure Storage: neem een SAS (Shared Access Signature) op die lees- en lijstmachtigingen voor de container verleent, gebruik een beheerde identiteit met lees- en lijstmachtigingen of stel de ACL voor de container in om openbare toegang toe te staan.

RollingUpgradePolicy

De configuratieparameters die worden gebruikt tijdens het uitvoeren van een rolling upgrade.

Name Type Description
enableCrossZoneUpgrade

boolean

Toestaan dat VMSS AZ-grenzen negeert bij het maken van upgradebatches. Neem rekening met het updatedomein en maxBatchInstancePercent om de batchgrootte te bepalen. Dit veld kan alleen worden ingesteld op waar of onwaar wanneer u NodePlacementConfiguration als zonegebonden gebruikt.

maxBatchInstancePercent

integer

Het maximumpercentage van het totale aantal exemplaren van virtuele machines dat tegelijkertijd wordt geüpgraded door de rolling upgrade in één batch. Omdat dit een maximum is, kunnen beschadigde exemplaren in eerdere of toekomstige batches ervoor zorgen dat het percentage exemplaren in een batch afneemt om een hogere betrouwbaarheid te garanderen. De waarde van dit veld moet tussen 5 en 100 liggen, inclusief. Als zowel maxBatchInstancePercent als maxUnhealthyInstancePercent aan waarde zijn toegewezen, mag de waarde van maxBatchInstancePercent niet meer zijn dan maxUnhealthyInstancePercent.

maxUnhealthyInstancePercent

integer

Het maximumpercentage van het totale aantal exemplaren van virtuele machines in de schaalset dat tegelijkertijd beschadigd kan zijn, hetzij als gevolg van een upgrade of door de statuscontroles van de virtuele machine te worden aangetroffen voordat de rolling upgrade wordt afgebroken. Deze beperking wordt gecontroleerd voordat u een batch start. De waarde van dit veld moet tussen 5 en 100 liggen, inclusief. Als zowel maxBatchInstancePercent als maxUnhealthyInstancePercent aan waarde zijn toegewezen, mag de waarde van maxBatchInstancePercent niet meer zijn dan maxUnhealthyInstancePercent.

maxUnhealthyUpgradedInstancePercent

integer

Het maximumpercentage van bijgewerkte exemplaren van virtuele machines die kunnen worden gevonden, hebben een slechte status. Deze controle vindt plaats nadat elke batch is bijgewerkt. Als dit percentage ooit wordt overschreden, wordt de rolling update afgebroken. De waarde van dit veld moet tussen 0 en 100, inclusief zijn.

pauseTimeBetweenBatches

string

De wachttijd tussen het voltooien van de update voor alle virtuele machines in één batch en het starten van de volgende batch. De tijdsduur moet worden opgegeven in ISO 8601-indeling.

prioritizeUnhealthyInstances

boolean

Werk alle beschadigde exemplaren in een schaalset bij voordat alle exemplaren in orde zijn.

rollbackFailedInstancesOnPolicyBreach

boolean

Het terugdraaien van mislukte exemplaren naar het vorige model als het beleid voor rolling upgrades wordt geschonden.

SecurityEncryptionTypes

Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor het niet behouden van de firmwarestatus in de VMGuestState-blob. Opmerking: deze kan alleen worden ingesteld voor vertrouwelijke VM's en is vereist bij het gebruik van vertrouwelijke VM's.

Name Type Description
NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

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

Name Type Description
encryptionAtHost

boolean

Deze eigenschap kan worden gebruikt door de gebruiker in de aanvraag om hostversleuteling voor de virtuele machine of virtuele-machineschaalset in of uit te schakelen. Hierdoor wordt de versleuteling ingeschakeld voor alle schijven, inclusief resource-/tijdelijke schijf op de host zelf. Raadpleeg https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizesvoor meer informatie over versleuteling bij hostvereisten.

securityType

SecurityTypes

Hiermee geeft u het SecurityType 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 tijdens het maken van de virtuele machine.
Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine.

SecurityTypes

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

Name Type Description
confidentialVM

string

Azure Confidential Computing biedt vertrouwelijke VM's voor tenants met hoge vereisten voor beveiliging en vertrouwelijkheid. Deze VM's bieden een sterke, hardware-afgedwongen grens om te voldoen aan uw beveiligingsbehoeften. U kunt vertrouwelijke VM's gebruiken voor migraties zonder wijzigingen aan te brengen in uw code, waarbij het platform dat de status van uw VIRTUELE machine beveiligt, niet kan worden gelezen of gewijzigd.

trustedLaunch

string

Vertrouwde lancering beschermt tegen geavanceerde en permanente aanvalstechnieken.

ServiceArtifactReference

Hiermee geeft u de referentie-id voor serviceartefacten op die wordt gebruikt voor het instellen van dezelfde installatiekopieënversie voor alle virtuele machines in de schaalset wanneer u de meest recente installatiekopieënversie gebruikt.

Name Type Description
id

string

De naslag-id van ServiceArtifactReference
De referentie-id van het serviceartefact 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 hersteld.

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 aanroepen op de opdrachtregel, bijvoorbeeld met 'cmd /c MyCommand' in Windows of '/bin/sh -c MyCommand' in Linux. Als de opdrachtregel verwijst naar bestandspaden, moet deze een relatief pad gebruiken (ten opzichte van de werkmap Taak) of de door Batch geleverde omgevingsvariabele (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).

containerSettings

TaskContainerSettings

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

environmentSettings

EnvironmentSetting[]

Een lijst met omgevingsvariabele-instellingen voor de StartTask.

maxTaskRetryCount

integer

Het maximum aantal keren dat de taak opnieuw kan worden geprobeerd.
De Batch-service probeert een taak opnieuw uit te voeren als de afsluitcode niet-nul is. Houd er rekening mee dat deze waarde specifiek het aantal nieuwe pogingen bepaalt. De Batch-service probeert de taak eenmaal uit en probeert vervolgens opnieuw tot deze limiet. Als het maximumaantal nieuwe pogingen bijvoorbeeld 3 is, probeert Batch de taak maximaal 4 keer (één eerste poging en drie 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 andere taak. De standaardwaarde is 0 (geen nieuwe pogingen).

resourceFiles

ResourceFile[]

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

userIdentity

UserIdentity

De gebruikersidentiteit waaronder StartTask wordt uitgevoerd.
Als u dit weglaat, wordt de taak uitgevoerd als een niet-gebruiker met 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.
Indien waar en starttask mislukt op een knooppunt, probeert de Batch-service de StartTask opnieuw uit te voeren tot het maximumaantal nieuwe pogingen (maxTaskRetryCount). Als de taak na alle nieuwe pogingen nog steeds niet is voltooid, markeert de Batch-service het knooppunt onbruikbaar en plant deze niet. Deze voorwaarde kan worden gedetecteerd via de details van de status en foutgegevens van het rekenknooppunt. Als dit onwaar is, 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 nog steeds gepland op het rekenknooppunt. De standaardwaarde is waar.

StorageAccountType

Het type opslagaccount voor gebruik bij het maken van gegevensschijven of een besturingssysteemschijf.

Name Type Description
premium_lrs

string

De gegevensschijf/besturingssysteemschijf moet premium lokaal redundante opslag gebruiken.

standard_lrs

string

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

standardssd_lrs

string

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

TaskConstraints

Uitvoeringsbeperkingen die van toepassing zijn op een taak.

Name Type Description
maxTaskRetryCount

integer

Het maximum aantal keren dat de taak opnieuw kan worden geprobeerd. De Batch-service probeert een taak opnieuw uit te voeren als de afsluitcode niet-nul is.
Houd er rekening mee dat deze waarde specifiek het aantal nieuwe pogingen voor het uitvoerbare taakbestand bepaalt vanwege een niet-nul-afsluitcode. De Batch-service probeert de taak eenmaal uit en probeert vervolgens opnieuw tot deze limiet. Als het maximumaantal nieuwe pogingen bijvoorbeeld 3 is, probeert Batch de taak maximaal 4 keer (één eerste poging en drie nieuwe pogingen). Als het maximumaantal nieuwe pogingen 0 is, voert de Batch-service de taak na de eerste poging 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 andere taak. De standaardwaarde is 0 (geen nieuwe pogingen).

maxWallClockTime

string

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

retentionTime

string

De minimale tijd voor het behouden van de taakmap op het rekenknooppunt waarop het is uitgevoerd, vanaf het moment dat de uitvoering is voltooid. Na deze tijd kan de Batch-service de map Taak en alle inhoud ervan verwijderen.
De standaardwaarde is 7 dagen, d.w. de map Taak wordt 7 dagen bewaard, tenzij het rekenknooppunt wordt verwijderd of de taak wordt verwijderd.

TaskContainerSettings

De containerinstellingen voor een taak.

Name Type Description
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

De paden die u aan de containertaak wilt koppelen.
Als deze matrix null is of niet aanwezig is, koppelt de containertaak een volledig tijdelijk schijfstation in Windows (of AZ_BATCH_NODE_ROOT_DIR in Linux). Er worden geen gegevenspaden in de container geplaatst als deze matrix is ingesteld als leeg.

containerRunOptions

string

Aanvullende opties voor de opdracht container maken.
Deze extra opties worden geleverd als argumenten voor de opdracht Docker create, 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 voor 'docker pull'. Als er geen tag wordt opgegeven als onderdeel van de naam van de installatiekopieën, wordt de tag ':latest' als 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 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, wordt de standaardwaarde verspreid.

UefiSettings

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

Name Type Description
secureBootEnabled

boolean

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

vTpmEnabled

boolean

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

UpgradeMode

Hiermee geeft u de modus van een upgrade naar virtuele machines in de schaalset.

Mogelijke waarden zijn:

Handmatige: u bepaalt de toepassing van updates voor virtuele machines in de schaalset. U doet dit met behulp van de manualUpgrade-actie.

Automatisch: alle virtuele machines in de schaalset worden automatisch tegelijkertijd bijgewerkt.

Rolling - Schaalset voert updates uit in batches met een optionele onderbrekingstijd ertussen.

Name Type Description
automatic

string

Alle virtuele machines in de schaalset worden automatisch tegelijkertijd bijgewerkt.

manual

string

U bepaalt de toepassing van updates voor virtuele machines in de schaalset. U doet dit met behulp van de manualUpgrade-actie.

rolling

string

De bestaande exemplaren in een schaalset worden neergezet in batches die moeten worden bijgewerkt. Zodra de bijgewerkte batch is voltooid, beginnen de exemplaren opnieuw met verkeer en wordt de volgende batch gestart. Dit gaat door totdat alle exemplaren up-to-date zijn gebracht.

UpgradePolicy

Beschrijft een upgradebeleid: automatisch, handmatig of rolling.

Name Type Description
automaticOSUpgradePolicy

AutomaticOSUpgradePolicy

Configuratieparameters die worden gebruikt voor het uitvoeren van automatische upgrade van het besturingssysteem.
De configuratieparameters die worden gebruikt voor het uitvoeren van automatische upgrade van het besturingssysteem.

mode

UpgradeMode

Hiermee geeft u de modus van een upgrade naar virtuele machines in de schaalset.

Mogelijke waarden zijn:

Handmatige: u bepaalt de toepassing van updates voor virtuele machines in de schaalset. U doet dit met behulp van de manualUpgrade-actie.

Automatisch: alle virtuele machines in de schaalset worden automatisch tegelijkertijd bijgewerkt.

Rolling - Schaalset voert updates uit in batches met een optionele onderbrekingstijd ertussen.

rollingUpgradePolicy

RollingUpgradePolicy

De configuratieparameters die worden gebruikt tijdens het uitvoeren van een rolling upgrade.
De configuratieparameters die worden gebruikt tijdens het uitvoeren van een rolling upgrade.

UserAccount

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

Name Type Description
elevationLevel

ElevationLevel

Het hoogteniveau van het gebruikersaccount.
De standaardwaarde is nietAdmin.

linuxUserConfiguration

LinuxUserConfiguration

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

name

string

De naam van het gebruikersaccount. Namen kunnen Unicode-tekens bevatten tot een maximale lengte van 20.

password

string

Het wachtwoord voor het gebruikersaccount.

windowsUserConfiguration

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-pool, 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 wederzijds 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 wederzijds 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 pool.
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 ook de schijf en alle gegevens die eraan zijn gekoppeld, verwijderd. De schijf is niet geformatteerd nadat deze is gekoppeld, moet worden geformatteerd voordat deze wordt gebruikt. Zie https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux en https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machinevoor meer informatie.

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 extensie van de virtuele machine voor de pool.
Indien opgegeven, worden de extensies die in deze configuratie worden genoemd, op elk knooppunt geïnstalleerd.

imageReference

ImageReference

Een verwijzing naar de Marketplace-installatiekopieën van Azure Virtual Machines of de aangepaste vm-installatiekopieën die u wilt gebruiken.

licenseType

string

Het type on-premises licentie dat moet worden gebruikt bij het implementeren van het besturingssysteem.
Dit geldt alleen voor installatiekopieën die het Windows-besturingssysteem bevatten en mogen alleen worden gebruikt wanneer u geldige on-premises licenties hebt voor de rekenknooppunten die worden geïmplementeerd. Als u dit weglaat, wordt er geen korting op on-premises licenties 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 opdracht-en-beheerinterface 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 rekenknooppuntagent-SKU opgeven die overeenkomt met de geselecteerde afbeeldingsreferentie. Zie de bewerking Ondersteunde SKU's voor compute-knooppuntagenten samen met de lijst met geverifieerde afbeeldingsverwijzingen voor de lijst met ondersteunde SKU's voor compute-knooppuntagenten.

nodePlacementConfiguration

NodePlacementConfiguration

De configuratie van de plaatsing van knooppunten voor de pool.
Met deze configuratie worden regels opgegeven voor de manier 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 voor het instellen van dezelfde installatiekopieënversie voor alle virtuele machines in de schaalset wanneer u de meest recente installatiekopieënversie gebruikt.
De referentie-id van het serviceartefact 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 mag niet worden opgegeven als de eigenschap imageReference een Linux-besturingssysteeminstallatiekopie opgeeft.

VMDiskSecurityProfile

Hiermee geeft u de beveiligingsprofielinstellingen voor de beheerde schijf. Opmerking: deze kan alleen worden ingesteld voor vertrouwelijke VM's en vereist bij het gebruik van vertrouwelijke VM's.

Name Type Description
securityEncryptionType

SecurityEncryptionTypes

Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor het niet behouden van de firmwarestatus in de VMGuestState-blob. Opmerking: deze kan alleen worden ingesteld voor vertrouwelijke VM's en is vereist bij het gebruik van vertrouwelijke VM's.

VMExtension

De configuratie voor extensies van virtuele machines.

Name Type Description
autoUpgradeMinorVersion

boolean

Geeft aan of de extensie een nieuwere secundaire versie moet gebruiken als deze beschikbaar is tijdens de implementatie. Zodra de extensie eenmaal is geïmplementeerd, worden er echter geen secundaire versies bijgewerkt, tenzij deze opnieuw wordt geïmplementeerd, zelfs niet als deze eigenschap is ingesteld op true.

enableAutomaticUpgrade

boolean

Geeft aan of de extensie automatisch moet worden bijgewerkt door het platform als er een nieuwere versie van de extensie beschikbaar is.

name

string

De naam van de extensie van de virtuele machine.

protectedSettings

object

De extensie kan protectedSettings of protectedSettingsFromKeyVault of helemaal geen beveiligde instellingen bevatten.

provisionAfterExtensions

string[]

De verzameling extensienamen.
Verzameling extensienamen waarna deze extensie moet worden ingericht.

publisher

string

De naam van de uitgever van de extensie-handler.

settings

object

Openbare instellingen met JSON-indeling voor de extensie.

type

string

Het type extensie.

typeHandlerVersion

string

De versie van de scripthandler.

WindowsConfiguration

Windows-besturingssysteeminstellingen die van toepassing zijn op de virtuele machine.

Name Type Description
enableAutomaticUpdates

boolean

Of automatische updates zijn ingeschakeld op de virtuele machine.
Als u dit weglaat, is de standaardwaarde waar.

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