Delen via


Compute Node - Get

Hiermee wordt informatie opgehaald over het opgegeven rekenknooppunt.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?api-version=2024-07-01.20.0
GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?$select={$select}&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.

nodeId
path True

string

De id van het rekenknooppunt waarover u informatie wilt ophalen.

poolId
path True

string

De id van de pool die het rekenknooppunt bevat.

api-version
query True

string

Client-API-versie.

$select
query

string

Een OData-$select-component.

timeout
query

integer

int32

De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. 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

ComputeNode

Een antwoord met het rekenknooppunt.

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

Node get

Voorbeeldaanvraag

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z?api-version=2024-07-01.20.0


Voorbeeldrespons

{
  "id": "tvm-1695681911_2-20161122t193202z",
  "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z",
  "state": "idle",
  "schedulingState": "enabled",
  "stateTransitionTime": "2016-11-22T19:37:31.4285526Z",
  "lastBootTime": "2016-11-22T19:37:28.623369Z",
  "allocationTime": "2016-11-22T19:32:02.8155319Z",
  "ipAddress": "1.1.1.1",
  "affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
  "vmSize": "small",
  "totalTasksRun": 0,
  "totalTasksSucceeded": 0,
  "runningTasksCount": 0,
  "isDedicated": true,
  "startTask": {
    "commandLine": "cmd /c echo hello",
    "userIdentity": {
      "autoUser": {
        "scope": "task",
        "elevationLevel": "nonadmin"
      }
    },
    "maxTaskRetryCount": 0,
    "waitForSuccess": false
  },
  "startTaskInfo": {
    "state": "completed",
    "startTime": "2016-11-22T19:37:31.4285526Z",
    "endTime": "2016-11-22T19:37:31.838028Z",
    "exitCode": 0,
    "retryCount": 0
  },
  "nodeAgentInfo": {
    "version": "1.2.0.0",
    "lastUpdateTime": "2016-11-22T19:37:28.623369Z"
  }
}

Definities

Name Description
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.

ComputeNode

Een rekenknooppunt in de Batch-service.

ComputeNodeEndpointConfiguration

De eindpuntconfiguratie voor het rekenknooppunt.

ComputeNodeError

Er is een fout opgetreden door een rekenknooppunt.

ComputeNodeIdentityReference

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

ComputeNodeState

De huidige status van het rekenknooppunt.

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.

ErrorCategory

De categorie van de fout.

ErrorMessage

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

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.

InboundEndpoint

Een binnenkomend eindpunt op een rekenknooppunt.

InboundEndpointProtocol

Het protocol van het eindpunt.

NameValuePair

Vertegenwoordigt een naam-waardepaar.

NodeAgentInformation

Informatie over de rekenknooppuntagent.

ResourceFile

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

SchedulingState

Of het rekenknooppunt beschikbaar is voor taakplanning.

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.

StartTaskInformation

Informatie over een StartTask die wordt uitgevoerd op een rekenknooppunt.

StartTaskState

De status van de StartTask op het rekenknooppunt.

TaskContainerExecutionInformation

Bevat informatie over de container die een taak uitvoert.

TaskContainerSettings

De containerinstellingen voor een taak.

TaskExecutionInformation

Informatie over de uitvoering van een taak.

TaskExecutionResult

Het resultaat van taakuitvoering.

TaskFailureInformation

Informatie over een taakfout.

TaskInformation

Informatie over een taak die wordt uitgevoerd op een rekenknooppunt.

TaskState

De status van de taak.

UserIdentity

De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd.

VirtualMachineInfo

Informatie over de huidige status van de virtuele machine.

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.

ComputeNode

Een rekenknooppunt in de Batch-service.

Name Type Description
affinityId

string

Een id die kan worden doorgegeven bij het toevoegen van een taak om aan te vragen of de taak op dit rekenknooppunt moet worden gepland.
Houd er rekening mee dat dit slechts een zachte affiniteit is. Als het doel-rekenknooppunt bezet is of niet beschikbaar is op het moment dat de taak is gepland, wordt de taak elders gepland.

allocationTime

string

