TaskOperations Classe

Operazioni TaskOperations.

Non è consigliabile creare un'istanza diretta di questa classe, ma creare un'istanza client che lo creerà per l'utente e collegarlo come attributo.

Ereditarietà

builtins.object

TaskOperations

Costruttore

TaskOperations(client, config, serializer, deserializer)

Parametri

client

Necessario

Client per le richieste di servizio.

config

Necessario

Configurazione del client del servizio.

serializer

Necessario

Serializzatore di modelli a oggetti.

deserializer

Necessario

Deserializzatore del modello a oggetti.

Variabili

api_version

Versione dell'API da usare per la richiesta. Valore costante: "2023-05-01.17.0".

Metodi

add	Aggiunge un'attività al processo specificato. La durata massima di un'attività dall'aggiunta al completamento è di 180 giorni. Se un'attività non è stata completata entro 180 giorni dall'aggiunta, verrà terminata dal servizio Batch e lasciato in qualsiasi stato in quel momento.
add_collection	Aggiunge una raccolta di attività al processo specificato. Si noti che ogni attività deve avere un ID univoco. Il servizio Batch potrebbe non restituire i risultati per ogni attività nello stesso ordine in cui sono state inviate le attività in questa richiesta. Se il server non esegue il timeout o la connessione viene chiusa durante la richiesta, la richiesta potrebbe essere stata parzialmente o completamente elaborata o meno. In questi casi, l'utente deve inviare di nuovo la richiesta. Si noti che è necessario che l'utente gestisca correttamente gli errori durante l'emissione di una richiesta. Ad esempio, è consigliabile usare gli stessi ID attività durante un tentativo in modo che, se l'operazione precedente ha avuto esito positivo, il tentativo non creerà attività aggiuntive in modo imprevisto. Se la risposta contiene tutte le attività che non sono state aggiunte, un client può ripetere la richiesta. In una ripetizione dei tentativi, è più efficiente inviare nuovamente solo attività che non sono riuscite ad aggiungere e omettere le attività aggiunte correttamente nel primo tentativo. La durata massima di un'attività dall'aggiunta al completamento è di 180 giorni. Se un'attività non è stata completata entro 180 giorni dall'aggiunta, verrà terminata dal servizio Batch e lasciato in qualsiasi stato in quel momento.
delete	Elimina un'attività dal processo specificato. Quando un'attività viene eliminata, tutti i file nella directory nel nodo di calcolo in cui è stato eseguito vengono eliminati (indipendentemente dal tempo di conservazione). Per attività multiistanza, l'operazione di eliminazione attività si applica in modo sincrono all'attività primaria; le sottotask e i relativi file vengono quindi eliminati in modo asincrono in background.
get	Ottiene informazioni sull'attività specificata. Per attività a più istanze, informazioni come affinityId, executionInfo e nodeInfo fanno riferimento all'attività primaria. Usare l'API sottotask di elenco per recuperare informazioni sulle sottotask.
list	Elenca tutte le attività associate al processo specificato. Per attività a più istanze, informazioni come affinityId, executionInfo e nodeInfo fanno riferimento all'attività primaria. Usare l'API sottotask di elenco per recuperare informazioni sulle sottotask.
list_subtasks	Elenca tutte le sottotask associate all'attività multiistanza specificata. Se l'attività non è un'attività a più istanze, questa restituisce una raccolta vuota.
reactivate	Riattiva un'attività, consentendo l'esecuzione anche se il conteggio dei tentativi è stato esaurito. La riattivazione rende un'attività idonea a essere riprovata fino al numero massimo di tentativi. Lo stato dell'attività viene modificato in attivo. Poiché l'attività non è più nello stato completato, qualsiasi codice di uscita precedente o informazioni sull'errore non è più disponibile dopo la riattivazione. Ogni volta che un'attività viene riattivata, il conteggio dei tentativi viene reimpostato su 0. La riattivazione avrà esito negativo per Le attività non completate o completate in precedenza (con un codice di uscita pari a 0). Inoltre, avrà esito negativo se il processo è stato completato (o termina o elimina).
terminate	Termina l'attività specificata. Quando l'attività è stata terminata, passa allo stato completato. Per le attività multiistanza, l'operazione di termina attività si applica in modo sincrono all'attività primaria; le sottotask vengono quindi terminate in modo asincrono in background.
update	Aggiornamenti le proprietà dell'attività specificata.

add

Aggiunge un'attività al processo specificato.

La durata massima di un'attività dall'aggiunta al completamento è di 180 giorni. Se un'attività non è stata completata entro 180 giorni dall'aggiunta, verrà terminata dal servizio Batch e lasciato in qualsiasi stato in quel momento.

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

Parametri

job_id

str

Necessario

ID del processo a cui aggiungere l'attività.

task

TaskAddParameter

Necessario

Attività da aggiungere.

task_add_options

TaskAddOptions

valore predefinito: None

Parametri aggiuntivi per l'operazione

custom_headers

dict

valore predefinito: None

intestazioni che verranno aggiunte alla richiesta

raw

bool

