Pool - Update Properties

Referencia

Szolgáltatás:: Batch Service

API-verzió:: 2024-07-01.20.0

Frissíti a megadott készlet tulajdonságait.
Ez teljes mértékben felülírja a készlet összes frissíthető tulajdonságát. Ha például a készlethez egy StartTask van társítva, és ha 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=2024-07-01.20.0

Opcionális paraméterekkel:

POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2024-07-01.20.0

URI-paraméterek

Name	In	Kötelező	Típus	Description
batchUrl	path	True	string	Az Összes Azure Batch-szolgáltatáskérés alap URL-címe.
poolId	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 kiszolgáló által a kérés feldolgozásának maximális időtartama másodpercben. Az alapértelmezett érték 30 másodperc. Ha az érték nagyobb, mint 30, akkor a rendszer az alapértelmezett értéket használja.

Kérelem fejléce

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

Name	Típus	Description
client-request-id	string (uuid)	A hívó által generált kérési identitás guid formában, díszítés nélkül, például kapcsos zárójelek, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Azt jelzi, hogy a kiszolgálónak vissza kell-e adnia az ügyfél-kérelem azonosítóját a válaszban.
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óra-időpontra állítják be; állítsa be explicit módon, ha közvetlenül a REST API-t hívja meg.

Kérelem törzse

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

Name	Kötelező	Típus	Description
applicationPackageReferences	True	ApplicationPackageReference[]	A készlet egyes számítási csomópontjaira telepíteni kívánt alkalmazáscsomagok listája. A lista lecseréli a készlet meglévő alkalmazáscsomag-hivatkozásait. Az alkalmazáscsomag-hivatkozások módosítása hatással van a készlethez csatlakozó összes új számítási csomópontra, de nem érinti a készletben lévő számítási csomópontokat, amíg újra nem indítja vagy újra nem alakítja őket. Egy adott készleten legfeljebb 10 alkalmazáscsomag-hivatkozás található. Ha nincs megadva, vagy üres gyűjteményt ad meg, a meglévő alkalmazáscsomag-hivatkozások törlődnek a készletből. Egy adott készleten legfeljebb 10 hivatkozás adható meg.
certificateReferences	True	CertificateReference[]	A készlet egyes számítási csomópontjaira telepíteni kívánt tanúsítványok listája. Ez a lista lecseréli a készleten konfigurált meglévő tanúsítványhivatkozásokat. Ha üres gyűjteményt ad meg, a meglévő tanúsítványhivatkozások törlődnek a készletből. Windows-csomópontok esetén a Batch szolgáltatás telepíti a tanúsítványokat a megadott tanúsítványtárolóba és helyre. Linux számítási csomópontok esetén a tanúsítványok a Feladat munkakönyvtárban lévő könyvtárban vannak tárolva, és a rendszer egy környezeti változót AZ_BATCH_CERTIFICATES_DIR a feladatnak, amely lekérdezi ezt a helyet. A "remoteUser" láthatóságú tanúsítványok esetében a rendszer létrehoz egy "tanúsítvány" könyvtárat a felhasználó kezdőkönyvtárában (például /home/{user-name}/certs), és a tanúsítványok ebben a könyvtárban vannak elhelyezve. Figyelmeztetés: Ez a tulajdonság elavult, és 2024 februárja után törlődik. Ehelyett használja az Azure KeyVault-bővítményt.
metadata	True	MetadataItem[]	A készlethez metaadatként társított név-érték párok listája. Ez a lista lecseréli a készleten konfigurált meglévő metaadatokat. Ha nincs megadva, vagy üres gyűjteményt ad meg, a meglévő metaadatok törlődnek a készletből.
startTask		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ópontot hozzáadják a készlethez, vagy amikor a számítási csomópont újraindul. Ha ez az elem jelen van, felülírja a meglévő StartTaskot. Ha nincs megadva, a rendszer eltávolítja a meglévő StartTaskot a készletből.
targetNodeCommunicationMode		NodeCommunicationMode	A készlet kívánt csomópontkommunikációs módja. Ez a beállítás lecseréli a készlet meglévő targetNodeCommunication beállítását. Ha nincs megadva, a meglévő beállítás alapértelmezett.

