Compute Node - List

Service:

Batch Service

API Version:

2023-11-01.18.0

Zobrazí seznam výpočetních uzlů v zadaném fondu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
batchUrl	path	True	string	Základní adresa URL pro všechny požadavky Azure Batch služby.
poolId	path	True	string	ID fondu, ze kterého chcete vypsat výpočetní uzly.
api-version	query	True	string	Verze rozhraní API klienta.
$filter	query		string	Klauzule $filter OData. Další informace o vytváření tohoto filtru najdete v tématu https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.
$select	query		string	Klauzule $select OData.
maxresults	query		integer int32	Maximální počet položek, které se mají v odpovědi vrátit. Může se vrátit maximálně 1000 výpočetních uzlů.
timeout	query		integer int32	Maximální doba, kterou může server strávit zpracováním požadavku( v sekundách). Výchozí hodnota je 30 sekund.

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
client-request-id		string uuid	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Určuje, jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vydána. Klientské knihovny obvykle nastavit na aktuální systémový čas hodin; pokud voláte rozhraní REST API přímo, explicitně ho nastavte.

Odpovědi

Name	Typ	Description
200 OK	ComputeNodeListResult	Odpověď obsahující seznam výpočetních uzlů. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Chyba ze služby Batch.

Zabezpečení

azure_auth

Microsoft Entra tok ověřovacího kódu OAuth 2.0

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

Scopes

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Authorization

Type: apiKey
In: header

Příklady

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"
      }
    }
  ]
}

Definice

Name	Description
AutoUserScope	Obor automatického uživatele
AutoUserSpecification	Určuje parametry pro automatického uživatele, který spouští úlohu ve službě Batch.
BatchError	Služba Azure Batch obdržela chybovou odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.
CertificateReference	Odkaz na certifikát, který se má nainstalovat na výpočetní uzly ve fondu.
CertificateStoreLocation	Umístění úložiště certifikátů na výpočetním uzlu, do kterého se má certifikát nainstalovat.
CertificateVisibility	Které uživatelské účty na výpočetním uzlu by měly mít přístup k privátním datům certifikátu.
ComputeNode	Výpočetní uzel ve službě Batch.
ComputeNodeEndpointConfiguration	Konfigurace koncového bodu pro výpočetní uzel.
ComputeNodeError	Došlo k chybě výpočetního uzlu.
ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude výpočetní uzel používat.
ComputeNodeListResult	Výsledek výpisu výpočetních uzlů ve fondu.
ComputeNodeState	Aktuální stav výpočetního uzlu.
ContainerRegistry	Privátní registr kontejneru.
ContainerWorkingDirectory	Umístění pracovního adresáře úloh kontejneru.
ElevationLevel	Úroveň zvýšení oprávnění uživatele.
EnvironmentSetting	Proměnná prostředí, která se má nastavit v procesu úlohy.
ErrorCategory	Kategorie chyby.
ErrorMessage	Chybová zpráva přijatá v Azure Batch chybovou odpověď.
ImageReference	Odkaz na image Azure Virtual Machines Marketplace nebo image Azure Compute Gallery. Pokud chcete získat seznam všech odkazů Azure Marketplace Image ověřených Azure Batch, projděte si operaci Výpis podporovaných imagí.
InboundEndpoint	Příchozí koncový bod na výpočetním uzlu.
InboundEndpointProtocol	Protokol koncového bodu.
NameValuePair	Představuje dvojici název-hodnota.
NodeAgentInformation	Informace o agentu výpočetního uzlu.
ResourceFile	Jeden soubor nebo více souborů ke stažení do výpočetního uzlu
SchedulingState	Určuje, jestli je výpočetní uzel dostupný pro plánování úkolů.
StartTask	Úloha, která se spustí, když se uzel připojí k fondu ve službě Azure Batch nebo když se výpočetní uzel restartuje nebo znovu z image.
StartTaskInformation	Informace o startTask spuštěném na výpočetním uzlu
StartTaskState	Stav startTask na výpočetním uzlu.
TaskContainerExecutionInformation	Obsahuje informace o kontejneru, který úloha provádí.
TaskContainerSettings	Nastavení kontejneru pro úlohu.
TaskExecutionInformation	Informace o provádění úlohy.
TaskExecutionResult	Výsledek spuštění úlohy.
TaskFailureInformation	Informace o selhání úlohy
TaskInformation	Informace o úkolu spuštěném na výpočetním uzlu
TaskState	Stav úkolu.
UserIdentity	Definice identity uživatele, pod kterou je úloha spuštěna.
VirtualMachineInfo	Informace o aktuálním stavu virtuálního počítače

AutoUserScope

Obor automatického uživatele

Name	Typ	Description
pool	string	Určuje, že se úloha spustí jako společný účet automatického uživatele, který se vytvoří na každém výpočetním uzlu ve fondu.
task	string	Určuje, že služba by měla pro úlohu vytvořit nového uživatele.

AutoUserSpecification

Určuje parametry pro automatického uživatele, který spouští úlohu ve službě Batch.

Name	Typ	Description
elevationLevel	ElevationLevel	Úroveň zvýšení oprávnění automatického uživatele. Výchozí hodnota je nonAdmin.
scope	AutoUserScope	Obor automatického uživatele Výchozí hodnota je fond. Pokud fond používá Systém Windows, měla by být zadána hodnota Úloha, pokud je vyžadována přísnější izolace mezi úkoly. Pokud například úloha zmutuje registr způsobem, který by mohl mít vliv na jiné úlohy, nebo pokud byly ve fondu zadány certifikáty, které by neměly být přístupné pro běžné úlohy, ale měly by být přístupné pro StartTasks.

