TaskOperations Klass

TaskOperations-åtgärder.

Du bör inte instansiera direkt den här klassen, utan skapa en klientinstans som skapar den åt dig och bifogar den som attribut.

Arv
builtins.object
TaskOperations

Konstruktor

TaskOperations(client, config, serializer, deserializer)

Parametrar

client
Obligatorisk

Klient för tjänstbegäranden.

config
Obligatorisk

Konfiguration av tjänstklient.

serializer
Obligatorisk

En objektmodellserialiserare.

deserializer
Obligatorisk

En deserialiserare för objektmodell.

Variabler

api_version

DEN API-version som ska användas för begäran. Konstant värde: "2023-05-01.17.0".

Metoder

add

Lägger till en aktivitet i det angivna jobbet.

Den maximala livslängden för en aktivitet från tillägg till slutförande är 180 dagar. Om en aktivitet inte har slutförts inom 180 dagar efter att den har lagts till avslutas den av Batch-tjänsten och lämnas i det tillstånd den befann sig i vid den tidpunkten.

add_collection

Lägger till en samling aktiviteter i det angivna jobbet.

Observera att varje aktivitet måste ha ett unikt ID. Batch-tjänsten kanske inte returnerar resultaten för varje aktivitet i samma ordning som aktiviteterna skickades i den här begäran. Om tidsgränsen uppnås för servern eller om anslutningen stängs under begäran kan begäran ha bearbetats helt eller delvis eller inte alls. I sådana fall bör användaren utfärda begäran igen. Observera att det är upp till användaren att korrekt hantera fel vid återutfärdande av en begäran. Du bör till exempel använda samma aktivitets-ID under ett nytt försök så att om den tidigare åtgärden lyckades skapar inte återförsöket extra aktiviteter oväntat. Om svaret innehåller uppgifter som inte kunde läggas till kan en klient försöka utföra begäran igen. I ett nytt försök är det mest effektivt att skicka om endast uppgifter som inte kunde läggas till och att utelämna uppgifter som har lagts till vid det första försöket. Den maximala livslängden för en aktivitet från tillägg till slutförande är 180 dagar. Om en aktivitet inte har slutförts inom 180 dagar efter att den har lagts till avslutas den av Batch-tjänsten och lämnas i det tillstånd den befann sig i vid den tidpunkten.

delete

Tar bort en aktivitet från det angivna jobbet.

När en aktivitet tas bort tas alla filer i dess katalog på beräkningsnoden där den kördes också bort (oavsett kvarhållningstid). För aktiviteter med flera instanser tillämpas borttagningsåtgärden synkront på den primära aktiviteten. underaktiviteter och deras filer tas sedan bort asynkront i bakgrunden.

get

Hämtar information om den angivna aktiviteten.

Information om aktiviteter med flera instanser, till exempel affinityId, executionInfo och nodeInfo, refererar till den primära aktiviteten. Använd API:et för listunderaktiviteter för att hämta information om underaktiviteter.

list

Visar en lista över alla aktiviteter som är associerade med det angivna jobbet.

Information om aktiviteter med flera instanser, till exempel affinityId, executionInfo och nodeInfo, refererar till den primära aktiviteten. Använd API:et för listunderaktiviteter för att hämta information om underaktiviteter.

list_subtasks

Visar en lista över alla underaktiviteter som är associerade med den angivna aktiviteten för flera instanser.

Om aktiviteten inte är en aktivitet med flera instanser returneras en tom samling.

reactivate

Reaktivaterar en aktivitet så att den kan köras igen även om antalet återförsök har förbrukats.

Återaktivering gör att en aktivitet kan försökas igen upp till maximalt antal återförsök. Aktivitetens tillstånd ändras till aktiv. Eftersom aktiviteten inte längre är i slutfört tillstånd är all tidigare slutkod eller felinformation inte längre tillgänglig efter återaktivering. Varje gång en aktivitet återaktiveras återställs antalet återförsök till 0. Återaktiveringen misslyckas för aktiviteter som inte har slutförts eller som har slutförts tidigare (med slutkoden 0). Dessutom misslyckas det om jobbet har slutförts (eller avslutas eller tas bort).

