JobScheduleOperations Klasse

JobScheduleOperations-Vorgänge.

Sie sollten diese Klasse nicht direkt instanziieren, sondern einen Client instance erstellen, der sie für Sie erstellt und als Attribut anfügen wird.

Vererbung

builtins.object

JobScheduleOperations

Konstruktor

JobScheduleOperations(client, config, serializer, deserializer)

Parameter

client

Erforderlich

Client für Dienstanforderungen.

config

Erforderlich

Konfiguration des Dienstclients.

serializer

Erforderlich

Ein Objektmodellserialisierungsprogramm.

deserializer

Erforderlich

Ein Objektmodell-Deserialisierer.

Variablen

api_version

API-Version, die für die Anforderung verwendet werden soll. Konstanter Wert: "2023-05-01.17.0".

Methoden

add	Fügt dem angegebenen Konto einen Auftragszeitplan hinzu.
delete	Löscht einen Auftragszeitplan aus dem angegebenen Konto. Wenn Sie einen Auftragszeitplan löschen, werden damit auch alle Aufträge und Aufgaben unter diesem Zeitplan gelöscht. Wenn Tasks gelöscht werden, werden auch alle Dateien in ihren Arbeitsverzeichnissen auf den Computeknoten gelöscht (der Aufbewahrungszeitraum wird ignoriert). Die Statistiken zum Auftragszeitplan sind nach dem Löschen des Auftragszeitplans nicht mehr verfügbar, werden jedoch weiterhin für Statistiken zur Kontolebensdauer gezählt.
disable	Deaktiviert einen Auftragszeitplan. Es werden keine neuen Aufträge erstellt, bis der Auftragszeitplan wieder aktiviert ist.
enable	Aktiviert einen Auftragszeitplan.
exists	Überprüft, ob der angegebene Auftragszeitplan vorhanden ist.
get	Ruft Informationen zum angegebenen Auftragszeitplan ab.
list	Listet alle Auftragszeitpläne im angegebenen Konto auf.
patch	Updates die Eigenschaften des angegebenen Auftragszeitplans. Dadurch werden nur die in der Anforderung angegebenen Eigenschaften des Auftragszeitplans ersetzt. Wenn die schedule-Eigenschaft beispielsweise nicht mit dieser Anforderung angegeben wird, behält der Batch-Dienst den vorhandenen Zeitplan bei. Änderungen an einem Auftragszeitplan wirken sich nur auf Aufträge aus, die nach dem Update vom Zeitplan erstellt wurden. Aktuell ausgeführte Aufträge sind nicht betroffen.
terminate	Beendet einen Auftragszeitplan.
update	Updates die Eigenschaften des angegebenen Auftragszeitplans. Dadurch werden alle aktualisierbaren Eigenschaften des Auftragszeitplans vollständig ersetzt. Wenn die schedule-Eigenschaft beispielsweise nicht mit dieser Anforderung angegeben wird, entfernt der Batch-Dienst den vorhandenen Zeitplan. Änderungen an einem Auftragszeitplan wirken sich nur auf Aufträge aus, die nach dem Update vom Zeitplan erstellt wurden. Aktuell ausgeführte Aufträge sind nicht betroffen.

add

Fügt dem angegebenen Konto einen Auftragszeitplan hinzu.

