JobOperations Osztály

JobOperations-műveletek.

Ne példányosítsa közvetlenül ezt az osztályt, hanem hozzon létre egy ügyfélpéldányt, amely létrehozza és attribútumként csatolja.

Öröklődés
builtins.object
JobOperations

Konstruktor

JobOperations(client, config, serializer, deserializer)

Paraméterek

client
Kötelező

Ügyfél szolgáltatáskérésekhez.

config
Kötelező

A szolgáltatásügyfél konfigurálása.

serializer
Kötelező

Objektummodell szerializálója.

deserializer
Kötelező

Objektummodell-deszerializáló.

Változók

api_version

A kéréshez használni kívánt API-verzió. Állandó érték: "2023-05-01.17.0".

Metódusok

add

Feladat hozzáadása a megadott fiókhoz.

A Batch szolgáltatás két módszert támogat a feladatok részeként végzett munka szabályozására. Az első megközelítésben a felhasználó egy Feladatkezelői feladatot határoz meg. A Batch szolgáltatás akkor indítja el ezt a feladatot, ha készen áll a feladat elindítására. A Feladatkezelő tevékenység a Feladat API-k használatával vezérli a feladat alatt futó összes többi tevékenységet. A második megközelítésben a felhasználó közvetlenül szabályozza a Feladatok végrehajtását egy aktív feladat alatt a Feladat API-k használatával. Vegye figyelembe azt is, hogy a Feladatok elnevezésekor kerülje a bizalmas információk, például a felhasználónevek vagy a titkos projektnevek beiktatását. Ezek az információk megjelenhetnek a Microsoft ügyfélszolgálata mérnökök számára elérhető telemetriai naplókban.

delete

Feladat törlése.

A feladatok törlése az adott feladat részét képező összes tevékenységet és az összes feladatstatisztikát is törli. Ez felülbírálja a tevékenységadatok megőrzési időtartamát is; vagyis ha a feladat olyan feladatokat tartalmaz, amelyek továbbra is megmaradnak a számítási csomópontokon, a Batch-szolgáltatások törlik a feladatok munkakönyvtárait és azok tartalmát. A Feladat törlése kérelem érkezésekor a Batch szolgáltatás a feladat törlési állapotára állítja be a feladatot. A törlési állapotban lévő feladatok összes frissítési művelete a 409-es (Ütközés) állapotkóddal meghiúsul, és további információk jelzik, hogy a feladat törölve van.

disable

Letiltja a megadott feladatot, és megakadályozza az új feladatok futtatását.

A Batch szolgáltatás azonnal áthelyezi a feladatot a letiltó állapotba. A Batch ezután a disableTasks paraméterrel határozza meg, hogy mi a teendő a feladat aktuálisan futó feladataival. A feladat letiltási állapotban marad, amíg a letiltási művelet be nem fejeződik, és az összes feladat a disableTasks beállításnak megfelelően lett kezelve; A feladat ezután a letiltott állapotba kerül. A feladat alatt nem indulnak el új feladatok, amíg vissza nem kerül az aktív állapotba. Ha olyan feladatot próbál letiltani, amely nem aktív, letiltott vagy letiltott állapotban van, a kérés a 409-s állapotkóddal meghiúsul.

enable

Engedélyezi a megadott feladatot, és lehetővé teszi az új feladatok futtatását.

Amikor meghívja ezt az API-t, a Batch szolgáltatás letiltott feladatot állít be az engedélyezés állapotára. A művelet befejezése után a feladat az aktív állapotba kerül, és a feladat alatti új tevékenységek ütemezése folytatódik. A Batch szolgáltatás nem teszi lehetővé, hogy egy tevékenység 180 napnál hosszabb ideig aktív állapotban maradjon. Ezért ha engedélyez egy olyan feladatot, amely több mint 180 nappal ezelőtt hozzáadott aktív feladatokat tartalmaz, ezek a feladatok nem futnak.

get

Információt kap a megadott feladatról.

get_task_counts

Lekéri a megadott feladat tevékenységszámát.

A tevékenységszámlálók az aktív, a futó vagy a befejezett tevékenységállapot, valamint a sikeres vagy sikertelen tevékenységek számát adják meg. Az előkészítési állapotban lévő tevékenységek futásnak számítanak. Vegye figyelembe, hogy a visszaadott számok nem mindig naprakészek. Ha pontos feladatszámra van szüksége, használjon lista lekérdezést.

list

A megadott fiók összes feladatát felsorolja.

list_from_job_schedule

Felsorolja a megadott feladatütemezés alapján létrehozott feladatokat.

list_preparation_and_release_task_status

Felsorolja a feladat-előkészítési és feladatkiadási feladat végrehajtási állapotát a megadott feladathoz azon számítási csomópontokon, amelyeken a feladat fut.

