Pools - Replace Pool Properties

Aktualizuje vlastnosti zadaného Poolu.
Tím se plně nahrazují všechny aktualizovatelné vlastnosti Poolu. Například pokud má Pool přiřazený StartTask a StartTask není specifikován tímto požadavkem, pak dávková služba odstraní stávající StartTask.

POST {endpoint}/pools/{poolId}/updateproperties?api-version=2025-06-01
POST {endpoint}/pools/{poolId}/updateproperties?api-version=2025-06-01&timeOut={timeOut}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
path True

string (uri)

Koncový bod účtu Batch (například: https://batchaccount.eastus2.batch.azure.com).

poolId
path True

string

ID poolu pro aktualizaci.

api-version
query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.

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

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-rfc7231)

Č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

BatchApplicationPackageReference[]

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ů.

metadata True

BatchMetadataItem[]

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

BatchStartTask

Ú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.

Odpovědi

Name Typ Description
204 No Content

Pro tento požadavek se nedá odeslat žádný obsah, ale hlavičky můžou být užitečné.

Hlavičky

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

BatchError

Neočekávaná chybová odpověď

Zabezpečení

OAuth2Auth

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

Rozsahy

Name Description
https://batch.core.windows.net//.default

Příklady

Pool update

Ukázkový požadavek

POST {endpoint}/pools/poolId/updateproperties?api-version=2025-06-01



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

Ukázková odpověď

Definice

Name Description
AutoUserScope

AutoUserScope enums

AutoUserSpecification

Určuje možnosti automatického uživatele, který spouští úlohu Služby Azure Batch.

BatchApplicationPackageReference

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

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

BatchErrorMessage

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

BatchMetadataItem

Služba Batch nepřiřazuje k tomuto metadatu žádný význam; je výhradně pro použití uživatelského kódu.

BatchNodeIdentityReference

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

BatchPoolReplaceOptions

Parametry pro nahrazení vlastností ve fondu Azure Batch

BatchStartTask

Služba Batch bude opakovat úlohy, když se na uzlu aktivuje operace obnovení. Příklady operací obnovení zahrnují (ale nejsou omezené) při restartování uzlu, který není v pořádku, nebo výpočetní uzel zmizel kvůli selhání hostitele. Opakované pokusy z důvodu operací obnovení jsou nezávislé na hodnotě maxTaskRetryCount 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 úkoly musí tolerovat přerušení a restartování, aniž by to způsobilo poškození nebo duplicitní data. Osvědčeným postupem pro dlouhotrvající úlohy je použití určité formy 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. Je potřeba věnovat zvláštní pozornost tomu, aby se zabránilo spuštění startTasks, které vytvářejí odrušovací proces nebo instalují nebo spouštějí služby z pracovního adresáře StartTask, protože to službě Batch znemožní opětovné spuštění StartTask.

BatchTaskContainerSettings

Nastavení kontejneru pro úlohu.

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.

ContainerRegistryReference

Privátní registr kontejneru.

ContainerWorkingDirectory

ContainerWorkingDirectory enums

ElevationLevel

Enumy ElevationLevel

EnvironmentSetting

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

ResourceFile

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

UserIdentity

Definice identity uživatele, pod kterou je úloha spuštěna. Zadejte vlastnost userName nebo autoUser, ale ne obojí.

AutoUserScope

AutoUserScope enums

Hodnota Description
task

Specifikuje, že služba by měla vytvořit nového uživatele pro úkol.

pool

Specifikuje, že úkol běží jako společný automatický uživatelský účet, který je vytvořen na každém výpočetním uzlu v poolu.

AutoUserSpecification

Určuje možnosti automatického uživatele, který spouští úlohu Služby Azure Batch.

Name Typ Description
elevationLevel

ElevationLevel

Úroveň zvýšení oprávnění automatického uživatele Výchozí hodnota neníadmin.

scope

AutoUserScope

Obor pro 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. Například pokud úloha zmutuje registr způsobem, který by mohl mít vliv na jiné úlohy.

BatchApplicationPackageReference

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

Name Typ Description
applicationId

string

ID aplikace, kterou 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 je tento požadavek v Poolu vynechán a pro tuto aplikaci není určena výchozí verze, požadavek selže s chybovým kódem InvalidApplicationPackageReferences a HTTP stavovým kódem 409. Pokud je tato funkce v úlohe vynechána a není pro tuto aplikaci určena výchozí verze, úloha selže s chybou při předzpracování.

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

BatchErrorMessage

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.

BatchErrorMessage

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

Name Typ Description
lang

string

Jazykový kód chybové zprávy.

value

string

Text zprávy.

BatchMetadataItem

Služba Batch nepřiřazuje k tomuto metadatu žádný význam; je výhradně pro použití uživatelského kódu.

Name Typ Description
name

string

Název položky metadat.

value

string

Hodnota položky metadat.

BatchNodeIdentityReference

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 (arm-id)

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

BatchPoolReplaceOptions

