JobOperations Klass

JobOperations-å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

JobOperations

Konstruktor

JobOperations(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 ett jobb i det angivna kontot. Batch-tjänsten stöder två sätt att styra det arbete som utförs som en del av ett jobb. I den första metoden anger användaren en Job Manager-uppgift. Batch-tjänsten startar den här aktiviteten när den är redo att starta jobbet. Job Manager-aktiviteten styr alla andra aktiviteter som körs under det här jobbet med hjälp av aktivitets-API:erna. I den andra metoden styr användaren direkt körningen av Uppgifter under ett aktivt jobb med hjälp av aktivitets-API:erna. Observera också: när du namnger jobb bör du undvika att inkludera känslig information, till exempel användarnamn eller hemliga projektnamn. Den här informationen kan visas i telemetriloggar som är tillgängliga för Microsoft Support tekniker.
delete	Tar bort ett jobb. Om du tar bort ett jobb tas även alla aktiviteter som ingår i jobbet bort och all jobbstatistik. Detta åsidosätter också kvarhållningsperioden för aktivitetsdata. Om jobbet innehåller uppgifter som fortfarande behålls på beräkningsnoder, tar Batch-tjänsterna alltså bort aktiviteternas arbetskataloger och allt deras innehåll. När en begäran om att ta bort jobb tas emot anger Batch-tjänsten jobbet till borttagningstillståndet. Alla uppdateringsåtgärder för ett jobb som är i borttagningstillstånd misslyckas med statuskod 409 (konflikt), med ytterligare information som anger att jobbet tas bort.
disable	Inaktiverar det angivna jobbet, vilket förhindrar att nya aktiviteter körs. Batch-tjänsten flyttar omedelbart jobbet till inaktiveringstillståndet. Batch använder sedan parametern disableTasks för att avgöra vad du ska göra med de uppgifter som körs för jobbet. Jobbet förblir i inaktiveringstillståndet tills inaktiveringsåtgärden har slutförts och alla aktiviteter har hanterats enligt alternativet disableTasks. Jobbet flyttas sedan till inaktiverat tillstånd. Inga nya aktiviteter startas under jobbet förrän det återgår till aktivt tillstånd. Om du försöker inaktivera ett jobb som är i något annat tillstånd än aktivt, inaktiverat eller inaktiverat misslyckas begäran med statuskod 409.
enable	Aktiverar det angivna jobbet så att nya aktiviteter kan köras. När du anropar det här API:et anger Batch-tjänsten ett inaktiverat jobb till aktiveringstillståndet. När den här åtgärden har slutförts flyttas jobbet till aktivt tillstånd och schemaläggningen av nya aktiviteter under jobbet återupptas. Batch-tjänsten tillåter inte att en aktivitet är i aktivt tillstånd i mer än 180 dagar. Om du aktiverar ett jobb som innehåller aktiva aktiviteter som lades till för mer än 180 dagar sedan körs därför inte dessa aktiviteter.
get	Hämtar information om det angivna jobbet.
get_task_counts	Hämtar antalet aktiviteter för det angivna jobbet. Uppgiftsantal anger antalet aktiviteter efter aktivt, pågående eller slutfört aktivitetstillstånd och antalet aktiviteter som lyckades eller misslyckades. Uppgifter i förberedelsetillståndet räknas som aktiva. Observera att de returnerade talen kanske inte alltid är uppdaterade. Om du behöver exakta uppgiftsantal använder du en listfråga.
list	Visar alla jobb i det angivna kontot.
list_from_job_schedule	Visar de jobb som har skapats under det angivna jobbschemat.
list_preparation_and_release_task_status	Visar körningsstatus för jobbförberedelse- och jobbpubliceringsaktiviteten för det angivna jobbet över beräkningsnoderna där jobbet har körts. Det här API:et returnerar statusen Jobbförberedelse och Jobbpubliceringsaktivitet på alla beräkningsnoder som har kört jobbförberedelse- eller jobbpubliceringsaktiviteten. Detta inkluderar beräkningsnoder som sedan dess har tagits bort från poolen. Om det här API:et anropas för ett jobb som inte har någon jobbförberedelse eller jobbpubliceringsaktivitet returnerar Batch-tjänsten HTTP-statuskod 409 (konflikt) med felkoden JobPreparationTaskNotSpecified.
patch	Uppdateringar egenskaperna för det angivna jobbet. Detta ersätter endast de jobbegenskaper som anges i begäran. Om jobbet till exempel har begränsningar och en begäran inte anger villkorselementet behåller jobbet de befintliga begränsningarna.
terminate	Avslutar det angivna jobbet och markerar det som slutfört. När en begäran om att avsluta jobb tas emot anger Batch-tjänsten jobbet till sluttillståndet. Batch-tjänsten avslutar sedan alla aktiviteter som körs som är associerade med jobbet och kör alla nödvändiga uppgifter för jobblansering. Sedan flyttas jobbet till slutfört tillstånd. Om det finns några aktiviteter i jobbet i aktivt tillstånd förblir de i aktivt tillstånd. När ett jobb har avslutats går det inte att lägga till nya aktiviteter och eventuella återstående aktiva aktiviteter schemaläggs inte.
update	Uppdateringar egenskaperna för det angivna jobbet. Detta ersätter helt alla updatable-egenskaper för jobbet. Om jobbet till exempel har begränsningar kopplade till sig och om begränsningar inte har angetts med den här begäran, tar Batch-tjänsten bort de befintliga begränsningarna.

add

Lägger till ett jobb i det angivna kontot.

Batch-tjänsten stöder två sätt att styra det arbete som utförs som en del av ett jobb. I den första metoden anger användaren en Job Manager-uppgift. Batch-tjänsten startar den här aktiviteten när den är redo att starta jobbet. Job Manager-aktiviteten styr alla andra aktiviteter som körs under det här jobbet med hjälp av aktivitets-API:erna. I den andra metoden styr användaren direkt körningen av Uppgifter under ett aktivt jobb med hjälp av aktivitets-API:erna. Observera också: när du namnger jobb bör du undvika att inkludera känslig information, till exempel användarnamn eller hemliga projektnamn. Den här informationen kan visas i telemetriloggar som är tillgängliga för Microsoft Support tekniker.

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

Parametrar

job

JobAddParameter

Obligatorisk

Jobbet som ska läggas till.

job_add_options

JobAddOptions

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,

ClientRawResponse

Undantag

BatchErrorException

delete

Tar bort ett jobb.

Om du tar bort ett jobb tas även alla aktiviteter som ingår i jobbet bort och all jobbstatistik. Detta åsidosätter också kvarhållningsperioden för aktivitetsdata. Om jobbet innehåller uppgifter som fortfarande behålls på beräkningsnoder, tar Batch-tjänsterna alltså bort aktiviteternas arbetskataloger och allt deras innehåll. När en begäran om att ta bort jobb tas emot anger Batch-tjänsten jobbet till borttagningstillståndet. Alla uppdateringsåtgärder för ett jobb som är i borttagningstillstånd misslyckas med statuskod 409 (konflikt), med ytterligare information som anger att jobbet tas bort.

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

Parametrar

job_id

str

Obligatorisk

ID för jobbet som ska tas bort.

job_delete_options

JobDeleteOptions

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,

ClientRawResponse

Undantag

BatchErrorException

disable

Inaktiverar det angivna jobbet, vilket förhindrar att nya aktiviteter körs.

Batch-tjänsten flyttar omedelbart jobbet till inaktiveringstillståndet. Batch använder sedan parametern disableTasks för att avgöra vad du ska göra med de uppgifter som körs för jobbet. Jobbet förblir i inaktiveringstillståndet tills inaktiveringsåtgärden har slutförts och alla aktiviteter har hanterats enligt alternativet disableTasks. Jobbet flyttas sedan till inaktiverat tillstånd. Inga nya aktiviteter startas under jobbet förrän det återgår till aktivt tillstånd. Om du försöker inaktivera ett jobb som är i något annat tillstånd än aktivt, inaktiverat eller inaktiverat misslyckas begäran med statuskod 409.

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

Parametrar

job_id

str

Obligatorisk

ID:t för jobbet som ska inaktiveras.

disable_tasks

str eller DisableJobOption

Obligatorisk

Möjliga värden är: "requeue", "terminate", "wait"

job_disable_options

JobDisableOptions

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,

ClientRawResponse

Undantag

BatchErrorException

enable

Aktiverar det angivna jobbet så att nya aktiviteter kan köras.

När du anropar det här API:et anger Batch-tjänsten ett inaktiverat jobb till aktiveringstillståndet. När den här åtgärden har slutförts flyttas jobbet till aktivt tillstånd och schemaläggningen av nya aktiviteter under jobbet återupptas. Batch-tjänsten tillåter inte att en aktivitet är i aktivt tillstånd i mer än 180 dagar. Om du aktiverar ett jobb som innehåller aktiva aktiviteter som lades till för mer än 180 dagar sedan körs därför inte dessa aktiviteter.

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

Parametrar

job_id

str

Obligatorisk

ID:t för jobbet som ska aktiveras.

job_enable_options

JobEnableOptions

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,

ClientRawResponse

Undantag

BatchErrorException

get

Hämtar information om det angivna jobbet.

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

Parametrar

job_id

str

Obligatorisk

Jobbets ID.

job_get_options

JobGetOptions

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

CloudJob eller ClientRawResponse om raw=true

Returtyp

CloudJob,

ClientRawResponse

Undantag

BatchErrorException

get_task_counts

Hämtar antalet aktiviteter för det angivna jobbet.

Uppgiftsantal anger antalet aktiviteter efter aktivt, pågående eller slutfört aktivitetstillstånd och antalet aktiviteter som lyckades eller misslyckades. Uppgifter i förberedelsetillståndet räknas som aktiva. Observera att de returnerade talen kanske inte alltid är uppdaterade. Om du behöver exakta uppgiftsantal använder du en listfråga.

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

Parametrar

job_id

str

Obligatorisk

Jobbets ID.

job_get_task_counts_options

JobGetTaskCountsOptions

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

TaskCountsResult eller ClientRawResponse om raw=true

Returtyp

TaskCountsResult,

ClientRawResponse

Undantag

BatchErrorException

list

Visar alla jobb i det angivna kontot.

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

Parametrar

job_list_options

JobListOptions

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 CloudJob

Returtyp

CloudJobPaged[CloudJob]

Undantag

BatchErrorException

list_from_job_schedule

Visar de jobb som har skapats under det angivna jobbschemat.

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

Parametrar

job_schedule_id

str

Obligatorisk

ID:t för jobbschemat som du vill hämta en lista över jobb från.

job_list_from_job_schedule_options

JobListFromJobScheduleOptions

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 CloudJob

Returtyp

CloudJobPaged[CloudJob]

Undantag

BatchErrorException

list_preparation_and_release_task_status

Visar körningsstatus för jobbförberedelse- och jobbpubliceringsaktiviteten för det angivna jobbet över beräkningsnoderna där jobbet har körts.

Det här API:et returnerar statusen Jobbförberedelse och Jobbpubliceringsaktivitet på alla beräkningsnoder som har kört jobbförberedelse- eller jobbpubliceringsaktiviteten. Detta inkluderar beräkningsnoder som sedan dess har tagits bort från poolen. Om det här API:et anropas för ett jobb som inte har någon jobbförberedelse eller jobbpubliceringsaktivitet returnerar Batch-tjänsten HTTP-statuskod 409 (konflikt) med felkoden JobPreparationTaskNotSpecified.

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

Parametrar

job_id

str

Obligatorisk

Jobbets ID.

job_list_preparation_and_release_task_status_options

JobListPreparationAndReleaseTaskStatusOptions

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 JobPreparationAndReleaseTaskExecutionInformation

Returtyp

JobPreparationAndReleaseTaskExecutionInformationPaged[JobPreparationAndReleaseTaskExecutionInformation]

Undantag

BatchErrorException

patch

Uppdateringar egenskaperna för det angivna jobbet.

Detta ersätter endast de jobbegenskaper som anges i begäran. Om jobbet till exempel har begränsningar och en begäran inte anger villkorselementet behåller jobbet de befintliga begränsningarna.

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

Parametrar

job_id

str

Obligatorisk

ID för jobbet vars egenskaper du vill uppdatera.

job_patch_parameter

JobPatchParameter

Obligatorisk

Parametrarna för begäran.

job_patch_options

JobPatchOptions

standardvärde: None

Ytterligare parametrar för åtgärden

custom_headers

dict

standardvärde: None

rubriker som ska läggas till i begäran

raw

bool

standardvärde: False

returnerar direktsvaret tillsammans med det deserialiserade svaret

operation_config

Obligatorisk

Åsidosättningar av åtgärdskonfiguration.

Returer

None eller ClientRawResponse om raw=true

Returtyp

None,

ClientRawResponse

Undantag

BatchErrorException

terminate

Avslutar det angivna jobbet och markerar det som slutfört.

När en begäran om att avsluta jobb tas emot anger Batch-tjänsten jobbet till sluttillståndet. Batch-tjänsten avslutar sedan alla aktiviteter som körs som är associerade med jobbet och kör alla nödvändiga uppgifter för jobblansering. Sedan flyttas jobbet till slutfört tillstånd. Om det finns några aktiviteter i jobbet i aktivt tillstånd förblir de i aktivt tillstånd. När ett jobb har avslutats går det inte att lägga till nya aktiviteter och eventuella återstående aktiva aktiviteter schemaläggs inte.

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

Parametrar

job_id

str

Obligatorisk

ID:t för jobbet som ska avslutas.

terminate_reason

str

standardvärde: None

job_terminate_options

JobTerminateOptions

standardvärde: None

Ytterligare parametrar för åtgärden

custom_headers

dict

standardvärde: None

rubriker som ska läggas till i begäran

raw

bool

standardvärde: False

returnerar direktsvaret tillsammans med det deserialiserade svaret

operation_config

Obligatorisk

Åsidosättningar av åtgärdskonfiguration.

Returer

None eller ClientRawResponse om raw=true

Returtyp

None,

ClientRawResponse

Undantag

BatchErrorException

update

Uppdateringar egenskaperna för det angivna jobbet.

Detta ersätter helt alla updatable-egenskaper för jobbet. Om jobbet till exempel har begränsningar kopplade till sig och om begränsningar inte har angetts med den här begäran, tar Batch-tjänsten bort de befintliga begränsningarna.

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

Parametrar

job_id

str

Obligatorisk

ID för jobbet vars egenskaper du vill uppdatera.

job_update_parameter

JobUpdateParameter

Obligatorisk

Parametrarna för begäran.

job_update_options

JobUpdateOptions

standardvärde: None

Ytterligare parametrar för åtgärden

custom_headers

dict

standardvärde: None

rubriker som ska läggas till i begäran

raw

bool

standardvärde: False

returnerar direktsvaret tillsammans med det deserialiserade svaret

operation_config

Obligatorisk

Åsidosättningar av åtgärdskonfiguration.

Returer

None eller ClientRawResponse om raw=true

Returtyp

None,

ClientRawResponse

Undantag

BatchErrorException

Attribut

models

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