Het tijdstip waarop dit rekenknooppunt is toegewezen aan de pool.
Dit is het moment waarop het rekenknooppunt in eerste instantie is toegewezen en niet eenmaal wordt gewijzigd. Het wordt niet bijgewerkt wanneer de rekenknooppuntservice is hersteld of wordt verschoven.

certificateReferences

CertificateReference[]

De lijst met certificaten die zijn geïnstalleerd op het rekenknooppunt.
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.

endpointConfiguration

ComputeNodeEndpointConfiguration

De eindpuntconfiguratie voor het rekenknooppunt.

errors

ComputeNodeError[]

De lijst met fouten die momenteel worden aangetroffen door het rekenknooppunt.

id

string

De id van het rekenknooppunt.
Aan elk rekenknooppunt dat aan een pool wordt toegevoegd, wordt een unieke id toegewezen. Wanneer een rekenknooppunt uit een pool wordt verwijderd, worden alle lokale bestanden ervan verwijderd en wordt de id vrijgemaakt en kan deze opnieuw worden gebruikt voor nieuwe rekenknooppunten.

ipAddress

string

Het IP-adres dat andere knooppunten kunnen gebruiken om te communiceren met dit rekenknooppunt.
Aan elk rekenknooppunt dat aan een pool wordt toegevoegd, wordt een uniek IP-adres toegewezen. Wanneer een rekenknooppunt uit een pool wordt verwijderd, worden alle lokale bestanden verwijderd en wordt het IP-adres vrijgemaakt en kan het opnieuw worden gebruikt voor nieuwe rekenknooppunten.

isDedicated

boolean

Of dit rekenknooppunt een toegewezen rekenknooppunt is. Als dit onwaar is, is het rekenknooppunt een rekenknooppunt met een spot-/lage prioriteit.

lastBootTime

string

De laatste keer dat het rekenknooppunt is gestart.
Deze eigenschap is mogelijk niet aanwezig als de status van het rekenknooppunt onbruikbaar is.

nodeAgentInfo

NodeAgentInformation

Informatie over de versie van de Compute Node-agent en de tijd waarop het rekenknooppunt is bijgewerkt naar een nieuwe versie.
De Batch Compute Node-agent is een programma dat wordt uitgevoerd op elk rekenknooppunt in de pool en biedt Batch-mogelijkheden op het rekenknooppunt.

recentTasks

TaskInformation[]

Een lijst met taken waarvan de status onlangs is gewijzigd.
Deze eigenschap is alleen aanwezig als ten minste één taak op dit rekenknooppunt is uitgevoerd sinds deze is toegewezen aan de pool.

runningTaskSlotsCount

integer

Het totale aantal planningssites dat momenteel wordt gebruikt door taaktaken uit te voeren op het rekenknooppunt. Dit omvat Job Manager-taken en normale taken, maar niet jobvoorbereiding, jobrelease of begintaken.

runningTasksCount

integer

Het totale aantal taaktaken dat momenteel wordt uitgevoerd op het rekenknooppunt. Dit omvat Job Manager-taken en normale taken, maar niet jobvoorbereiding, jobrelease of begintaken.

schedulingState

SchedulingState

Of het rekenknooppunt beschikbaar is voor taakplanning.

startTask

StartTask

De taak die moet worden uitgevoerd op het rekenknooppunt terwijl deze lid wordt van de pool.
Batch voert taken opnieuw uit wanneer een herstelbewerking wordt geactiveerd op een knooppunt. Voorbeelden van herstelbewerkingen zijn (maar zijn niet beperkt tot) wanneer een beschadigd knooppunt opnieuw wordt opgestart of een rekenknooppunt is verdwenen vanwege een hostfout. Nieuwe pogingen vanwege herstelbewerkingen zijn onafhankelijk van en worden niet meegeteld voor 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.

startTaskInfo

StartTaskInformation

Runtime-informatie over de uitvoering van de StartTask op het rekenknooppunt.

state

ComputeNodeState

De huidige status van het rekenknooppunt.
Het rekenknooppunt met spot-/lage prioriteit is afgewend. Taken die werden uitgevoerd op het rekenknooppunt toen het werd uitgesteld, worden opnieuw gepland wanneer er een ander rekenknooppunt beschikbaar komt.

stateTransitionTime

string

Het tijdstip waarop het rekenknooppunt de huidige status heeft ingevoerd.

