Task - Add Collection

Service:

Batch Service

API Version:

2023-11-01.18.0

Feladatgyűjteményt ad hozzá a megadott feladathoz.
Vegye figyelembe, hogy minden tevékenységnek egyedi azonosítóval kell rendelkeznie. Előfordulhat, hogy a Batch szolgáltatás nem adja vissza az egyes tevékenységek eredményeit ugyanabban a sorrendben, mint amelyben a Feladatok el lettek küldve ebben a kérelemben. Ha a kiszolgáló túllépi az időkorlátot, vagy a kapcsolat lezárul a kérés során, előfordulhat, hogy a kérés részben vagy teljesen fel lett dolgozva, vagy egyáltalán nem. Ilyen esetekben a felhasználónak újra ki kell küldenie a kérést. Vegye figyelembe, hogy a felhasználónak kell megfelelően kezelnie a kérések újbóli kiadásakor fellépő hibákat. Az újrapróbálkozások során például ugyanazokat a tevékenységazonosítókat kell használnia, hogy ha az előző művelet sikeres volt, az újrapróbálkozott művelet ne hozzon létre váratlanul további feladatokat. Ha a válasz olyan feladatokat tartalmaz, amelyeket nem sikerült hozzáadni, az ügyfél újra megpróbálhatja a kérést. Az újrapróbálkozások során a leghatékonyabb, ha csak azokat a feladatokat adja újra újra, amelyeket nem sikerült hozzáadni, és kihagyni azokat a feladatokat, amelyeket az első kísérlet során sikeresen hozzáadtak. A tevékenységek maximális élettartama a befejezéstől számítva 180 nap. Ha egy tevékenység a hozzáadást követő 180 napon belül nem fejeződik be, a Batch szolgáltatás leállítja, és bármilyen állapotban marad abban az időben.

POST {batchUrl}/jobs/{jobId}/addtaskcollection?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/jobs/{jobId}/addtaskcollection?timeout={timeout}&api-version=2023-11-01.18.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.
jobId	path	True	string	Annak a feladatnak az azonosítója, amelyhez a tevékenységgyűjteményt hozzá szeretné adni.
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 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 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
value	True	TaskAddParameter[]	A hozzáadni kívánt feladatok gyűjteménye. A Feladatok maximális száma 100. A gyűjtemény szerializált teljes méretének 1 MB-nál kisebbnek kell lennie. Ha nagyobb, mint 1 MB (például ha minden tevékenységhez 100-100 erőforrásfájl vagy környezeti változó tartozik), a kérés "RequestBodyTooLarge" kóddal hiúsul meg, és újra meg kell próbálkozni kevesebb tevékenységgel.

Válaszok

Name	Típus	Description
200 OK	TaskAddCollectionResult	A Feladatgyűjtemény hozzáadása művelet eredményeit tartalmazó válasz. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Váratlan hiba

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

Add a basic collection of tasks

Add a complex collection of tasks

Add a basic collection of tasks

Sample Request

HTTP

POST account.region.batch.azure.com/jobs/jobId/addtaskcollection?api-version=2023-11-01.18.0



{
  "value": [
    {
      "id": "simple1",
      "commandLine": "cmd /c dir /s"
    },
    {
      "id": "simple2",
      "commandLine": "cmd /c dir /s"
    }
  ]
}

Sample Response

Status code:

200

{
  "value": [
    {
      "status": "success",
      "taskId": "simple1",
      "eTag": "0x8D3D623CD661246",
      "lastModified": "2016-09-06T07:02:44.7589958Z",
      "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple1"
    },
    {
      "status": "success",
      "taskId": "simple2",
      "eTag": "0x8D3D623CD7072CC",
      "lastModified": "2016-09-06T07:02:44.8270028Z",
      "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple2"
    }
  ]
}

Add a complex collection of tasks

Sample Request

HTTP

POST account.region.batch.azure.com/jobs/jobId/addtaskcollection?api-version=2023-11-01.18.0



{
  "value": [
    {
      "id": "complex1",
      "commandLine": "cmd /c dir /s",
      "resourceFiles": [
        {
          "autoStorageContainerName": "containerName",
          "filePath": "data"
        }
      ],
      "environmentSettings": [
        {
          "name": "env1",
          "value": "value1"
        },
        {
          "name": "env2",
          "value": "value2"
        }
      ],
      "affinityInfo": {
        "affinityId": "affinityId"
      },
      "constraints": {
        "maxWallClockTime": "P1D",
        "retentionTime": "P2D",
        "maxTaskRetryCount": 5
      },
      "requiredSlots": 2,
      "multiInstanceSettings": {
        "numberOfInstances": 3,
        "coordinationCommandLine": "cmd /c echo coordinating",
        "commonResourceFiles": [
          {
            "httpUrl": "https://common.blob.core.windows.net/",
            "filePath": "common.exe"
          }
        ]
      }
    },
    {
      "id": "simple3",
      "commandLine": "cmd /c dir /s"
    }
  ]
}

Sample Response

Status code:

200

