JobOperations Classe
Operazioni JobOperations.
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.objectJobOperations
Costruttore
JobOperations(client, config, serializer, deserializer)Parametri
- client
Client per le richieste di servizio.
- config
Configurazione del client del servizio.
- serializer
Serializzatore del modello a oggetti.
- deserializer
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 processo all'account specificato. Il servizio Batch supporta due modi per controllare il lavoro svolto come parte di un processo. Nel primo approccio, l'utente specifica un'attività di Gestione processi. Il servizio Batch avvia questa attività quando è pronto per avviare il processo. L'attività Gestione processi controlla tutte le altre attività eseguite in questo processo, usando le API attività. Nel secondo approccio, l'utente controlla direttamente l'esecuzione di Attività in un processo attivo usando le API attività. Nota anche: quando si assegnano nomi ai processi, evitare di includere informazioni riservate, ad esempio nomi utente o nomi di progetto segreti. Queste informazioni potrebbero essere visualizzate nei log di telemetria accessibili ai tecnici del supporto tecnico Microsoft. |
| delete |
Elimina un processo. L'eliminazione di un processo elimina anche tutte le attività che fanno parte di tale processo e tutte le statistiche del processo. In questo modo viene eseguito l'override del periodo di conservazione per i dati delle attività; ovvero, se il processo contiene attività che vengono ancora mantenute nei nodi di calcolo, i servizi Batch eliminano le directory di lavoro delle attività e tutto il relativo contenuto. Quando viene ricevuta una richiesta di eliminazione processo, il servizio Batch imposta lo stato di eliminazione del processo. Tutte le operazioni di aggiornamento in un processo in stato di eliminazione avranno esito negativo con codice di stato 409 (conflitto), con informazioni aggiuntive che indicano che il processo viene eliminato. |
| disable |
Disabilita il processo specificato, impedendo l'esecuzione di nuove attività. Il servizio Batch sposta immediatamente il processo nello stato di disabilitazione. Batch usa quindi il parametro disableTasks per determinare cosa fare con le attività attualmente in esecuzione del processo. Il processo rimane nello stato di disabilitazione fino al completamento dell'operazione di disabilitazione e tutte le attività sono state gestite in base all'opzione disableTasks; Il processo passa quindi allo stato disabilitato. Nessuna nuova attività viene avviata nel processo fino a quando non torna allo stato attivo. Se si tenta di disabilitare un processo in qualsiasi stato diverso da attivo, disabilitazione o disabilitato, la richiesta ha esito negativo con codice di stato 409. |
| enable |
Abilita il processo specificato, consentendo l'esecuzione di nuove attività. Quando si chiama questa API, il servizio Batch imposta un processo disabilitato sullo stato di abilitazione. Al termine dell'operazione, il processo passa allo stato attivo e la pianificazione di nuove attività nel processo riprende. Il servizio Batch non consente a un'attività di rimanere nello stato attivo per più di 180 giorni. Pertanto, se si abilita un processo contenente attività attive aggiunte più di 180 giorni fa, tali attività non verranno eseguite. |
| get |
Ottiene informazioni sul processo specificato. |
| get_task_counts |
Ottiene il conteggio delle attività per il processo specificato. I conteggi delle attività forniscono un conteggio delle attività in base allo stato attività attivo, in esecuzione o completato e a un conteggio delle attività riuscite o non riuscite. Le attività nello stato di preparazione vengono conteggiate come in esecuzione. Si noti che i numeri restituiti potrebbero non essere sempre aggiornati. Se sono necessari conteggi di attività esatti, usare una query di elenco. |
| list |
Elenca tutti i processi nell'account specificato. |
| list_from_job_schedule |
Elenca i processi creati nella pianificazione processo specificata. |
| list_preparation_and_release_task_status |
Elenca lo stato di esecuzione dell'attività Preparazione processo e rilascio processo per il processo specificato nei nodi di calcolo in cui è stato eseguito il processo. Questa API restituisce lo stato dell'attività Preparazione processo e Rilascio processo in tutti i nodi di calcolo che hanno eseguito l'attività Preparazione processo o Rilascio processo. Sono inclusi i nodi di calcolo che sono stati rimossi dal pool. Se questa API viene richiamata in un processo senza attività di preparazione processo o rilascio processo, il servizio Batch restituisce il codice di stato HTTP 409 (conflitto) con un codice di errore JobPreparationTaskNotSpecified. |
| patch |
Aggiornamenti le proprietà del processo specificato. In questo modo vengono sostituite solo le proprietà del processo specificate nella richiesta. Ad esempio, se il processo ha vincoli e una richiesta non specifica l'elemento vincoli, il processo mantiene i vincoli esistenti. |
| terminate |
Termina il processo specificato, contrassegnandolo come completato. Quando viene ricevuta una richiesta di processo termina, il servizio Batch imposta il processo sullo stato di terminazione. Il servizio Batch termina quindi qualsiasi attività in esecuzione associata al processo ed esegue tutte le attività necessarie per la versione del processo. Il processo viene quindi spostato nello stato completato. Se nel processo sono presenti attività nello stato attivo, rimarranno nello stato attivo. Una volta terminato un processo, non è possibile aggiungere nuove attività e le attività attive rimanenti non verranno pianificate. |
| update |
Aggiornamenti le proprietà del processo specificato. Questo sostituisce completamente tutte le proprietà aggiornabili del processo. Ad esempio, se il processo ha vincoli associati a esso e se i vincoli non vengono specificati con questa richiesta, il servizio Batch rimuoverà i vincoli esistenti. |
add
Aggiunge un processo all'account specificato.
Il servizio Batch supporta due modi per controllare il lavoro svolto come parte di un processo. Nel primo approccio, l'utente specifica un'attività di Gestione processi. Il servizio Batch avvia questa attività quando è pronto per avviare il processo. L'attività Gestione processi controlla tutte le altre attività eseguite in questo processo, usando le API attività. Nel secondo approccio, l'utente controlla direttamente l'esecuzione di Attività in un processo attivo usando le API attività. Nota anche: quando si assegnano nomi ai processi, evitare di includere informazioni riservate, ad esempio nomi utente o nomi di progetto segreti. Queste informazioni potrebbero essere visualizzate nei log di telemetria accessibili ai tecnici del supporto tecnico Microsoft.
add(job, job_add_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
Override della configurazione dell'operazione.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
delete
Elimina un processo.
L'eliminazione di un processo elimina anche tutte le attività che fanno parte di tale processo e tutte le statistiche del processo. In questo modo viene eseguito l'override del periodo di conservazione per i dati delle attività; ovvero, se il processo contiene attività che vengono ancora mantenute nei nodi di calcolo, i servizi Batch eliminano le directory di lavoro delle attività e tutto il relativo contenuto. Quando viene ricevuta una richiesta di eliminazione processo, il servizio Batch imposta lo stato di eliminazione del processo. Tutte le operazioni di aggiornamento in un processo in stato di eliminazione avranno esito negativo con codice di stato 409 (conflitto), con informazioni aggiuntive che indicano che il processo viene eliminato.
delete(job_id, job_delete_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
Override della configurazione dell'operazione.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
disable
Disabilita il processo specificato, impedendo l'esecuzione di nuove attività.
Il servizio Batch sposta immediatamente il processo nello stato di disabilitazione. Batch usa quindi il parametro disableTasks per determinare cosa fare con le attività attualmente in esecuzione del processo. Il processo rimane nello stato di disabilitazione fino al completamento dell'operazione di disabilitazione e tutte le attività sono state gestite in base all'opzione disableTasks; Il processo passa quindi allo stato disabilitato. Nessuna nuova attività viene avviata nel processo fino a quando non torna allo stato attivo. Se si tenta di disabilitare un processo in qualsiasi stato diverso da attivo, disabilitazione o disabilitato, la richiesta ha esito negativo con codice di stato 409.
disable(job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- disable_tasks
- str oppure DisableJobOption
I valori possibili includono: 'requeue', 'terminate', 'wait'
- job_disable_options
- JobDisableOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
Override della configurazione dell'operazione.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
enable
Abilita il processo specificato, consentendo l'esecuzione di nuove attività.
Quando si chiama questa API, il servizio Batch imposta un processo disabilitato sullo stato di abilitazione. Al termine dell'operazione, il processo passa allo stato attivo e la pianificazione di nuove attività nel processo riprende. Il servizio Batch non consente a un'attività di rimanere nello stato attivo per più di 180 giorni. Pertanto, se si abilita un processo contenente attività attive aggiunte più di 180 giorni fa, tali attività non verranno eseguite.
enable(job_id, job_enable_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
Override della configurazione dell'operazione.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
get
Ottiene informazioni sul processo specificato.
get(job_id, job_get_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
Override della configurazione dell'operazione.
Restituisce
CloudJob o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
get_task_counts
Ottiene il conteggio delle attività per il processo specificato.
I conteggi delle attività forniscono un conteggio delle attività in base allo stato attività attivo, in esecuzione o completato e a un conteggio delle attività riuscite o non riuscite. Le attività nello stato di preparazione vengono conteggiate come in esecuzione. Si noti che i numeri restituiti potrebbero non essere sempre aggiornati. Se sono necessari conteggi di attività esatti, usare una query di elenco.
get_task_counts(job_id, job_get_task_counts_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- job_get_task_counts_options
- JobGetTaskCountsOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
Override della configurazione dell'operazione.
Restituisce
TaskCountsResult o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
list
Elenca tutti i processi nell'account specificato.
list(job_list_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
Override della configurazione dell'operazione.
Restituisce
Iteratore come l'istanza di CloudJob
Tipo restituito
Eccezioni
list_from_job_schedule
Elenca i processi creati nella pianificazione processo specificata.
list_from_job_schedule(job_schedule_id, job_list_from_job_schedule_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- job_schedule_id
- str
ID della pianificazione del processo da cui si desidera ottenere un elenco di processi.
- job_list_from_job_schedule_options
- JobListFromJobScheduleOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
Override della configurazione dell'operazione.
Restituisce
Iteratore come l'istanza di CloudJob
Tipo restituito
Eccezioni
list_preparation_and_release_task_status
Elenca lo stato di esecuzione dell'attività Preparazione processo e rilascio processo per il processo specificato nei nodi di calcolo in cui è stato eseguito il processo.
Questa API restituisce lo stato dell'attività Preparazione processo e Rilascio processo in tutti i nodi di calcolo che hanno eseguito l'attività Preparazione processo o Rilascio processo. Sono inclusi i nodi di calcolo che sono stati rimossi dal pool. Se questa API viene richiamata in un processo senza attività di preparazione processo o rilascio processo, il servizio Batch restituisce il codice di stato HTTP 409 (conflitto) con un codice di errore 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)Parametri
- job_list_preparation_and_release_task_status_options
- JobListPreparationAndReleaseTaskStatusOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
Override della configurazione dell'operazione.
Restituisce
Iteratore come l'istanza di JobPreparationAndReleaseTaskExecutionInformation
Tipo restituito
Eccezioni
patch
Aggiornamenti le proprietà del processo specificato.
In questo modo vengono sostituite solo le proprietà del processo specificate nella richiesta. Ad esempio, se il processo ha vincoli e una richiesta non specifica l'elemento vincoli, il processo mantiene i vincoli esistenti.
patch(job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
terminate
Termina il processo specificato, contrassegnandolo come completato.
Quando viene ricevuta una richiesta di processo termina, il servizio Batch imposta il processo sullo stato di terminazione. Il servizio Batch termina quindi qualsiasi attività in esecuzione associata al processo ed esegue tutte le attività necessarie per la versione del processo. Il processo viene quindi spostato nello stato completato. Se nel processo sono presenti attività nello stato attivo, rimarranno nello stato attivo. Una volta terminato un processo, non è possibile aggiungere nuove attività e le attività attive rimanenti non verranno pianificate.
terminate(job_id, terminate_reason=None, job_terminate_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- terminate_reason
- str
- job_terminate_options
- JobTerminateOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
update
Aggiornamenti le proprietà del processo specificato.
Questo sostituisce completamente tutte le proprietà aggiornabili del processo. Ad esempio, se il processo ha vincoli associati a esso e se i vincoli non vengono specificati con questa richiesta, il servizio Batch rimuoverà i vincoli esistenti.
update(job_id, job_update_parameter, job_update_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
Attributi
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>
Azure SDK for Python
Commenti e suggerimenti
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedere https://aka.ms/ContentUserFeedback.
Invia e visualizza il feedback per