totalTasksRun

integer

Het totale aantal taaktaken dat is voltooid op het rekenknooppunt. Dit omvat Job Manager-taken en normale taken, maar niet jobvoorbereiding, jobrelease of begintaken.

totalTasksSucceeded

integer

Het totale aantal taaktaken dat is voltooid (met exitCode 0) op het rekenknooppunt. Dit omvat Job Manager-taken en normale taken, maar niet jobvoorbereiding, jobrelease of begintaken.

url

string

De URL van het rekenknooppunt.

virtualMachineInfo

VirtualMachineInfo

Informatie over de huidige status van de virtuele machine.

vmSize

string

De grootte van de virtuele machine die als host fungeert voor het rekenknooppunt.
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.

ComputeNodeEndpointConfiguration

De eindpuntconfiguratie voor het rekenknooppunt.

Name Type Description
inboundEndpoints

InboundEndpoint[]

De lijst met binnenkomende eindpunten die toegankelijk zijn op het rekenknooppunt.

ComputeNodeError

Er is een fout opgetreden door een rekenknooppunt.

Name Type Description
code

string

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

errorDetails

NameValuePair[]

De lijst met aanvullende foutdetails met betrekking tot de rekenknooppuntfout.

message

string

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

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.

ComputeNodeState

De huidige status van het rekenknooppunt.

Name Type Description
creating

string

De Batch-service heeft de onderliggende virtuele machine verkregen van Azure Compute, maar is nog niet begonnen met het toevoegen van de pool.

deallocated

string

De toewijzing van het rekenknooppunt is ongedaan gemaakt.

deallocating

string

Het rekenknooppunt krijgt de toewijzing ongedaan.

idle

string

Er wordt momenteel geen taak uitgevoerd op het rekenknooppunt.

leavingpool

string

Het rekenknooppunt verlaat de pool omdat de gebruiker deze expliciet heeft verwijderd of omdat de pool het formaat wijzigt of automatisch omlaag schaalt.

offline

string

Het rekenknooppunt voert momenteel geen taak uit en het plannen van nieuwe taken naar het rekenknooppunt is uitgeschakeld.

preempted

string

Het rekenknooppunt met spot-/lage prioriteit is afgewend. Taken die werden uitgevoerd op het rekenknooppunt toen het werd uitgesteld, worden opnieuw gepland wanneer er een ander rekenknooppunt beschikbaar komt.

rebooting

string

Het rekenknooppunt wordt opnieuw opgestart.

reimaging

string

Het rekenknooppunt wordt opnieuw ontworpen.

running

string

Het rekenknooppunt voert een of meer taken uit (behalve een StartTask).

starting

string

De Batch-service begint op de onderliggende virtuele machine.

starttaskfailed

string

De StartTask is mislukt op het rekenknooppunt (en alle nieuwe pogingen zijn uitgeput) en waitForSuccess is ingesteld. Het rekenknooppunt is niet bruikbaar voor het uitvoeren van taken.

unknown

string

De Batch-service heeft geen contact meer met het rekenknooppunt en weet de werkelijke status ervan niet.

unusable

string

Het rekenknooppunt kan niet worden gebruikt voor taakuitvoering vanwege fouten.

upgradingos

string

Het rekenknooppunt ondergaat een upgradebewerking voor het besturingssysteem.

waitingforstarttask

string

De StartTask is gestart op het rekenknooppunt, maar waitForSuccess is ingesteld en de StartTask is nog niet voltooid.

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.

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.

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/nodes-and-pools#virtual-network-vnet-and-firewall-configurationvoor informatie over de firewallinstellingen voor de Batch Compute Node-agent om te communiceren met de Batch-service.

InboundEndpoint

Een binnenkomend eindpunt op een rekenknooppunt.

Name Type Description
backendPort

integer

Het back-endpoortnummer van het eindpunt.

frontendPort

integer

Het openbare poortnummer van het eindpunt.

name

string

De naam van het eindpunt.

protocol

InboundEndpointProtocol

Het protocol van het eindpunt.

publicFQDN

string

De openbare volledig gekwalificeerde domeinnaam voor het rekenknooppunt.

publicIPAddress

string

Het openbare IP-adres van het rekenknooppunt.

