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 |
---|---|---|---|---|
batch
|
path | True |
string |
Základní adresa URL pro všechny požadavky služby Azure Batch. |
pool
|
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 |
Seznam balíčků aplikací, které se mají nainstalovat na každý výpočetní uzel ve fondu. |
|
certificateReferences | True |
Seznam certifikátů, které se mají nainstalovat na každý výpočetní uzel ve fondu. Upozornění: Tato vlastnost je zastaralá a bude odebrána po únoru 2024. Místo toho použijte |
|
metadata | True |
Seznam párů název-hodnota přidružených k fondu jako metadata. |
|
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. |
||
targetNodeCommunicationMode |
Režim komunikace požadovaného uzlu pro fond. |
Odpovědi
Name | Typ | Description |
---|---|---|
204 No Content |
Požadavek na službu Batch byl úspěšný. Hlavičky
|
|
Other Status Codes |
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 |
---|---|
Application |
Odkaz na balíček, který se má nasadit do výpočetních uzlů. |
Auto |
Obor automatického uživatele |
Auto |
Určuje parametry pro automatického uživatele, který spouští úlohu ve službě Batch. |
Batch |
Odpověď na chybu přijatá ze služby Azure Batch |
Batch |
Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch |
Certificate |
Odkaz na certifikát, který se má nainstalovat na výpočetní uzly ve fondu. |
Certificate |
Umístění úložiště certifikátů na výpočetním uzlu, do kterého se má certifikát nainstalovat. |
Certificate |
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. |
Compute |
Odkaz na identitu přiřazenou uživatelem přidruženou k fondu Batch, který bude používat výpočetní uzel. |
Container |
Vstup cesty a režimu připojení, který chcete připojit k kontejneru úloh. |
Container |
Cesty, které budou připojeny ke kontejneru úlohy kontejneru. |
Container |
Privátní registr kontejneru. |
Container |
Umístění pracovního adresáře úlohy kontejneru. |
Elevation |
Úroveň zvýšení úrovně uživatele |
Environment |
Proměnná prostředí, která se má nastavit v procesu úkolu. |
Error |
V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva. |
Metadata |
Pár název-hodnota přidružený k prostředku služby Batch. |
Node |
Určuje, jak fond komunikuje se službou Batch. |
Pool |
Sada změn, které se mají provést ve fondu. |
Resource |
Jeden soubor nebo více souborů, které se mají stáhnout do výpočetního uzlu. |
Start |
Ú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. |
Task |
Nastavení kontejneru pro úlohu. |
User |
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. |
version |
string |
Verze aplikace, která se má nasadit. Pokud tuto hodnotu vynecháte, nasadí se výchozí verze. |
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 |
Úroveň zvýšení oprávnění automatického uživatele |
|
scope |
Obor automatického uživatele |
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 |
Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní. |
|
values |
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 |
Umístění úložiště certifikátů na výpočetním uzlu, do kterého se má certifikát nainstalovat. |
|
storeName |
string |
Název úložiště certifikátů na výpočetním uzlu, do kterého se má certifikát nainstalovat. |
thumbprint |
string |
Kryptografický otisk certifikátu. |
thumbprintAlgorithm |
string |
Algoritmus, ke kterému je kryptografický otisk přidružený. To musí být sha1. |
visibility |
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. |
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). |
source |
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 |
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 |
Heslo pro přihlášení k serveru registru. |
registryServer |
string |
Adresa URL registru. |
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 |
Seznam balíčků aplikací, které se mají nainstalovat na každý výpočetní uzel ve fondu. |
|
certificateReferences |
Seznam certifikátů, které se mají nainstalovat na každý výpočetní uzel ve fondu. Upozornění: Tato vlastnost je zastaralá a bude odebrána po únoru 2024. Místo toho použijte |
|
metadata |
Seznam párů název-hodnota přidružených k fondu jako metadata. |
|
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. |
|
targetNodeCommunicationMode |
Režim komunikace požadovaného uzlu pro fond. |
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ě. |
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. |
fileMode |
string |
Atribut režimu oprávnění souboru v osmičkovém formátu. |
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. |
httpUrl |
string |
Adresa URL souboru, který chcete stáhnout. |
identityReference |
Odkaz na identitu přiřazenou uživatelem pro přístup ke službě Azure Blob Storage určené službou storageContainerUrl nebo httpUrl |
|
storageContainerUrl |
string |
Adresa URL kontejneru objektů blob v rámci služby Azure Blob Storage. |
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. |
containerSettings |
Nastavení kontejneru, pod kterým běží StartTask. |
|
environmentSettings |
Seznam nastavení proměnných prostředí pro StartTask |
|
maxTaskRetryCount |
integer |
Maximální počet opakování úkolu. |
resourceFiles |
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. |
|
userIdentity |
Identita uživatele, pod kterou se spouští StartTask. |
|
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. |
TaskContainerSettings
Nastavení kontejneru pro úlohu.
Name | Typ | Description |
---|---|---|
containerHostBatchBindMounts |
Cesty, které chcete připojit k úloze kontejneru. |
|
containerRunOptions |
string |
Další možnosti příkazu create kontejneru |
imageName |
string |
Image, která se má použít k vytvoření kontejneru, ve kterém se úloha spustí. |
registry |
Privátní registr, který obsahuje image kontejneru. |
|
workingDirectory |
Umístění pracovního adresáře úlohy kontejneru. |
UserIdentity
Definice identity uživatele, pod kterou je úloha spuštěna.
Name | Typ | Description |
---|---|---|
autoUser |
Automatický uživatel, pod kterým je úloha spuštěna. |
|
username |
string |
Název identity uživatele, pod kterou je úloha spuštěna. |