Compute Node - List

Service:

Batch Service

API Version:

2023-11-01.18.0

Visar en lista över beräkningsnoderna i den angivna poolen.

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

With optional parameters:

GET {batchUrl}/pools/{poolId}/nodes?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch tjänstbegäranden.
poolId	path	True	string	ID:t för den pool som du vill visa en lista över beräkningsnoder från.
api-version	query	True	string	Klient-API-version.
$filter	query		string	En OData-$filter-sats. Mer information om hur du skapar det här filtret finns i https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.
$select	query		string	En OData-$select-sats.
maxresults	query		integer int32	Det maximala antalet objekt som ska returneras i svaret. Högst 1 000 beräkningsnoder kan returneras.
timeout	query		integer int32	Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
client-request-id		string uuid	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Om servern ska returnera klient-request-id i svaret.
ocp-date		string date-time-rfc1123	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det uttryckligen om du anropar REST-API:et direkt.

Svar

Name	Typ	Description
200 OK	ComputeNodeListResult	Ett svar som innehåller listan över beräkningsnoder. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Felet från Batch-tjänsten.

Säkerhet

azure_auth

Microsoft Entra autentiseringskodflöde för OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Type: apiKey
In: header

Exempel

Node list

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "tvm-1695681911_1-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2016-11-22T22:22:27.2236818Z",
      "lastBootTime": "2016-11-22T22:22:24.4634125Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_1-20161122t193202z",
      "vmSize": "small",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 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-22T22:22:27.2236818Z",
        "endTime": "2016-11-22T22:22:27.567189Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
      }
    },
    {
      "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,
      "runningTaskSlotsCount": 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-22T22:22:24.4634125Z"
      }
    },
    {
      "id": "tvm-1695681911_3-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2016-11-22T19:36:51.0013378Z",
      "lastBootTime": "2016-11-22T19:36:48.21721Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_3-20161122t193202z",
      "vmSize": "small",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 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:36:51.0013378Z",
        "endTime": "2016-11-22T19:36:51.2363447Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
      }
    }
  ]
}

Definitioner

Name	Description
AutoUserScope	Omfånget för den automatiska användaren
AutoUserSpecification	Anger parametrarna för den automatiska användare som kör en aktivitet i Batch-tjänsten.
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
CertificateReference	En referens till ett certifikat som ska installeras på beräkningsnoder i en pool.
CertificateStoreLocation	Platsen för certifikatarkivet på beräkningsnoden där certifikatet ska installeras.
CertificateVisibility	Vilka användarkonton på beräkningsnoden ska ha åtkomst till certifikatets privata data.
ComputeNode	En beräkningsnod i Batch-tjänsten.
ComputeNodeEndpointConfiguration	Slutpunktskonfigurationen för beräkningsnoden.
ComputeNodeError	Ett fel påträffades av en beräkningsnod.
ComputeNodeIdentityReference	Referensen till en användartilldelad identitet som är associerad med batchpoolen som en beräkningsnod ska använda.
ComputeNodeListResult	Resultatet av att lista beräkningsnoderna i en pool.
ComputeNodeState	Det aktuella tillståndet för beräkningsnoden.
ContainerRegistry	Ett privat containerregister.
ContainerWorkingDirectory	Platsen för containerns arbetskatalog för uppgift.
ElevationLevel	Användarens höjdnivå.
EnvironmentSetting	En miljövariabel som ska anges för en uppgiftsprocess.
ErrorCategory	Kategorin för felet.
ErrorMessage	Ett felmeddelande som togs emot i ett Azure Batch felsvar.
ImageReference	En referens till en Azure Virtual Machines Marketplace-avbildning eller en Azure Compute Gallery-avbildning. Information om hur du hämtar listan över alla Azure Marketplace Image-referenser som verifierats av Azure Batch finns i åtgärden "Lista över avbildningar som stöds".
InboundEndpoint	En inkommande slutpunkt på en beräkningsnod.
InboundEndpointProtocol	Protokollet för slutpunkten.
NameValuePair	Representerar ett namn/värde-par.
NodeAgentInformation	Information om Compute Node-agenten.
ResourceFile	En enda fil eller flera filer som ska laddas ned till en beräkningsnod.
SchedulingState	Om beräkningsnoden är tillgänglig för schemaläggning av uppgifter.
StartTask	En aktivitet som körs när en nod ansluter till en pool i Azure Batch-tjänsten, eller när beräkningsnoden startas om eller omskapas.
StartTaskInformation	Information om en StartTask som körs på en beräkningsnod.
StartTaskState	Tillståndet för StartTask på beräkningsnoden.
TaskContainerExecutionInformation	Innehåller information om containern som en aktivitet körs i.
TaskContainerSettings	Containerinställningarna för en aktivitet.
TaskExecutionInformation	Information om körning av en aktivitet.
TaskExecutionResult	Resultatet av aktivitetskörningen.
TaskFailureInformation	Information om ett aktivitetsfel.
TaskInformation	Information om en aktivitet som körs på en beräkningsnod.
TaskState	Status för uppgiften.
UserIdentity	Definitionen av den användaridentitet som aktiviteten körs under.
VirtualMachineInfo	Information om den virtuella datorns aktuella tillstånd.