{
  "value": [
    {
      "taskId": "simple3",
      "status": "success",
      "eTag": "0x8D3D623CE295629",
      "lastModified": "2016-09-06T07:02:46.0386857Z",
      "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple3"
    },
    {
      "taskId": "complex1",
      "status": "success",
      "eTag": "0x8D3D623CE29A412",
      "lastModified": "2016-09-06T07:02:46.0406802Z",
      "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/complex1"
    }
  ]
}

Definíciók

Name	Description
AccessScope	Azok a Batch-erőforrások, amelyekhez a jogkivonat hozzáférést biztosít.
AffinityInformation	A Batch szolgáltatás által a tevékenység indítására szolgáló számítási csomópont kiválasztásához használható helyi tipp.
ApplicationPackageReference	A számítási csomópontokon üzembe helyezendő csomagra mutató hivatkozás.
AuthenticationTokenSettings	Egy hitelesítési jogkivonat beállításai, amelyeket a feladat a Batch-szolgáltatásműveletek végrehajtásához használhat.
AutoUserScope	Az automatikus felhasználó hatóköre
AutoUserSpecification	A Batch szolgáltatásban feladatot futtató automatikus felhasználó paramétereit adja meg.
BatchError	Hibaválasz érkezett a Azure Batch szolgáltatástól.
BatchErrorDetail	A Azure Batch hibaválaszban szereplő további információk egy eleme.
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.
ContainerRegistry	Egy privát tárolóregisztrációs adatbázis.
ContainerWorkingDirectory	A tároló Feladat munkakönyvtárának helye.
DependencyAction	A Batch szolgáltatás által a tevékenységtől függő feladatokon végrehajtott művelet.
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.
ExitCodeMapping	Hogyan reagáljon a Batch szolgáltatás, ha egy tevékenység egy adott kilépési kóddal lép ki.
ExitCodeRangeMapping	A kilépési kódok egy tartománya, és hogy a Batch szolgáltatás hogyan reagáljon az adott tartományon belüli kilépési kódokra.
ExitConditions	Meghatározza, hogy a Batch szolgáltatás hogyan válaszoljon a feladat befejezésekor.
ExitOptions	Meghatározza, hogy a Batch szolgáltatás hogyan reagál egy adott kilépési feltételre.
HttpHeader	EGY HTTP-fejléc név-érték párja
JobAction	Ha a feladat a megadott kilépési feltétellel fejeződik be, és a Feladat onTaskFailed tulajdonsága a "performExitOptionsJobAction", akkor a feladatot tartalmazó feladaton végrehajtandó művelet.
MultiInstanceSettings	A többpéldányos feladat futtatását meghatározó beállítások.
OutputFile	A fájlok Azure Batch számítási csomópontról egy másik helyre való feltöltésének specifikációja, miután a Batch szolgáltatás befejezte a feladatfolyamat végrehajtását.
OutputFileBlobContainerDestination	Egy fájlfeltöltési célhelyet határoz meg egy Azure Blob Storage-tárolóban.
OutputFileDestination	Az a cél, amelyre a fájlt fel kell tölteni.
OutputFileUploadCondition	A tevékenység kimeneti fájljának vagy fájlkészletének feltöltésének feltételei.
OutputFileUploadOptions	A kimeneti fájlfeltöltési művelet részletei, beleértve a feltöltés végrehajtásának feltételeit is.
ResourceFile	Egy vagy több fájl, amely egy számítási csomópontra tölthető le.
TaskAddCollectionParameter	Azure Batch hozzáadandó feladatok gyűjteménye.
TaskAddCollectionResult	Tevékenységgyűjtemény feladathoz való hozzáadásának eredménye.
TaskAddParameter	Hozzáadandó Azure Batch feladat.
TaskAddResult	Egyetlen tevékenység eredménye, amely a Tevékenység hozzáadása gyűjtemény hozzáadása művelet részeként van hozzáadva.
TaskAddStatus	A Tevékenység hozzáadása kérelem állapota.
TaskConstraints	A tevékenységre alkalmazandó végrehajtási korlátozások.
TaskContainerSettings	A feladat tárolóbeállításai.
TaskDependencies	A tevékenység minden függőségét megadja. Az explicit módon megadott vagy függőségi tartományon belüli tevékenységeknek be kell fejeződniük a függő tevékenység ütemezése előtt.
TaskIdRange	Tevékenységazonosítók tartománya, amelyektől a tevékenység függhet. A tartomány összes azonosítójával rendelkező tevékenységnek sikeresen be kell fejeződnie, mielőtt a függő tevékenység ütemezhető lenne.
UserIdentity	Annak a felhasználói identitásnak a definíciója, amely alatt a feladat fut.

AccessScope

Azok a Batch-erőforrások, amelyekhez a jogkivonat hozzáférést biztosít.

Name	Típus	Description
job	string	Hozzáférést biztosít a feladatot tartalmazó feladat összes műveletének végrehajtásához.

AffinityInformation

A Batch szolgáltatás által a tevékenység indítására szolgáló számítási csomópont kiválasztásához használható helyi tipp.

Name	Típus	Description
affinityId	string	Egy átlátszatlan sztring, amely egy korábban futtatott számítási csomópont vagy feladat helyét jelöli. A csomópont affinitási azonosítóját átadva jelezheti, hogy a feladatnak ezen a számítási csomóponton kell futnia. Vegye figyelembe, hogy ez csak egy puha affinitás. Ha a cél számítási csomópont foglalt vagy nem érhető el a tevékenység ütemezésekor, akkor a tevékenység máshol lesz ütemezve.