InboundEndpointProtocol

Het protocol van het eindpunt.

Name Type Description
tcp

string

Gebruik TCP voor het eindpunt.

udp

string

Gebruik UDP voor het eindpunt.

NameValuePair

Vertegenwoordigt een naam-waardepaar.

Name Type Description
name

string

De naam in het naam-waardepaar.

value

string

De waarde in het naam-waardepaar.

NodeAgentInformation

Informatie over de rekenknooppuntagent.

Name Type Description
lastUpdateTime

string

Het tijdstip waarop de rekenknooppuntagent is bijgewerkt op het rekenknooppunt.
Dit is de meest recente keer dat de Compute Node-agent is bijgewerkt naar een nieuwe versie.

version

string

De versie van de Batch Compute Node-agent die wordt uitgevoerd op het rekenknooppunt.
Dit versienummer kan worden gecontroleerd aan de releaseopmerkingen van de Compute Node-agent op https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.

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.

SchedulingState

Of het rekenknooppunt beschikbaar is voor taakplanning.

Name Type Description
disabled

string

Er worden geen nieuwe taken gepland op het rekenknooppunt. Taken die al op het rekenknooppunt worden uitgevoerd, kunnen nog steeds worden uitgevoerd tot voltooiing. Alle rekenknooppunten beginnen met planning ingeschakeld.

enabled

string

Taken kunnen worden gepland op het 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.

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.

StartTaskInformation

Informatie over een StartTask die wordt uitgevoerd op een rekenknooppunt.

Name Type Description
containerInfo

TaskContainerExecutionInformation

Informatie over de container waaronder de taak wordt uitgevoerd.
Deze eigenschap is alleen ingesteld als de taak wordt uitgevoerd in een containercontext.

endTime

string

Het tijdstip waarop de StartTask niet meer actief was.
Dit is de eindtijd van de meest recente uitvoering van de StartTask, als die uitvoering is voltooid (zelfs als die uitvoering is mislukt en een nieuwe poging in behandeling is). Dit element is niet aanwezig als de StartTask momenteel wordt uitgevoerd.

exitCode

integer

De afsluitcode van het programma dat is opgegeven op de Opdrachtregel StartTask.
Deze eigenschap is alleen ingesteld als de StartTask de voltooide status heeft. Over het algemeen weerspiegelt de afsluitcode voor een proces de specifieke conventie die door de toepassingsontwikkelaar voor dat proces is geïmplementeerd. Als u de waarde van de afsluitcode gebruikt om beslissingen te nemen in uw code, moet u ervoor zorgen dat u de afsluitcodeconventie kent die wordt gebruikt door het toepassingsproces. Als de Batch-service echter de StartTask beëindigt (vanwege een time-out of door een gebruiker via de API) ziet u mogelijk een door het besturingssysteem gedefinieerde afsluitcode.

failureInfo

TaskFailureInformation

Informatie over de taakfout, indien van toepassing.
Deze eigenschap is alleen ingesteld als de taak de status Voltooid heeft en er een fout is opgetreden.

lastRetryTime

string

Het meest recente tijdstip waarop een nieuwe poging van de taak is gestart.
Dit element is alleen aanwezig als de taak opnieuw is geprobeerd (bijvoorbeeld retryCount is niet-nul). Indien aanwezig, is dit meestal hetzelfde als startTime, maar kan dit anders zijn als de taak om andere redenen dan opnieuw is opgestart; Als het rekenknooppunt bijvoorbeeld opnieuw is opgestart tijdens een nieuwe poging, wordt de startTime bijgewerkt, maar de lastRetryTime niet.

result

TaskExecutionResult

Het resultaat van de taakuitvoering.
Als de waarde 'mislukt' is, kunt u de details van de fout vinden in de eigenschap failureInfo.

retryCount

integer

Het aantal keren dat de taak opnieuw is geprobeerd door de Batch-service.
Mislukte taaktoepassingen (niet-nul afsluitcode) worden opnieuw geprobeerd, fouten vooraf verwerken (de taak kan niet worden uitgevoerd) en fouten bij het uploaden van bestanden worden niet opnieuw geprobeerd. De Batch-service voert de taak opnieuw uit tot de limiet die is opgegeven door de beperkingen.