AutoUserScope

Omfånget för den automatiska användaren

Name	Typ	Description
pool	string	Anger att aktiviteten körs som det vanliga automatiska användarkontot som skapas på varje beräkningsnod i en pool.
task	string	Anger att tjänsten ska skapa en ny användare för uppgiften.

AutoUserSpecification

Anger parametrarna för den automatiska användare som kör en aktivitet i Batch-tjänsten.

Name	Typ	Description
elevationLevel	ElevationLevel	Den automatiska användarens höjdnivå. Standardvärdet är nonAdmin.
scope	AutoUserScope	Omfånget för den automatiska användaren Standardvärdet är pool. Om poolen kör Windows ska värdet Aktivitet anges om striktare isolering mellan aktiviteter krävs. Om uppgiften till exempel muterar registret på ett sätt som kan påverka andra aktiviteter, eller om certifikat har angetts i poolen som inte ska vara tillgängliga för normala uppgifter, men som ska vara tillgängliga av StartTasks.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

CertificateReference

En referens till ett certifikat som ska installeras på beräkningsnoder i en pool.

Name	Typ	Description
storeLocation	CertificateStoreLocation	Platsen för certifikatarkivet på beräkningsnoden där certifikatet ska installeras. Standardvärdet är currentuser. Den här egenskapen gäller endast för pooler som konfigurerats med Windows-beräkningsnoder (dvs. skapas med cloudServiceConfiguration eller med virtualMachineConfiguration med hjälp av en Windows-avbildningsreferens). För Linux-beräkningsnoder lagras certifikaten i en katalog i arbetskatalogen Aktivitet och en miljövariabel AZ_BATCH_CERTIFICATES_DIR skickas till uppgiften för att fråga efter den här platsen. För certifikat med synlighet för "remoteUser" skapas en "certs"-katalog i användarens hemkatalog (t.ex. /home/{användarnamn}/certifikat) och certifikat placeras i den katalogen.
storeName	string	Namnet på certifikatarkivet på beräkningsnoden som certifikatet ska installeras i. Den här egenskapen gäller endast för pooler som konfigurerats med Windows-beräkningsnoder (dvs. skapas med cloudServiceConfiguration eller med virtualMachineConfiguration med hjälp av en Windows-avbildningsreferens). Vanliga butiksnamn är: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, men alla anpassade butiksnamn kan också användas. Standardvärdet är Min.
thumbprint	string	Certifikatets tumavtryck.
thumbprintAlgorithm	string	Algoritmen som tumavtrycket är associerat med. Det här måste vara sha1.
visibility	CertificateVisibility[]	Vilka användarkonton på beräkningsnoden ska ha åtkomst till certifikatets privata data. Du kan ange mer än en synlighet i den här samlingen. Standardvärdet är alla konton.

CertificateStoreLocation

Platsen för certifikatarkivet på beräkningsnoden där certifikatet ska installeras.

Name	Typ	Description
currentuser	string	Certifikat ska installeras i arkivet CurrentUser Certificate.
localmachine	string	Certifikat ska installeras i LocalMachine-certifikatarkivet.

CertificateVisibility

Vilka användarkonton på beräkningsnoden ska ha åtkomst till certifikatets privata data.

Name	Typ	Description
remoteuser	string	Certifikatet ska vara synligt för de användarkonton där användare fjärråtkomst till beräkningsnoden.
starttask	string	Certifikatet ska vara synligt för det användarkonto som StartTask körs under. Observera att om AutoUser-omfånget är pool för både StartTask och en aktivitet, kommer även det här certifikatet att vara synligt för aktiviteten.
task	string	Certifikatet ska vara synligt för de användarkonton under vilka jobbaktiviteter körs.

ComputeNode

En beräkningsnod i Batch-tjänsten.

