Sdílet prostřednictvím


Pool - Update Properties

Aktualizuje vlastnosti zadaného fondu.
Tím se plně nahradí všechny aktualizovatelné vlastnosti fondu. Pokud má fond například přidružený startTask a není-li v tomto požadavku zadaný StartTask, služba Batch odebere existující startTask.

POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2024-07-01.20.0
POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2024-07-01.20.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 služby Azure Batch.

poolId
path True

string

ID fondu, který chcete aktualizovat.

api-version
query True

string

Verze rozhraní API klienta.

timeout
query

integer

int32

Maximální doba, po kterou může server strávit zpracováním požadavku v sekundách. Výchozí hodnota je 30 sekund. Pokud je hodnota větší než 30, použije se výchozí hodnota.

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, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Určuje, jestli má server v odpovědi vrátit ID požadavku klienta.

ocp-date

string

date-time-rfc1123

Čas vydání žádosti. Klientské knihovny obvykle nastavily aktuální systémový čas; explicitně ji nastavte, pokud voláte přímo rozhraní REST API.

Text požadavku

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

Name Vyžadováno Typ Description
applicationPackageReferences True

ApplicationPackageReference[]

Seznam balíčků aplikací, které se mají nainstalovat na každý výpočetní uzel ve fondu.
Seznam nahrazuje všechny existující odkazy na balíčky aplikací ve fondu. Změny odkazů na balíčky aplikací ovlivňují všechny nové výpočetní uzly připojující se k fondu, ale nemají vliv na výpočetní uzly, které už jsou ve fondu, dokud se nerestartují nebo nezomagí. V každém daném fondu je maximálně 10 odkazů na balíček aplikace. Pokud tuto hodnotu vynecháte nebo zadáte prázdnou kolekci, odeberou se z fondu všechny existující odkazy na balíčky aplikací. Pro daný fond lze zadat maximálně 10 odkazů.

certificateReferences True

CertificateReference[]

Seznam certifikátů, které se mají nainstalovat na každý výpočetní uzel ve fondu.
Tento seznam nahrazuje všechny existující odkazy na certifikáty nakonfigurované ve fondu. Pokud zadáte prázdnou kolekci, odeberou se z fondu všechny existující odkazy na certifikáty. Pro uzly Systému Windows služba Batch nainstaluje certifikáty do zadaného úložiště certifikátů a umístění. Pro výpočetní uzly s Linuxem jsou certifikáty uložené v adresáři v pracovním adresáři úlohy a proměnné prostředí, AZ_BATCH_CERTIFICATES_DIR je zadána do úlohy, která se má dotazovat na toto umístění. Pro certifikáty s viditelností remoteUser se vytvoří adresář certs v domovském adresáři uživatele (např. /home/{uživatelské jméno}/certs) a certifikáty v daném adresáři.

Upozornění: Tato vlastnost je zastaralá a bude odebrána po únoru 2024. Místo toho použijte rozšíření Azure KeyVault.

metadata True

MetadataItem[]

Seznam párů název-hodnota přidružených k fondu jako metadata.
Tento seznam nahrazuje všechna existující metadata nakonfigurovaná ve fondu. Pokud tuto hodnotu vynecháte nebo zadáte prázdnou kolekci, odeberou se z fondu všechna existující metadata.

startTask

StartTask

Úkol, který se má spustit na každém výpočetním uzlu, když se připojí k fondu. Úloha se spustí při přidání výpočetního uzlu do fondu nebo při restartování výpočetního uzlu.
Pokud je tento prvek k dispozici, přepíše všechny existující StartTask. Pokud tento parametr vynecháte, odeberou se z fondu všechny existující starttask.

targetNodeCommunicationMode

NodeCommunicationMode

Režim komunikace požadovaného uzlu pro fond.
Toto nastavení nahrazuje všechna existující nastavení targetNodeCommunication ve fondu. Pokud je tento parametr vynechán, je výchozí nastavení.

Odpovědi

Name Typ Description
204 No Content

Požadavek na službu Batch byl úspěšný.

Hlavičky

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

Chyba ze služby Batch.

Zabezpečení

azure_auth

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

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Authorization

Typ: apiKey
V: header

Příklady

Pool update

Ukázkový požadavek

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



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

Ukázková odpověď

Definice

Name Description
ApplicationPackageReference

Odkaz na balíček, který se má nasadit do výpočetních uzlů.

AutoUserScope

Obor automatického uživatele

AutoUserSpecification

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