terminate

Avslutar den angivna aktiviteten.

När aktiviteten har avslutats flyttas den till slutfört tillstånd. För aktiviteter med flera instanser tillämpas åtgärden Avsluta aktivitet synkront på den primära aktiviteten. underaktiviteter avslutas sedan asynkront i bakgrunden.

update

Uppdateringar egenskaperna för den angivna aktiviteten.

add

Lägger till en aktivitet i det angivna jobbet.

Den maximala livslängden för en aktivitet från tillägg till slutförande är 180 dagar. Om en aktivitet inte har slutförts inom 180 dagar efter att den har lagts till avslutas den av Batch-tjänsten och lämnas i det tillstånd den befann sig i vid den tidpunkten.

add(job_id, task, task_add_options=None, custom_headers=None, raw=False, **operation_config)

Parametrar

job_id
str
Obligatorisk

ID:t för jobbet som aktiviteten ska läggas till i.

task
TaskAddParameter
Obligatorisk

Uppgiften som ska läggas till.

task_add_options
TaskAddOptions
standardvärde: None

Ytterligare parametrar för åtgärden

custom_headers
dict
standardvärde: None

rubriker som läggs till i begäran

raw
bool
standardvärde: False

returnerar det direkta svaret tillsammans med det avserialiserade svaret

operation_config
Obligatorisk

Åsidosättningar av åtgärdskonfiguration.

Returer

Ingen eller ClientRawResponse om raw=true

Returtyp

None,

Undantag

add_collection

Lägger till en samling aktiviteter i det angivna jobbet.

Observera att varje aktivitet måste ha ett unikt ID. Batch-tjänsten kanske inte returnerar resultaten för varje aktivitet i samma ordning som aktiviteterna skickades i den här begäran. Om tidsgränsen uppnås för servern eller om anslutningen stängs under begäran kan begäran ha bearbetats helt eller delvis eller inte alls. I sådana fall bör användaren utfärda begäran igen. Observera att det är upp till användaren att korrekt hantera fel vid återutfärdande av en begäran. Du bör till exempel använda samma aktivitets-ID under ett nytt försök så att om den tidigare åtgärden lyckades skapar inte återförsöket extra aktiviteter oväntat. Om svaret innehåller uppgifter som inte kunde läggas till kan en klient försöka utföra begäran igen. I ett nytt försök är det mest effektivt att skicka om endast uppgifter som inte kunde läggas till och att utelämna uppgifter som har lagts till vid det första försöket. Den maximala livslängden för en aktivitet från tillägg till slutförande är 180 dagar. Om en aktivitet inte har slutförts inom 180 dagar efter att den har lagts till avslutas den av Batch-tjänsten och lämnas i det tillstånd den befann sig i vid den tidpunkten.

add_collection(job_id, value, task_add_collection_options=None, custom_headers=None, raw=False, threads=0, **operation_config)

Parametrar

job_id
str
Obligatorisk

ID för jobbet som uppgiftssamlingen ska läggas till i.

value
list of TaskAddParameter
Obligatorisk

Den samling uppgifter som ska läggas till. Den totala serialiserade storleken för den här samlingen måste vara mindre än 4 MB. Om den är större än 4 MB (till exempel om varje aktivitet har 100-talet resursfiler eller miljövariabler) misslyckas begäran med koden "RequestBodyTooLarge" och bör försökas igen med färre aktiviteter.

task_add_collection_options
TaskAddCollectionOptions
standardvärde: None

Ytterligare parametrar för åtgärden

custom_headers
dict
standardvärde: None

rubriker som läggs till i begäran

raw
bool
standardvärde: False

returnerar det direkta svaret tillsammans med det avserialiserade svaret

threads
int
standardvärde: 0