Name	Typ	Description
affinityId	string	En identifierare som kan skickas när du lägger till en aktivitet för att begära att aktiviteten schemaläggs på den här beräkningsnoden. Observera att detta bara är en mjuk tillhörighet. Om mål-beräkningsnoden är upptagen eller otillgänglig när aktiviteten schemaläggs schemaläggs aktiviteten någon annanstans.
allocationTime	string	Den tidpunkt då den här beräkningsnoden allokerades till poolen. Det här är den tid då beräkningsnoden ursprungligen allokerades och inte ändras när den har angetts. Den uppdateras inte när beräkningsnoden är tjänsten reparerad eller föregripen.
certificateReferences	CertificateReference[]	Listan över certifikat som är installerade på beräkningsnoden. För Windows-noder installerar Batch-tjänsten certifikaten till det angivna certifikatarkivet och platsen. För Linux-beräkningsnoder lagras certifikaten i en katalog i arbetskatalogen Aktivitet och en miljövariabel AZ_BATCH_CERTIFICATES_DIR skickas till uppgiften för att fråga efter den här platsen. För certifikat med synlighet för "remoteUser" skapas en "certs"-katalog i användarens hemkatalog (t.ex. /home/{användarnamn}/certifikat) och certifikat placeras i den katalogen. Varning! Den här egenskapen är inaktuell och tas bort efter februari 2024. Använd Azure KeyVault-tillägget i stället.
endpointConfiguration	ComputeNodeEndpointConfiguration	Slutpunktskonfigurationen för beräkningsnoden.
errors	ComputeNodeError[]	Listan över fel som för närvarande påträffas av beräkningsnoden.
id	string	ID för beräkningsnoden. Varje beräkningsnod som läggs till i en pool tilldelas ett unikt ID. När en beräkningsnod tas bort från en pool tas alla dess lokala filer bort och ID:t frigörs och kan återanvändas för nya beräkningsnoder.
ipAddress	string	IP-adressen som andra noder kan använda för att kommunicera med den här beräkningsnoden. Varje beräkningsnod som läggs till i en pool tilldelas en unik IP-adress. När en beräkningsnod tas bort från en pool tas alla dess lokala filer bort och IP-adressen tas bort och kan återanvändas för nya beräkningsnoder.
isDedicated	boolean	Om den här beräkningsnoden är en dedikerad beräkningsnod. Om det är falskt är beräkningsnoden en beräkningsnod med oanvänd kapacitet/låg prioritet.
lastBootTime	string	Den senaste gången som beräkningsnoden startades. Den här egenskapen kanske inte finns om beräkningsnodtillståndet är oanvändbart.
nodeAgentInfo	NodeAgentInformation	Information om beräkningsnodens agentversion och den tid då beräkningsnoden uppgraderades till en ny version. Batch Compute Node-agenten är ett program som körs på varje beräkningsnod i poolen och ger Batch-funktioner på beräkningsnoden.
recentTasks	TaskInformation[]	En lista över uppgifter vars tillstånd nyligen har ändrats. Den här egenskapen finns bara om minst en aktivitet har körts på den här beräkningsnoden sedan den tilldelades till poolen.
runningTaskSlotsCount	integer	Det totala antalet schemaläggningsfack som används av jobbaktiviteter som körs på beräkningsnoden. Detta inkluderar Job Manager-uppgifter och normala uppgifter, men inte jobbförberedelse, jobblansering eller startaktiviteter.
runningTasksCount	integer	Det totala antalet jobbaktiviteter som körs på beräkningsnoden. Detta inkluderar Job Manager-uppgifter och normala uppgifter, men inte jobbförberedelse, jobblansering eller startaktiviteter.
schedulingState	SchedulingState	Om beräkningsnoden är tillgänglig för schemaläggning av uppgifter.
startTask	StartTask	Uppgiften som angetts för att köras på beräkningsnoden när den ansluter till poolen. Batch försöker utföra uppgifter igen när en återställningsåtgärd utlöses på en nod. Exempel på återställningsåtgärder är (men är inte begränsade till) när en nod med feltillstånd startas om eller en beräkningsnod försvinner på grund av värdfel. Återförsök på grund av återställningsåtgärder är oberoende av och räknas inte mot maxTaskRetryCount. Även om maxTaskRetryCount är 0 kan ett internt återförsök på grund av en återställningsåtgärd inträffa. Därför bör alla aktiviteter vara idempotent. Det innebär att uppgifter måste tolerera att avbrytas och startas om utan att orsaka skada eller duplicera data. Bästa praxis för långvariga uppgifter är att använda någon form av kontrollpunkter. I vissa fall kan StartTask köras igen även om beräkningsnoden inte startades om. Särskild försiktighet bör iakttas för att undvika StartTasks som skapar utbrytarprocesser eller installerar/startar tjänster från Arbetskatalogen StartTask, eftersom batch inte kan köra StartTask igen.
startTaskInfo	StartTaskInformation	Körningsinformation om körningen av StartTask på beräkningsnoden.
state	ComputeNodeState	Det aktuella tillståndet för beräkningsnoden. Beräkningsnoden Spot/Low-priority har förutbestämts. Aktiviteter som kördes på beräkningsnoden när den föregicks av schemaläggs om när en annan beräkningsnod blir tillgänglig.
stateTransitionTime	string	Den tidpunkt då beräkningsnoden övergick i sitt aktuella tillstånd.
totalTasksRun	integer	Det totala antalet jobbaktiviteter som har slutförts på beräkningsnoden. Detta inkluderar Job Manager-uppgifter och normala uppgifter, men inte jobbförberedelse, jobblansering eller startaktiviteter.
totalTasksSucceeded	integer	Det totala antalet jobbaktiviteter som har slutförts (med exitCode 0) på beräkningsnoden. Detta inkluderar Job Manager-uppgifter och normala uppgifter, men inte jobbförberedelse, jobblansering eller startaktiviteter.
url	string	URL:en för beräkningsnoden.
virtualMachineInfo	VirtualMachineInfo	Information om den virtuella datorns aktuella tillstånd.
vmSize	string	Storleken på den virtuella dator som är värd för beräkningsnoden. Information om tillgängliga storlekar på virtuella datorer i pooler finns i Välja en VM-storlek för beräkningsnoder i en Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

ComputeNodeEndpointConfiguration

Slutpunktskonfigurationen för beräkningsnoden.

Name	Typ	Description
inboundEndpoints	InboundEndpoint[]	Listan över inkommande slutpunkter som är tillgängliga på beräkningsnoden.

ComputeNodeError

Ett fel påträffades av en beräkningsnod.