Válaszok

Name	Típus	Description
204 No Content		A Batch szolgáltatásnak küldött kérés sikeres volt. Fejlécek client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	A Batch szolgáltatás hibája.

Name

Típus

Description

204 No Content

A Batch szolgáltatásnak küldött kérés sikeres volt.

Fejlécek

client-request-id: string
request-id: string
ETag: string
Last-Modified: string
DataServiceId: string

Other Status Codes

BatchError

A Batch szolgáltatás hibája.

Biztonság

azure_auth

Microsoft Entra OAuth 2.0 hitelesítési kódfolyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	A felhasználói fiók megszemélyesítése

Authorization

Típus: apiKey
In: header

Példák

Pool update

Mintakérelem

HTTP

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": []
}

Mintaválasz

Állapotkód:: 204

Definíciók

Name	Description
ApplicationPackageReference	Hivatkozás a számítási csomópontokon üzembe helyezendő csomagra.
AutoUserScope	Az automatikus felhasználó hatóköre
AutoUserSpecification	Megadja annak az automatikus felhasználónak a paramétereit, aki egy feladatot futtat a Batch szolgáltatásban.
BatchError	Az Azure Batch szolgáltatástól kapott hibaválasz.
BatchErrorDetail	Az Azure Batch-hibaválaszban szereplő további információk egy eleme.
CertificateReference	Hivatkozás egy készlet számítási csomópontjaira telepíteni kívánt tanúsítványra.
CertificateStoreLocation	A tanúsítványtároló helye a számítási csomóponton, ahová telepíteni szeretné a tanúsítványt.
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.
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.
ContainerHostBatchBindMountEntry	A feladattárolóba csatlakoztatni kívánt elérési út és csatlakoztatási mód bejegyzése.
ContainerHostDataPath	A tárolófeladat tárolójára csatlakoztatni kívánt elérési utak.
ContainerRegistry	Egy privát tárolóregisztrációs adatbázis.
ContainerWorkingDirectory	A tároló tevékenység munkakönyvtárának helye.
ElevationLevel	A felhasználó szintemelési szintje.
EnvironmentSetting	Egy tevékenységfolyamathoz beállítandó környezeti változó.
ErrorMessage	Hibaüzenet érkezett egy Azure Batch-hibaválaszban.
MetadataItem	Egy Batch-szolgáltatáserőforráshoz társított név-érték pár.
NodeCommunicationMode	Meghatározza, hogy a készlet hogyan kommunikál a Batch szolgáltatással.
PoolUpdatePropertiesParameter	A készleten végrehajtott módosítások készlete.
ResourceFile	Egy vagy több, a számítási csomópontra letöltendő fájl.
StartTask	Olyan feladat, amely akkor fut, amikor egy csomópont csatlakozik egy készlethez az Azure Batch szolgáltatásban, vagy amikor a számítási csomópont újraindul vagy újraépül.
TaskContainerSettings	A tevékenység tárolóbeállításai.
UserIdentity	Annak a felhasználói identitásnak a definíciója, amely alatt a feladat fut.

ApplicationPackageReference

Objektum

Hivatkozás a számítási csomópontokon üzembe helyezendő csomagra.