BatchError

Služba Azure Batch obdržela chybovou odpověď.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou neutrální a mají být využívány programově.
message	ErrorMessage	Zpráva popisující chybu, která má být vhodná k zobrazení v uživatelském rozhraní.
values	BatchErrorDetail[]	Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.

Name	Typ	Description
key	string	Identifikátor určující význam value vlastnost.
value	string	Další informace zahrnuté v chybové odpovědi.

CertificateReference

Odkaz na certifikát, který se má nainstalovat na výpočetní uzly ve fondu.

Name	Typ	Description
storeLocation	CertificateStoreLocation	Umístění úložiště certifikátů na výpočetním uzlu, do kterého se má certifikát nainstalovat. Výchozí hodnota je currentuser. Tato vlastnost se vztahuje pouze na fondy nakonfigurované pomocí výpočetních uzlů Windows (to znamená vytvořených pomocí cloudServiceConfiguration nebo virtualMachineConfiguration pomocí odkazu na image Windows). V případě linuxových výpočetních uzlů jsou certifikáty uložené v adresáři v pracovním adresáři úlohy a proměnná prostředí AZ_BATCH_CERTIFICATES_DIR je předána úkolu, který se má dotazovat na toto umístění. V případě certifikátů s viditelností remoteUser se adresář certs vytvoří v domovském adresáři uživatele (např. /home/{uživatelské_jméno}/certs) a certifikáty se umístí do tohoto adresáře.
storeName	string	Název úložiště certifikátů na výpočetním uzlu, do kterého se má certifikát nainstalovat. Tato vlastnost se vztahuje pouze na fondy nakonfigurované pomocí výpočetních uzlů Windows (to znamená vytvořených pomocí cloudServiceConfiguration nebo virtualMachineConfiguration pomocí odkazu na image Windows). Mezi běžné názvy obchodů patří: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, ale je možné použít také jakýkoli vlastní název obchodu. Výchozí hodnota je My.
thumbprint	string	Kryptografický otisk certifikátu.
thumbprintAlgorithm	string	Algoritmus, se kterým je kryptografický otisk přidružený. To musí být sha1.
visibility	CertificateVisibility[]	Které uživatelské účty na výpočetním uzlu by měly mít přístup k privátním datům certifikátu. V této kolekci můžete zadat více než jednu viditelnost. Výchozí hodnota je všechny účty.

CertificateStoreLocation

Umístění úložiště certifikátů na výpočetním uzlu, do kterého se má certifikát nainstalovat.

Name	Typ	Description
currentuser	string	Certifikáty by se měly nainstalovat do úložiště certifikátů CurrentUser.
localmachine	string	Certifikáty by se měly nainstalovat do úložiště certifikátů LocalMachine.

CertificateVisibility

Které uživatelské účty na výpočetním uzlu by měly mít přístup k privátním datům certifikátu.

Name	Typ	Description
remoteuser	string	Certifikát by měl být viditelný pro uživatelské účty, pod kterými uživatelé vzdáleně přistupují k výpočetnímu uzlu.
starttask	string	Certifikát by měl být viditelný pro uživatelský účet, pod kterým se spouští StartTask. Všimněte si, že pokud je obor automatického uživatele fond pro startTask i úkol, bude tento certifikát viditelný i pro úkol.
task	string	Certifikát by měl být viditelný pro uživatelské účty, pod kterými se spouští úlohy.

ComputeNode

Výpočetní uzel ve službě Batch.