ApplicationPackageReference

A számítási csomópontokon üzembe helyezendő csomagra mutató hivatkozás.

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észletben, é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.

AuthenticationTokenSettings

Egy hitelesítési jogkivonat beállításai, amelyeket a feladat a Batch-szolgáltatásműveletek végrehajtásához használhat.

Name	Típus	Description
access	AccessScope[]	Azok a Batch-erőforrások, amelyekhez a jogkivonat hozzáférést biztosít. A hitelesítési jogkivonat korlátozott Számú Batch-szolgáltatásművelethez biztosít hozzáférést. Jelenleg a hozzáférési tulajdonság egyetlen támogatott értéke a "feladat", amely hozzáférést biztosít a feladatot tartalmazó feladathoz kapcsolódó összes művelethez.

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	ElevationLevel	Az automatikus felhasználó jogosultságszintje. Az alapértelmezett érték a nonAdmin.
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 feladat ú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észletben, amelyeknek nem lehetnek elérhetők a normál tevékenységek, de a StartTasksnak elérhetővé kell tenniük.

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

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	ComputeNodeIdentityReference	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. 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 megadott 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 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.

DependencyAction

A Batch szolgáltatás által a tevékenységtől függő feladatokon végrehajtott művelet.

Name	Típus	Description
block	string	Letiltja a tevékenységre várakozó tevékenységeket, megakadályozva az ütemezésüket.
satisfy	string	A feladatra várakozó feladatok kielégítése; Ha az összes függőség teljesül, a tevékenység futása ütemezve lesz.

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.

ExitCodeMapping

Hogyan reagáljon a Batch szolgáltatás, ha egy tevékenység egy adott kilépési kóddal lép ki.

Name	Típus	Description
code	integer	Folyamat kilépési kódja.
exitOptions	ExitOptions	Hogyan reagáljon a Batch szolgáltatás, ha a feladat ezzel a kilépési kóddal lép ki.

ExitCodeRangeMapping

A kilépési kódok egy tartománya, és hogy a Batch szolgáltatás hogyan reagáljon az adott tartományon belüli kilépési kódokra.

Name	Típus	Description
end	integer	A tartomány utolsó kilépési kódja.
exitOptions	ExitOptions	Hogyan reagáljon a Batch szolgáltatás, ha a tevékenység kilép egy kilépési kóddal a tartományban (beleértve).
start	integer	A tartomány első kilépési kódja.

ExitConditions

Meghatározza, hogy a Batch szolgáltatás hogyan válaszoljon a feladat befejezésekor.

Name	Típus	Description
default	ExitOptions	Hogyan reagáljon a Batch szolgáltatás, ha a feladat olyan kilépési feltétellel meghiúsul, amelyet egyik tulajdonság sem fed le. Ezt az értéket akkor használja a rendszer, ha a feladat kilép az exitCodes vagy exitCodeRanges gyűjteményben nem szereplő, nem nulla kilépési kóddal, előfeldolgozási hibával, ha a preProcessingError tulajdonság nincs jelen, vagy fájlfeltöltési hibával, ha a fileUploadError tulajdonság nincs jelen. Ha nem alapértelmezett viselkedést szeretne a 0-s kilépési kódon, explicit módon fel kell sorolnia az exitCodes vagy az exitCodeRanges gyűjtemény használatával.
exitCodeRanges	ExitCodeRangeMapping[]	A tevékenység kilépési kódtartományainak listája, valamint az, hogy a Batch szolgáltatás hogyan reagáljon rájuk.
exitCodes	ExitCodeMapping[]	Az egyes tevékenységkilépési kódok listája, valamint az, hogy a Batch szolgáltatás hogyan reagáljon rájuk.
fileUploadError	ExitOptions	Hogyan reagáljon a Batch szolgáltatás fájlfeltöltési hiba esetén? Ha a feladat kilépési kóddal lépett ki, amelyet az exitCodes vagy az exitCodeRanges parancs használatával adott meg, majd fájlfeltöltési hibát észlelt, akkor a kilépési kód által megadott művelet elsőbbséget élvez.
preProcessingError	ExitOptions	Hogyan reagáljon a Batch szolgáltatás, ha a feladat hiba miatt nem indul el.

ExitOptions

Meghatározza, hogy a Batch szolgáltatás hogyan reagál egy adott kilépési feltételre.

Name	Típus	Description
dependencyAction	DependencyAction	A Batch szolgáltatás által a tevékenységtől függő feladatokon végrehajtott művelet. A lehetséges értékek a "megfelelő" (amely lehetővé teszi a függő tevékenységek előrehaladását) és a "blokk" (a függő tevékenységek továbbra is várakoznak). A Batch még nem támogatja a függő tevékenységek törlését.
jobAction	JobAction	Ha a feladat a megadott kilépési feltétellel fejeződik be, és a Feladat onTaskFailed tulajdonsága a "performExitOptionsJobAction", akkor a feladatot tartalmazó feladaton végrehajtandó művelet. Az alapértelmezett érték a 0-s kilépési kódnál nincs, és az összes többi kilépési feltételnél leáll. Ha a feladat onTaskFailed tulajdonsága nincs megadva, akkor a tulajdonság megadása hibát ad vissza, és a Feladat hozzáadása kérelem érvénytelen tulajdonságérték-hibával meghiúsul; Ha közvetlenül a REST API-t hívja meg, a HTTP-állapotkód 400 (hibás kérés).