startTime

string

Het tijdstip waarop de StartTask werd uitgevoerd.
Deze waarde wordt opnieuw ingesteld telkens wanneer de taak opnieuw wordt gestart of opnieuw wordt geprobeerd (dit is het meest recente tijdstip waarop de StartTask is gestart).

state

StartTaskState

De status van de StartTask op het rekenknooppunt.

StartTaskState

De status van de StartTask op het rekenknooppunt.

Name Type Description
completed

string

De StartTask is afgesloten met afsluitcode 0 of de StartTask is mislukt en de limiet voor opnieuw proberen is bereikt, of het StartTask-proces is niet uitgevoerd vanwege taakvoorbereidingsfouten (zoals fouten bij het downloaden van resourcebestanden).

running

string

De StartTask wordt momenteel uitgevoerd.

TaskContainerExecutionInformation

Bevat informatie over de container die een taak uitvoert.

Name Type Description
containerId

string

De id van de container.

error

string

Gedetailleerde foutinformatie over de container.
Dit is de gedetailleerde fouttekenreeks van de Docker-service, indien beschikbaar. Het is gelijk aan het foutveld dat wordt geretourneerd door 'docker inspect'.

state

string

De status van de container.
Dit is de status van de container volgens de Docker-service. Het is gelijk aan het statusveld dat wordt geretourneerd door 'docker inspect'.

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.

TaskExecutionInformation

Informatie over de uitvoering van een taak.

Name Type Description
containerInfo

TaskContainerExecutionInformation

Informatie over de container waaronder de taak wordt uitgevoerd.
Deze eigenschap is alleen ingesteld als de taak wordt uitgevoerd in een containercontext.

endTime

string

Het tijdstip waarop de taak is voltooid.
Deze eigenschap is alleen ingesteld als de taak de status Voltooid heeft.

exitCode

integer

De afsluitcode van het programma dat is opgegeven op de opdrachtregel Taak.
Deze eigenschap is alleen ingesteld als de taak de status Voltooid heeft. Over het algemeen weerspiegelt de afsluitcode voor een proces de specifieke conventie die door de toepassingsontwikkelaar voor dat proces is geïmplementeerd. Als u de waarde van de afsluitcode gebruikt om beslissingen te nemen in uw code, moet u ervoor zorgen dat u de afsluitcodeconventie kent die wordt gebruikt door het toepassingsproces. Als de Batch-service echter de taak beëindigt (vanwege een time-out of door gebruikersbeëindiging via de API), ziet u mogelijk een door het besturingssysteem gedefinieerde afsluitcode.

failureInfo

TaskFailureInformation

Informatie over de taakfout, indien van toepassing.
Deze eigenschap is alleen ingesteld als de taak de status Voltooid heeft en er een fout is opgetreden.

lastRequeueTime

string

Het meest recente tijdstip waarop de taak door de Batch-service opnieuw in de wachtrij is geplaatst als gevolg van een gebruikersaanvraag.
Deze eigenschap is alleen ingesteld als requeueCount niet-nul is.

lastRetryTime

string

Het meest recente tijdstip waarop een nieuwe poging van de taak is gestart.
Dit element is alleen aanwezig als de taak opnieuw is geprobeerd (bijvoorbeeld retryCount is niet-nul). Indien aanwezig, is dit meestal hetzelfde als startTime, maar kan dit anders zijn als de taak om andere redenen dan opnieuw is opgestart; Als het rekenknooppunt bijvoorbeeld opnieuw is opgestart tijdens een nieuwe poging, wordt de startTime bijgewerkt, maar de lastRetryTime niet.

requeueCount

integer

Het aantal keren dat de taak opnieuw in de wachtrij is geplaatst door de Batch-service als gevolg van een gebruikersaanvraag.
Wanneer de gebruiker rekenknooppunten verwijdert uit een pool (door het formaat van de pool te wijzigen/verkleinen) of wanneer de taak wordt uitgeschakeld, kan de gebruiker opgeven dat taken op de rekenknooppunten opnieuw in de wachtrij worden geplaatst voor uitvoering. Met dit aantal wordt bijgehouden hoe vaak de taak om deze redenen opnieuw in de wachtrij is gezet.

result

TaskExecutionResult

