Pool - Update Properties
Aktualizace vlastnosti zadaného fondu.
Tím se plně nahradí všechny aktualizovatelné vlastnosti fondu. Pokud má například fond přidružený startTask a není-li s tímto požadavkem zadán StartTask, odebere služba Batch existující startTask.
POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2023-11-01.18.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ý se má aktualizovat. |
api-version
|
query | True |
string |
Verze klientského rozhraní API. |
timeout
|
query |
integer int32 |
Maximální čas, který 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 ozdob, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Jestli má server v odpovědi vrátit client-request-id. |
|
ocp-date |
string date-time-rfc1123 |
Čas, kdy byla žádost vystavena. Klientské knihovny obvykle tuto možnost nastaví na aktuální systémový čas. pokud přímo voláte rozhraní REST API, nastavte ho explicitně. |
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 po únoru 2024 se odebere. Místo toho použijte rozšíření Azure KeyVault . |
|
metadata | True |
Seznam párů název-hodnota přidružených k fondu jako metadata. |
|
startTask |
Úloha, která se má spustit na každém výpočetním uzlu při připojení 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 |
Požadovaný režim komunikace 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
Microsoft Entra tok kódu ověřování 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=2023-11-01.18.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 |
Ze služby Azure Batch byla přijata chybová odpověď. |
Batch |
Položka s dalšími informacemi, které jsou součástí Azure Batch odpovědi na chybu. |
Certificate |
Odkaz na certifikát, který se má nainstalovat do výpočetních uzlů 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 na 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 služby Batch, který bude používat výpočetní uzel. |
Container |
Privátní registr kontejneru. |
Container |
Umístění pracovního adresáře úloh kontejneru. |
Elevation |
Úroveň zvýšení oprávnění uživatele. |
Environment |
Proměnná prostředí, která se má nastavit v procesu úlohy. |
Error |
Chybová zpráva přijatá v Azure Batch odpověď na chybu. |
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ů ke stažení 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 opětovném nastavení 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 ji 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
Ze služby Azure Batch byla přijata chybová odpověď.
Name | Typ | Description |
---|---|---|
code |
string |
Identifikátor chyby. Kódy jsou invariantní a mají být využívány 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 s dalšími informacemi, které jsou součástí Azure Batch odpovědi na chybu.
Name | Typ | Description |
---|---|---|
key |
string |
Identifikátor určující význam vlastnosti Value. |
value |
string |
Další informace zahrnuté v chybové odpovědi. |
CertificateReference
Odkaz na certifikát, který se má nainstalovat do výpočetních uzlů 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 na 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 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. |
ComputeNodeIdentityReference
Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude používat výpočetní uzel.
Name | Typ | Description |
---|---|---|
resourceId |
string |
ID prostředku ARM identity přiřazené uživatelem. |
ContainerRegistry
Privátní registr kontejneru.
Name | Typ | Description |
---|---|---|
identityReference |
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. |
|
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 úloh kontejneru.
Name | Typ | Description |
---|---|---|
containerImageDefault |
string |
Použijte pracovní adresář definovaný v kontejneru Image. Mějte na pozoru, že tento adresář nebude obsahovat soubory prostředků stažené službou Batch. |
taskWorkingDirectory |
string |
Použijte standardní pracovní adresář úloh služby Batch, který bude obsahovat soubory zdrojů úkolů vyplně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í. |
ErrorMessage
Chybová zpráva přijatá v Azure Batch odpověď na chybu.
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ý režim komunikace vyžadují příchozí komunikaci TCP na portech 29876 a 29877 z rutiny BatchNodeManagement. Značka služby {region} a odchozí komunikace TCP na portu 443 do "Storage.region" a "BatchNodeManagement. Značky služby {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 do 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 po únoru 2024 se odebere. Místo toho použijte rozšíření Azure KeyVault . |
|
metadata |
Seznam párů název-hodnota přidružených k fondu jako metadata. |
|
startTask |
Úloha, která se má spustit na každém výpočetním uzlu při připojení 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 |
Požadovaný režim komunikace uzlu pro fond. |
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ě. |
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í k souboru v osmičkovém formátu. |
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. |
httpUrl |
string |
Adresa URL souboru, který chcete stáhnout. |
identityReference |
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 |
|
storageContainerUrl |
string |
Adresa URL kontejneru objektů blob v rámci 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 opětovném nastavení výpočetního uzlu.
Name | Typ | Description |
---|---|---|
commandLine |
string |
Příkazový řádek StartTask. |
containerSettings |
Nastavení kontejneru, ve 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í se zmenšit velikost kolekce ResourceFiles. Toho můžete dosáhnout pomocí souborů .zip, balíčků aplikací nebo kontejnerů Dockeru. |
|
userIdentity |
Identita uživatele, pod kterou běží StartTask. |
|
waitForSuccess |
boolean |
Jestli 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. |
TaskContainerSettings
Nastavení kontejneru pro úlohu.
Name | Typ | Description |
---|---|---|
containerRunOptions |
string |
Další možnosti příkazu container create |
imageName |
string |
Image, která se má použít k vytvoření kontejneru, ve kterém bude úloha spuštěna. |
registry |
Privátní registr, který obsahuje image kontejneru. |
|
workingDirectory |
Umístění pracovního adresáře úloh 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. |