Name	Typ	Description
code	string	En identifierare för felet Beräkningsnod. Koder är invarianta och är avsedda att användas programmatiskt.
errorDetails	NameValuePair[]	Listan över ytterligare felinformation som rör felet Beräkningsnod.
message	string	Ett meddelande som beskriver felet beräkningsnod som är avsett att vara lämpligt för visning i ett användargränssnitt.

ComputeNodeIdentityReference

Referensen till en användartilldelad identitet som är associerad med batchpoolen som en beräkningsnod ska använda.

Name	Typ	Description
resourceId	string	ARM-resurs-ID för den användartilldelade identiteten.

ComputeNodeListResult

Resultatet av att lista beräkningsnoderna i en pool.

Name	Typ	Description
odata.nextLink	string	URL:en för att hämta nästa uppsättning resultat.
value	ComputeNode[]	Listan över beräkningsnoder.

ComputeNodeState

Det aktuella tillståndet för beräkningsnoden.

Name	Typ	Description
creating	string	Batch-tjänsten har hämtat den underliggande virtuella datorn från Azure Compute, men den har ännu inte börjat ansluta till poolen.
idle	string	Beräkningsnoden kör för närvarande inte en aktivitet.
leavingpool	string	Beräkningsnoden lämnar poolen, antingen för att användaren uttryckligen har tagit bort den eller för att poolen ändrar storlek eller automatiskt skalas ned.
offline	string	Beräkningsnoden kör för närvarande inte en aktivitet och schemaläggningen av nya aktiviteter till beräkningsnoden är inaktiverad.
preempted	string	Beräkningsnoden Spot/Low-priority har förutbestämts. Aktiviteter som kördes på beräkningsnoden när den föregicks av schemaläggs om när en annan beräkningsnod blir tillgänglig.
rebooting	string	Beräkningsnoden startas om.
reimaging	string	Beräkningsnoden återskapas.
running	string	Beräkningsnoden kör en eller flera aktiviteter (förutom en StartTask).
starting	string	Batch-tjänsten startar på den underliggande virtuella datorn.
starttaskfailed	string	StartTask har misslyckats på beräkningsnoden (och uttömt alla återförsök) och waitForSuccess har angetts. Beräkningsnoden kan inte användas för att köra uppgifter.
unknown	string	Batch-tjänsten har förlorat kontakten med beräkningsnoden och känner inte till dess sanna tillstånd.
unusable	string	Beräkningsnoden kan inte användas för aktivitetskörning på grund av fel.
waitingforstarttask	string	StartTask har börjat köras på beräkningsnoden, men waitForSuccess har angetts och StartTask har ännu inte slutförts.

ContainerRegistry

Ett privat containerregister.

Name	Typ	Description
identityReference	ComputeNodeIdentityReference	Referensen till den användartilldelade identitet som ska användas för att komma åt en Azure Container Registry i stället för användarnamn och lösenord. Referensen till en användartilldelad identitet som är associerad med batchpoolen som en beräkningsnod ska använda.
password	string	Lösenordet för att logga in på registerservern.
registryServer	string	Registrets URL. Om det utelämnas är standardvärdet "docker.io".
username	string	Användarnamnet för att logga in på registerservern.

ContainerWorkingDirectory

Platsen för containerns arbetskatalog för uppgift.

Name	Typ	Description
containerImageDefault	string	Använd arbetskatalogen som definierats i containern Avbildning. Se upp för att den här katalogen inte innehåller de resursfiler som laddats ned av Batch.
taskWorkingDirectory	string	Använd arbetskatalogen för Batch-tjänstens standardtjänst, som innehåller de aktivitetsresursfiler som fylls i av Batch.

ElevationLevel

Användarens höjdnivå.

Name	Typ	Description
admin	string	Användaren är en användare med förhöjd åtkomst och fungerar med fullständiga administratörsbehörigheter.
nonadmin	string	Användaren är en standardanvändare utan förhöjd åtkomst.

EnvironmentSetting

En miljövariabel som ska anges för en uppgiftsprocess.

Name	Typ	Description
name	string	Namnet på miljövariabeln.
value	string	Värdet för miljövariabeln.

ErrorCategory

Kategorin för felet.

Name	Typ	Description
servererror	string	Felet beror på ett internt serverproblem.
usererror	string	Felet beror på ett användarproblem, till exempel felkonfiguration.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch felsvar.

Name	Typ	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.

ImageReference

En referens till en Azure Virtual Machines Marketplace-avbildning eller en Azure Compute Gallery-avbildning. Information om hur du hämtar listan över alla Azure Marketplace Image-referenser som verifierats av Azure Batch finns i åtgärden "Lista över avbildningar som stöds".