valore predefinito: False

restituisce la risposta diretta insieme alla risposta deserializzata

operation_config

Necessario

La configurazione dell'operazione esegue l'override.

Restituisce

Nessuno o ClientRawResponse se raw=true

Tipo restituito

None,

ClientRawResponse

Eccezioni

BatchErrorException

add_collection

Aggiunge una raccolta di attività al processo specificato.

Si noti che ogni attività deve avere un ID univoco. Il servizio Batch potrebbe non restituire i risultati per ogni attività nello stesso ordine in cui sono state inviate le attività in questa richiesta. Se il server non esegue il timeout o la connessione viene chiusa durante la richiesta, la richiesta potrebbe essere stata parzialmente o completamente elaborata o meno. In questi casi, l'utente deve inviare di nuovo la richiesta. Si noti che è necessario che l'utente gestisca correttamente gli errori durante l'emissione di una richiesta. Ad esempio, è consigliabile usare gli stessi ID attività durante un tentativo in modo che, se l'operazione precedente ha avuto esito positivo, il tentativo non creerà attività aggiuntive in modo imprevisto. Se la risposta contiene tutte le attività che non sono state aggiunte, un client può ripetere la richiesta. In una ripetizione dei tentativi, è più efficiente inviare nuovamente solo attività che non sono riuscite ad aggiungere e omettere le attività aggiunte correttamente nel primo tentativo. La durata massima di un'attività dall'aggiunta al completamento è di 180 giorni. Se un'attività non è stata completata entro 180 giorni dall'aggiunta, verrà terminata dal servizio Batch e lasciato in qualsiasi stato in quel momento.

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

Parametri

job_id

str

Necessario

ID del processo a cui aggiungere l'insieme di attività.

value

list of TaskAddParameter

Necessario

Raccolta di attività da aggiungere. Le dimensioni totali serializzate di questa raccolta devono essere inferiori a 4 MB. Se è maggiore di 4 MB ,ad esempio se ogni attività ha 100 file di risorse o variabili di ambiente, la richiesta avrà esito negativo con il codice 'RequestBodyTooLarge' e dovrebbe essere riprovata con meno attività.

task_add_collection_options

TaskAddCollectionOptions

valore predefinito: None

Parametri aggiuntivi per l'operazione

custom_headers

dict

valore predefinito: None

intestazioni che verranno aggiunte alla richiesta

raw

bool

valore predefinito: False

restituisce la risposta diretta insieme alla risposta deserializzata

threads

int

valore predefinito: 0

numero di thread da usare in parallelo quando si aggiungono attività. Se specificato e maggiore di 0, inizierà altri thread per inviare richieste e attendere il completamento. In caso contrario, le richieste di add_collection verranno inviate in sequenza nel thread principale

Restituisce

TaskAddCollectionResult o ClientRawResponse se raw=true

Tipo restituito

TaskAddCollectionResult,

ClientRawResponse

Eccezioni

azure.batch.custom.CreateTasksErrorException

delete

Elimina un'attività dal processo specificato.

Quando un'attività viene eliminata, tutti i file nella directory nel nodo di calcolo in cui è stato eseguito vengono eliminati (indipendentemente dal tempo di conservazione). Per attività multiistanza, l'operazione di eliminazione attività si applica in modo sincrono all'attività primaria; le sottotask e i relativi file vengono quindi eliminati in modo asincrono in background.

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

Parametri

job_id

str

Necessario

ID del processo da cui eliminare l'attività.

task_id

str

Necessario

ID dell'attività da eliminare.

task_delete_options

TaskDeleteOptions

valore predefinito: None

Parametri aggiuntivi per l'operazione

custom_headers

dict

valore predefinito: None

intestazioni che verranno aggiunte alla richiesta

raw

bool

valore predefinito: False

restituisce la risposta diretta insieme alla risposta deserializzata

operation_config

Necessario

La configurazione dell'operazione esegue l'override.

Restituisce

Nessuno o ClientRawResponse se raw=true

Tipo restituito

None,

ClientRawResponse

Eccezioni

BatchErrorException

get

Ottiene informazioni sull'attività specificata.

Per attività a più istanze, informazioni come affinityId, executionInfo e nodeInfo fanno riferimento all'attività primaria. Usare l'API sottotask di elenco per recuperare informazioni sulle sottotask.

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

Parametri

job_id

str

Necessario

ID del processo che contiene l'attività.

task_id

str

Necessario

ID dell'attività per ottenere informazioni su.

task_get_options

TaskGetOptions

valore predefinito: None

Parametri aggiuntivi per l'operazione

custom_headers

dict

valore predefinito: None

intestazioni che verranno aggiunte alla richiesta

raw

bool

valore predefinito: False

restituisce la risposta diretta insieme alla risposta deserializzata

operation_config

Necessario

La configurazione dell'operazione esegue l'override.

Restituisce

CloudTask o ClientRawResponse se raw=true

Tipo restituito

CloudTask,

ClientRawResponse

Eccezioni

BatchErrorException

list

Elenca tutte le attività associate al processo specificato.