Ez az API a feladat-előkészítési és feladatkiadási feladat állapotát adja vissza az összes olyan számítási csomóponton, amely a feladat-előkészítési vagy a feladatkiadási feladatot futtatja. Ide tartoznak azok a számítási csomópontok, amelyek azóta el lettek távolítva a készletből. Ha ezt az API-t olyan feladaton hívja meg a rendszer, amely nem rendelkezik feladat-előkészítési vagy feladat-kiadási feladattal, a Batch szolgáltatás a 409-es (ütközés) HTTP-állapotkódot adja vissza a JobPreparationTaskNotSpecified hibakóddal.

patch

Frissítések a megadott feladat tulajdonságait.

Ez csak a kérelemben megadott feladattulajdonságokat cseréli le. Ha például a feladatnak vannak megkötései, és a kérés nem adja meg a kényszerek elemet, akkor a Feladat megtartja a meglévő kényszereket.

terminate

Leállítja a megadott feladatot, és befejezettként jelöli meg.

A Feladat megszakítása kérelem fogadásakor a Batch szolgáltatás a feladatot lezáró állapotra állítja. A Batch szolgáltatás ezután leállítja a feladathoz társított futó feladatokat, és futtatja a szükséges feladatkiadási feladatokat. Ezután a feladat befejezett állapotba kerül. Ha a Feladat aktív állapotban van, azok aktív állapotban maradnak. A feladat leállása után az új tevékenységek nem vehetők fel, és a fennmaradó aktív tevékenységek nem lesznek ütemezve.

update

Frissítések a megadott feladat tulajdonságait.

Ez teljes mértékben lecseréli a feladat összes frissíthető tulajdonságát. Ha például a feladathoz kényszerek vannak társítva, és ha a kérelemhez nincs megadva kényszer, akkor a Batch szolgáltatás eltávolítja a meglévő kényszereket.

add

Feladat hozzáadása a megadott fiókhoz.

A Batch szolgáltatás két módszert támogat a feladatok részeként végzett munka szabályozására. Az első megközelítésben a felhasználó egy Feladatkezelői feladatot határoz meg. A Batch szolgáltatás akkor indítja el ezt a feladatot, ha készen áll a feladat elindítására. A Feladatkezelő tevékenység a Feladat API-k használatával vezérli a feladat alatt futó összes többi tevékenységet. A második megközelítésben a felhasználó közvetlenül szabályozza a Feladatok végrehajtását egy aktív feladat alatt a Feladat API-k használatával. Vegye figyelembe azt is, hogy a Feladatok elnevezésekor kerülje a bizalmas információk, például a felhasználónevek vagy a titkos projektnevek beiktatását. Ezek az információk megjelenhetnek a Microsoft ügyfélszolgálata mérnökök számára elérhető telemetriai naplókban.

add(job, job_add_options=None, custom_headers=None, raw=False, **operation_config)

Paraméterek

job
JobAddParameter
Kötelező

A hozzáadni kívánt feladat.

job_add_options
JobAddOptions
alapértelmezett érték: None

A művelet további paraméterei

custom_headers
dict
alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw
bool
alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config
Kötelező

A műveletkonfiguráció felülbírálása.

Válaszok

Nincs vagy ClientRawResponse, ha raw=true

Visszatérési típus

None,

Kivételek

delete

Feladat törlése.

A feladatok törlése az adott feladat részét képező összes tevékenységet és az összes feladatstatisztikát is törli. Ez felülbírálja a tevékenységadatok megőrzési időtartamát is; vagyis ha a feladat olyan feladatokat tartalmaz, amelyek továbbra is megmaradnak a számítási csomópontokon, a Batch-szolgáltatások törlik a feladatok munkakönyvtárait és azok tartalmát. A Feladat törlése kérelem érkezésekor a Batch szolgáltatás a feladat törlési állapotára állítja be a feladatot. A törlési állapotban lévő feladatok összes frissítési művelete a 409-es (Ütközés) állapotkóddal meghiúsul, és további információk jelzik, hogy a feladat törölve van.

delete(job_id, job_delete_options=None, custom_headers=None, raw=False, **operation_config)

Paraméterek

job_id
str
Kötelező

A törölni kívánt feladat azonosítója.

job_delete_options
JobDeleteOptions
alapértelmezett érték: None

A művelet további paraméterei

custom_headers
dict
alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw
bool
alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config
Kötelező

A műveletkonfiguráció felülbírálása.

Válaszok

Nincs vagy ClientRawResponse, ha raw=true

Visszatérési típus

None,

Kivételek

disable

Letiltja a megadott feladatot, és megakadályozza az új feladatok futtatását.