BatchError

Odpověď na chybu přijatá ze služby Azure Batch

BatchErrorDetail

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch

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 ve výpočetním uzlu by měly mít přístup k privátním datům certifikátu.

ComputeNodeIdentityReference

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

ContainerHostBatchBindMountEntry

Vstup cesty a režimu připojení, který chcete připojit k kontejneru úloh.

ContainerHostDataPath

Cesty, které budou připojeny ke kontejneru úlohy kontejneru.

ContainerRegistry

Privátní registr kontejneru.

ContainerWorkingDirectory

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

ElevationLevel

Úroveň zvýšení úrovně uživatele

EnvironmentSetting

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

ErrorMessage

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

MetadataItem

Pár název-hodnota přidružený k prostředku služby Batch.

NodeCommunicationMode

Určuje, jak fond komunikuje se službou Batch.

PoolUpdatePropertiesParameter

Sada změn, které se mají provést ve fondu.

ResourceFile

Jeden soubor nebo více souborů, které se mají stáhnout do výpočetního uzlu.

StartTask

Úloha, která se spustí při připojení uzlu k fondu ve službě Azure Batch nebo při restartování nebo obnovení výpočetního uzlu.

TaskContainerSettings

Nastavení kontejneru pro úlohu.

UserIdentity

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

ApplicationPackageReference

Odkaz na balíček, který se má nasadit do výpočetních uzlů.

Name Typ Description
applicationId

string

ID aplikace, která se má nasadit.
Při vytváření fondu musí být ID aplikace balíčku plně kvalifikované (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).

version

string

Verze aplikace, která se má nasadit. Pokud tuto hodnotu vynecháte, nasadí se výchozí verze.
Pokud se tento parametr vynechá ve fondu a pro tuto aplikaci není zadána žádná výchozí verze, požadavek selže s kódem chyby InvalidApplicationPackageReferences a stavovým kódem HTTP 409. Pokud je tento parametr vynechán u úlohy a pro tuto aplikaci není zadána žádná výchozí verze, úloha selže s chybou předběžného zpracování.

AutoUserScope

Obor automatického uživatele

Name Typ Description
pool

string

Určuje, že úloha se spustí jako běž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 neníadmin.

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 Úlohy, pokud je vyžadována přísnější izolace mezi úlohami. Pokud například úloha ztlumí registr způsobem, který by mohl mít vliv na jiné úkoly, nebo pokud byly ve fondu zadány certifikáty, které by neměly být přístupné běžnými úkoly, ale měly by být přístupné nástrojem StartTasks.

BatchError

Odpověď na chybu přijatá ze služby Azure Batch

Name Typ Description
code

string

Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.

message

ErrorMessage

Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.

values

BatchErrorDetail[]

Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch

Name Typ Description
key

string

Identifikátor určující význam vlastnosti Value.

value

string

Další informace zahrnuté v odpovědi na chybu.

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é s výpočetními uzly Windows. Pro výpočetní uzly s Linuxem jsou certifikáty uložené v adresáři v pracovním adresáři úlohy a proměnné prostředí, AZ_BATCH_CERTIFICATES_DIR je zadána do úlohy, která se má dotazovat na toto umístění. Pro certifikáty s viditelností remoteUser se vytvoří adresář certs v domovském adresáři uživatele (např. /home/{uživatelské jméno}/certs) a certifikáty v daném adresáři.

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é s výpočetními uzly Windows. Mezi běžné názvy obchodů patří: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, ale můžete také použít jakýkoli vlastní název úložiště. Výchozí hodnota je My.

thumbprint

string

Kryptografický otisk certifikátu.

thumbprintAlgorithm

string

Algoritmus, ke kterému je kryptografický otisk přidružený. To musí být sha1.

visibility

CertificateVisibility[]

Které uživatelské účty ve 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 ve 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, ve kterých uživatelé vzdáleně přistupuje 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 fondem pro starttask i úlohu, bude tento certifikát viditelný i pro úlohu.

task

string

Certifikát by měl být viditelný pro uživatelské účty, ve kterých se spouští úlohy.

ComputeNodeIdentityReference

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

Name Typ Description
resourceId

string

ID prostředku ARM identity přiřazené uživatelem.

ContainerHostBatchBindMountEntry

Vstup cesty a režimu připojení, který chcete připojit k kontejneru úloh.

Name Typ Description
isReadOnly

boolean