Name	Typ	Description
exactVersion	string	Den specifika versionen av plattformsbilden eller marketplace-avbildningen som används för att skapa noden. Det här skrivskyddade fältet skiljer sig endast från "version" om värdet som angavs för "version" när poolen skapades var "senaste".
offer	string	Erbjudandetypen för Azure Virtual Machines Marketplace Image. Till exempel UbuntuServer eller WindowsServer.
publisher	string	Utgivaren av Azure Virtual Machines Marketplace Image. Till exempel Canonical eller MicrosoftWindowsServer.
sku	string	SKU:n för Azure Virtual Machines Marketplace Image. Till exempel 18.04-LTS eller 2019-Datacenter.
version	string	Versionen av Azure Virtual Machines Marketplace Image. Du kan ange värdet "senaste" för att välja den senaste versionen av en bild. Om det utelämnas är standardvärdet "senaste".
virtualMachineImageId	string	ARM-resursidentifieraren för Azure Compute Gallery Image. Beräkningsnoder i poolen skapas med det här avbildnings-ID:t. Det här är av formuläret /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} eller /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} för att alltid vara standard för den senaste avbildningsversionen. Den här egenskapen är ömsesidigt uteslutande med andra ImageReference-egenskaper. Azure Compute Gallery Image måste ha repliker i samma region och måste finnas i samma prenumeration som Azure Batch-kontot. Om avbildningsversionen inte anges i imageId används den senaste versionen. Information om brandväggsinställningarna för Batch Compute Node-agenten som ska kommunicera med Batch-tjänsten finns https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configurationi .

InboundEndpoint

En inkommande slutpunkt på en beräkningsnod.

Name	Typ	Description
backendPort	integer	Serverdelsportnumret för slutpunkten.
frontendPort	integer	Slutpunktens offentliga portnummer.
name	string	Namnet på slutpunkten.
protocol	InboundEndpointProtocol	Protokollet för slutpunkten.
publicFQDN	string	Det offentliga fullständigt kvalificerade domännamnet för beräkningsnoden.
publicIPAddress	string	Den offentliga IP-adressen för beräkningsnoden.

InboundEndpointProtocol

Protokollet för slutpunkten.

Name	Typ	Description
tcp	string	Använd TCP för slutpunkten.
udp	string	Använd UDP för slutpunkten.

NameValuePair

Representerar ett namn/värde-par.

Name	Typ	Description
name	string	Namnet i namn/värde-paret.
value	string	Värdet i namn/värde-paret.

NodeAgentInformation

Information om Compute Node-agenten.

Name	Typ	Description
lastUpdateTime	string	Tiden då Compute Node-agenten uppdaterades på beräkningsnoden. Det här är den senaste gången som Compute Node-agenten uppdaterades till en ny version.
version	string	Versionen av Batch Compute Node-agenten som körs på beräkningsnoden. Det här versionsnumret kan kontrolleras mot viktig information om Compute Node-agenten som finns på https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.

ResourceFile

En enda fil eller flera filer som ska laddas ned till en beräkningsnod.

Name	Typ	Description
autoStorageContainerName	string	Namnet på lagringscontainern i det automatiska lagringskontot. Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl utesluter varandra och en av dem måste anges.
blobPrefix	string	Blobprefixet som ska användas vid nedladdning av blobar från en Azure Storage-container. Endast de blobar vars namn börjar med det angivna prefixet laddas ned. Egenskapen är endast giltig när autoStorageContainerName eller storageContainerUrl används. Det här prefixet kan vara ett partiellt filnamn eller en underkatalog. Om inget prefix anges laddas alla filer i containern ned.
fileMode	string	Attributet för filbehörighetsläge i oktalt format. Den här egenskapen gäller endast för filer som laddas ned till Linux-beräkningsnoder. Den ignoreras om den har angetts för en resourceFile som laddas ned till en Windows Compute-nod. Om den här egenskapen inte har angetts för en Linux-beräkningsnod tillämpas standardvärdet 0770 på filen.
filePath	string	Platsen på beräkningsnoden som filen/filerna ska laddas ned till i förhållande till aktivitetens arbetskatalog. Om egenskapen httpUrl anges krävs filePath och den sökväg som filen laddas ned till, inklusive filnamnet. Om egenskapen autoStorageContainerName eller storageContainerUrl anges är filePath valfritt och är den katalog som filerna ska laddas ned till. Om filePath används som en katalog behålls alla katalogstrukturer som redan är associerade med indata i sin helhet och läggs till i den angivna filePath-katalogen. Den angivna relativa sökvägen kan inte bryta sig ut ur aktivitetens arbetskatalog (till exempel med hjälp av ..).
httpUrl	string	URL:en för filen som ska laddas ned. Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl utesluter varandra och en av dem måste anges. Om URL:en pekar på Azure Blob Storage måste den vara läsbar från beräkningsnoder. Det finns tre sätt att hämta en sådan URL för en blob i Azure Storage: inkludera en signatur för delad åtkomst (SAS) som beviljar läsbehörighet för bloben, använder en hanterad identitet med läsbehörighet eller anger ACL för bloben eller dess container för att tillåta offentlig åtkomst.
identityReference	ComputeNodeIdentityReference	Referensen till den användartilldelade identitet som ska användas för att komma åt Azure Blob Storage som anges av storageContainerUrl eller httpUrl Referensen till en användartilldelad identitet som är associerad med den Batch-pool som en beräkningsnod ska använda.
storageContainerUrl	string	URL:en för blobcontainern i Azure Blob Storage. Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl utesluter varandra och en av dem måste anges. Den här URL:en måste vara läsbar och listbar från beräkningsnoder. Det finns tre sätt att hämta en sådan URL för en container i Azure Storage: inkludera en signatur för delad åtkomst (SAS) som beviljar läs- och listbehörigheter för containern, använder en hanterad identitet med läs- och listbehörigheter eller anger ACL för containern för att tillåta offentlig åtkomst.