Name	Typ	Description
affinityId	string	Identifikátor, který lze předat při přidávání úkolu, který požaduje naplánování úkolu na tomto výpočetním uzlu. Všimněte si, že je to jen měkké spřažení. Pokud je cílový výpočetní uzel v době, kdy je úkol naplánovaný, zaneprázdněný nebo nedostupný, pak se úkol naplánuje jinde.
allocationTime	string	Čas, kdy byl tento výpočetní uzel přidělen fondu. Jedná se o čas, kdy byl výpočetní uzel původně přidělen a po nastavení se nezmění. Neaktualizuje se, když je výpočetní uzel zhojený nebo zrušený službou.
certificateReferences	CertificateReference[]	Seznam certifikátů nainstalovaných na výpočetním uzlu. V případě uzlů Windows služba Batch nainstaluje certifikáty do zadaného úložiště a umístění certifikátů. V případě linuxových výpočetních uzlů jsou certifikáty uložené v adresáři v pracovním adresáři úlohy a proměnná prostředí AZ_BATCH_CERTIFICATES_DIR je předána úkolu, který se má dotazovat na toto umístění. V případě certifikátů s viditelností remoteUser se adresář certs vytvoří v domovském adresáři uživatele (např. /home/{uživatelské_jméno}/certs) a certifikáty se umístí do tohoto adresáře. Upozornění: Tato vlastnost je zastaralá a po únoru 2024 se odebere. Místo toho použijte rozšíření Azure KeyVault .
endpointConfiguration	ComputeNodeEndpointConfiguration	Konfigurace koncového bodu pro výpočetní uzel.
errors	ComputeNodeError[]	Seznam chyb, ke kterým aktuálně dochází u výpočetního uzlu.
id	string	ID výpočetního uzlu. Každému výpočetnímu uzlu, který je přidaný do fondu, se přiřadí jedinečné ID. Při každém odebrání výpočetního uzlu z fondu se odstraní všechny jeho místní soubory a ID se uvolní a může se znovu použít pro nové výpočetní uzly.
ipAddress	string	IP adresa, kterou můžou ostatní uzly používat ke komunikaci s tímto výpočetním uzlem. Každému výpočetnímu uzlu přidanému do fondu se přiřadí jedinečná IP adresa. Při každém odebrání výpočetního uzlu z fondu se odstraní všechny jeho místní soubory a IP adresa se uvolní a může se znovu použít pro nové výpočetní uzly.
isDedicated	boolean	Určuje, jestli je tento výpočetní uzel vyhrazeným výpočetním uzlem. Pokud je false, výpočetní uzel je výpočetní uzel spotové nebo s nízkou prioritou.
lastBootTime	string	Čas posledního spuštění výpočetního uzlu. Tato vlastnost nemusí být přítomná, pokud je výpočetní uzel ve stavu nepoužitelný.
nodeAgentInfo	NodeAgentInformation	Informace o verzi agenta výpočetního uzlu a času upgradu výpočetního uzlu na novou verzi Agent výpočetního uzlu služby Batch je program, který běží na každém výpočetním uzlu ve fondu a poskytuje na výpočetním uzlu možnost batch.
recentTasks	TaskInformation[]	Seznam úkolů, jejichž stav se nedávno změnil. Tato vlastnost je k dispozici pouze v případě, že byl na tomto výpočetním uzlu spuštěn alespoň jeden úkol od jeho přiřazení k fondu.
runningTaskSlotsCount	integer	Celkový počet slotů plánování používaných aktuálně spuštěnými úkoly úloh na výpočetním uzlu. Patří sem úkoly Správce úloh a běžné úkoly, ale ne Příprava úlohy, Uvolnění úlohy nebo Zahájení úkolů.
runningTasksCount	integer	Celkový počet aktuálně spuštěných úkolů úloh na výpočetním uzlu. Patří sem úkoly Správce úloh a běžné úkoly, ale ne Příprava úlohy, Uvolnění úlohy nebo Zahájení úkolů.
schedulingState	SchedulingState	Určuje, jestli je výpočetní uzel dostupný pro plánování úkolů.
startTask	StartTask	Úloha určená ke spuštění na výpočetním uzlu při připojování k fondu. Služba Batch bude opakovat úlohy při aktivaci operace obnovení na uzlu. Mezi příklady operací obnovení patří (mimo jiné) restartování uzlu, který není v pořádku, nebo zmizení výpočetního uzlu kvůli selhání hostitele. Opakování kvůli operacím obnovení jsou nezávislé na a nezapočítávají se do hodnoty maxTaskRetryCount. I když je hodnota maxTaskRetryCount 0, může dojít k internímu opakování kvůli operaci obnovení. Z tohoto důvodu by všechny úkoly měly být idempotentní. To znamená, že úlohy musí tolerovat přerušení a restartování bez poškození nebo duplicitních dat. Osvědčeným postupem pro dlouhotrvající úlohy je použít nějakou formu vytváření kontrolních bodů. V některých případech se startTask může znovu spustit, i když se výpočetní uzel nerestartoval. Zvláštní pozornost je třeba věnovat tomu, abyste se vyhnuli úlohám StartTasks, které vytvářejí přerušovaný proces nebo instalují nebo spouštějí služby z pracovního adresáře StartTask, protože to službě Batch zablokuje možnost znovu spustit startTask.
startTaskInfo	StartTaskInformation	Informace o spuštění StartTask na výpočetním uzlu.
state	ComputeNodeState	Aktuální stav výpočetního uzlu. Došlo k pozastavení spotového výpočetního uzlu nebo výpočetního uzlu s nízkou prioritou. Úkoly, které byly spuštěny na výpočetním uzlu, když byl zrušen, se přeplánují, jakmile bude k dispozici jiný výpočetní uzel.
stateTransitionTime	string	Čas, kdy výpočetní uzel vstoupil do aktuálního stavu.
totalTasksRun	integer	Celkový počet úkolů úloh dokončených na výpočetním uzlu Patří sem úkoly Správce úloh a běžné úkoly, ale ne Příprava úlohy, Uvolnění úlohy nebo Zahájení úkolů.
totalTasksSucceeded	integer	Celkový počet úloh, které se úspěšně dokončily (s ukončovacím kódem 0) na výpočetním uzlu. Patří sem úkoly Správce úloh a běžné úkoly, ale ne Příprava úlohy, Uvolnění úlohy nebo Zahájení úkolů.
url	string	Adresa URL výpočetního uzlu.
virtualMachineInfo	VirtualMachineInfo	Informace o aktuálním stavu virtuálního počítače
vmSize	string	Velikost virtuálního počítače, který je hostitelem výpočetního uzlu. Informace o dostupných velikostech virtuálních počítačů ve fondech najdete v tématu Volba velikosti virtuálního počítače pro výpočetní uzly v Azure Batch fondu (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

ComputeNodeEndpointConfiguration

Konfigurace koncového bodu pro výpočetní uzel.

Name	Typ	Description
inboundEndpoints	InboundEndpoint[]	Seznam příchozích koncových bodů, které jsou přístupné na výpočetním uzlu.

ComputeNodeError

Došlo k chybě výpočetního uzlu.

Name	Typ	Description
code	string	Identifikátor chyby výpočetního uzlu. Kódy jsou neutrální a mají být využívány programově.
errorDetails	NameValuePair[]	Seznam dalších podrobností o chybách souvisejících s chybou výpočetního uzlu
message	string	Zpráva popisující chybu výpočetního uzlu, která má být vhodná pro zobrazení v uživatelském rozhraní.

ComputeNodeIdentityReference

Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude výpočetní uzel používat.

Name	Typ	Description
resourceId	string	ID prostředku ARM identity přiřazené uživatelem.

ComputeNodeListResult

Výsledek výpisu výpočetních uzlů ve fondu.

Name	Typ	Description
odata.nextLink	string	Adresa URL pro získání další sady výsledků
value	ComputeNode[]	Seznam výpočetních uzlů.

ComputeNodeState

Aktuální stav výpočetního uzlu.

Name	Typ	Description
creating	string	Služba Batch získala základní virtuální počítač z Azure Compute, ale ještě se nezačala připojovat k fondu.
idle	string	Na výpočetním uzlu není aktuálně spuštěný úkol.
leavingpool	string	Výpočetní uzel opouští fond, a to buď proto, že ho uživatel explicitně odebral, nebo proto, že fond provádí změnu velikosti nebo automatické vertikální snížení kapacity.
offline	string	Na výpočetním uzlu aktuálně není spuštěný úkol a plánování nových úkolů do výpočetního uzlu je zakázané.
preempted	string	Došlo k pozastavení spotového výpočetního uzlu nebo výpočetního uzlu s nízkou prioritou. Úkoly, které byly spuštěny na výpočetním uzlu, když byl zrušen, se přeplánují, jakmile bude k dispozici jiný výpočetní uzel.
rebooting	string	Výpočetní uzel se restartuje.
reimaging	string	Výpočetní uzel se znovu namíslí.
running	string	Na výpočetním uzlu běží jeden nebo více úkolů (kromě StartTask).
starting	string	Služba Batch se spouští na základním virtuálním počítači.
starttaskfailed	string	StartTask selhal na výpočetním uzlu (a vyčerpala všechna opakování) a je nastavená hodnota waitForSuccess. Výpočetní uzel není použitelný pro spouštění úkolů.
unknown	string	Služba Batch ztratila kontakt s výpočetním uzlem a nezná jeho skutečný stav.
unusable	string	Výpočetní uzel nejde použít ke spuštění úlohy kvůli chybám.
waitingforstarttask	string	StartTask začal běžet na výpočetním uzlu, ale je nastavený parametr waitForSuccess a startTask se ještě nedokončil.

ContainerRegistry

Privátní registr kontejneru.

Name	Typ	Description
identityReference	ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem, která se použije pro přístup k Azure Container Registry místo uživatelského jména a hesla. Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude výpočetní uzel používat.
password	string	Heslo pro přihlášení k serveru registru.
registryServer	string	Adresa URL registru. Pokud ho vynecháte, výchozí hodnota je "docker.io".
username	string	Uživatelské jméno pro přihlášení k serveru registru.

ContainerWorkingDirectory

Umístění pracovního adresáře úloh kontejneru.

Name	Typ	Description
containerImageDefault	string	Použijte pracovní adresář definovaný v imagi kontejneru. Mějte na pozoru, že tento adresář nebude obsahovat soubory prostředků stažené službou Batch.
taskWorkingDirectory	string	Použijte standardní pracovní adresář úkolů služby Batch, který bude obsahovat soubory zdrojů úkolů naplněné službou Batch.

ElevationLevel

Úroveň zvýšení oprávnění uživatele.

Name	Typ	Description
admin	string	Uživatel je uživatel se zvýšeným přístupem a pracuje s úplnými oprávněními správce.
nonadmin	string	Uživatel je standardní uživatel bez zvýšeného přístupu.

EnvironmentSetting

Proměnná prostředí, která se má nastavit v procesu úlohy.

Name	Typ	Description
name	string	Název proměnné prostředí.
value	string	Hodnota proměnné prostředí.

ErrorCategory

Kategorie chyby.

Name	Typ	Description
servererror	string	Příčinou této chyby je interní problém se serverem.
usererror	string	Příčinou chyby je problém s uživatelem, například chybná konfigurace.

ErrorMessage

Chybová zpráva přijatá v Azure Batch chybovou odpověď.

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy

ImageReference

Odkaz na image Azure Virtual Machines Marketplace nebo image Azure Compute Gallery. Pokud chcete získat seznam všech odkazů Azure Marketplace Image ověřených Azure Batch, projděte si operaci Výpis podporovaných imagí.

Name	Typ	Description
exactVersion	string	Konkrétní verze image platformy nebo image z Marketplace, která se použila k vytvoření uzlu. Toto pole jen pro čtení se liší od pole version pouze v případě, že hodnota zadaná pro "version" při vytvoření fondu byla "latest".
offer	string	Typ nabídky image Azure Virtual Machines Marketplace. Například UbuntuServer nebo WindowsServer.
publisher	string	Vydavatel image Azure Virtual Machines Marketplace. Například Canonical nebo MicrosoftWindowsServer.
sku	string	Skladová položka image Azure Virtual Machines Marketplace. Například 18.04-LTS nebo 2019-Datacenter.
version	string	Verze image Azure Virtual Machines Marketplace. Je možné zadat hodnotu "latest" pro výběr nejnovější verze image. Pokud ho vynecháte, výchozí hodnota je "latest".
virtualMachineImageId	string	Identifikátor prostředku ARM image Azure Compute Gallery. Výpočetní uzly ve fondu se vytvoří pomocí tohoto ID image. Má formát /subscriptions/{id_předplatného}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{Id_verze} nebo /subscriptions/{id_předplatného}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} pro vždy nastavenou nejnovější verzi image. Tato vlastnost se vzájemně vylučuje s jinými ImageReference vlastnosti. Image Azure Compute Gallery musí mít repliky ve stejné oblasti a musí být ve stejném předplatném jako účet Azure Batch. Pokud v identifikátoru imageId není uvedená verze image, použije se nejnovější verze. Informace o nastavení brány firewall pro komunikaci agenta Výpočetního uzlu služby Batch se službou Batch najdete v tématu https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpoint

Příchozí koncový bod na výpočetním uzlu.

Name	Typ	Description
backendPort	integer	Číslo back-endového portu koncového bodu.
frontendPort	integer	Číslo veřejného portu koncového bodu.
name	string	Název koncového bodu.
protocol	InboundEndpointProtocol	Protokol koncového bodu.
publicFQDN	string	Veřejný plně kvalifikovaný název domény pro výpočetní uzel.
publicIPAddress	string	Veřejná IP adresa výpočetního uzlu.

InboundEndpointProtocol

Protokol koncového bodu.

Name	Typ	Description
tcp	string	Jako koncový bod použijte protokol TCP.
udp	string	Jako koncový bod použijte UDP.

NameValuePair

Představuje dvojici název-hodnota.

Name	Typ	Description
name	string	Název ve dvojici název-hodnota.
value	string	Hodnota ve dvojici název-hodnota.

NodeAgentInformation

Informace o agentu výpočetního uzlu.

Name	Typ	Description
lastUpdateTime	string	Čas aktualizace agenta výpočetního uzlu na výpočetním uzlu. Jedná se o poslední čas aktualizace agenta výpočetního uzlu na novou verzi.
version	string	Verze agenta výpočetního uzlu služby Batch spuštěného na výpočetním uzlu. Toto číslo verze je možné zkontrolovat v poznámkách k verzi agenta Compute Node, které najdete na adrese https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.