Připojte tuto zdrojovou cestu jako režim jen pro čtení nebo ne. Výchozí hodnota je false (režim čtení a zápisu).
Pokud tuto cestu pro Linux připojíte jako režim pro čtení a zápis, neznamená to, že všichni uživatelé v kontejneru mají pro cestu přístup pro čtení a zápis, závisí na přístupu na hostitelském virtuálním počítači. Pokud je tato cesta připojená jen pro čtení, nebudou moct změnit cestu všichni uživatelé v kontejneru.

source

ContainerHostDataPath

Cestu, která se připojí k zákazníkovi kontejneru, může vybrat.

ContainerHostDataPath

Cesty, které budou připojeny ke kontejneru úlohy kontejneru.

Name Typ Description
Applications

string

Cesta k aplikacím.

JobPrep

string

Cesta úkolu přípravy úlohy.

Shared

string

Cesta pro úlohu s více instancemi ke sdílení souborů.

Startup

string

Cesta ke spouštěcímu úkolu.

Task

string

Cesta k úkolu.

VfsMounts

string

Cesta obsahuje všechny virtuální systémy souborů, které jsou připojené k tomuto uzlu.

ContainerRegistry

Privátní registr kontejneru.

Name Typ Description
identityReference

ComputeNodeIdentityReference

Odkaz na identitu přiřazenou uživatelem, která se má použít pro přístup ke službě 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 Batch, který bude používat výpočetní uzel.

password

string

Heslo pro přihlášení k serveru registru.

registryServer

string

Adresa URL registru.
Pokud tuto hodnotu 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 úlohy kontejneru.

Name Typ Description
containerImageDefault

string

Použijte pracovní adresář definovaný v imagi kontejneru. Mějte na pozor, že tento adresář nebude obsahovat soubory prostředků stažené službou Batch.

taskWorkingDirectory

string

Použijte standardní pracovní adresář úlohy služby Batch, který bude obsahovat soubory zdrojů úkolů naplněné službou Batch.

ElevationLevel

Úroveň zvýšení úrovně 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 úkolu.

Name Typ Description
name

string

Název proměnné prostředí.

value

string

Hodnota proměnné prostředí.

ErrorMessage

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

Name Typ Description
lang

string

Kód jazyka chybové zprávy

value

string

Text zprávy.

MetadataItem

Pár název-hodnota přidružený k prostředku služby Batch.

Name Typ Description
name

string

Název položky metadat.

value

string

Hodnota položky metadat.

NodeCommunicationMode

Určuje, jak fond komunikuje se službou Batch.

Name Typ Description
classic

string

Uzly používající klasický komunikační režim vyžadují příchozí komunikaci TCP na portech 29876 a 29877 z modulu BatchNodeManagement. Značka služby {region} a odchozí komunikace TCP na portu 443 s "Storage.region" a BatchNodeManagement. Značky služeb {region}.

default

string

Režim komunikace uzlu je automaticky nastaven službou Batch.

simplified

string

Uzly používající zjednodušený režim komunikace vyžadují odchozí komunikaci TCP na portu 443 s BatchNodeManagement. Značka služby {region}. Nejsou vyžadovány žádné otevřené příchozí porty.

PoolUpdatePropertiesParameter

Sada změn, které se mají provést ve fondu.

Name Typ Description
applicationPackageReferences

ApplicationPackageReference[]

Seznam balíčků aplikací, které se mají nainstalovat na každý výpočetní uzel ve fondu.
Seznam nahrazuje všechny existující odkazy na balíčky aplikací ve fondu. Změny odkazů na balíčky aplikací ovlivňují všechny nové výpočetní uzly připojující se k fondu, ale nemají vliv na výpočetní uzly, které už jsou ve fondu, dokud se nerestartují nebo nezomagí. V každém daném fondu je maximálně 10 odkazů na balíček aplikace. Pokud tuto hodnotu vynecháte nebo zadáte prázdnou kolekci, odeberou se z fondu všechny existující odkazy na balíčky aplikací. Pro daný fond lze zadat maximálně 10 odkazů.

certificateReferences

CertificateReference[]

Seznam certifikátů, které se mají nainstalovat na každý výpočetní uzel ve fondu.
Tento seznam nahrazuje všechny existující odkazy na certifikáty nakonfigurované ve fondu. Pokud zadáte prázdnou kolekci, odeberou se z fondu všechny existující odkazy na certifikáty. Pro uzly Systému Windows služba Batch nainstaluje certifikáty do zadaného úložiště certifikátů a umístění. Pro výpočetní uzly s Linuxem jsou certifikáty uložené v adresáři v pracovním adresáři úlohy a proměnné prostředí, AZ_BATCH_CERTIFICATES_DIR je zadána do úlohy, která se má dotazovat na toto umístění. Pro certifikáty s viditelností remoteUser se vytvoří adresář certs v domovském adresáři uživatele (např. /home/{uživatelské jméno}/certs) a certifikáty v daném adresáři.