HttpHeader

EGY HTTP-fejléc név-érték párja

Name	Típus	Description
name	string	A kimeneti fájlok feltöltése során használandó fejléc kis- és nagybetűkre nem érzékeny neve
value	string	A kimeneti fájlok feltöltése során használni kívánt fejléc értéke

JobAction

Ha a feladat a megadott kilépési feltétellel fejeződik be, és a Feladat onTaskFailed tulajdonsága a "performExitOptionsJobAction", akkor a feladatot tartalmazó feladaton végrehajtandó művelet.

Name	Típus	Description
disable	string	Tiltsa le a feladatot. Ez egyenértékű a disable Job API meghívásával, a disableTasks újrakihívási értékével.
none	string	Ne tegyen semmilyen műveletet.
terminate	string	Állítsa le a feladatot. A feladat végrehajtásának megszakításaInfo értéke "TaskFailed".

MultiInstanceSettings

A többpéldányos feladat futtatását meghatározó beállítások.

Name	Típus	Description
commonResourceFiles	ResourceFile[]	Azon fájlok listája, amelyeket a Batch szolgáltatás letölt a koordinációs parancssor futtatása előtt. A közös erőforrásfájlok és a Feladat erőforrásfájlok közötti különbség az, hogy a rendszer az összes altevékenységhez letölti a közös erőforrásfájlokat, beleértve az elsődlegest is, míg a Tevékenység erőforrásfájlok csak az elsődlegesre lesznek letöltve. Azt is vegye figyelembe, hogy ezek az erőforrásfájlok nem a Feladat munkakönyvtárba töltődnek le, hanem a feladat gyökérkönyvtárába (a munkakönyvtár felett egy könyvtárba). Az erőforrásfájlok listájának maximális mérete van. A maximális méret túllépésekor a kérés sikertelen lesz, a válasz hibakódja pedig RequestEntityTooLarge lesz. Ha ez történik, a ResourceFiles gyűjteményének méretét csökkenteni kell. Ez .zip fájlok, alkalmazáscsomagok vagy Docker-tárolók használatával érhető el.
coordinationCommandLine	string	Az összes számítási csomóponton futtatandó parancssor, amely lehetővé teszi számukra a koordinációt, amikor az elsődleges futtatja a fő feladat parancsot. Egy tipikus koordinációs parancssor elindít egy háttérszolgáltatást, és ellenőrzi, hogy a szolgáltatás készen áll-e a csomópontok közötti üzenetek feldolgozására.
numberOfInstances	integer	A tevékenység által igényelt számítási csomópontok száma. Ha nincs megadva, az alapértelmezett érték 1.

OutputFile

A fájlok Azure Batch számítási csomópontról egy másik helyre való feltöltésének specifikációja, miután a Batch szolgáltatás befejezte a feladatfolyamat végrehajtását.

Name	Típus	Description
destination	OutputFileDestination	A kimeneti fájl(ok) célhelye.
filePattern	string	Egy minta, amely jelzi, hogy mely fájl(ok) tölthetők fel. A relatív és az abszolút elérési utak is támogatottak. A relatív elérési utak a Tevékenység munkakönyvtárhoz vannak viszonyítva. A következő helyettesítő karakterek támogatottak: * egyezik legalább 0 karakterrel (például az abc* minta megegyezik az abc vagy az abcdef karakterrel), ** megfelel bármely könyvtárnak, ? egyetlen karakternek felel meg, az [abc] a zárójelek egyik karakterével, az [a-c] pedig a tartomány egy karakterével egyezik. A szögletes zárójelek tartalmazhatnak olyan negációt, amely megfelel a megadott karaktereknek (például [!abc] bármely karakternek megfelel, de az a, b vagy c). Ha egy fájlnév "." betűvel kezdődik, akkor a program alapértelmezés szerint figyelmen kívül hagyja, de explicit módon megadhatja (például .gif nem egyezik meg a .a.gif, de a ..gif). Egy egyszerű példa: a ***.txt megegyezik minden olyan fájllal, amely nem "." kezdetű, és .txt végződik a Feladat munkakönyvtárban vagy bármely alkönyvtárban. Ha a fájlnév helyettesítő karaktert tartalmaz, szögletes zárójelek használatával feloldható (például az abc[] egyezik az abc nevű fájllal). Vegye figyelembe, hogy a \ és a / is címtárelválasztóként van kezelve a Windowson, de csak a / linuxos. A környezeti változók (%var% Windowson vagy $var Linuxon) ki vannak bontva a minta alkalmazása előtt.
uploadOptions	OutputFileUploadOptions	További lehetőségek a feltöltési művelethez, beleértve a feltöltés végrehajtásának feltételeit is.

OutputFileBlobContainerDestination

Egy fájlfeltöltési célhelyet határoz meg egy Azure Blob Storage-tárolóban.

