Pool - Update Properties
Frissítések a megadott készlet tulajdonságait.
Ez teljes mértékben lecseréli a készlet összes frissíthető tulajdonságát. Ha például a készlethez egy StartTask van társítva, és a StartTask nincs megadva ezzel a kéréssel, akkor a Batch szolgáltatás eltávolítja a meglévő StartTaskot.
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
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
batch
|
path | True |
string |
Az összes Azure Batch szolgáltatáskérés alap URL-címe. |
pool
|
path | True |
string |
A frissíteni kívánt készlet azonosítója. |
api-version
|
query | True |
string |
Ügyfél API-verziója. |
timeout
|
query |
integer int32 |
A kérés feldolgozásának maximális időtartama másodpercben. Az alapértelmezett érték 30 mp. |
Kérelem fejléce
Media Types: "application/json; odata=minimalmetadata"
Name | Kötelező | Típus | Description |
---|---|---|---|
client-request-id |
string uuid |
A hívó által generált kérési identitás, olyan GUID formátumban, amely nem rendelkezik díszítéssel, például kapcsos zárójelekkel, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Azt határozza meg, hogy a kiszolgálónak vissza kell-e küldenie a válaszban szereplő client-request-id azonosítót. |
|
ocp-date |
string date-time-rfc1123 |
A kérelem kiállításának időpontja. Az ügyfélkódtárak ezt általában az aktuális rendszeróraidőre állítják be; állítsa be explicit módon, ha a REST API-t közvetlenül hívja meg. |
Kérelem törzse
Media Types: "application/json; odata=minimalmetadata"
Name | Kötelező | Típus | Description |
---|---|---|---|
applicationPackageReferences | True |
A készlet egyes számítási csomópontjaira telepíteni kívánt alkalmazáscsomagok listája. |
|
certificateReferences | True |
A készlet egyes számítási csomópontjaira telepíteni kívánt tanúsítványok listája. Figyelmeztetés: Ez a tulajdonság elavult, és 2024 februárja után törlődik. Használja inkább az Azure KeyVault bővítményt . |
|
metadata | True |
A készlethez metaadatként társított név-érték párok listája. |
|
startTask |
A készlethez való csatlakozáskor az egyes számítási csomópontokon futtatandó feladat. A feladat akkor fut, amikor a számítási csomópont hozzá van adva a készlethez, vagy amikor a számítási csomópont újraindul. |
||
targetNodeCommunicationMode |
A készlet kívánt csomópontkommunikációs módja. |
Válaszok
Name | Típus | Description |
---|---|---|
204 No Content |
A Batch szolgáltatásnak küldött kérés sikeres volt. Headers
|
|
Other Status Codes |
A Batch szolgáltatás hibája. |
Biztonság
azure_auth
Microsoft Entra OAuth 2.0 hitelesítési kódfolyamata
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | A felhasználói fiók megszemélyesítése |
Authorization
Type:
apiKey
In:
header
Példák
Pool update
Sample Request
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": []
}
Sample Response
Definíciók
Name | Description |
---|---|
Application |
A számítási csomópontokon üzembe helyezendő csomagra mutató hivatkozás. |
Auto |
Az automatikus felhasználó hatóköre |
Auto |
A Batch szolgáltatásban feladatot futtató automatikus felhasználó paramétereit adja meg. |
Batch |
Hibaválasz érkezett a Azure Batch szolgáltatástól. |
Batch |
A Azure Batch hibaválaszban szereplő további információk egy eleme. |
Certificate |
Hivatkozás egy készlet számítási csomópontjaira telepíteni kívánt tanúsítványra. |
Certificate |
A tanúsítványtároló helye a számítási csomóponton, ahová a tanúsítványt telepíteni szeretné. |
Certificate |
A számítási csomóponton található felhasználói fiókoknak hozzáféréssel kell rendelkezniük a tanúsítvány személyes adataihoz. |
Compute |
A számítási csomópont által használt Batch-készlethez társított felhasználó által hozzárendelt identitásra mutató hivatkozás. |
Container |
Egy privát tárolóregisztrációs adatbázis. |
Container |
A tároló Feladat munkakönyvtárának helye. |
Elevation |
A felhasználó szintemelési szintje. |
Environment |
Egy tevékenységfolyamathoz beállítandó környezeti változó. |
Error |
Hibaüzenet érkezett egy Azure Batch hibaválaszban. |
Metadata |
Egy Batch-szolgáltatáserőforráshoz társított név-érték pár. |
Node |
Meghatározza, hogy a készlet hogyan kommunikál a Batch szolgáltatással. |
Pool |
A készleten végrehajtott módosítások halmaza. |
Resource |
Egy vagy több fájl, amely egy számítási csomópontra tölthető le. |
Start |
Olyan feladat, amely akkor fut, amikor egy csomópont csatlakozik egy készlethez a Azure Batch szolgáltatásban, vagy amikor a számítási csomópont újraindul vagy újra létre lesz hozva. |
Task |
A feladat tárolóbeállításai. |
User |
Annak a felhasználói identitásnak a definíciója, amely alatt a feladat fut. |
ApplicationPackageReference
A számítási csomópontokon üzembe helyezendő csomagra mutató hivatkozás.
Name | Típus | Description |
---|---|---|
applicationId |
string |
Az üzembe helyezni kívánt alkalmazás azonosítója. |
version |
string |
Az üzembe helyezendő alkalmazás verziója. Ha nincs megadva, az alapértelmezett verzió lesz üzembe helyezve. |
AutoUserScope
Az automatikus felhasználó hatóköre
Name | Típus | Description |
---|---|---|
pool |
string |
Megadja, hogy a feladat a készlet minden számítási csomópontján létrehozott közös automatikus felhasználói fiókként fusson. |
task |
string |
Megadja, hogy a szolgáltatásnak létre kell hoznia egy új felhasználót a feladathoz. |
AutoUserSpecification
A Batch szolgáltatásban feladatot futtató automatikus felhasználó paramétereit adja meg.
Name | Típus | Description |
---|---|---|
elevationLevel |
Az automatikus felhasználó jogosultságszintje. |
|
scope |
Az automatikus felhasználó hatóköre |
BatchError
Hibaválasz érkezett a Azure Batch szolgáltatástól.
Name | Típus | Description |
---|---|---|
code |
string |
A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók. |
message |
A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre. |
|
values |
Kulcs-érték párok gyűjteménye, amely további részleteket tartalmaz a hibáról. |
BatchErrorDetail
A Azure Batch hibaválaszban szereplő további információk egy eleme.
Name | Típus | Description |
---|---|---|
key |
string |
Az Érték tulajdonság jelentését meghatározó azonosító. |
value |
string |
A hibaválaszban szereplő további információk. |
CertificateReference
Hivatkozás egy készlet számítási csomópontjaira telepíteni kívánt tanúsítványra.
Name | Típus | Description |
---|---|---|
storeLocation |
A tanúsítványtároló helye a számítási csomóponton, ahová a tanúsítványt telepíteni szeretné. |
|
storeName |
string |
Annak a számítási csomópontnak a tanúsítványtárolója, amelybe telepíteni szeretné a tanúsítványt. |
thumbprint |
string |
A tanúsítvány ujjlenyomata. |
thumbprintAlgorithm |
string |
Az algoritmus, amelyhez az ujjlenyomat társítva van. Ennek sha1-nek kell lennie. |
visibility |
A számítási csomóponton található felhasználói fiókoknak hozzáféréssel kell rendelkezniük a tanúsítvány személyes adataihoz. |
CertificateStoreLocation
A tanúsítványtároló helye a számítási csomóponton, ahová a tanúsítványt telepíteni szeretné.
Name | Típus | Description |
---|---|---|
currentuser |
string |
A tanúsítványokat a CurrentUser tanúsítványtárolóba kell telepíteni. |
localmachine |
string |
A tanúsítványokat a LocalMachine tanúsítványtárolóba kell telepíteni. |
CertificateVisibility
A számítási csomóponton található felhasználói fiókoknak hozzáféréssel kell rendelkezniük a tanúsítvány személyes adataihoz.
Name | Típus | Description |
---|---|---|
remoteuser |
string |
A tanúsítványnak láthatónak kell lennie azon felhasználói fiókok számára, amelyek alatt a felhasználók távolról hozzáférnek a számítási csomóponthoz. |
starttask |
string |
A tanúsítványnak láthatónak kell lennie annak a felhasználói fióknak, amely alatt a StartTask fut. Vegye figyelembe, hogy ha az Automatikusfelhasználó hatóköre a StartTask és a Tevékenység készlete, akkor ez a tanúsítvány a tevékenység számára is látható lesz. |
task |
string |
A tanúsítványnak láthatónak kell lennie azokhoz a felhasználói fiókokhoz, amelyeken a feladatfeladatok futnak. |
ComputeNodeIdentityReference
A számítási csomópont által használt Batch-készlethez társított felhasználó által hozzárendelt identitásra mutató hivatkozás.
Name | Típus | Description |
---|---|---|
resourceId |
string |
A felhasználó által hozzárendelt identitás ARM-erőforrás-azonosítója. |
ContainerRegistry
Egy privát tárolóregisztrációs adatbázis.
Name | Típus | Description |
---|---|---|
identityReference |
A felhasználó által hozzárendelt identitásra mutató hivatkozás, a felhasználónév és a jelszó helyett egy Azure Container Registry eléréséhez. |
|
password |
string |
A beállításjegyzék-kiszolgálóra való bejelentkezéshez megadott jelszó. |
registryServer |
string |
A beállításjegyzék URL-címe. |
username |
string |
A beállításjegyzék-kiszolgálóra való bejelentkezéshez megadott felhasználónév. |
ContainerWorkingDirectory
A tároló Feladat munkakönyvtárának helye.
Name | Típus | Description |
---|---|---|
containerImageDefault |
string |
Használja a tároló lemezképében definiált munkakönyvtárat. Ne feledje, hogy ez a könyvtár nem tartalmazza a Batch által letöltött erőforrásfájlokat. |
taskWorkingDirectory |
string |
Használja a Batch szolgáltatás szokásos tevékenység munkakönyvtárát, amely tartalmazza a Batch által kitöltött tevékenységerőforrás-fájlokat. |
ElevationLevel
A felhasználó szintemelési szintje.
Name | Típus | Description |
---|---|---|
admin |
string |
A felhasználó emelt szintű hozzáféréssel rendelkező felhasználó, és teljes rendszergazdai engedélyekkel rendelkezik. |
nonadmin |
string |
A felhasználó egy emelt szintű hozzáféréssel nem rendelkező standard felhasználó. |
EnvironmentSetting
Egy tevékenységfolyamathoz beállítandó környezeti változó.
Name | Típus | Description |
---|---|---|
name |
string |
A környezeti változó neve. |
value |
string |
A környezeti változó értéke. |
ErrorMessage
Hibaüzenet érkezett egy Azure Batch hibaválaszban.
Name | Típus | Description |
---|---|---|
lang |
string |
A hibaüzenet nyelvkódja |
value |
string |
Az üzenet szövege. |
MetadataItem
Egy Batch-szolgáltatáserőforráshoz társított név-érték pár.
Name | Típus | Description |
---|---|---|
name |
string |
A metaadatelem neve. |
value |
string |
A metaadatelem értéke. |
NodeCommunicationMode
Meghatározza, hogy a készlet hogyan kommunikál a Batch szolgáltatással.
Name | Típus | Description |
---|---|---|
classic |
string |
A klasszikus kommunikációs módot használó csomópontok bejövő TCP-kommunikációt igényelnek a "BatchNodeManagement" 29876-os és 29877-es porton. {region}" szolgáltatáscímke és kimenő TCP-kommunikáció a 443-as porton a "Storage.region" és a "BatchNodeManagement" felé. {region}" szolgáltatáscímkék. |
default |
string |
A csomópont kommunikációs módját a Batch szolgáltatás automatikusan beállítja. |
simplified |
string |
Az egyszerűsített kommunikációs módot használó csomópontok kimenő TCP-kommunikációt igényelnek a 443-es porton a "BatchNodeManagement" felé. {region}" szolgáltatáscímke. Nincs szükség nyitott bejövő portra. |
PoolUpdatePropertiesParameter
A készleten végrehajtott módosítások halmaza.
Name | Típus | Description |
---|---|---|
applicationPackageReferences |
A készlet egyes számítási csomópontjaira telepíteni kívánt alkalmazáscsomagok listája. |
|
certificateReferences |
A készlet egyes számítási csomópontjaira telepíteni kívánt tanúsítványok listája. Figyelmeztetés: Ez a tulajdonság elavult, és 2024 februárja után el lesz távolítva. Használja helyette az Azure KeyVault bővítményt . |
|
metadata |
A készlethez metaadatként társított név-érték párok listája. |
|
startTask |
Az egyes számítási csomópontokon a készlethez való csatlakozáskor futtatandó feladat. A feladat akkor fut, amikor a számítási csomópontot hozzáadják a készlethez, vagy amikor a számítási csomópont újraindul. |
|
targetNodeCommunicationMode |
A készlet kívánt csomópontkommunikációs módja. |
ResourceFile
Egy vagy több fájl, amely egy számítási csomópontra tölthető le.
Name | Típus | Description |
---|---|---|
autoStorageContainerName |
string |
A tároló neve az automatikus tárfiókban. |
blobPrefix |
string |
A blobok Azure Storage-tárolóból való letöltésekor használandó blobelőtag. Csak azok a blobok töltődnek le, amelyeknek a neve a megadott előtaggal kezdődik. |
fileMode |
string |
A fájlengedélyezési mód attribútuma oktális formátumban. |
filePath |
string |
A számítási csomópont azon helye, amelyre a fájlt le szeretné tölteni a tevékenység munkakönyvtárához képest. |
httpUrl |
string |
A letölteni kívánt fájl URL-címe. |
identityReference |
A storageContainerUrl vagy a httpUrl által megadott Azure Blob Storage eléréséhez használni kívánt felhasználó által hozzárendelt identitásra mutató hivatkozás |
|
storageContainerUrl |
string |
A blobtároló URL-címe a Azure Blob Storage belül. |
StartTask
Olyan feladat, amely akkor fut, amikor egy csomópont csatlakozik egy készlethez a Azure Batch szolgáltatásban, vagy amikor a számítási csomópont újraindul vagy újra létre lesz hozva.
Name | Típus | Description |
---|---|---|
commandLine |
string |
A StartTask parancssora. |
containerSettings |
Annak a tárolónak a beállításai, amelyek alatt a StartTask fut. |
|
environmentSettings |
A StartTask környezeti változóbeállításainak listája. |
|
maxTaskRetryCount |
integer |
A tevékenység újrapróbálkozásának maximális száma. |
resourceFiles |
Azon fájlok listája, amelyeket a Batch szolgáltatás letölt a számítási csomópontra a parancssor futtatása előtt. Az erőforrásfájlok listájának maximális mérete van. Ha túllépi a maximális méretet, a kérés sikertelen lesz, és a válasz hibakódja RequestEntityTooLarge lesz. Ha ez történik, a ResourceFiles gyűjteményét méretben kell csökkenteni. Ez .zip fájlok, alkalmazáscsomagok vagy Docker-tárolók használatával érhető el. |
|
userIdentity |
Az a felhasználói identitás, amely alatt a StartTask fut. |
|
waitForSuccess |
boolean |
Meg kell-e várnia a Batch szolgáltatásnak, hogy a StartTask sikeresen befejeződjön (azaz a 0-s kilépési kóddal lépjen ki) a számítási csomóponton lévő tevékenységek ütemezése előtt. |
TaskContainerSettings
A feladat tárolóbeállításai.
Name | Típus | Description |
---|---|---|
containerRunOptions |
string |
További lehetőségek a tároló létrehozása parancshoz. |
imageName |
string |
A tároló létrehozásához használni kívánt rendszerkép, amelyben a feladat futni fog. |
registry |
A rendszerkép tárolót tartalmazó privát beállításjegyzék. |
|
workingDirectory |
A tároló Feladat munkakönyvtárának helye. |
UserIdentity
Annak a felhasználói identitásnak a definíciója, amely alatt a feladat fut.
Name | Típus | Description |
---|---|---|
autoUser |
Az automatikus felhasználó, amely alatt a feladat fut. |
|
username |
string |
Annak a felhasználói identitásnak a neve, amely alatt a feladat fut. |