add(cloud_job_schedule, job_schedule_add_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

cloud_job_schedule

JobScheduleAddParameter

Erforderlich

Der hinzuzufügende Auftragszeitplan.

job_schedule_add_options

JobScheduleAddOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

None oder ClientRawResponse if raw=true

Rückgabetyp

None,

ClientRawResponse

Ausnahmen

BatchErrorException

delete

Löscht einen Auftragszeitplan aus dem angegebenen Konto.

Wenn Sie einen Auftragszeitplan löschen, werden damit auch alle Aufträge und Aufgaben unter diesem Zeitplan gelöscht. Wenn Tasks gelöscht werden, werden auch alle Dateien in ihren Arbeitsverzeichnissen auf den Computeknoten gelöscht (der Aufbewahrungszeitraum wird ignoriert). Die Statistiken zum Auftragszeitplan sind nach dem Löschen des Auftragszeitplans nicht mehr verfügbar, werden jedoch weiterhin für Statistiken zur Kontolebensdauer gezählt.

delete(job_schedule_id, job_schedule_delete_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_schedule_id

str

Erforderlich

Die ID des zu löschenden Auftragszeitplans.

job_schedule_delete_options

JobScheduleDeleteOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

None oder ClientRawResponse if raw=true

Rückgabetyp

None,

ClientRawResponse

Ausnahmen

BatchErrorException

disable

Deaktiviert einen Auftragszeitplan.

Es werden keine neuen Aufträge erstellt, bis der Auftragszeitplan wieder aktiviert ist.

disable(job_schedule_id, job_schedule_disable_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_schedule_id

str

Erforderlich

Die ID des zu deaktivierenden Auftragszeitplans.

job_schedule_disable_options

JobScheduleDisableOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

None oder ClientRawResponse if raw=true

Rückgabetyp

None,

ClientRawResponse

Ausnahmen

BatchErrorException

enable

Aktiviert einen Auftragszeitplan.

enable(job_schedule_id, job_schedule_enable_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_schedule_id

str

Erforderlich

Die ID des zu aktivierenden Auftragszeitplans.

job_schedule_enable_options

JobScheduleEnableOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

None oder ClientRawResponse if raw=true

Rückgabetyp

None,

ClientRawResponse

Ausnahmen

BatchErrorException

exists

Überprüft, ob der angegebene Auftragszeitplan vorhanden ist.

exists(job_schedule_id, job_schedule_exists_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_schedule_id

str

Erforderlich

Die ID des Auftragszeitplans, den Sie überprüfen möchten.

job_schedule_exists_options

JobScheduleExistsOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

bool oder ClientRawResponse if raw=true

Rückgabetyp

bool,

ClientRawResponse

Ausnahmen

BatchErrorException

get

Ruft Informationen zum angegebenen Auftragszeitplan ab.

get(job_schedule_id, job_schedule_get_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_schedule_id

str

Erforderlich

Die ID des abzurufenden Auftragszeitplans.

job_schedule_get_options

JobScheduleGetOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

CloudJobSchedule oder ClientRawResponse if raw=true

Rückgabetyp

CloudJobSchedule,

ClientRawResponse

Ausnahmen

BatchErrorException

list

Listet alle Auftragszeitpläne im angegebenen Konto auf.

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

Parameter

job_schedule_list_options

JobScheduleListOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

Ein Iterator wie instance von CloudJobSchedule

Rückgabetyp

CloudJobSchedulePaged[CloudJobSchedule]

Ausnahmen

BatchErrorException

patch

Updates die Eigenschaften des angegebenen Auftragszeitplans.

Dadurch werden nur die in der Anforderung angegebenen Eigenschaften des Auftragszeitplans ersetzt. Wenn die schedule-Eigenschaft beispielsweise nicht mit dieser Anforderung angegeben wird, behält der Batch-Dienst den vorhandenen Zeitplan bei. Änderungen an einem Auftragszeitplan wirken sich nur auf Aufträge aus, die nach dem Update vom Zeitplan erstellt wurden. Aktuell ausgeführte Aufträge sind nicht betroffen.

patch(job_schedule_id, job_schedule_patch_parameter, job_schedule_patch_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_schedule_id

str

Erforderlich

Die ID des zu aktualisierenden Auftragszeitplans.

job_schedule_patch_parameter

JobSchedulePatchParameter

Erforderlich

Die Parameter für die Anforderung.

job_schedule_patch_options

JobSchedulePatchOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

None oder ClientRawResponse if raw=true

Rückgabetyp

None,

ClientRawResponse

Ausnahmen

BatchErrorException

terminate

Beendet einen Auftragszeitplan.

terminate(job_schedule_id, job_schedule_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_schedule_id

str

Erforderlich

Die ID des zu beendenden Auftragszeitplans.

job_schedule_terminate_options

JobScheduleTerminateOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

None oder ClientRawResponse if raw=true

Rückgabetyp

None,

ClientRawResponse

Ausnahmen

BatchErrorException

update

Updates die Eigenschaften des angegebenen Auftragszeitplans.

Dadurch werden alle aktualisierbaren Eigenschaften des Auftragszeitplans vollständig ersetzt. Wenn die schedule-Eigenschaft beispielsweise nicht mit dieser Anforderung angegeben wird, entfernt der Batch-Dienst den vorhandenen Zeitplan. Änderungen an einem Auftragszeitplan wirken sich nur auf Aufträge aus, die nach dem Update vom Zeitplan erstellt wurden. Aktuell ausgeführte Aufträge sind nicht betroffen.

update(job_schedule_id, job_schedule_update_parameter, job_schedule_update_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_schedule_id

str

Erforderlich

Die ID des zu aktualisierenden Auftragszeitplans.

job_schedule_update_parameter

JobScheduleUpdateParameter

Erforderlich

Die Parameter für die Anforderung.

job_schedule_update_options

JobScheduleUpdateOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

None oder ClientRawResponse if raw=true

Rückgabetyp

None,

ClientRawResponse

Ausnahmen

BatchErrorException

Attribute

models

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