Name	Típus	Description
containerUrl	string	Annak a tárolónak az URL-címe Azure Blob Storage, amelyre a fájl(oka)t fel szeretné tölteni. Ha nem használ felügyelt identitást, az URL-címnek tartalmaznia kell egy közös hozzáférésű jogosultságkódot (SAS), amely írási engedélyeket ad a tárolónak.
identityReference	ComputeNodeIdentityReference	A containerUrl által megadott Azure Blob Storage eléréséhez használni kívánt felhasználó által hozzárendelt identitásra mutató hivatkozás Az identitásnak írási hozzáféréssel kell rendelkeznie a Azure Blob Storage tárolóhoz
path	string	A cél blob vagy virtuális könyvtár az Azure Storage-tárolóban. Ha a filePattern egy adott fájlra hivatkozik (azaz nem tartalmaz helyettesítő karaktereket), akkor az elérési út annak a blobnak a neve, amelyre fel szeretné tölteni a fájlt. Ha a filePattern egy vagy több helyettesítő karaktert tartalmaz (és ezért több fájlnak is megfelelhet), akkor az elérési út annak a blob virtuális könyvtárnak a neve (amely minden blobnévre elő van állítva), amelyre a fájl(ok) feltöltéséhez szükség van. Ha nincs megadva, a rendszer feltölti a fájl(oka)t a tároló gyökerére a fájlnévnek megfelelő blobnévvel.
uploadHeaders	HttpHeader[]	A kimeneti fájlok feltöltéséhez használandó fejlécek név-érték párjainak listája Ezek a fejlécek a fájlok Azure Storage-ba való feltöltésekor lesznek megadva. Hivatalos dokumentum az engedélyezett fejlécekről blobok feltöltésekor: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

Az a cél, amelyre a fájlt fel kell tölteni.

Name	Típus	Description
container	OutputFileBlobContainerDestination	Egy hely az Azure Blob Storage-ban, ahová a fájlokat feltöltik.

OutputFileUploadCondition

A tevékenység kimeneti fájljának vagy fájlkészletének feltöltésének feltételei.

Name	Típus	Description
taskcompletion	string	Töltse fel a fájlt a feladatfolyamat kilépése után, függetlenül attól, hogy mi volt a kilépési kód.
taskfailure	string	A fájl(ok) feltöltése csak akkor történik meg, ha a feladatfolyamat kilép egy nemzero kilépési kóddal.
tasksuccess	string	A fájl(ok) feltöltése csak akkor történik meg, ha a feladatfolyamat kilép a 0-s kilépési kóddal.

OutputFileUploadOptions

A kimeneti fájlfeltöltési művelet részletei, beleértve a feltöltés végrehajtásának feltételeit is.

Name	Típus	Description
uploadCondition	OutputFileUploadCondition	A feladat kimeneti fájljának vagy fájlkészletének feltöltésének feltételei. Az alapértelmezett feladat-kiegészítés.

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. Az autoStorageContainerName, storageContainerUrl és httpUrl tulajdonságok kölcsönösen kizárják egymást, és meg kell adni közülük egyet.
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. A tulajdonság csak az autoStorageContainerName vagy storageContainerUrl használatakor érvényes. Ez az előtag lehet részleges fájlnév vagy alkönyvtár. Ha nincs megadva előtag, a rendszer letölti a tárolóban lévő összes fájlt.
fileMode	string	A fájlengedélyezési mód attribútuma oktális formátumban. Ez a tulajdonság csak a Linux számítási csomópontokra letöltött fájlokra vonatkozik. A rendszer figyelmen kívül hagyja, ha egy erőforráshoz van megadvaFile, amelyet a rendszer letölt egy Windows számítási csomópontra. Ha ez a tulajdonság nincs megadva linuxos számítási csomóponthoz, akkor a rendszer egy alapértelmezett 0770-es értéket alkalmaz a fájlra.
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. Ha a httpUrl tulajdonság meg van adva, a filePath megadása kötelező, és ismerteti a fájl letöltési útvonalát, beleértve a fájlnevet is. Ellenkező esetben, ha az autoStorageContainerName vagy storageContainerUrl tulajdonság meg van adva, a filePath megadása nem kötelező, és az a könyvtár, amelyre a fájlokat le szeretné tölteni. Abban az esetben, ha a filePath könyvtárként van használatban, a bemeneti adatokhoz már társított könyvtárstruktúrák teljes mértékben megmaradnak, és hozzá lesznek fűzve a megadott filePath-könyvtárhoz. A megadott relatív elérési út nem bontható ki a tevékenység munkakönyvtárából (például a ".." használatával).
httpUrl	string	A letölteni kívánt fájl URL-címe. Az autoStorageContainerName, storageContainerUrl és httpUrl tulajdonságok kölcsönösen kizárják egymást, és meg kell adni közülük egyet. Ha az URL-cím Azure Blob Storage mutat, akkor olvashatónak kell lennie a számítási csomópontokról. Egy blob ilyen URL-címének lekérése háromféleképpen lehetséges az Azure Storage-ban: tartalmazzon egy közös hozzáférésű jogosultságkódot (SAS), amely olvasási engedélyeket ad a blobhoz, használjon olvasási engedéllyel rendelkező felügyelt identitást, vagy állítsa be a blob vagy a tároló ACL-jét a nyilvános hozzáférés engedélyezéséhez.
identityReference	ComputeNodeIdentityReference	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 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.
storageContainerUrl	string	A blobtároló URL-címe Azure Blob Storage. Az autoStorageContainerName, storageContainerUrl és httpUrl tulajdonságok kölcsönösen kizárják egymást, és meg kell adni közülük egyet. Ennek az URL-címnek olvashatónak és listázhatónak kell lennie a számítási csomópontokról. Az Azure Storage-tárolókhoz háromféleképpen lehet ilyen URL-címet beszerezni: tartalmazzon egy közös hozzáférésű jogosultságkódot (SAS), amely olvasási és listázási engedélyeket ad a tárolóhoz, használjon olvasási és listázási engedélyekkel rendelkező felügyelt identitást, vagy állítsa be a tároló ACL-ét a nyilvános hozzáférés engedélyezéséhez.