Parametry pro nahrazení vlastností ve fondu Azure Batch

Name Typ Description
applicationPackageReferences

BatchApplicationPackageReference[]

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ů.

metadata

BatchMetadataItem[]

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

BatchStartTask

Ú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.

BatchStartTask

Služba Batch bude opakovat úlohy, když se na uzlu aktivuje operace obnovení. Příklady operací obnovení zahrnují (ale nejsou omezené) při restartování uzlu, který není v pořádku, nebo výpočetní uzel zmizel kvůli selhání hostitele. Opakované pokusy z důvodu operací obnovení jsou nezávislé na hodnotě maxTaskRetryCount 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 úkoly musí tolerovat přerušení a restartování, aniž by to způsobilo poškození nebo duplicitní data. Osvědčeným postupem pro dlouhotrvající úlohy je použití určité formy 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. Je potřeba věnovat zvláštní pozornost tomu, aby se zabránilo spuštění startTasks, které vytvářejí odrušovací proces nebo instalují nebo spouštějí služby z pracovního adresáře StartTask, protože to službě Batch znemožní opětovné spuštění StartTask.

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

BatchTaskContainerSettings

Nastavení kontejneru, pod kterým StartTask běží. Když je toto specifikováno, všechny adresáře rekurzivně pod AZ_BATCH_NODE_ROOT_DIR (kořen adresářů Azure Batch na uzlu) jsou namapovány do kontejneru, všechny proměnné prostředí Tasku jsou do kontejneru namapovány a příkazový řádek Úkolu se vykoná v kontejneru. Soubory vytvořené v kontejneru mimo AZ_BATCH_NODE_ROOT_DIR nemusí být zobrazeny na hostitelském disku, což znamená, že dávková API souborů k těmto souborům nebudou mít přístup.

environmentSettings

EnvironmentSetting[]

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

maxTaskRetryCount

integer (int32)

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 StartTask běží. Pokud je vynechán, Úkol běží jako neadministrátorský uživatel unikátní pro daný úkol.

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.

BatchTaskContainerSettings

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

Obrázek, který použijete k vytvoření kontejneru, ve kterém bude úkol běžet. Toto je úplná reference na Image, jak by bylo specifikováno pro "docker pull". Pokud není v názvu obrázku uveden žádný tag, používá se tag ":latest" jako výchozí.

registry

ContainerRegistryReference

Soukromý registr, který obsahuje obraz kontejneru. Toto nastavení lze vynechat, pokud bylo již při tvorbě Poolu k dispozici.

workingDirectory

ContainerWorkingDirectory

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

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.

Hodnota Description
Shared

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

Startup

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

VfsMounts

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

Task

Cesta k úkolu.

JobPrep

Cesta úkolu přípravy úlohy.

Applications

Cesta k aplikacím.

ContainerRegistryReference

Privátní registr kontejneru.

Name Typ Description
identityReference

BatchNodeIdentityReference

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.

password

string (password)

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

registryServer

string (uri)

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

ContainerWorkingDirectory enums

Hodnota Description
taskWorkingDirectory

Použijte standardní pracovní adresář Batch service Task Work, který bude obsahovat soubory Task Resource Files vyplněné Batchem.

containerImageDefault

Použijte pracovní adresář definovaný v kontejnerovém obrazu. Pozor, tento adresář nebude obsahovat soubory zdrojů stažené Batchem.

ElevationLevel

Enumy ElevationLevel

Hodnota Description
nonadmin

Uživatel je standardní uživatel bez zvýšeného přístupu.

admin

Uživatel je uživatel se zvýšeným přístupem a pracuje s úplnými oprávněními správce.

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í.

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 skladovacího kontejneru 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 stahované do Linux Compute Nodes. Bude ignorován, pokud je specifikován pro resource file, který bude stažen do Windows Compute Node. Pokud tato vlastnost není specifikována pro Linux Compute Node, je na soubor aplikována výchozí hodnota 0770.

filePath

string

Umístění na Compute Node, kam se soubor (soubory) stahují, vzhledem k pracovnímu adresáři úkolu. 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. Specifikovaná relativní cesta nemůže vystoupit z pracovního adresáře úkolu (například použitím '..').

httpUrl

string (uri)

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

BatchNodeIdentityReference

Odkaz na uživatelem přiřazenou identitu pro přístup k Azure Blob Storage specifikuje storageContainerUrl nebo httpUrl.

storageContainerUrl

string (uri)

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.

UserIdentity

Definice identity uživatele, pod kterou je úloha spuštěna. Zadejte vlastnost userName nebo autoUser, ale ne obojí.

Name Typ Description
autoUser

AutoUserSpecification

Automatický uživatel, pod kterým se úkol spouští. Vlastnosti userName a autoUser se vzájemně vylučují; musíte zadat jednu, ale ne obě.

username

string

Název uživatelské identity, pod kterou je úkol spuštěn. Vlastnosti userName a autoUser se vzájemně vylučují; musíte zadat jednu, ale ne obě.