antal trådar som ska användas parallellt när aktiviteter läggs till. Om det anges och är större än 0 startar ytterligare trådar för att skicka begäranden och vänta tills de har slutförts. Annars skickas add_collection begäranden sekventiellt på huvudtråden

Returer

TaskAddCollectionResult eller ClientRawResponse om raw=true

Returtyp

Undantag

azure.batch.custom.CreateTasksErrorException

delete

Tar bort en aktivitet från det angivna jobbet.

När en aktivitet tas bort tas alla filer i dess katalog på beräkningsnoden där den kördes också bort (oavsett kvarhållningstid). För aktiviteter med flera instanser tillämpas borttagningsåtgärden synkront på den primära aktiviteten. underaktiviteter och deras filer tas sedan bort asynkront i bakgrunden.

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

Parametrar

job_id
str
Obligatorisk

ID för jobbet som uppgiften ska tas bort från.

task_id
str
Obligatorisk

ID:t för uppgiften som ska tas bort.

task_delete_options
TaskDeleteOptions
standardvärde: None

Ytterligare parametrar för åtgärden

custom_headers
dict
standardvärde: None

rubriker som läggs till i begäran

raw
bool
standardvärde: False

returnerar det direkta svaret tillsammans med det avserialiserade svaret

operation_config
Obligatorisk

Åsidosättningar av åtgärdskonfiguration.

Returer

Ingen eller ClientRawResponse om raw=true

Returtyp

None,

Undantag

get

Hämtar information om den angivna aktiviteten.

Information om aktiviteter med flera instanser, till exempel affinityId, executionInfo och nodeInfo, refererar till den primära aktiviteten. Använd API:et för listunderaktiviteter för att hämta information om underaktiviteter.

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

Parametrar

job_id
str
Obligatorisk

ID:t för jobbet som innehåller uppgiften.

task_id
str
Obligatorisk

ID:t för uppgiften att hämta information om.

task_get_options
TaskGetOptions
standardvärde: None

Ytterligare parametrar för åtgärden

custom_headers
dict
standardvärde: None

rubriker som läggs till i begäran

raw
bool
standardvärde: False

returnerar det direkta svaret tillsammans med det avserialiserade svaret

operation_config
Obligatorisk

Åsidosättningar av åtgärdskonfiguration.

Returer

CloudTask eller ClientRawResponse om raw=true

Returtyp

Undantag

list

Visar en lista över alla aktiviteter som är associerade med det angivna jobbet.

Information om aktiviteter med flera instanser, till exempel affinityId, executionInfo och nodeInfo, refererar till den primära aktiviteten. Använd API:et för listunderaktiviteter för att hämta information om underaktiviteter.

list(job_id, task_list_options=None, custom_headers=None, raw=False, **operation_config)

Parametrar

job_id
str
Obligatorisk

Jobbets ID.

task_list_options
TaskListOptions
standardvärde: None

Ytterligare parametrar för åtgärden

custom_headers
dict
standardvärde: None

rubriker som läggs till i begäran

raw
bool
standardvärde: False

returnerar det direkta svaret tillsammans med det avserialiserade svaret

operation_config
Obligatorisk

Åsidosättningar av åtgärdskonfiguration.

Returer

En iterator som en instans av CloudTask

Returtyp

Undantag

list_subtasks

Visar en lista över alla underaktiviteter som är associerade med den angivna aktiviteten för flera instanser.

Om aktiviteten inte är en aktivitet med flera instanser returneras en tom samling.

list_subtasks(job_id, task_id, task_list_subtasks_options=None, custom_headers=None, raw=False, **operation_config)

Parametrar

job_id
str
Obligatorisk

Jobbets ID.

task_id
str
Obligatorisk

ID:t för uppgiften.

task_list_subtasks_options
TaskListSubtasksOptions
standardvärde: None

Ytterligare parametrar för åtgärden

custom_headers
dict
standardvärde: None

rubriker som läggs till i begäran

raw
bool
standardvärde: False

