Pool - Patch

Service:

Batch Service

API Version:

2023-11-01.18.0

Updates de eigenschappen van de opgegeven pool.
Dit vervangt alleen de pooleigenschappen die zijn opgegeven in de aanvraag. Als er bijvoorbeeld aan de pool een StartTask is gekoppeld en een aanvraag geen StartTask-element opgeeft, behoudt de pool de bestaande StartTask.

PATCH {batchUrl}/pools/{poolId}?api-version=2023-11-01.18.0

With optional parameters:

PATCH {batchUrl}/pools/{poolId}?timeout={timeout}&api-version=2023-11-01.18.0

URI-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch serviceaanvragen.
poolId	path	True	string	De id van de pool die moet worden 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.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string uuid	De aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Of de server de client-request-id in het antwoord moet retourneren.
ocp-date		string date-time-rfc1123	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige systeemkloktijd; stel dit expliciet in als u de REST API rechtstreeks aanroept.
If-Match		string	Een ETag-waarde die is gekoppeld aan de versie van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de huidige ETag van de resource op de service exact overeenkomt met de waarde die is opgegeven door de client.
If-None-Match		string	Een ETag-waarde die is gekoppeld aan de versie van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de huidige ETag van de resource op de service niet overeenkomt met de waarde die is opgegeven door de client.
If-Modified-Since		string date-time-rfc1123	Een tijdstempel die de laatste wijzigingstijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource op de service sinds de opgegeven tijd is gewijzigd.
If-Unmodified-Since		string date-time-rfc1123	Een tijdstempel die de laatste wijzigingstijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource op de service sinds de opgegeven tijd niet is gewijzigd.

Aanvraagbody

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

Name	Type	Description
applicationPackageReferences	ApplicationPackageReference[]	Een lijst met pakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. Wijzigingen in pakketverwijzingen zijn van invloed op alle nieuwe knooppunten die lid worden van de pool, maar hebben geen invloed op rekenknooppunten die zich al in de pool bevinden totdat ze opnieuw worden opgestart of opnieuw zijn geïnstalleerd. Als dit element aanwezig is, worden alle bestaande pakketverwijzingen vervangen. Als u een lege verzameling opgeeft, worden alle pakketverwijzingen verwijderd uit de pool. Als u dit weglaat, blijven alle bestaande pakketverwijzingen ongewijzigd.
certificateReferences	CertificateReference[]	Een lijst met certificaten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. Als dit element aanwezig is, vervangt het eventuele bestaande certificaatverwijzingen die zijn geconfigureerd in de pool. Als u dit weglaat, blijven alle bestaande certificaatverwijzingen ongewijzigd. Voor Windows-knooppunten installeert de Batch-service de certificaten in het opgegeven certificaatarchief en de opgegeven locatie. Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap Taak en een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR wordt geleverd aan de taak om een query uit te voeren op deze locatie. Voor certificaten met zichtbaarheid van 'remoteUser' wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst. Waarschuwing: deze eigenschap is afgeschaft en wordt na februari 2024 verwijderd. Gebruik in plaats daarvan de Azure KeyVault-extensie .
metadata	MetadataItem[]	Een lijst met naam-waardeparen die als metagegevens zijn gekoppeld aan de pool. Als dit element aanwezig is, worden alle bestaande metagegevens die in de pool zijn geconfigureerd, vervangen. Als u een lege verzameling opgeeft, worden alle metagegevens uit de pool verwijderd. Als u dit weglaat, blijven alle bestaande metagegevens ongewijzigd.
startTask	StartTask	Een taak die moet worden uitgevoerd op elk rekenknooppunt wanneer het lid wordt van de pool. De taak wordt uitgevoerd wanneer het rekenknooppunt wordt toegevoegd aan de pool of wanneer het rekenknooppunt opnieuw wordt gestart. Als dit element aanwezig is, worden alle bestaande StartTask overschreven. Als u dit weglaat, blijft elke bestaande StartTask ongewijzigd.
targetNodeCommunicationMode	NodeCommunicationMode	De gewenste knooppuntcommunicatiemodus voor de pool. Als dit element aanwezig is, vervangt het de bestaande targetNodeCommunicationMode die is geconfigureerd in de pool. Als u dit weglaat, blijven alle bestaande metagegevens ongewijzigd.

Antwoorden

Name	Type	Description
200 OK		De aanvraag voor de Batch-service is geslaagd. Headers 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
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

Patch the Pool

Sample Request

HTTP

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



{
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'"
  }
}

Sample Response

Status code:

200

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 voor de automatische gebruiker die een taak uitvoert op de Batch-service.
BatchError	Een foutbericht dat is ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
CertificateReference	Een verwijzing naar een certificaat dat moet worden geïnstalleerd op rekenknooppunten in een pool.
CertificateStoreLocation	De locatie van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd.
CertificateVisibility	Welke gebruikersaccounts op het rekenknooppunt moeten toegang hebben tot de persoonlijke gegevens van het certificaat.
ComputeNodeIdentityReference	De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
ContainerRegistry	Een privécontainerregister.
ContainerWorkingDirectory	De locatie van de werkmap van de containertaak.
ElevationLevel	Het hoogteniveau van de gebruiker.
EnvironmentSetting	Een omgevingsvariabele die moet worden ingesteld voor een taakproces.
ErrorMessage	Een foutbericht ontvangen in een Azure Batch antwoord.
MetadataItem	Een naam-waardepaar dat is gekoppeld aan een Batch-serviceresource.
NodeCommunicationMode	Bepaalt hoe een pool communiceert met de Batch-service.
PoolPatchParameter	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 een nieuwe installatiekopie wordt gemaakt.
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. Wanneer u een groep maakt, moet de toepassings-id van het pakket volledig zijn gekwalificeerd (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	De versie van de toepassing die moet worden geïmplementeerd. Als u dit weglaat, wordt de standaardversie geïmplementeerd. Als dit wordt weggelaten in een pool en er geen standaardversie is opgegeven voor deze toepassing, mislukt de aanvraag met de foutcode InvalidApplicationPackageReferences en HTTP-statuscode 409. Als dit wordt weggelaten voor een taak en er geen standaardversie is opgegeven voor deze toepassing, mislukt de taak met een voorverwerkingsfout.

AutoUserScope

Het bereik voor de automatische gebruiker

Name	Type	Description
pool	string	Hiermee geeft u op dat de taak wordt uitgevoerd als het algemene automatische gebruikersaccount dat wordt gemaakt op elk rekenknooppunt in een pool.
task	string	Hiermee geeft u op dat de service een nieuwe gebruiker voor de taak moet maken.

AutoUserSpecification

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

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

BatchError

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

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	ErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	Een verzameling sleutel-waardeparen met aanvullende details over de fout.

BatchErrorDetail

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

Name	Type	Description
key	string	Een id die de betekenis van de eigenschap Value aangeeft.
value	string	De aanvullende informatie die is opgenomen in de foutreactie.

CertificateReference

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

Name	Type	Description
storeLocation	CertificateStoreLocation	De locatie van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd. De standaardwaarde is currentuser. Deze eigenschap is alleen van toepassing op pools die zijn geconfigureerd met Windows-rekenknooppunten (dat wil gezegd, gemaakt met cloudServiceConfiguration of met virtualMachineConfiguration met behulp van een Referentie voor Windows-installatiekopieën). Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap Taak en een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR wordt geleverd aan de taak om een query uit te voeren op deze locatie. Voor certificaten met zichtbaarheid van 'remoteUser' wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst.
storeName	string	De naam van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd. Deze eigenschap is alleen van toepassing op pools die zijn geconfigureerd met Windows-rekenknooppunten (dat wil gezegd, gemaakt met cloudServiceConfiguration of met virtualMachineConfiguration met behulp van een Referentie voor Windows-installatiekopieën). Algemene winkelnamen zijn: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, maar elke aangepaste winkelnaam kan ook worden gebruikt. De standaardwaarde is Mijn.
thumbprint	string	De vingerafdruk van het certificaat.
thumbprintAlgorithm	string	Het algoritme waaraan de vingerafdruk is gekoppeld. Dit moet sha1 zijn.
visibility	CertificateVisibility[]	Welke gebruikersaccounts op het rekenknooppunt moeten toegang hebben tot de persoonlijke gegevens van het certificaat. U kunt meer dan één zichtbaarheid in deze verzameling opgeven. De standaardwaarde is alle accounts.

CertificateStoreLocation

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

Name	Type	Description
currentuser	string	Certificaten moeten worden geïnstalleerd in het certificaatarchief CurrentUser.
localmachine	string	Certificaten moeten worden geïnstalleerd in het LocalMachine-certificaatarchief.

CertificateVisibility

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

Name	Type	Description
remoteuser	string	Het certificaat moet zichtbaar zijn voor de gebruikersaccounts waaronder gebruikers extern toegang hebben tot het rekenknooppunt.
starttask	string	Het certificaat moet zichtbaar zijn voor het gebruikersaccount waaronder de StartTask wordt uitgevoerd. Houd er rekening mee dat als AutoUser-bereik pool is voor zowel de StartTask als een taak, dit certificaat ook zichtbaar is voor de taak.
task	string	Het certificaat moet zichtbaar zijn voor de gebruikersaccounts waaronder taaktaken worden uitgevoerd.

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.

ContainerRegistry

Een privécontainerregister.

Name	Type	Description
identityReference	ComputeNodeIdentityReference	De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot een Azure Container Registry in plaats van gebruikersnaam en wachtwoord. De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
password	string	Het wachtwoord om u aan te melden bij de registerserver.
registryServer	string	De register-URL. Als u dit weglaat, is de standaardwaarde 'docker.io'.
username	string	De gebruikersnaam om u aan te melden bij de registerserver.

ContainerWorkingDirectory

De locatie van de werkmap van de containertaak.

Name	Type	Description
containerImageDefault	string	Gebruik de werkmap die is gedefinieerd in de containerinstallatiekopieën. Deze map bevat niet de bronbestanden die door Batch zijn gedownload.
taskWorkingDirectory	string	Gebruik de standaardwerkmap taak van de Batch-service, die de taakbronbestanden bevat die door Batch worden gevuld.

ElevationLevel

Het hoogteniveau van de gebruiker.

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

EnvironmentSetting

Een omgevingsvariabele die moet worden ingesteld voor een taakproces.

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

ErrorMessage

Een foutbericht ontvangen in een Azure Batch antwoord.

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

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	Voor knooppunten die de klassieke communicatiemodus gebruiken, is binnenkomende TCP-communicatie vereist op poorten 29876 en 29877 van batchnodemanagement. Servicetag {region} en uitgaande TCP-communicatie op poort 443 naar storage.region en BatchNodeManagement. {region}'-servicetags.
default	string	De communicatiemodus voor het knooppunt wordt automatisch ingesteld door de Batch-service.
simplified	string	Knooppunten die de vereenvoudigde communicatiemodus gebruiken, vereisen uitgaande TCP-communicatie op poort 443 naar batchnodemanagement. Servicetag {region}. Er zijn geen open binnenkomende poorten vereist.

PoolPatchParameter

De set wijzigingen die moeten worden aangebracht in een pool.

Name	Type	Description
applicationPackageReferences	ApplicationPackageReference[]	Een lijst met pakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. Wijzigingen in pakketverwijzingen zijn van invloed op alle nieuwe knooppunten die lid worden van de pool, maar hebben geen invloed op rekenknooppunten die zich al in de pool bevinden totdat ze opnieuw worden opgestart of opnieuw zijn geïnstalleerd. Als dit element aanwezig is, worden alle bestaande pakketverwijzingen vervangen. Als u een lege verzameling opgeeft, worden alle pakketverwijzingen verwijderd uit de pool. Als u dit weglaat, blijven alle bestaande pakketverwijzingen ongewijzigd.
certificateReferences	CertificateReference[]	Een lijst met certificaten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. Als dit element aanwezig is, vervangt het eventuele bestaande certificaatverwijzingen die zijn geconfigureerd in de pool. Als u dit weglaat, blijven alle bestaande certificaatverwijzingen ongewijzigd. Voor Windows-knooppunten installeert de Batch-service de certificaten in het opgegeven certificaatarchief en de opgegeven locatie. Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap Taak en een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR wordt geleverd aan de taak om een query uit te voeren op deze locatie. Voor certificaten met zichtbaarheid van 'remoteUser' wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst. Waarschuwing: deze eigenschap is afgeschaft en wordt na februari 2024 verwijderd. Gebruik in plaats daarvan de Azure KeyVault-extensie .
metadata	MetadataItem[]	Een lijst met naam-waardeparen die als metagegevens zijn gekoppeld aan de pool. Als dit element aanwezig is, worden alle bestaande metagegevens die in de pool zijn geconfigureerd, vervangen. Als u een lege verzameling opgeeft, worden alle metagegevens uit de pool verwijderd. Als u dit weglaat, blijven alle bestaande metagegevens ongewijzigd.
startTask	StartTask	Een taak die moet worden uitgevoerd op elk rekenknooppunt wanneer het lid wordt van de pool. De taak wordt uitgevoerd wanneer het rekenknooppunt wordt toegevoegd aan de pool of wanneer het rekenknooppunt opnieuw wordt gestart. Als dit element aanwezig is, worden alle bestaande StartTask overschreven. Als u dit weglaat, blijft elke bestaande StartTask ongewijzigd.
targetNodeCommunicationMode	NodeCommunicationMode	De gewenste knooppuntcommunicatiemodus voor de pool. Als dit element aanwezig is, vervangt het de bestaande targetNodeCommunicationMode die is geconfigureerd in de pool. Als u dit weglaat, blijven alle bestaande metagegevens ongewijzigd.

ResourceFile

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

Name	Type	Description
autoStorageContainerName	string	De naam van de opslagcontainer in het automatische opslagaccount. De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar uit en een van deze eigenschappen moet worden opgegeven.
blobPrefix	string	Het blobvoorvoegsel dat moet worden gebruikt bij het downloaden van blobs uit een Azure Storage-container. Alleen de blobs waarvan de naam begint met het opgegeven voorvoegsel, worden gedownload. De eigenschap is alleen geldig wanneer autoStorageContainerName of storageContainerUrl wordt gebruikt. Dit voorvoegsel kan een gedeeltelijke bestandsnaam of een submap zijn. Als er geen voorvoegsel is opgegeven, worden alle bestanden in de container gedownload.
fileMode	string	Het kenmerk bestandsmachtigingsmodus in octale indeling. Deze eigenschap is alleen van toepassing op bestanden die worden gedownload naar Linux-rekenknooppunten. Deze wordt genegeerd als deze is opgegeven voor een resourceFile die wordt gedownload naar een Windows-rekenknooppunt. Als deze eigenschap niet is opgegeven voor een Linux-rekenknooppunt, wordt de standaardwaarde 0770 toegepast op het bestand.
filePath	string	De locatie op het rekenknooppunt waarnaar het bestand(en) moet worden gedownload, ten opzichte van de werkmap van de taak. Als de eigenschap httpUrl is opgegeven, is filePath vereist en wordt het pad beschreven waarnaar het bestand wordt gedownload, inclusief de bestandsnaam. Als de eigenschap autoStorageContainerName of storageContainerUrl is opgegeven, is filePath optioneel en de map waar de bestanden naar moeten worden gedownload. In het geval dat filePath wordt gebruikt als een map, wordt elke mapstructuur die al aan de invoergegevens is gekoppeld, volledig bewaard en toegevoegd aan de opgegeven filePath-map. Het opgegeven relatieve pad kan niet worden doorbroken uit de werkmap van de taak (bijvoorbeeld met behulp van '..').
httpUrl	string	De URL van het bestand dat u wilt downloaden. De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar uit en een van deze eigenschappen moet worden opgegeven. Als de URL naar Azure Blob Storage verwijst, moet deze leesbaar zijn vanuit rekenknooppunten. Er zijn drie manieren om een dergelijke URL voor een blob in Azure Storage op te halen: voeg een Shared Access Signature (SAS) toe die leesmachtigingen verleent voor de blob, gebruik een beheerde identiteit met leesmachtiging of stel de ACL in voor de blob of de bijbehorende container om openbare toegang toe te staan.
identityReference	ComputeNodeIdentityReference	De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage opgegeven door storageContainerUrl of httpUrl De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
storageContainerUrl	string	De URL van de blobcontainer in Azure Blob Storage. De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar uit en een van deze eigenschappen moet worden opgegeven. Deze URL moet kunnen worden gelezen en vermeld vanuit rekenknooppunten. Er zijn drie manieren om een dergelijke URL voor een container in Azure Storage op te halen: voeg een Sas (Shared Access Signature) toe die lees- en lijstmachtigingen verleent voor de container, gebruik een beheerde identiteit met lees- en lijstmachtigingen, of stel de ACL voor de container in om openbare toegang toe te staan.

StartTask

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

Name	Type	Description
commandLine	string	De opdrachtregel van de StartTask. De opdrachtregel wordt niet uitgevoerd onder een shell en kan daarom niet profiteren van shellfuncties zoals omgevingsvariabeleuitbreiding. Als u van dergelijke functies wilt profiteren, moet u de shell in de opdrachtregel aanroepen, bijvoorbeeld met behulp van 'cmd /c Mijnopdracht' in Windows of '/bin/sh -c MyCommand' in Linux. Als de opdrachtregel naar bestandspaden verwijst, moet deze een relatief pad gebruiken (ten opzichte van de taakwerkmap) of de door Batch opgegeven omgevingsvariabele (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) gebruiken.
containerSettings	TaskContainerSettings	De instellingen voor de container waaronder de StartTask wordt uitgevoerd. Wanneer dit is opgegeven, worden alle mappen recursief onder de AZ_BATCH_NODE_ROOT_DIR (de hoofdmap van Azure Batch mappen op het knooppunt) toegewezen aan de container, worden alle taakomgevingsvariabelen toegewezen aan de container en wordt de taakopdrachtregel uitgevoerd in de container. Bestanden die buiten AZ_BATCH_NODE_ROOT_DIR in de container worden geproduceerd, worden mogelijk niet weergegeven op de hostschijf, wat betekent dat Batch-bestands-API's geen toegang hebben tot deze bestanden.
environmentSettings	EnvironmentSetting[]	Een lijst met omgevingsvariabele-instellingen voor de StartTask.
maxTaskRetryCount	integer	Het maximum aantal keren dat de taak opnieuw kan worden uitgevoerd. De Batch-service probeert een taak opnieuw uit te voeren als de afsluitcode een andere is dan nul. Houd er rekening mee dat deze waarde specifiek het aantal nieuwe pogingen bepaalt. De Batch-service probeert de taak eenmaal en kan vervolgens opnieuw proberen tot deze limiet. Als het maximumaantal nieuwe pogingen bijvoorbeeld 3 is, probeert Batch de taak maximaal 4 keer (één initiële poging en 3 nieuwe pogingen). Als het maximumaantal nieuwe pogingen 0 is, voert de Batch-service de taak niet opnieuw uit. Als het maximumaantal nieuwe pogingen -1 is, probeert de Batch-service de taak opnieuw zonder limiet, maar dit wordt niet aanbevolen voor een starttaak of een taak. De standaardwaarde is 0 (geen nieuwe pogingen).
resourceFiles	ResourceFile[]	Een lijst met bestanden die de Batch-service naar het rekenknooppunt downloadt voordat de opdrachtregel wordt uitgevoerd. Er is een maximale grootte voor de lijst met resourcebestanden. Wanneer de maximale grootte wordt overschreden, mislukt de aanvraag en is de antwoordfoutcode RequestEntityTooLarge. Als dit gebeurt, moet de verzameling ResourceFiles worden verkleind. Dit kan worden bereikt met behulp van .zip-bestanden, toepassingspakketten of Docker-containers. Bestanden die onder dit element worden vermeld, bevinden zich in de werkmap van de taak.
userIdentity	UserIdentity	De gebruikersidentiteit waaronder de StartTask wordt uitgevoerd. Als u dit weglaat, wordt de taak uitgevoerd als een gebruiker zonder beheerdersrechten die uniek is voor de taak.
waitForSuccess	boolean	Of de Batch-service moet wachten tot de StartTask is voltooid (dat wil gezegd, afsluiten met afsluitcode 0) voordat taken op het rekenknooppunt worden gepland. Als waar en de StartTask mislukt op een knooppunt, probeert de Batch-service de StartTask opnieuw tot het maximale aantal nieuwe pogingen (maxTaskRetryCount). Als de taak na alle nieuwe pogingen nog steeds niet is voltooid, markeert de Batch-service het knooppunt als onbruikbaar en worden er geen taken op gepland. Deze voorwaarde kan worden gedetecteerd via de details van de status van het rekenknooppunt en de foutgegevens. Als dit onwaar is, wacht de Batch-service niet totdat de StartTask is voltooid. In dit geval kunnen andere taken worden uitgevoerd op het rekenknooppunt terwijl de StartTask nog steeds wordt uitgevoerd; en zelfs als de StartTask mislukt, worden er nog steeds nieuwe taken gepland op het rekenknooppunt. De standaardwaarde is true.

TaskContainerSettings

De containerinstellingen voor een taak.

Name	Type	Description
containerRunOptions	string	Aanvullende opties voor de opdracht container maken. Deze extra opties worden geleverd als argumenten voor de opdracht 'docker maken', naast de opties die worden beheerd door de Batch-service.
imageName	string	De installatiekopieën die moeten worden gebruikt om de container te maken waarin de taak wordt uitgevoerd. Dit is de volledige verwijzing naar de installatiekopie, zoals wordt opgegeven bij 'docker pull'. Als er geen tag wordt opgegeven als onderdeel van de naam van de installatiekopieën, wordt de tag ':latest' standaard gebruikt.
registry	ContainerRegistry	Het privéregister dat de containerinstallatiekopieën bevat. Deze instelling kan worden weggelaten als deze al is opgegeven bij het maken van de pool.
workingDirectory	ContainerWorkingDirectory	De locatie van de werkmap van de containertaak. De standaardwaarde is 'taskWorkingDirectory'.

UserIdentity

De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd.

Name	Type	Description
autoUser	AutoUserSpecification	De automatische gebruiker waaronder de taak wordt uitgevoerd. De eigenschappen userName en autoUser sluiten elkaar uit. u moet één, maar niet beide opgeven.
username	string	De naam van de gebruikersidentiteit waaronder de taak wordt uitgevoerd. De eigenschappen userName en autoUser sluiten elkaar uit. u moet één, maar niet beide opgeven.