ResourceFile

Jeden soubor nebo více souborů ke stažení do výpočetního uzlu

Name	Typ	Description
autoStorageContainerName	string	Název kontejneru úložiště v účtu automatického úložiště. Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a jedna z nich musí být zadána.
blobPrefix	string	Předpona objektu blob, která se má použít při stahování objektů blob z kontejneru Azure Storage. Stáhnou se jenom objekty blob, jejichž názvy začínají zadanou předponou. Vlastnost je platná pouze při použití autoStorageContainerName nebo storageContainerUrl. Tato předpona může být částečný název souboru nebo podadresář. Pokud není předpona zadána, stáhnou se všechny soubory v kontejneru.
fileMode	string	Atribut režimu oprávnění k souboru v osmičkovém formátu. Tato vlastnost se vztahuje pouze na soubory stahované do výpočetních uzlů s Linuxem. Pokud je zadaný pro resourceFile, který se stáhne do výpočetního uzlu Windows, bude ignorován. Pokud tato vlastnost není pro výpočetní uzel s Linuxem zadaná, použije se pro soubor výchozí hodnota 0770.
filePath	string	Umístění na výpočetním uzlu, do kterého se mají stáhnout soubory, vzhledem k pracovnímu adresáři úlohy. Pokud je zadána vlastnost httpUrl, filePath je povinný a popisuje cestu, do které bude soubor stažen, včetně názvu souboru. Jinak pokud je zadána vlastnost autoStorageContainerName nebo storageContainerUrl, filePath je nepovinný a je adresář ke stažení souborů do. V případě použití filePath jako adresáře se veškerá adresářová struktura, která je již přidružená ke vstupním datům, zachovají v plném rozsahu a připojí se k zadanému adresáři filePath. Zadaná relativní cesta nemůže být oddělena od pracovního adresáře úlohy (například pomocí ..).
httpUrl	string	Adresa URL souboru, který chcete stáhnout. Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a jedna z nich musí být zadána. Pokud adresa URL odkazuje na Azure Blob Storage, musí být čitelná z výpočetních uzlů. Existují tři způsoby, jak získat takovou adresu URL pro objekt blob ve službě Azure Storage: patří sdílený přístupový podpis (SAS) udělující oprávnění ke čtení objektu blob, použití spravované identity s oprávněním ke čtení nebo nastavení seznamu ACL pro objekt blob nebo jeho kontejner tak, aby umožňoval veřejný přístup.
identityReference	ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem, která se má použít pro přístup k Azure Blob Storage určené pomocí storageContainerUrl nebo httpUrl Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude používat výpočetní uzel.
storageContainerUrl	string	Adresa URL kontejneru objektů blob v rámci Azure Blob Storage. Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a jedna z nich musí být zadána. Tato adresa URL musí být čitelná a vypsatelná z výpočetních uzlů. Existují tři způsoby, jak takovou adresu URL pro kontejner ve službě Azure Storage získat: můžete zahrnout sdílený přístupový podpis (SAS) udělující oprávnění ke čtení a seznamu v kontejneru, použít spravovanou identitu s oprávněními ke čtení a seznamu seznamů nebo nastavit seznam ACL pro kontejner tak, aby umožňoval veřejný přístup.

