Pool - Update Properties

Service:

Batch Service

API-versie:

2024-07-01.20.0

Hiermee worden de eigenschappen van de opgegeven pool bijgewerkt.
Hierdoor worden alle updatable eigenschappen van de pool volledig vervangen. Als er bijvoorbeeld een StartTask aan de pool is gekoppeld en als StartTask niet is opgegeven met deze aanvraag, wordt de bestaande StartTask door de Batch-service verwijderd.

POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2024-07-01.20.0

Met optionele parameters:

POST {batchUrl}/pools/{poolId}/updateproperties?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.
poolId	path	True	string	De id van de pool die moet worden bijgewerkt.
api-version	query	True	string	Client-API-versie.
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.

Aanvraagbody

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

Name	Vereist	Type	Description
applicationPackageReferences	True	ApplicationPackageReference[]	De lijst met toepassingspakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. De lijst vervangt alle bestaande verwijzingen naar toepassingspakketten in de groep. Wijzigingen in toepassingspakketverwijzingen zijn van invloed op alle nieuwe rekenknooppunten die lid zijn van de pool, maar hebben geen invloed op rekenknooppunten die al in de pool staan totdat ze opnieuw worden opgestart of opnieuw worden gemaakt. Er zijn maximaal 10 toepassingspakketverwijzingen voor een bepaalde groep. Als u dit weglaat of als u een lege verzameling opgeeft, worden bestaande verwijzingen naar toepassingspakketten uit de groep verwijderd. Er kunnen maximaal 10 verwijzingen worden opgegeven voor een bepaalde groep.
certificateReferences	True	CertificateReference[]	Een lijst met certificaten die op elk rekenknooppunt in de pool moeten worden geïnstalleerd. Deze lijst vervangt alle bestaande certificaatverwijzingen die zijn geconfigureerd voor de groep. Als u een lege verzameling opgeeft, worden alle bestaande certificaatverwijzingen uit de groep verwijderd. 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.
metadata	True	MetadataItem[]	Een lijst met naam-waardeparen die zijn gekoppeld aan de pool als metagegevens. Deze lijst vervangt alle bestaande metagegevens die zijn geconfigureerd voor de pool. Als u dit weglaat of als u een lege verzameling opgeeft, worden bestaande metagegevens uit de pool verwijderd.
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. Als dit element aanwezig is, overschrijft het alle bestaande StartTask. Als u dit weglaat, wordt een bestaande StartTask verwijderd uit de pool.
targetNodeCommunicationMode		NodeCommunicationMode	De gewenste communicatiemodus voor knooppunten voor de pool. Deze instelling vervangt elke bestaande targetNodeCommunication-instelling in de pool. Als u dit weglaat, is de bestaande instelling standaard.

Antwoorden

Name	Type	Description
204 No Content		De aanvraag voor de Batch-service is geslaagd. Kopteksten client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: 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

Pool update

Voorbeeldaanvraag

HTTP

POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2024-07-01.20.0



{
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'"
  },
  "certificateReferences": [],
  "applicationPackageReferences": [],
  "metadata": []
}

Voorbeeldrespons

Statuscode:

204

Definities

Name	Description
ApplicationPackageReference	Een verwijzing naar een pakket dat moet worden geïmplementeerd op rekenknooppunten.
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.
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.
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.
ComputeNodeIdentityReference	De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
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.
ContainerWorkingDirectory	De locatie van de werkmap containertaak.
ElevationLevel	Het hoogteniveau van de gebruiker.
EnvironmentSetting	Een omgevingsvariabele die moet worden ingesteld voor een taakproces.
ErrorMessage	Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
MetadataItem	Een naam-waardepaar dat is gekoppeld aan een Batch-serviceresource.
NodeCommunicationMode	Bepaalt hoe een pool communiceert met de Batch-service.
PoolUpdatePropertiesParameter	De set wijzigingen die moeten worden aangebracht in een pool.
ResourceFile	Eén bestand of meerdere bestanden die moeten worden gedownload naar een rekenknooppunt.
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.
TaskContainerSettings	De containerinstellingen voor een taak.
UserIdentity	De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd.

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.

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.

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.

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.

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.

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.

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.

ElevationLevel

Het hoogteniveau van de gebruiker.

Name	Type	Description
admin	string	De gebruiker is een gebruiker met verhoogde toegang en werkt met volledige beheerdersmachtigingen.
nonadmin	string	De gebruiker is een standaardgebruiker zonder verhoogde toegang.

EnvironmentSetting

Een omgevingsvariabele die moet worden ingesteld voor een taakproces.

Name	Type	Description
name	string	De naam van de omgevingsvariabele.
value	string	De waarde van de omgevingsvariabele.

ErrorMessage

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

Name	Type	Description
lang	string	De taalcode van het foutbericht
value	string	De tekst van het bericht.

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.

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.

PoolUpdatePropertiesParameter

De set wijzigingen die moeten worden aangebracht in een pool.

Name	Type	Description
applicationPackageReferences	ApplicationPackageReference[]	De lijst met toepassingspakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. De lijst vervangt alle bestaande verwijzingen naar toepassingspakketten in de groep. Wijzigingen in toepassingspakketverwijzingen zijn van invloed op alle nieuwe rekenknooppunten die lid zijn van de pool, maar hebben geen invloed op rekenknooppunten die al in de pool staan totdat ze opnieuw worden opgestart of opnieuw worden gemaakt. Er zijn maximaal 10 toepassingspakketverwijzingen voor een bepaalde groep. Als u dit weglaat of als u een lege verzameling opgeeft, worden bestaande verwijzingen naar toepassingspakketten uit de groep verwijderd. Er kunnen maximaal 10 verwijzingen worden opgegeven voor een bepaalde groep.
certificateReferences	CertificateReference[]	Een lijst met certificaten die op elk rekenknooppunt in de pool moeten worden geïnstalleerd. Deze lijst vervangt alle bestaande certificaatverwijzingen die zijn geconfigureerd voor de groep. Als u een lege verzameling opgeeft, worden alle bestaande certificaatverwijzingen uit de groep verwijderd. 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.
metadata	MetadataItem[]	Een lijst met naam-waardeparen die zijn gekoppeld aan de pool als metagegevens. Deze lijst vervangt alle bestaande metagegevens die zijn geconfigureerd voor de pool. Als u dit weglaat of als u een lege verzameling opgeeft, worden bestaande metagegevens uit de pool verwijderd.
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. Als dit element aanwezig is, overschrijft het alle bestaande StartTask. Als u dit weglaat, wordt een bestaande StartTask verwijderd uit de pool.
targetNodeCommunicationMode	NodeCommunicationMode	De gewenste communicatiemodus voor knooppunten voor de pool. Deze instelling vervangt elke bestaande targetNodeCommunication-instelling in de pool. Als u dit weglaat, is de bestaande instelling standaard.

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.

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://learn.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.

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.

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.