returnerar det direkta svaret tillsammans med det avserialiserade svaret

operation_config
Obligatorisk

Åsidosättningar av åtgärdskonfiguration.

Returer

CloudTaskListSubtasksResult eller ClientRawResponse om raw=true

Returtyp

Undantag

reactivate

Reaktivaterar en aktivitet så att den kan köras igen även om antalet återförsök har förbrukats.

Återaktivering gör att en aktivitet kan försökas igen upp till maximalt antal återförsök. Aktivitetens tillstånd ändras till aktiv. Eftersom aktiviteten inte längre är i slutfört tillstånd är all tidigare slutkod eller felinformation inte längre tillgänglig efter återaktivering. Varje gång en aktivitet återaktiveras återställs antalet återförsök till 0. Återaktiveringen misslyckas för aktiviteter som inte har slutförts eller som har slutförts tidigare (med slutkoden 0). Dessutom misslyckas det om jobbet har slutförts (eller avslutas eller tas bort).

reactivate(job_id, task_id, task_reactivate_options=None, custom_headers=None, raw=False, **operation_config)

Parametrar

job_id
str
Obligatorisk

ID:t för jobbet som innehåller aktiviteten.

task_id
str
Obligatorisk

ID:t för uppgiften som ska återaktiveras.

task_reactivate_options
TaskReactivateOptions
standardvärde: None

Ytterligare parametrar för åtgärden

custom_headers
dict
standardvärde: None

rubriker som läggs till i begäran

raw
bool
standardvärde: False

returnerar det direkta svaret tillsammans med det avserialiserade svaret

operation_config
Obligatorisk

Åsidosättningar av åtgärdskonfiguration.

Returer

Ingen eller ClientRawResponse om raw=true

Returtyp

None,

Undantag

terminate

Avslutar den angivna aktiviteten.

När aktiviteten har avslutats flyttas den till slutfört tillstånd. För aktiviteter med flera instanser tillämpas åtgärden Avsluta aktivitet synkront på den primära aktiviteten. underaktiviteter avslutas sedan asynkront i bakgrunden.

terminate(job_id, task_id, task_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Parametrar

job_id
str
Obligatorisk

ID:t för jobbet som innehåller aktiviteten.

task_id
str
Obligatorisk

ID:t för uppgiften som ska avslutas.

task_terminate_options
TaskTerminateOptions
standardvärde: None

Ytterligare parametrar för åtgärden

custom_headers
dict
standardvärde: None

rubriker som läggs till i begäran

raw
bool
standardvärde: False

returnerar det direkta svaret tillsammans med det avserialiserade svaret

operation_config
Obligatorisk

Åsidosättningar av åtgärdskonfiguration.

Returer

Ingen eller ClientRawResponse om raw=true

Returtyp

None,

Undantag

update

Uppdateringar egenskaperna för den angivna aktiviteten.

update(job_id, task_id, constraints=None, task_update_options=None, custom_headers=None, raw=False, **operation_config)

Parametrar

job_id
str
Obligatorisk

ID:t för jobbet som innehåller aktiviteten.

task_id
str
Obligatorisk

ID:t för uppgiften som ska uppdateras.

constraints
TaskConstraints
standardvärde: None

Begränsningar som gäller för den här aktiviteten. Om den utelämnas får aktiviteten standardbegränsningarna. För aktiviteter med flera instanser gäller uppdatering av kvarhållningstiden endast för den primära aktiviteten och inte underaktiviteter.

task_update_options
TaskUpdateOptions
standardvärde: None

Ytterligare parametrar för åtgärden

custom_headers
dict
standardvärde: None

rubriker som läggs till i begäran

raw
bool
standardvärde: False

returnerar det direkta svaret tillsammans med det avserialiserade svaret

operation_config
Obligatorisk

Åsidosättningar av åtgärdskonfiguration.

Returer

Ingen eller ClientRawResponse om raw=true

Returtyp

None,

Undantag

Attribut

models

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