SchedulingState

Určuje, jestli je výpočetní uzel dostupný pro plánování úkolů.

Name	Typ	Description
disabled	string	Na výpočetním uzlu se nebudou plánovat žádné nové úkoly. Úkoly, které už jsou spuštěné na výpočetním uzlu, můžou přesto běžet až do konce. Všechny výpočetní uzly začínají s povoleným plánováním.
enabled	string	Úkoly je možné naplánovat na výpočetním uzlu.

StartTask

Úloha, která se spustí, když se uzel připojí k fondu ve službě Azure Batch nebo když se výpočetní uzel restartuje nebo znovu z image.

Name	Typ	Description
commandLine	string	Příkazový řádek StartTask. Příkazový řádek se nespouští v prostředí, a proto nemůže využívat funkce prostředí, jako je rozšíření proměnné prostředí. Pokud chcete tyto funkce využít, měli byste vyvolat prostředí v příkazovém řádku, například pomocí příkazu "cmd /c MyCommand" ve Windows nebo "/bin/sh -c MyCommand" v Linuxu. Pokud příkazový řádek odkazuje na cesty k souborům, měl by použít relativní cestu (vzhledem k pracovnímu adresáři úkolů) nebo proměnnou prostředí poskytnutou službou Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	Nastavení pro kontejner, pod kterým se spouští StartTask. Při zadání se všechny adresáře rekurzivně pod AZ_BATCH_NODE_ROOT_DIR (kořen Azure Batch adresářů na uzlu) namapují do kontejneru, všechny proměnné prostředí task se mapují do kontejneru a příkazový řádek Task se spustí v kontejneru. Soubory vytvořené v kontejneru mimo AZ_BATCH_NODE_ROOT_DIR se nemusí projevit na disku hostitele, což znamená, že rozhraní API pro soubory služby Batch nebudou mít k těmto souborům přístup.
environmentSettings	EnvironmentSetting[]	Seznam nastavení proměnných prostředí pro StartTask.
maxTaskRetryCount	integer	Maximální počet pokusů o opakování úkolu Služba Batch opakuje úlohu, pokud je její ukončovací kód nenulový. Všimněte si, že tato hodnota konkrétně řídí počet opakovaných pokusů. Služba Batch tuto úlohu jednou vyzkouší a pak to může opakovat až do tohoto limitu. Pokud je například maximální počet opakování 3, služba Batch zkouší úlohu až 4krát (jeden počáteční pokus a 3 opakování). Pokud je maximální počet opakování 0, služba Batch úlohu opakovat nebude. Pokud je maximální počet opakování -1, služba Batch opakuje úlohu bez omezení, ale nedoporučuje se to pro spouštěcí úkol ani žádný úkol. Výchozí hodnota je 0 (bez opakování).
resourceFiles	ResourceFile[]	Seznam souborů, které služba Batch stáhne do výpočetního uzlu před spuštěním příkazového řádku. Pro seznam souborů prostředků platí maximální velikost. Při překročení maximální velikosti požadavek selže a kód chyby odpovědi bude RequestEntityTooLarge. Pokud k tomu dojde, musí se zmenšit velikost kolekce ResourceFiles. Toho můžete dosáhnout pomocí souborů .zip, balíčků aplikací nebo kontejnerů Dockeru. Soubory uvedené v tomto prvku jsou umístěny v pracovním adresáři úlohy.
userIdentity	UserIdentity	Identita uživatele, pod kterou běží StartTask. Pokud tento parametr vynecháte, spustí se úloha jako uživatel bez oprávnění správce, který je pro úlohu jedinečný.
waitForSuccess	boolean	Zda má služba Batch čekat na úspěšné dokončení startTask (tj. na ukončení s ukončovacím kódem 0) před plánováním úkolů na výpočetním uzlu. Pokud je hodnota true a startTask selže na uzlu, služba Batch opakuje startTask až do maximálního počtu opakování (maxTaskRetryCount). Pokud se úkol ani po všech opakováních úspěšně nedokončil, služba Batch označí uzel jako nepoužitelný a neplánuje na něj úkoly. Tuto podmínku je možné zjistit prostřednictvím podrobností o stavu výpočetního uzlu a informací o selhání. Pokud je false, služba Batch nebude čekat na dokončení StartTask. V takovém případě se na výpočetním uzlu můžou spustit další úkoly, zatímco startTask je stále spuštěný. a i když startTask selže, budou se nové úkoly dál plánovat na výpočetním uzlu. Výchozí hodnota je true.

StartTaskInformation

Informace o startTask spuštěném na výpočetním uzlu