Per attività a più istanze, informazioni come affinityId, executionInfo e nodeInfo fanno riferimento all'attività primaria. Usare l'API sottotask di elenco per recuperare informazioni sulle sottotask.

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

Parametri

job_id

str

Necessario

ID del processo.

task_list_options

TaskListOptions

valore predefinito: None

Parametri aggiuntivi per l'operazione

custom_headers

dict

valore predefinito: None

intestazioni che verranno aggiunte alla richiesta

raw

bool

valore predefinito: False

restituisce la risposta diretta insieme alla risposta deserializzata

operation_config

Necessario

La configurazione dell'operazione esegue l'override.

Restituisce

Iteratore come istanza di CloudTask

Tipo restituito

CloudTaskPaged[CloudTask]

Eccezioni

BatchErrorException

list_subtasks

Elenca tutte le sottotask associate all'attività multiistanza specificata.

Se l'attività non è un'attività a più istanze, questa restituisce una raccolta vuota.

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

Parametri

job_id

str

Necessario

ID del processo.

task_id

str

Necessario

ID dell'attività.

task_list_subtasks_options

TaskListSubtasksOptions

valore predefinito: None

Parametri aggiuntivi per l'operazione

custom_headers

dict

valore predefinito: None

intestazioni che verranno aggiunte alla richiesta

raw

bool

valore predefinito: False

restituisce la risposta diretta insieme alla risposta deserializzata

operation_config

Necessario

La configurazione dell'operazione esegue l'override.

Restituisce

CloudTaskListSubtasksResult o ClientRawResponse se raw=true

Tipo restituito

CloudTaskListSubtasksResult,

ClientRawResponse

Eccezioni

BatchErrorException

reactivate

Riattiva un'attività, consentendo l'esecuzione anche se il conteggio dei tentativi è stato esaurito.

La riattivazione rende un'attività idonea a essere riprovata fino al numero massimo di tentativi. Lo stato dell'attività viene modificato in attivo. Poiché l'attività non è più nello stato completato, qualsiasi codice di uscita precedente o informazioni sull'errore non è più disponibile dopo la riattivazione. Ogni volta che un'attività viene riattivata, il conteggio dei tentativi viene reimpostato su 0. La riattivazione avrà esito negativo per Le attività non completate o completate in precedenza (con un codice di uscita pari a 0). Inoltre, avrà esito negativo se il processo è stato completato (o termina o elimina).

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

Parametri

job_id

str

Necessario

ID del processo contenente l'attività.

task_id

str

Necessario

ID dell'attività da riattivare.

task_reactivate_options

TaskReactivateOptions

valore predefinito: None

Parametri aggiuntivi per l'operazione

custom_headers

dict

valore predefinito: None

intestazioni che verranno aggiunte alla richiesta

raw

bool

valore predefinito: False

restituisce la risposta diretta insieme alla risposta deserializzata

operation_config

Necessario

La configurazione dell'operazione esegue l'override.

Restituisce

Nessuno o ClientRawResponse se raw=true

Tipo restituito

None,

ClientRawResponse

Eccezioni

BatchErrorException

terminate

Termina l'attività specificata.

Quando l'attività è stata terminata, passa allo stato completato. Per le attività multiistanza, l'operazione di termina attività si applica in modo sincrono all'attività primaria; le sottotask vengono quindi terminate in modo asincrono in background.

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

Parametri

job_id

str

Necessario

ID del processo contenente l'attività.

task_id

str

Necessario

ID dell'attività da terminare.

task_terminate_options

TaskTerminateOptions

valore predefinito: None

Parametri aggiuntivi per l'operazione

custom_headers

dict

valore predefinito: None

intestazioni che verranno aggiunte alla richiesta

raw

bool

valore predefinito: False

restituisce la risposta diretta insieme alla risposta deserializzata

operation_config

Necessario

La configurazione dell'operazione esegue l'override.

Restituisce

Nessuno o ClientRawResponse se raw=true

Tipo restituito

None,

ClientRawResponse

Eccezioni

BatchErrorException

update

Aggiornamenti le proprietà dell'attività specificata.

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

Parametri

job_id

str

Necessario

ID del processo contenente l'attività.

task_id

str

Necessario

ID dell'attività da aggiornare.

constraints

TaskConstraints

valore predefinito: None

Vincoli che si applicano a questa attività. Se omesso, l'attività viene assegnata ai vincoli predefiniti. Per attività multiistanza, l'aggiornamento del tempo di conservazione si applica solo all'attività primaria e non alle sottotask.

task_update_options

TaskUpdateOptions

valore predefinito: None

Parametri aggiuntivi per l'operazione

custom_headers

dict

valore predefinito: None

intestazioni che verranno aggiunte alla richiesta

raw

bool

valore predefinito: False

restituisce la risposta diretta insieme alla risposta deserializzata

operation_config

Necessario

La configurazione dell'operazione esegue l'override.

Restituisce

Nessuno o ClientRawResponse se raw=true

Tipo restituito

None,

ClientRawResponse

Eccezioni

BatchErrorException

Attributi

models

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