A Batch szolgáltatás azonnal áthelyezi a feladatot a letiltó állapotba. A Batch ezután a disableTasks paraméterrel határozza meg, hogy mi a teendő a feladat aktuálisan futó feladataival. A feladat letiltási állapotban marad, amíg a letiltási művelet be nem fejeződik, és az összes feladat a disableTasks beállításnak megfelelően lett kezelve; A feladat ezután a letiltott állapotba kerül. A feladat alatt nem indulnak el új feladatok, amíg vissza nem kerül az aktív állapotba. Ha olyan feladatot próbál letiltani, amely nem aktív, letiltott vagy letiltott állapotban van, a kérés a 409-s állapotkóddal meghiúsul.

disable(job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config)

Paraméterek

job_id
str
Kötelező

A letiltani kívánt feladat azonosítója.

disable_tasks
str vagy DisableJobOption
Kötelező

Lehetséges értékek: "requeue", "terminate", "wait"

job_disable_options
JobDisableOptions
alapértelmezett érték: None

A művelet további paraméterei

custom_headers
dict
alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw
bool
alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config
Kötelező

A műveletkonfiguráció felülbírálása.

Válaszok

Nincs vagy ClientRawResponse, ha raw=true

Visszatérési típus

None,

Kivételek

enable

Engedélyezi a megadott feladatot, és lehetővé teszi az új feladatok futtatását.

Amikor meghívja ezt az API-t, a Batch szolgáltatás letiltott feladatot állít be az engedélyezés állapotára. A művelet befejezése után a feladat az aktív állapotba kerül, és a feladat alatti új tevékenységek ütemezése folytatódik. A Batch szolgáltatás nem teszi lehetővé, hogy egy tevékenység 180 napnál hosszabb ideig aktív állapotban maradjon. Ezért ha engedélyez egy olyan feladatot, amely több mint 180 nappal ezelőtt hozzáadott aktív feladatokat tartalmaz, ezek a feladatok nem futnak.

enable(job_id, job_enable_options=None, custom_headers=None, raw=False, **operation_config)

Paraméterek

job_id
str
Kötelező

Az engedélyezni kívánt feladat azonosítója.

job_enable_options
JobEnableOptions
alapértelmezett érték: None

A művelet további paraméterei

custom_headers
dict
alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw
bool
alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config
Kötelező

A műveletkonfiguráció felülbírálása.

Válaszok

Nincs vagy ClientRawResponse, ha raw=true

Visszatérési típus

None,

Kivételek

get

Információt kap a megadott feladatról.

get(job_id, job_get_options=None, custom_headers=None, raw=False, **operation_config)

Paraméterek

job_id
str
Kötelező

A feladat azonosítója.

job_get_options
JobGetOptions
alapértelmezett érték: None

A művelet további paraméterei

custom_headers
dict
alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw
bool
alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config
Kötelező

A műveletkonfiguráció felülbírálása.

Válaszok

CloudJob vagy ClientRawResponse, ha raw=true

Visszatérési típus

Kivételek

get_task_counts

Lekéri a megadott feladat tevékenységszámát.

A tevékenységszámlálók az aktív, a futó vagy a befejezett tevékenységállapot, valamint a sikeres vagy sikertelen tevékenységek számát adják meg. Az előkészítési állapotban lévő tevékenységek futásnak számítanak. Vegye figyelembe, hogy a visszaadott számok nem mindig naprakészek. Ha pontos feladatszámra van szüksége, használjon lista lekérdezést.

get_task_counts(job_id, job_get_task_counts_options=None, custom_headers=None, raw=False, **operation_config)

Paraméterek

job_id
str
Kötelező

A feladat azonosítója.

job_get_task_counts_options
JobGetTaskCountsOptions
alapértelmezett érték: None

A művelet további paraméterei

custom_headers
dict
alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw
bool
alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config
Kötelező

A műveletkonfiguráció felülbírálása.

Válaszok

TaskCountsResult vagy ClientRawResponse, ha raw=true

Visszatérési típus

Kivételek

list

A megadott fiók összes feladatát felsorolja.

list(job_list_options=None, custom_headers=None, raw=False, **operation_config)

Paraméterek

job_list_options
JobListOptions
alapértelmezett érték: None

A művelet további paraméterei

custom_headers
dict
alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw
bool
alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config
Kötelező

A műveletkonfiguráció felülbírálása.

Válaszok

Iterátor, például CloudJob-példány

Visszatérési típus

Kivételek

list_from_job_schedule

Felsorolja a megadott feladatütemezés alapján létrehozott feladatokat.

list_from_job_schedule(job_schedule_id, job_list_from_job_schedule_options=None, custom_headers=None, raw=False, **operation_config)

Paraméterek

job_schedule_id
str
Kötelező

Annak a feladatütemezésnek az azonosítója, amelyből le szeretné kapni a feladatok listáját.

job_list_from_job_schedule_options
JobListFromJobScheduleOptions
alapértelmezett érték: None