Name	Typ	Description
containerInfo	TaskContainerExecutionInformation	Informace o kontejneru, ve kterém se úloha spouští. Tato vlastnost je nastavena pouze v případě, že úloha běží v kontextu kontejneru.
endTime	string	Čas, kdy startTask přestal běžet. Toto je čas ukončení posledního spuštění StartTask, pokud se toto spuštění dokončilo (i když se toto spuštění nezdařilo a opakování čeká na vyřízení). Tento prvek není k dispozici, pokud startTask je aktuálně spuštěna.
exitCode	integer	Ukončovací kód programu zadaný na příkazovém řádku StartTask. Tato vlastnost je nastavena pouze v případě, že startTask je v dokončeném stavu. Obecně platí, že ukončovací kód procesu odráží konkrétní konvenci implementovanou vývojářem aplikace pro daný proces. Pokud k rozhodování v kódu použijete hodnotu ukončovacího kódu, ujistěte se, že znáte konvenci ukončovacího kódu používanou procesem aplikace. Pokud však služba Batch ukončí startTask (kvůli vypršení časového limitu nebo ukončení uživatele prostřednictvím rozhraní API), může se zobrazit ukončovací kód definovaný operačním systémem.
failureInfo	TaskFailureInformation	Informace popisující selhání úlohy, pokud existuje. Tato vlastnost je nastavena pouze v případě, že je úloha v dokončeném stavu a došlo k selhání.
lastRetryTime	string	Poslední čas, kdy se spustilo opakování úlohy. Tento prvek je k dispozici pouze v případě, že byl pokus o opakování úkolu (tj. retryCount je nenulový). Pokud je k dispozici, obvykle je to stejné jako startTime, ale může se lišit, pokud úloha byla restartována z jiných důvodů než opakování; Pokud například došlo k restartování výpočetního uzlu během opakování, čas spuštění se aktualizuje, ale hodnota lastRetryTime nikoli.
result	TaskExecutionResult	Výsledek spuštění úlohy. Pokud je hodnota "failed", podrobnosti o selhání najdete ve vlastnosti failureInfo.
retryCount	integer	Kolikrát služba Batch úlohu zopakovala. Selhání aplikace úloh (nenulový ukončovací kód) se opakují, dojde k chybám předběžného zpracování (úloha se nedá spustit) a chyby odeslání souboru se neopakují. Služba Batch zopakuje úlohu až do limitu určeného omezeními.
startTime	string	Čas, kdy startTask začal běžet. Tato hodnota se resetuje při každém restartování nebo opakování úlohy (to znamená, že se jedná o poslední čas, kdy se startTask spustil).
state	StartTaskState	Stav StartTask na výpočetním uzlu.

StartTaskState

Stav startTask na výpočetním uzlu.

Name	Typ	Description
completed	string	StartTask se ukončil s ukončovacím kódem 0, nebo došlo k selhání startTask a dosažení limitu opakování nebo se proces StartTask nespustí kvůli chybám přípravy úlohy (například kvůli selhání stahování souboru prostředků).
running	string	StartTask je aktuálně spuštěný.

TaskContainerExecutionInformation

Obsahuje informace o kontejneru, který úloha provádí.

Name	Typ	Description
containerId	string	ID kontejneru.
error	string	Podrobné informace o chybě o kontejneru Toto je podrobný řetězec chyby ze služby Dockeru, pokud je k dispozici. Je ekvivalentní chybovému poli, které vrátil docker inspect.
state	string	Stav kontejneru. Toto je stav kontejneru podle služby Dockeru. Je ekvivalentní poli stavu, které vrátil docker inspect.

TaskContainerSettings

Nastavení kontejneru pro úlohu.

Name	Typ	Description
containerRunOptions	string	Další možnosti příkazu container create Tyto další možnosti jsou kromě možností řízených službou Batch k dispozici jako argumenty příkazu docker create.
imageName	string	Image, která se má použít k vytvoření kontejneru, ve kterém bude úloha spuštěna. Toto je úplný odkaz na image, který by byl zadán pro "docker pull". Pokud jako součást názvu obrázku není uvedena žádná značka, použije se jako výchozí značka ":latest".
registry	ContainerRegistry	Privátní registr, který obsahuje image kontejneru. Toto nastavení je možné vynechat, pokud už jste ho zadali při vytváření fondu.
workingDirectory	ContainerWorkingDirectory	Umístění pracovního adresáře úloh kontejneru. Výchozí hodnota je taskWorkingDirectory.

TaskExecutionInformation

Informace o provádění úlohy.