Upozornění: Tato vlastnost je zastaralá a bude odebrána po únoru 2024. Místo toho použijte rozšíření Azure KeyVault.

metadata

MetadataItem[]

Seznam párů název-hodnota přidružených k fondu jako metadata.
Tento seznam nahrazuje všechna existující metadata nakonfigurovaná ve fondu. Pokud tuto hodnotu vynecháte nebo zadáte prázdnou kolekci, odeberou se z fondu všechna existující metadata.

startTask

StartTask

Úkol, který se má spustit na každém výpočetním uzlu, když se připojí k fondu. Úloha se spustí při přidání výpočetního uzlu do fondu nebo při restartování výpočetního uzlu.
Pokud je tento prvek k dispozici, přepíše všechny existující StartTask. Pokud tento parametr vynecháte, odeberou se z fondu všechny existující starttask.

targetNodeCommunicationMode

NodeCommunicationMode

Režim komunikace požadovaného uzlu pro fond.
Toto nastavení nahrazuje všechna existující nastavení targetNodeCommunication ve fondu. Pokud je tento parametr vynechán, je výchozí nastavení.

ResourceFile

Jeden soubor nebo více souborů, které se mají stáhnout 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 je nutné zadat jeden z nich.

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ým názvem souboru nebo podadresářem. Pokud předpona není zadaná, stáhnou se všechny soubory v kontejneru.

fileMode

string

Atribut režimu oprávnění souboru v osmičkovém formátu.
Tato vlastnost se vztahuje pouze na soubory, které se stahují do výpočetních uzlů Linuxu. Bude ignorován, pokud je zadán pro resourceFile, který se stáhne do výpočetního uzlu Windows. Pokud tato vlastnost není zadána pro výpočetní uzel Linuxu, použije se na soubor výchozí hodnota 0770.

filePath

string

Umístění na výpočetním uzlu, ke kterému chcete stáhnout soubory vzhledem k pracovnímu adresáři úlohy.
Pokud je zadána vlastnost httpUrl, je souborPath vyžadován a popisuje cestu, do které se soubor stáhne, včetně názvu souboru. Jinak je zadána vlastnost autoStorageContainerName nebo storageContainerUrl, filePath je nepovinný a je adresář ke stažení souborů. V případě, že se filePath používá jako adresář, všechny adresářové struktury, které jsou již přidruženy ke vstupním datům, se zachovají v plném rozsahu a připojí se k zadanému adresáři filePath. Zadaná relativní cesta nemůže rozdělit pracovní adresář úkolu (například pomocí ..).

httpUrl

string

Adresa URL souboru, který chcete stáhnout.
Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a je nutné zadat jeden z nich. 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 objektu blob v úložišti Azure: zahrnout sdílený přístupový podpis (SAS) udělující oprávnění ke čtení objektu blob, použít spravovanou identitu s oprávněním ke čtení nebo nastavit seznam ACL objektu blob nebo jeho kontejneru tak, aby umožňoval veřejný přístup.

identityReference

ComputeNodeIdentityReference

Odkaz na identitu přiřazenou uživatelem pro přístup ke službě Azure Blob Storage určené službou storageContainerUrl nebo httpUrl
Odkaz na identitu přiřazenou uživatelem přidruženou k fondu Batch, který bude používat výpočetní uzel.

storageContainerUrl

string

Adresa URL kontejneru objektů blob v rámci služby Azure Blob Storage.
Vlastnosti autoStorageContainerName, storageContainerUrl a httpUrl se vzájemně vylučují a je nutné zadat jeden z nich. Tato adresa URL musí být čitelná a vypisovatelná z výpočetních uzlů. Existují tři způsoby, jak získat takovou adresu URL kontejneru v úložišti Azure: zahrnutí sdíleného přístupového podpisu (SAS) udělujícího oprávnění ke čtení a seznamu v kontejneru, použití spravované identity s oprávněními ke čtení a seznamu nebo nastavení seznamu ACL pro kontejner tak, aby umožňoval veřejný přístup.

StartTask