SchedulingState

Om beräkningsnoden är tillgänglig för schemaläggning av uppgifter.

Name	Typ	Description
disabled	string	Inga nya aktiviteter schemaläggs på beräkningsnoden. Aktiviteter som redan körs på beräkningsnoden kan fortfarande köras för att slutföras. Alla beräkningsnoder börjar med schemaläggning aktiverat.
enabled	string	Aktiviteter kan schemaläggas på beräkningsnoden.

StartTask

En aktivitet som körs när en nod ansluter till en pool i Azure Batch-tjänsten, eller när beräkningsnoden startas om eller omskapas.

Name	Typ	Description
commandLine	string	Kommandoraden i StartTask. Kommandoraden körs inte under ett gränssnitt och kan därför inte dra nytta av gränssnittsfunktioner som miljövariabelexpansion. Om du vill dra nytta av sådana funktioner bör du anropa gränssnittet på kommandoraden, till exempel med hjälp av "cmd /c MyCommand" i Windows eller "/bin/sh -c MyCommand" i Linux. Om kommandoraden refererar till filsökvägar bör den använda en relativ sökväg (i förhållande till arbetskatalogen Uppgift) eller använda miljövariabeln Batch som tillhandahålls (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	Inställningarna för containern som StartTask körs under. När detta anges mappas alla kataloger rekursivt under AZ_BATCH_NODE_ROOT_DIR (roten för Azure Batch kataloger på noden) till containern, alla miljövariabler för aktivitet mappas till containern och kommandoraden Aktivitet körs i containern. Filer som skapas i containern utanför AZ_BATCH_NODE_ROOT_DIR kanske inte återspeglas på värddisken, vilket innebär att Batch-fil-API:er inte kan komma åt dessa filer.
environmentSettings	EnvironmentSetting[]	En lista över miljövariabelinställningar för StartTask.
maxTaskRetryCount	integer	Det maximala antalet gånger som aktiviteten kan försökas igen. Batch-tjänsten försöker utföra en aktivitet igen om dess slutkod inte är noll. Observera att det här värdet specifikt styr antalet återförsök. Batch-tjänsten provar uppgiften en gång och kan sedan försöka igen upp till den här gränsen. Om det maximala antalet återförsök till exempel är 3 försöker Batch aktiviteten upp till 4 gånger (ett första försök och 3 återförsök). Om det maximala antalet återförsök är 0 försöker inte Batch-tjänsten uppgiften igen. Om det maximala antalet återförsök är -1 försöker Batch-tjänsten uppgiften utan begränsning igen, men detta rekommenderas inte för en startaktivitet eller någon aktivitet. Standardvärdet är 0 (inga återförsök).
resourceFiles	ResourceFile[]	En lista över filer som Batch-tjänsten laddar ned till beräkningsnoden innan du kör kommandoraden. Det finns en maximal storlek för listan över resursfiler. När maxstorleken överskrids misslyckas begäran och svarsfelkoden är RequestEntityTooLarge. Om detta inträffar måste samlingen resourcefiles minskas i storlek. Detta kan uppnås med hjälp av .zip filer, programpaket eller Docker-containrar. Filer som visas under det här elementet finns i arbetskatalogen för aktiviteten.
userIdentity	UserIdentity	Användaridentiteten som StartTask körs under. Om den utelämnas körs aktiviteten som en icke-administrativ användare som är unik för aktiviteten.
waitForSuccess	boolean	Om Batch-tjänsten ska vänta tills StartTask har slutförts (d.v.s. avslutas med slutkod 0) innan aktiviteter schemaläggs på beräkningsnoden. Om true och StartTask misslyckas på en nod försöker Batch-tjänsten starta om StartTask upp till det maximala antalet återförsök (maxTaskRetryCount). Om aktiviteten fortfarande inte har slutförts efter alla återförsök markerar Batch-tjänsten noden oanvändbar och schemalägger inte Aktiviteter till den. Det här villkoret kan identifieras via beräkningsnodens tillstånd och information om felinformation. Om det är falskt väntar inte Batch-tjänsten på att StartTask ska slutföras. I det här fallet kan andra uppgifter börja köras på beräkningsnoden medan StartTask fortfarande körs. och även om StartTask misslyckas fortsätter nya aktiviteter att schemaläggas på beräkningsnoden. Standardvärdet är sant.

StartTaskInformation

Information om en StartTask som körs på en beräkningsnod.

Name	Typ	Description
containerInfo	TaskContainerExecutionInformation	Information om containern som aktiviteten körs under. Den här egenskapen anges endast om aktiviteten körs i en containerkontext.
endTime	string	Tiden då StartTask slutade köras. Det här är sluttiden för den senaste körningen av StartTask, om den körningen har slutförts (även om körningen misslyckades och ett nytt försök väntar). Det här elementet finns inte om StartTask körs för tillfället.
exitCode	integer	Slutkoden för programmet som anges på StartTask-kommandoraden. Den här egenskapen anges endast om StartTask är i slutfört tillstånd. I allmänhet återspeglar slutkoden för en process den specifika konvention som implementerats av programutvecklaren för den processen. Om du använder slutkodsvärdet för att fatta beslut i koden ska du vara säker på att du känner till den slutkodskonvention som används av programprocessen. Men om Batch-tjänsten avslutar StartTask (på grund av timeout eller användaravslut via API:et) kan du se en operativsystemdefinierad slutkod.
failureInfo	TaskFailureInformation	Information som beskriver aktivitetsfelet, om det finns någon. Den här egenskapen anges endast om aktiviteten är i slutfört tillstånd och påträffade ett fel.
lastRetryTime	string	Den senaste gången ett återförsök av aktiviteten började köras. Det här elementet finns bara om aktiviteten har gjorts om (dvs. retryCount är inte noll). Om det finns är detta vanligtvis samma som startTime, men kan vara annorlunda om aktiviteten har startats om av andra orsaker än återförsök. Om beräkningsnoden till exempel startades om under ett nytt försök uppdateras startTime men inte lastRetryTime.
result	TaskExecutionResult	Resultatet av aktivitetskörningen. Om värdet är "failed" (misslyckades) finns information om felet i egenskapen failureInfo.
retryCount	integer	Antalet gånger som uppgiften har gjorts om av Batch-tjänsten. Fel i aktivitetsprogrammet (icke-nollavslutskod) görs på nytt, förbearbetningsfel (aktiviteten kunde inte köras) och filuppladdningsfel görs inte igen. Batch-tjänsten försöker uppgiften igen upp till den gräns som anges av begränsningarna.
startTime	string	Tiden då StartTask började köras. Det här värdet återställs varje gång aktiviteten startas om eller görs ett nytt försök (dvs. det här är den senaste gången som StartTask började köras).
state	StartTaskState	Tillståndet för StartTask på beräkningsnoden.

StartTaskState

Tillståndet för StartTask på beräkningsnoden.

Name	Typ	Description
completed	string	StartTask har avslutats med slutkod 0, eller så misslyckades StartTask och återförsöksgränsen har nåtts, eller så kördes inte StartTask-processen på grund av aktivitetsförberedelsefel (till exempel fel vid nedladdning av resursfiler).
running	string	StartTask körs för närvarande.

TaskContainerExecutionInformation

Innehåller information om containern som en aktivitet körs i.

Name	Typ	Description
containerId	string	Containerns ID.
error	string	Detaljerad felinformation om containern. Det här är den detaljerade felsträngen från Docker-tjänsten, om den är tillgänglig. Det motsvarar det felfält som returneras av "docker inspect".
state	string	Containerns tillstånd. Det här är containerns tillstånd enligt Docker-tjänsten. Det motsvarar statusfältet som returneras av "docker inspect".

TaskContainerSettings

Containerinställningarna för en aktivitet.

Name	Typ	Description
containerRunOptions	string	Ytterligare alternativ för kommandot container create. Dessa ytterligare alternativ anges som argument till kommandot "docker create", förutom de som styrs av Batch-tjänsten.
imageName	string	Avbildningen som ska användas för att skapa containern där aktiviteten ska köras. Det här är den fullständiga avbildningsreferensen, som skulle anges till "docker pull". Om ingen tagg anges som en del av avbildningsnamnet används taggen ":latest" som standard.
registry	ContainerRegistry	Det privata registret som innehåller containeravbildningen. Den här inställningen kan utelämnas om den redan angavs när poolen skapades.
workingDirectory	ContainerWorkingDirectory	Platsen för containerns arbetskatalog för uppgift. Standardvärdet är "taskWorkingDirectory".

TaskExecutionInformation

Information om körning av en aktivitet.

Name	Typ	Description
containerInfo	TaskContainerExecutionInformation	Information om containern under vilken aktiviteten körs. Den här egenskapen anges endast om aktiviteten körs i en containerkontext.
endTime	string	Tidpunkten då uppgiften slutfördes. Den här egenskapen anges endast om aktiviteten är i tillståndet Slutförd.
exitCode	integer	Slutkoden för programmet som anges på kommandoraden Aktivitet. Den här egenskapen anges endast om aktiviteten är i slutfört tillstånd. I allmänhet återspeglar slutkoden för en process den specifika konvention som implementeras av programutvecklaren för den processen. Om du använder slutkodsvärdet för att fatta beslut i koden ska du vara säker på att du känner till den slutkodskonvention som används av programprocessen. Men om Batch-tjänsten avslutar aktiviteten (på grund av timeout eller användaravslutning via API:et) kan du se en operativsystemdefinierad slutkod.
failureInfo	TaskFailureInformation	Information som beskriver eventuella aktivitetsfel. Den här egenskapen anges endast om aktiviteten är i slutfört tillstånd och påträffade ett fel.
lastRequeueTime	string	Den senaste gången som aktiviteten har ställts i kö av Batch-tjänsten som ett resultat av en användarbegäran. Den här egenskapen anges endast om requeueCount inte är noll.
lastRetryTime	string	Den senaste tiden då ett nytt försök av aktiviteten började köras. Det här elementet finns bara om aktiviteten gjordes om (dvs. retryCount är inte noll). Om det finns är detta vanligtvis samma som startTime, men kan skilja sig om aktiviteten har startats om av andra orsaker än att försöka igen. Om beräkningsnoden till exempel startades om under ett nytt försök uppdateras startTime men inte lastRetryTime.
requeueCount	integer	Antalet gånger som aktiviteten har ställts till svars av Batch-tjänsten som ett resultat av en användarbegäran. När användaren tar bort beräkningsnoder från en pool (genom att ändra storlek på/krympa poolen) eller när jobbet inaktiveras kan användaren ange att aktiviteter som körs på beräkningsnoderna ska placeras i kö igen för körning. Det här antalet spårar hur många gånger uppgiften har ställts in på nytt av dessa skäl.
result	TaskExecutionResult	Resultatet av aktivitetskörningen. Om värdet är "failed" (misslyckades) finns information om felet i egenskapen failureInfo.
retryCount	integer	Antalet gånger som Batch-tjänsten har försökt utföra uppgiften igen. Fel i aktivitetsprogram (slutkod som inte är noll) görs om, förbearbetningsfel (aktiviteten kunde inte köras) och filuppladdningsfel görs inte på nytt. Batch-tjänsten försöker utföra uppgiften igen upp till den gräns som anges av begränsningarna.
startTime	string	Den tidpunkt då aktiviteten började köras. "Körs" motsvarar körningstillståndet, så om aktiviteten anger resursfiler eller paket visar starttiden den tidpunkt då aktiviteten började ladda ned eller distribuera dessa. Om aktiviteten har startats om eller gjorts om är det här den senaste gången som aktiviteten började köras. Den här egenskapen finns bara för uppgifter som körs eller är i slutfört tillstånd.

TaskExecutionResult

Resultatet av aktivitetskörningen.

Name	Typ	Description
failure	string	Ett fel uppstod under bearbetningen av aktiviteten. Felet kan ha inträffat innan aktivitetsprocessen startades, medan aktivitetsprocessen kördes eller efter att uppgiftsprocessen avslutades.
success	string	Uppgiften har körts.

TaskFailureInformation

Information om ett aktivitetsfel.

Name	Typ	Description
category	ErrorCategory	Kategorin för aktivitetsfelet.
code	string	En identifierare för aktivitetsfelet. Koder är invarianta och är avsedda att användas programmatiskt.
details	NameValuePair[]	En lista med ytterligare information som rör felet.
message	string	Ett meddelande som beskriver aktivitetsfelet, avsett att vara lämpligt för visning i ett användargränssnitt.

TaskInformation

Information om en aktivitet som körs på en beräkningsnod.

Name	Typ	Description
executionInfo	TaskExecutionInformation	Information om körningen av uppgiften.
jobId	string	ID för jobbet som aktiviteten tillhör.
subtaskId	integer	ID för underuppgiften om aktiviteten är en aktivitet med flera instanser.
taskId	string	ID:t för uppgiften.
taskState	TaskState	Aktivitetens aktuella tillstånd.
taskUrl	string	Url:en för uppgiften.

TaskState

Status för uppgiften.

Name	Typ	Description
active	string	Uppgiften placeras i kö och kan köras, men är för närvarande inte tilldelad till en beräkningsnod. En aktivitet anger det här tillståndet när den skapas, när den är aktiverad efter att den har inaktiverats eller när den väntar på ett nytt försök efter en misslyckad körning.
completed	string	Aktiviteten är inte längre berättigad att köras, vanligtvis på grund av att aktiviteten har slutförts, eller så har aktiviteten slutförts utan framgång och har uttömt sin återförsöksgräns. En aktivitet markeras också som slutförd om ett fel uppstod när aktiviteten startades eller när aktiviteten har avslutats.
preparing	string	Uppgiften har tilldelats till en beräkningsnod, men väntar på att en obligatorisk jobbförberedelseaktivitet ska slutföras på beräkningsnoden. Om jobbförberedelseaktiviteten lyckas flyttas aktiviteten till att köras. Om jobbförberedelseaktiviteten misslyckas återgår aktiviteten till aktiv och är berättigad att tilldelas till en annan beräkningsnod.
running	string	Uppgiften körs på en beräkningsnod. Detta inkluderar förberedelse på aktivitetsnivå, till exempel nedladdning av resursfiler eller distribution av paket som anges i aktiviteten – det betyder inte nödvändigtvis att kommandoraden Aktivitet har börjat köras.

UserIdentity

Definitionen av den användaridentitet som aktiviteten körs under.

Name	Typ	Description
autoUser	AutoUserSpecification	Den automatiska användare under vilken aktiviteten körs. Egenskaperna userName och autoUser är ömsesidigt uteslutande; du måste ange en men inte båda.
username	string	Namnet på den användaridentitet som aktiviteten körs under. Egenskaperna userName och autoUser är ömsesidigt uteslutande; du måste ange en men inte båda.

VirtualMachineInfo

Information om den virtuella datorns aktuella tillstånd.

Name	Typ	Description
imageReference	ImageReference	Referensen till Den virtuella Azure-datorns Marketplace-avbildning.
scaleSetVmResourceId	string	Resurs-ID:t för beräkningsnodens aktuella vm-skalningsuppsättning. Definieras endast om Batch-kontot skapades med egenskapen poolAllocationMode inställd på "UserSubscription".