Name	Típus	Description
applicationId	string	Az üzembe helyezendő alkalmazás azonosítója. Készlet létrehozásakor a csomag alkalmazásazonosítójának teljes mértékben minősítettnek kell lennie (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Az üzembe helyezendő alkalmazás verziója. Ha nincs megadva, az alapértelmezett verzió lesz üzembe helyezve. Ha ez nincs megadva egy készleten, és nincs megadva alapértelmezett verzió ehhez az alkalmazáshoz, a kérés az InvalidApplicationPackageReferences hibakóddal és a 409-es HTTP-állapotkóddal hiúsul meg. Ha ez nincs megadva egy tevékenységen, és nincs megadva alapértelmezett verzió ehhez az alkalmazáshoz, a feladat előfeldolgozási hibával meghiúsul.

AutoUserScope

Enumerálás

Az automatikus felhasználó hatóköre

Érték	Description
pool	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	Megadja, hogy a szolgáltatásnak létre kell hoznia egy új felhasználót a feladathoz.

AutoUserSpecification

Objektum

Megadja annak az automatikus felhasználónak a paramétereit, aki egy feladatot futtat a Batch szolgáltatásban.

Name	Típus	Description
elevationLevel	ElevationLevel	Az automatikus felhasználó jogosultságszintje. Az alapértelmezett érték nem Admin.
scope	AutoUserScope	Az automatikus felhasználó hatóköre Az alapértelmezett érték a készlet. Ha a készlet Windows rendszert futtat, a Tevékenység értéket kell megadni, ha szigorúbb elkülönítésre van szükség a tevékenységek között. Ha például a tevékenység úgy mutálja a beállításjegyzéket, hogy az hatással lehet más tevékenységekre, vagy olyan tanúsítványokat adott meg a készleten, amelyek nem lehetnek elérhetők a normál tevékenységek által, de a StartTasks számára hozzáférhetőnek kell lenniük.

BatchError

Objektum

Az Azure Batch szolgáltatástól kapott hibaválasz.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message	ErrorMessage	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
values	BatchErrorDetail[]	Kulcs-érték párok gyűjteménye, amelyek további részleteket tartalmaznak a hibáról.

BatchErrorDetail

Objektum

Az 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álasz további információi.

CertificateReference

Objektum

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	CertificateStoreLocation	A tanúsítványtároló helye a számítási csomóponton, ahová telepíteni szeretné a tanúsítványt. Az alapértelmezett érték a currentuser. Ez a tulajdonság csak a Windows számítási csomópontokkal konfigurált készletekre vonatkozik. Linux számítási csomópontok esetén a tanúsítványok a Feladat munkakönyvtárban lévő könyvtárban vannak tárolva, és a rendszer egy környezeti változót AZ_BATCH_CERTIFICATES_DIR a feladatnak, amely lekérdezi ezt a helyet. A "remoteUser" láthatóságú tanúsítványok esetében a rendszer létrehoz egy "tanúsítvány" könyvtárat a felhasználó kezdőkönyvtárában (például /home/{user-name}/certs), és a tanúsítványok ebben a könyvtárban vannak elhelyezve.
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. Ez a tulajdonság csak a Windows számítási csomópontokkal konfigurált készletekre vonatkozik. Az áruházak gyakori nevei a következők: Saját, Gyökér, HITELESÍTÉSSZOLGÁLTATÓ, Megbízhatóság, Letiltás, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, de bármilyen egyéni tárolónév is használható. Az alapértelmezett érték a Saját.
thumbprint	string	A tanúsítvány ujjlenyomata.
thumbprintAlgorithm	string	Az az algoritmus, amelyhez az ujjlenyomat társítva van. Ennek sha1-nek kell lennie.
visibility	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. Ebben a gyűjteményben több láthatóságot is megadhat. Az alapértelmezett érték az összes fiók.

CertificateStoreLocation

Enumerálás

A tanúsítványtároló helye a számítási csomóponton, ahová telepíteni szeretné a tanúsítványt.

Érték	Description
currentuser	A tanúsítványokat telepíteni kell a CurrentUser tanúsítványtárolóba.
localmachine	A tanúsítványokat telepíteni kell a LocalMachine tanúsítványtárolóba.

CertificateVisibility

Enumerálás

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.

Érték	Description
remoteuser	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	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 AutoUser-hatókör a StartTask és a Tevékenység készlete is, akkor ez a tanúsítvány a tevékenység számára is látható lesz.
task	A tanúsítványnak láthatónak kell lennie azon felhasználói fiókok számára, amelyek alatt a feladatfeladatok futnak.

ComputeNodeIdentityReference

Objektum

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.

ContainerHostBatchBindMountEntry

Objektum

A feladattárolóba csatlakoztatni kívánt elérési út és csatlakoztatási mód bejegyzése.

Name	Típus	Description
isReadOnly	boolean	Csatlakoztassa ezt a forrásútvonalat írásvédett módként vagy sem. Az alapértelmezett érték hamis (olvasási/írási mód). Linux esetén, ha ezt az elérési utat írási/olvasási módként csatlakoztatja, az nem jelenti azt, hogy a tároló összes felhasználója rendelkezik olvasási/írási hozzáféréssel az elérési úthoz, az a gazdagép virtuális gépének hozzáférésétől függ. Ha ez az elérési út írásvédett, a tárolóban lévő összes felhasználó nem fogja tudni módosítani az elérési utat.
source	ContainerHostDataPath	A tároló-ügyfélhez csatlakoztatni kívánt elérési út kiválasztható.

ContainerHostDataPath

Enumerálás

A tárolófeladat tárolójára csatlakoztatni kívánt elérési utak.

Érték	Description
Applications	Az alkalmazások elérési útja.
JobPrep	A feladat-előkészítési tevékenység elérési útja.
Shared	A többpéldányos feladat elérési útja a fájlok megosztásához.
Startup	A tevékenység kezdési útvonala.
Task	A tevékenység elérési útja.
VfsMounts	Az elérési út az összes virtuális fájlrendszert tartalmazza ezen a csomóponton.

ContainerRegistry

Objektum

Egy privát tárolóregisztrációs adatbázis.

Name	Típus	Description
identityReference	ComputeNodeIdentityReference	A felhasználó által hozzárendelt identitásra mutató hivatkozás, a felhasználónév és a jelszó helyett az Azure Container Registry eléréséhez. 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.
password	string	A beállításjegyzék-kiszolgálóra való bejelentkezéshez szükséges jelszó.
registryServer	string	A beállításjegyzék URL-címe. Ha nincs megadva, az alapértelmezett érték a "docker.io".
username	string	A beállításjegyzék-kiszolgálóra való bejelentkezéshez szükséges felhasználónév.

ContainerWorkingDirectory

Enumerálás

A tároló tevékenység munkakönyvtárának helye.

Érték	Description
containerImageDefault	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	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

Enumerálás

A felhasználó szintemelési szintje.

Érték	Description
admin	A felhasználó emelt szintű hozzáféréssel rendelkező felhasználó, és teljes rendszergazdai engedélyekkel rendelkezik.
nonadmin	A felhasználó egy általános jogú felhasználó, aki nem rendelkezik emelt szintű hozzáféréssel.

EnvironmentSetting

Objektum

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

Objektum

Hibaüzenet érkezett egy Azure Batch-hibaválaszban.

Name	Típus	Description
lang	string	A hibaüzenet nyelvi kódja
value	string	Az üzenet szövege.

MetadataItem

Objektum

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

Enumerálás

Meghatározza, hogy a készlet hogyan kommunikál a Batch szolgáltatással.

Érték	Description
classic	A klasszikus kommunikációs módot használó csomópontok bejövő TCP-kommunikációt igényelnek a 29876-os és a 29877-ös porton a "BatchNodeManagement" portról. {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	A csomópont-kommunikációs módot a Batch szolgáltatás automatikusan beállítja.
simplified	Az egyszerűsített kommunikációs módot használó csomópontok kimenő TCP-kommunikációt igényelnek a 443-as porton a "BatchNodeManagement" felé. {region}" szolgáltatáscímke. Nincs szükség nyitott bejövő portra.