Het resultaat van de taakuitvoering.
Als de waarde 'mislukt' is, kunt u de details van de fout vinden in de eigenschap failureInfo.

retryCount

integer

Het aantal keren dat de taak opnieuw is geprobeerd door de Batch-service.
Mislukte taaktoepassingen (niet-nul afsluitcode) worden opnieuw geprobeerd, fouten vooraf verwerken (de taak kan niet worden uitgevoerd) en fouten bij het uploaden van bestanden worden niet opnieuw geprobeerd. De Batch-service voert de taak opnieuw uit tot de limiet die is opgegeven door de beperkingen.

startTime

string

Het tijdstip waarop de taak wordt uitgevoerd.
'Wordt uitgevoerd' komt overeen met de status Actief, dus als de taak resourcebestanden of pakketten opgeeft, geeft de begintijd het tijdstip aan waarop de taak is begonnen met het downloaden of implementeren van deze. Als de taak opnieuw is gestart of opnieuw is geprobeerd, is dit het meest recente tijdstip waarop de taak is gestart. Deze eigenschap is alleen aanwezig voor taken die de status Actief of Voltooid hebben.

TaskExecutionResult

Het resultaat van taakuitvoering.

Name Type Description
failure

string

Er is een fout opgetreden tijdens de verwerking van de taak. De fout is mogelijk opgetreden voordat het taakproces werd gestart, terwijl het taakproces werd uitgevoerd of nadat het taakproces is afgesloten.

success

string

De taak is uitgevoerd.

TaskFailureInformation

Informatie over een taakfout.

Name Type Description
category

ErrorCategory

De categorie van de taakfout.

code

string

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

details

NameValuePair[]

Een lijst met aanvullende details met betrekking tot de fout.

message

string

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

TaskInformation

Informatie over een taak die wordt uitgevoerd op een rekenknooppunt.

Name Type Description
executionInfo

TaskExecutionInformation

Informatie over de uitvoering van de taak.

jobId

string

De id van de taak waartoe de taak behoort.

subtaskId

integer

De id van de subtaak als de taak een taak met meerdere exemplaren is.

taskId

string

De id van de taak.

taskState

TaskState

De huidige status van de taak.

taskUrl

string

De URL van de taak.

TaskState

De status van de taak.

Name Type Description
active

string

De taak wordt in de wachtrij geplaatst en kan worden uitgevoerd, maar is momenteel niet toegewezen aan een rekenknooppunt. Een taak voert deze status in wanneer deze wordt gemaakt, wanneer deze is ingeschakeld nadat deze is uitgeschakeld of wanneer deze wacht op een nieuwe poging na een mislukte uitvoering.

completed

string

De taak komt niet meer in aanmerking voor uitvoering, meestal omdat de taak is voltooid of de taak is voltooid en de limiet voor opnieuw proberen is uitgeput. Een taak wordt ook gemarkeerd als voltooid als er een fout is opgetreden bij het starten van de taak of wanneer de taak is beëindigd.

preparing

string

De taak is toegewezen aan een rekenknooppunt, maar wacht tot een vereiste taakvoorbereidingstaak is voltooid op het rekenknooppunt. Als de taakvoorbereidingstaak slaagt, wordt de taak verplaatst naar actief. Als de taakvoorbereidingstaak mislukt, keert de taak terug naar actief en komt deze in aanmerking voor toewijzing aan een ander rekenknooppunt.

running

string

De taak wordt uitgevoerd op een rekenknooppunt. Dit omvat voorbereiding op taakniveau, zoals het downloaden van resourcebestanden of het implementeren van pakketten die zijn opgegeven voor de taak. Dit betekent niet noodzakelijkerwijs dat de opdrachtregel Taak is gestart met uitvoeren.

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.

VirtualMachineInfo

Informatie over de huidige status van de virtuele machine.

Name Type Description
imageReference

ImageReference

De verwijzing naar de Marketplace-installatiekopieën van de virtuele Azure-machine.

scaleSetVmResourceId

string

De resource-id van de huidige VM van de virtuele-machineschaalset van het rekenknooppunt. Alleen gedefinieerd als het Batch-account is gemaakt met de eigenschap poolAllocationMode ingesteld op UserSubscription.