Name	Typ	Description
containerInfo	TaskContainerExecutionInformation	Informace o kontejneru, ve kterém se úloha spouští. Tato vlastnost je nastavena pouze v případě, že úloha běží v kontextu kontejneru.
endTime	string	Čas dokončení úkolu. Tato vlastnost je nastavena pouze v případě, že úkol je ve stavu Dokončeno.
exitCode	integer	Ukončovací kód programu zadaný na příkazovém řádku úlohy. Tato vlastnost je nastavena pouze v případě, že úkol je ve stavu dokončeno. Obecně platí, že ukončovací kód procesu odráží konkrétní konvenci implementovanou vývojářem aplikace pro tento proces. Pokud k rozhodování v kódu použijete hodnotu ukončovacího kódu, ujistěte se, že znáte konvenci ukončovacího kódu používanou procesem aplikace. Pokud však služba Batch úlohu ukončí (kvůli vypršení časového limitu nebo ukončení uživatele prostřednictvím rozhraní API), může se zobrazit ukončovací kód definovaný operačním systémem.
failureInfo	TaskFailureInformation	Informace popisující selhání úlohy, pokud existuje. Tato vlastnost je nastavena pouze v případě, že úkol je v dokončeném stavu a došlo k selhání.
lastRequeueTime	string	Poslední čas, kdy služba Batch znovu zavedla úlohu do fronty jako výsledek požadavku uživatele. Tato vlastnost je nastavena pouze v případě, že hodnota requeueCount není nenulová.
lastRetryTime	string	Poslední čas, kdy se spustilo opakování úlohy. Tento prvek je k dispozici pouze v případě, že byl úkol zopakován (tj. retryCount není nenulový). Pokud je k dispozici, je to obvykle stejné jako startTime, ale může se lišit, pokud úloha byla restartována z jiných důvodů než opakování; Pokud se například během opakování restartoval výpočetní uzel, aktualizuje se čas startTime, ale hodnota lastRetryTime ne.
requeueCount	integer	Počet opětovného zařazení úlohy do fronty službou Batch v důsledku požadavku uživatele. Když uživatel odebere výpočetní uzly z fondu (změnou velikosti nebo zmenšením fondu) nebo když je úloha zakázaná, může určit, že spuštěné úlohy na výpočetních uzlech se mají znovu spustit. Tento počet sleduje, kolikrát byla úloha z těchto důvodů znovu zadaná do fronty.
result	TaskExecutionResult	Výsledek provedení úlohy. Pokud je hodnota "failed", podrobnosti o selhání lze najít ve vlastnosti failureInfo.
retryCount	integer	Počet opakování úlohy službou Batch. Neúspěšné aplikace úloh (nenulový ukončovací kód) se opakují, chyby předběžného zpracování (úlohu nelze spustit) a chyby nahrávání souborů se neopakují. Služba Batch bude úlohu opakovat až do limitu určeného omezeními.
startTime	string	Čas, kdy úloha začala běžet. Hodnota Spuštěno odpovídá stavu spuštění, takže pokud úloha určuje soubory prostředků nebo balíčky, pak čas spuštění odráží čas, kdy úloha začala tyto soubory stahovat nebo nasazovat. Pokud se úloha restartovala nebo se zopakovala, jedná se o poslední čas, kdy se úloha spustila. Tato vlastnost je k dispozici pouze pro úlohy, které jsou ve spuštěném nebo dokončeném stavu.

TaskExecutionResult

Výsledek spuštění úlohy.

Name	Typ	Description
failure	string	Při zpracování úlohy došlo k chybě. K selhání mohlo dojít před spuštěním procesu úkolu, během provádění procesu úkolu nebo po ukončení procesu úkolu.
success	string	Úloha se úspěšně spustila.

TaskFailureInformation

Informace o selhání úlohy

Name	Typ	Description
category	ErrorCategory	Kategorie chyby Úlohy.
code	string	Identifikátor chyby úlohy. Kódy jsou invariantní a mají být využívány programově.
details	NameValuePair[]	Seznam dalších podrobností souvisejících s chybou
message	string	Zpráva popisující chybu Úlohy, která má být vhodná pro zobrazení v uživatelském rozhraní.

TaskInformation

Informace o úkolu spuštěném na výpočetním uzlu

Name	Typ	Description
executionInfo	TaskExecutionInformation	Informace o provádění úlohy.
jobId	string	ID úlohy, ke které úkol patří.
subtaskId	integer	ID dílčího úkolu, pokud se jedná o úkol s více instancemi.
taskId	string	ID úkolu.
taskState	TaskState	Aktuální stav úkolu.
taskUrl	string	Adresa URL úkolu.

TaskState

Stav úkolu.

Name	Typ	Description
active	string	Úloha je zařazená do fronty a může se spustit, ale aktuálně není přiřazená k výpočetnímu uzlu. Úloha přejde do tohoto stavu, když je vytvořena, když je povolena po zakázání nebo když čeká na opakování po neúspěšném spuštění.
completed	string	Úloha již není způsobilá ke spuštění, obvykle z důvodu úspěšného dokončení úlohy nebo neúspěšného dokončení a vyčerpání limitu opakování. Úkol je také označen jako dokončený, pokud při spouštění úlohy došlo k chybě nebo když byl úkol ukončen.
preparing	string	Úkol byl přiřazen výpočetnímu uzlu, ale čeká na dokončení požadovaného úkolu přípravy úlohy na výpočetním uzlu. Pokud je úkol přípravy úlohy úspěšný, přesune se do spuštěného úkolu. Pokud úkol přípravy úlohy selže, úkol se vrátí do aktivního a bude mít nárok na přiřazení k jinému výpočetnímu uzlu.
running	string	Úkol běží na výpočetním uzlu. To zahrnuje přípravu na úrovni úkolu, jako je stahování souborů prostředků nebo nasazení balíčků zadaných u úkolu – nemusí to nutně znamenat, že se spustil příkazový řádek úkolu.

UserIdentity

Definice identity uživatele, pod kterou je úloha spuštěna.

Name	Typ	Description
autoUser	AutoUserSpecification	Automatický uživatel, pod kterým je úloha spuštěna. Vlastnosti userName a autoUser se vzájemně vylučují; musíte zadat jeden, ale ne oba.
username	string	Název identity uživatele, pod kterou je úloha spuštěna. Vlastnosti userName a autoUser se vzájemně vylučují; musíte zadat jeden, ale ne oba.

VirtualMachineInfo

Informace o aktuálním stavu virtuálního počítače

Name	Typ	Description
imageReference	ImageReference	Odkaz na image virtuálního počítače Azure z Marketplace.
scaleSetVmResourceId	string	ID prostředku aktuálního virtuálního počítače škálovací sady virtuálních počítačů výpočetního uzlu. Definováno pouze v případě, že byl účet Batch vytvořen s vlastností poolAllocationMode nastavenou na hodnotu UserSubscription.