A művelet további paraméterei

custom_headers
dict
alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw
bool
alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config
Kötelező

A műveletkonfiguráció felülbírálása.

Válaszok

Iterátor, például CloudJob-példány

Visszatérési típus

Kivételek

list_preparation_and_release_task_status

Felsorolja a feladat-előkészítési és feladatkiadási feladat végrehajtási állapotát a megadott feladathoz azon számítási csomópontokon, amelyeken a feladat fut.

Ez az API a feladat-előkészítési és feladatkiadási feladat állapotát adja vissza az összes olyan számítási csomóponton, amely a feladat-előkészítési vagy a feladatkiadási feladatot futtatja. Ide tartoznak azok a számítási csomópontok, amelyek azóta el lettek távolítva a készletből. Ha ezt az API-t olyan feladaton hívja meg a rendszer, amely nem rendelkezik feladat-előkészítési vagy feladat-kiadási feladattal, a Batch szolgáltatás a 409-es (ütközés) HTTP-állapotkódot adja vissza a JobPreparationTaskNotSpecified hibakóddal.

list_preparation_and_release_task_status(job_id, job_list_preparation_and_release_task_status_options=None, custom_headers=None, raw=False, **operation_config)

Paraméterek

job_id
str
Kötelező

A feladat azonosítója.

job_list_preparation_and_release_task_status_options
JobListPreparationAndReleaseTaskStatusOptions
alapértelmezett érték: None

A művelet további paraméterei

custom_headers
dict
alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw
bool
alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config
Kötelező

A műveletkonfiguráció felülbírálása.

Válaszok

Iterátor, például JobPreparationAndReleaseTaskExecutionInformation

Visszatérési típus

Kivételek

patch

Frissítések a megadott feladat tulajdonságait.

Ez csak a kérelemben megadott feladattulajdonságokat cseréli le. Ha például a feladatnak vannak megkötései, és a kérés nem adja meg a kényszerek elemet, akkor a Feladat megtartja a meglévő kényszereket.

patch(job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config)

Paraméterek

job_id
str
Kötelező

Annak a feladatnak az azonosítója, amelynek a tulajdonságait frissíteni szeretné.

job_patch_parameter
JobPatchParameter
Kötelező

A kérelem paraméterei.

job_patch_options
JobPatchOptions
alapértelmezett érték: None

A művelet további paraméterei

custom_headers
dict
alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw
bool
alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config
Kötelező

A műveletkonfiguráció felülbírálása.

Válaszok

Nincs vagy ClientRawResponse, ha raw=true

Visszatérési típus

None,

Kivételek

terminate

Leállítja a megadott feladatot, és befejezettként jelöli meg.

A Feladat megszakítása kérelem fogadásakor a Batch szolgáltatás a feladatot lezáró állapotra állítja. A Batch szolgáltatás ezután leállítja a feladathoz társított futó feladatokat, és futtatja a szükséges feladatkiadási feladatokat. Ezután a feladat befejezett állapotba kerül. Ha a Feladat aktív állapotban van, azok aktív állapotban maradnak. A feladat leállása után az új tevékenységek nem vehetők fel, és a fennmaradó aktív tevékenységek nem lesznek ütemezve.

terminate(job_id, terminate_reason=None, job_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Paraméterek

job_id
str
Kötelező

A leállítandó feladat azonosítója.

terminate_reason
str
alapértelmezett érték: None
job_terminate_options
JobTerminateOptions
alapértelmezett érték: None

A művelet további paraméterei

custom_headers
dict
alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw
bool
alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config
Kötelező

A műveletkonfiguráció felülbírálása.

Válaszok

Nincs vagy ClientRawResponse, ha raw=true

Visszatérési típus

None,

Kivételek

update

Frissítések a megadott feladat tulajdonságait.

Ez teljes mértékben lecseréli a feladat összes frissíthető tulajdonságát. Ha például a feladathoz kényszerek vannak társítva, és ha a kérelemhez nincs megadva kényszer, akkor a Batch szolgáltatás eltávolítja a meglévő kényszereket.

update(job_id, job_update_parameter, job_update_options=None, custom_headers=None, raw=False, **operation_config)

Paraméterek

job_id
str
Kötelező

Annak a feladatnak az azonosítója, amelynek a tulajdonságait frissíteni szeretné.

job_update_parameter
JobUpdateParameter
Kötelező

A kérelem paraméterei.

job_update_options
JobUpdateOptions
alapértelmezett érték: None

A művelet további paraméterei

custom_headers
dict
alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw
bool
alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config
Kötelező

A műveletkonfiguráció felülbírálása.

Válaszok

Nincs vagy ClientRawResponse, ha raw=true

Visszatérési típus

None,

Kivételek

Attribútumok

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>