TaskAddCollectionParameter

Azure Batch hozzáadandó feladatok gyűjteménye.

Name	Típus	Description
value	TaskAddParameter[]	A hozzáadni kívánt feladatok gyűjteménye. A feladatok maximális száma 100. A gyűjtemény teljes szerializált méretének 1 MB-nál kisebbnek kell lennie. Ha nagyobb, mint 1 MB (például ha minden tevékenységhez 100 erőforrásfájl vagy környezeti változó tartozik), a kérés "RequestBodyTooLarge" kóddal hiúsul meg, és újra meg kell próbálkoznia kevesebb tevékenységgel.

TaskAddCollectionResult

Tevékenységgyűjtemény feladathoz való hozzáadásának eredménye.

Name	Típus	Description
value	TaskAddResult[]	A Feladatgyűjtemény hozzáadása művelet eredményei.

TaskAddParameter

Hozzáadandó Azure Batch feladat.

Name	Típus	Description
affinityInfo	AffinityInformation	A Batch szolgáltatás által egy olyan számítási csomópont kiválasztására használható helymutató, amelyen az új feladatot el szeretné indítani.
applicationPackageReferences	ApplicationPackageReference[]	Azon csomagok listája, amelyeket a Batch szolgáltatás üzembe helyez a számítási csomóponton a parancssor futtatása előtt. Az alkalmazáscsomagokat a rendszer egy megosztott könyvtárba tölti le és helyezi üzembe, nem pedig a Feladat munkakönyvtárba. Ezért ha egy hivatkozott csomag már megtalálható a Csomóponton, és naprakész, akkor nem tölti le újra; A rendszer a számítási csomópont meglévő példányát használja. Ha egy hivatkozott csomag nem telepíthető, például a csomag törlése vagy a letöltés sikertelensége miatt, a feladat meghiúsul.
authenticationTokenSettings	AuthenticationTokenSettings	A hitelesítési jogkivonat beállításai, amelyekkel a feladat Batch-szolgáltatásműveleteket hajthat végre. Ha ez a tulajdonság be van állítva, a Batch szolgáltatás egy hitelesítési jogkivonatot biztosít a feladatnak, amely a Batch szolgáltatás műveleteinek hitelesítésére használható fiókhozzáférési kulcs megkövetelése nélkül. A jogkivonatot a AZ_BATCH_AUTHENTICATION_TOKEN környezeti változó biztosítja. A beállításoktól függ, hogy a tevékenység milyen műveleteket hajthat végre a jogkivonat használatával. Egy tevékenység például feladatengedélyeket kérhet, hogy más tevékenységeket vegyen fel a feladatba, vagy ellenőrizze a feladat vagy a feladat alatti egyéb tevékenységek állapotát.
commandLine	string	A Feladat parancssora. Többpéldányos feladatok esetén a parancssor elsődleges feladatként lesz végrehajtva, miután az elsődleges tevékenység és az összes altevékenység befejezte a koordinációs parancssor végrehajtását. A parancssor nem rendszerhéj alatt fut, ezért nem tudja kihasználni a rendszerhéj olyan funkcióit, mint a környezeti változók bővítése. Ha ki szeretné használni az ilyen funkciókat, hívja meg a rendszerhéjat a parancssorban, például a windowsos "cmd /c MyCommand" vagy a "/bin/sh -c MyCommand" parancsmagot Linuxon. Ha a parancssor fájlelérési utakra hivatkozik, relatív elérési utat kell használnia (a Tevékenység munkakönyvtárhoz viszonyítva), vagy a Batch által megadott környezeti változót (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
constraints	TaskConstraints	A tevékenységre vonatkozó végrehajtási korlátozások. Ha nem ad meg korlátozásokat, a maxTaskRetryCount a feladathoz megadott maxTaskRetryCount, a maxWallClockTime végtelen, a retentionTime pedig 7 nap.
containerSettings	TaskContainerSettings	Annak a tárolónak a beállításai, amelyek alatt a feladat fut. Ha a feladatot futtató készlet tárolókonfigurálási készlettel rendelkezik, ezt is be kell állítani. Ha a feladatot futtató készlet nem rendelkezik tárolókOnfigurálás beállításával, ezt nem szabad beállítani. Ha ez a beállítás meg van adva, a AZ_BATCH_NODE_ROOT_DIR alatti összes címtár (a csomóponton Azure Batch könyvtárak gyökere) a tárolóba lesz leképezve, az összes tevékenységkörnyezeti változó a tárolóba lesz leképezve, a Feladat parancssor pedig a tárolóban lesz végrehajtva. Előfordulhat, hogy a tárolóban a AZ_BATCH_NODE_ROOT_DIR kívül létrehozott fájlok nem jelennek meg a gazdalemezen, ami azt jelenti, hogy a Batch-fájl API-k nem fogják tudni elérni ezeket a fájlokat.
dependsOn	TaskDependencies	Azok a tevékenységek, amelyektől ez a tevékenység függ. Ez a tevékenység csak akkor lesz ütemezve, ha az összes olyan tevékenység sikeresen befejeződött, amelytől függ. Ha bármelyik tevékenység sikertelen, és kimeríti az újrapróbálkozások számát, ez a tevékenység soha nem lesz ütemezve. Ha a feladat nem rendelkezik true (igaz) értékre állított UsesTaskDependencies értékekkel, és ez az elem jelen van, a kérés a TaskDependenciesNotSpecifiedOnJob hibakóddal hiúsul meg.
displayName	string	A feladat megjelenítendő neve. A megjelenítendő névnek nem kell egyedinek lennie, és legfeljebb 1024 karakter hosszúságú Unicode-karaktereket tartalmazhat.
environmentSettings	EnvironmentSetting[]	A tevékenység környezeti változóbeállításainak listája.
exitConditions	ExitConditions	Meghatározza, hogy a Batch szolgáltatás hogyan válaszoljon a feladat befejezésekor. Hogyan reagáljon a Batch szolgáltatás a feladat befejezésekor?
id	string	Egy sztring, amely egyedileg azonosítja a feladatot a feladaton belül. Az azonosító tartalmazhat alfanumerikus karakterek bármilyen kombinációját, beleértve a kötőjeleket és az aláhúzásjeleket, és legfeljebb 64 karaktert tartalmazhat. Az azonosító kis- és nagybetűket nem különböztet meg (vagyis előfordulhat, hogy nem rendelkezik két azonosítóval egy feladaton belül, amelyek csak esetenként különböznek).
multiInstanceSettings	MultiInstanceSettings	Egy objektum, amely azt jelzi, hogy a tevékenység többpéldányos feladat, és információt tartalmaz a többpéldányos feladat futtatásáról. A többpéldányos feladatokat általában az MPI-feladatok támogatására használják. Az MPI esetében, ha az altevékenységek bármelyike meghiúsul (például egy nem nulla kilépési kóddal való kilépés miatt), a teljes többpéldányos feladat meghiúsul. A többpéldányos feladat ezután leáll, és újrapróbálkozott, egészen az újrapróbálkozás korlátig.
outputFiles	OutputFile[]	Azon fájlok listája, amelyeket a Batch szolgáltatás feltölt a számítási csomópontról a parancssor futtatása után. Többpéldányos feladatok esetén a fájlok csak abból a számítási csomópontból lesznek feltöltve, amelyen az elsődleges tevékenység végrehajtása történik.
requiredSlots	integer	Az ütemezési pontok száma, amelyeket a feladatnak futtatnia kell. Az alapértelmezett érték 1. Egy tevékenység csak akkor ütemezhető úgy, hogy egy számítási csomóponton fusson, ha a csomópont elegendő szabad ütemezési hellyel rendelkezik. Többpéldányos feladatok esetén ennek 1-nek kell lennie.
resourceFiles	ResourceFile[]	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. Többpéldányos feladatok esetén az erőforrásfájlok csak arra a számítási csomópontra lesznek letöltve, amelyen az elsődleges tevékenység végrehajtása történik. 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	UserIdentity	A felhasználói identitás, amely alatt a feladat fut. Ha nincs megadva, a tevékenység a tevékenységre egyedi, nem rendszergazdai felhasználóként fut.

TaskAddResult

Egyetlen tevékenység eredménye, amely a Tevékenység hozzáadása gyűjtemény hozzáadása művelet részeként van hozzáadva.

Name	Típus	Description
eTag	string	A tevékenység ETagje, ha a tevékenység hozzáadása sikerült. Ezzel észlelheti, hogy a tevékenység megváltozott-e a kérések között. Az ETagnek átadhat egy Frissítési feladat kérést, amely azt határozza meg, hogy a módosítások csak akkor lépnek érvénybe, ha időközben senki más nem módosította a feladatot.
error	BatchError	A hiba a feladat hozzáadásának megkísérlésekor jelentkezett.
lastModified	string	A tevékenység utolsó módosítási időpontja.
location	string	A tevékenység URL-címe, ha a tevékenység hozzáadása sikerült.
status	TaskAddStatus	A Tevékenység hozzáadása kérelem állapota.
taskId	string	Annak a tevékenységnek az azonosítója, amelynek ez az eredménye.

TaskAddStatus

A Tevékenység hozzáadása kérelem állapota.

Name	Típus	Description
clienterror	string	A feladat hozzáadása ügyfélhiba miatt nem sikerült, ezért a kérés megfelelő módosítása nélkül nem lehet újrapróbálkozást végrehajtani.
servererror	string	A feladat hozzáadása kiszolgálóhiba miatt nem sikerült, és módosítás nélkül újrapróbálható.
success	string	A feladat hozzáadása sikerült.

TaskConstraints

A tevékenységre alkalmazandó végrehajtási korlátozások.

Name	Típus	Description
maxTaskRetryCount	integer	A tevékenység újrapróbálkozásának maximális száma. A Batch szolgáltatás újrapróbál egy feladatot, ha a kilépési kódja nem ero. Vegye figyelembe, hogy ez az érték határozza meg a nem aero kilépési kód miatt végrehajtható tevékenység újrapróbálkozásának számát. A Batch szolgáltatás egyszer próbálja ki a feladatot, majd megpróbálkozhat ezzel a korláttal. Ha például a maximális újrapróbálkozásszám 3, a Batch legfeljebb 4 alkalommal próbálja meg a feladatot (egy kezdeti próbálkozás és 3 újrapróbálkozás). Ha a maximális újrapróbálkozási szám 0, a Batch szolgáltatás nem próbálja újra a feladatot az első kísérlet után. Ha az újrapróbálkozás maximális száma -1, a Batch szolgáltatás korlátozás nélkül újrapróbálkozott a tevékenységtel, de ez nem ajánlott kezdő tevékenységekhez vagy tevékenységekhez. Az alapértelmezett érték a 0 (nincs újrapróbálkozás).
maxWallClockTime	string	A tevékenység futásának maximális időtartama a Tevékenység kezdetekor mérve. Ha a tevékenység nem fejeződik be az időkorláton belül, a Batch szolgáltatás leállítja. Ha ez nincs megadva, nincs időkorlát arra vonatkozóan, hogy a tevékenység mennyi ideig futhat.
retentionTime	string	A tevékenységkönyvtár megőrzésének minimális ideje azon a számítási csomóponton, ahol futott, a végrehajtás befejezésének időpontjától kezdve. Ezután a Batch szolgáltatás törölheti a Feladat könyvtárat és annak tartalmát. Az alapértelmezett érték 7 nap, azaz a Tevékenység könyvtár 7 napig megmarad, kivéve, ha a számítási csomópontot eltávolítják vagy a feladatot törlik.

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. Ezek a további lehetőségek a "docker create" parancs argumentumaiként vannak megadva a Batch szolgáltatás által szabályozottak mellett.
imageName	string	A tároló létrehozásához használni kívánt rendszerkép, amelyben a feladat futni fog. Ez a teljes rendszerkép-hivatkozás, ahogyan a "docker pull" esetében meg van adva. Ha a Rendszerkép neve nem tartalmaz címkét, a rendszer alapértelmezés szerint a "latest" címkét használja.
registry	ContainerRegistry	A rendszerkép tárolót tartalmazó privát beállításjegyzék. Ez a beállítás kihagyható, ha már meg lett adva a készlet létrehozásakor.
workingDirectory	ContainerWorkingDirectory	A tároló Feladat munkakönyvtárának helye. Az alapértelmezett érték a "taskWorkingDirectory".

TaskDependencies

A tevékenység minden függőségét megadja. Az explicit módon megadott vagy függőségi tartományon belüli tevékenységeknek be kell fejeződniük a függő tevékenység ütemezése előtt.

Name	Típus	Description
taskIdRanges	TaskIdRange[]	Azoknak a tevékenységazonosító-tartományoknak a listája, amelyektől ez a tevékenység függ. Az összes tartomány összes tevékenységének sikeresen be kell fejeződnie, mielőtt a függő tevékenység ütemezhető lenne.
taskIds	string[]	Azoknak a tevékenységazonosítóknak a listája, amelyektől ez a tevékenység függ. A listában szereplő összes tevékenységnek sikeresen be kell fejeződnie ahhoz, hogy a függő tevékenység ütemezhető legyen. A taskIds gyűjtemény összesen legfeljebb 64000 karakter hosszúságú lehet (azaz az összes tevékenységazonosító együttes hossza). Ha a taskIds gyűjtemény túllépi a maximális hosszt, a Feladat hozzáadása kérelem a TaskDependencyListTooLong hibakóddal meghiúsul. Ebben az esetben fontolja meg inkább a Tevékenységazonosító-tartományok használatát.

TaskIdRange

Tevékenységazonosítók tartománya, amelyektől a tevékenység függhet. A tartomány összes azonosítójával rendelkező tevékenységnek sikeresen be kell fejeződnie, mielőtt a függő tevékenység ütemezhető lenne.

Name	Típus	Description
end	integer	A tartomány utolsó tevékenységazonosítója.
start	integer	A tartomány első tevékenységazonosítója.

UserIdentity

Annak a felhasználói identitásnak a definíciója, amely alatt a feladat fut.

Name	Típus	Description
autoUser	AutoUserSpecification	Az automatikus felhasználó, amely alatt a feladat fut. A userName és az autoUser tulajdonságok kölcsönösen kizárják egymást; meg kell adnia egyet, de nem mindkettőt.
username	string	Annak a felhasználói identitásnak a neve, amely alatt a feladat fut. A userName és az autoUser tulajdonságok kölcsönösen kizárják egymást; meg kell adnia egyet, de nem mindkettőt.