Úloha, která se spustí při připojení uzlu k fondu ve službě Azure Batch nebo při restartování nebo obnovení výpočetního uzlu.

Name Typ Description
commandLine

string

Příkazový řádek StartTask.
Příkazový řádek se nespustí pod prostředím, 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í na 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 (relativní k pracovnímu adresáři úkolu) nebo použít proměnnou prostředí poskytovanou službou Batch (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

containerSettings

TaskContainerSettings

Nastavení kontejneru, pod kterým běží StartTask.
Po zadání se všechny adresáře rekurzivně pod AZ_BATCH_NODE_ROOT_DIR (kořen adresářů Azure Batch na uzlu) mapují do kontejneru, všechny proměnné prostředí úloh se mapují do kontejneru a v kontejneru se spustí příkazový řádek úkolu. Soubory vytvořené v kontejneru mimo AZ_BATCH_NODE_ROOT_DIR se nemusí projevit na hostitelském disku, což znamená, že rozhraní API souborů batch nebudou mít přístup k těmto souborům.

environmentSettings

EnvironmentSetting[]

Seznam nastavení proměnných prostředí pro StartTask

maxTaskRetryCount

integer

Maximální počet opakování úkolu.
Služba Batch opakuje úlohu, pokud je jeho ukončovací kód nenulový. Všimněte si, že tato hodnota konkrétně řídí počet opakování. Služba Batch zkusí úlohu jednou a může to zkusit znovu až do tohoto limitu. Pokud je například maximální počet opakování 3, služba Batch se pokusí úkol opakovat až 4krát (jeden počáteční pokus a 3 opakování). Pokud je maximální počet opakování 0, služba Batch nezopakuje úlohu. Pokud je maximální počet opakování -1, služba Batch opakuje úkol bez omezení, ale nedoporučuje se to pro spouštěcí úkol ani žádný úkol. Výchozí hodnota je 0 (žádné 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. Seznam souborů prostředků má 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í být kolekce ResourceFiles zmenšena velikostí. Toho lze dosáhnout pomocí .zip souborů, balíčků aplikací nebo kontejnerů Dockeru.
Soubory uvedené v tomto prvku jsou umístěny v pracovním adresáři úkolu.

userIdentity

UserIdentity

Identita uživatele, pod kterou se spouští StartTask.
Pokud tento parametr vynecháte, úloha se spustí jako uživatel, který není správcem, který je pro úlohu jedinečný.

waitForSuccess

boolean

Jestli má služba Batch čekat na úspěšné dokončení startTask (tj. ukončit s ukončovacím kódem 0) před naplánování všech úkolů na výpočetním uzlu.
Pokud hodnota true a StartTask selže na uzlu, služba Batch opakuje hodnotu StartTask až do maximálního počtu opakování (maxTaskRetryCount). Pokud se úkol po všech opakováních úspěšně nedokončil, služba Batch označí nepoužitelný uzel a nenaplánuje do něj úkoly. Tuto podmínku lze zjistit prostřednictvím podrobností o stavu výpočetního uzlu a informacích o selhání. Pokud je false, služba Batch nebude čekat na dokončení startTask. V tomto případě se na výpočetním uzlu můžou spustit jiné úlohy, zatímco startTask je stále spuštěný; a i když startTask selže, budou nové úlohy i nadále naplánované na výpočetním uzlu. Výchozí hodnota je true.

TaskContainerSettings

Nastavení kontejneru pro úlohu.

Name Typ Description
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

Cesty, které chcete připojit k úloze kontejneru.
Pokud je toto pole null nebo není k dispozici, úloha kontejneru připojí celou dočasnou diskovou jednotku ve Windows (nebo AZ_BATCH_NODE_ROOT_DIR v Linuxu). Pokud je toto pole nastavené jako prázdné, nepřipoje do kontejneru žádné cesty k datům.

containerRunOptions

string

Další možnosti příkazu create kontejneru
Tyto další možnosti se předávají jako argumenty příkazu "docker create" kromě těch, které řídí služba Batch.

imageName

string

Image, která se má použít k vytvoření kontejneru, ve kterém se úloha spustí.
Toto je úplný odkaz na image, jak by bylo určeno k "docker pull". Pokud v názvu image není k dispozici žá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ž bylo k dispozici při vytváření fondu.

workingDirectory

ContainerWorkingDirectory

Umístění pracovního adresáře úlohy kontejneru.
Výchozí hodnota je taskWorkingDirectory.

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 jednu, ale ne obě.

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 jednu, ale ne obě.