JobScheduleOperations Class
JobScheduleOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Inheritance
-
builtins.objectJobScheduleOperations
Constructor
JobScheduleOperations(client, config, serializer, deserializer)Parameters
| Name | Description |
|---|---|
|
client
Required
|
Client for service requests. |
|
config
Required
|
Configuration of service client. |
|
serializer
Required
|
An object model serializer. |
|
deserializer
Required
|
An object model deserializer. |
Variables
| Name | Description |
|---|---|
|
api_version
|
The API version to use for the request. Constant value: "2024-02-01.19.0". |
Methods
| add |
Adds a Job Schedule to the specified Account. |
| delete |
Deletes a Job Schedule from the specified Account. When you delete a Job Schedule, this also deletes all Jobs and Tasks under that schedule. When Tasks are deleted, all the files in their working directories on the Compute Nodes are also deleted (the retention period is ignored). The Job Schedule statistics are no longer accessible once the Job Schedule is deleted, though they are still counted towards Account lifetime statistics. |
| disable |
Disables a Job Schedule. No new Jobs will be created until the Job Schedule is enabled again. |
| enable |
Enables a Job Schedule. |
| exists |
Checks the specified Job Schedule exists. |
| get |
Gets information about the specified Job Schedule. |
| list |
Lists all of the Job Schedules in the specified Account. |
| patch |
Updates the properties of the specified Job Schedule. This replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected. |
| terminate |
Terminates a Job Schedule. |
| update |
Updates the properties of the specified Job Schedule. This fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected. |
add
Adds a Job Schedule to the specified Account.
add(cloud_job_schedule, job_schedule_add_options=None, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
cloud_job_schedule
Required
|
The Job Schedule to be added. |
|
job_schedule_add_options
|
Additional parameters for the operation default value: None
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
None,
<xref:msrest.pipeline.ClientRawResponse>
|
None or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
delete
Deletes a Job Schedule from the specified Account.
When you delete a Job Schedule, this also deletes all Jobs and Tasks under that schedule. When Tasks are deleted, all the files in their working directories on the Compute Nodes are also deleted (the retention period is ignored). The Job Schedule statistics are no longer accessible once the Job Schedule is deleted, though they are still counted towards Account lifetime statistics.
delete(job_schedule_id, job_schedule_delete_options=None, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
job_schedule_id
Required
|
The ID of the Job Schedule to delete. |
|
job_schedule_delete_options
|
Additional parameters for the operation default value: None
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
None,
<xref:msrest.pipeline.ClientRawResponse>
|
None or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
disable
Disables a Job Schedule.
No new Jobs will be created until the Job Schedule is enabled again.
disable(job_schedule_id, job_schedule_disable_options=None, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
job_schedule_id
Required
|
The ID of the Job Schedule to disable. |
|
job_schedule_disable_options
|
Additional parameters for the operation default value: None
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
None,
<xref:msrest.pipeline.ClientRawResponse>
|
None or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
enable
Enables a Job Schedule.
enable(job_schedule_id, job_schedule_enable_options=None, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
job_schedule_id
Required
|
The ID of the Job Schedule to enable. |
|
job_schedule_enable_options
|
Additional parameters for the operation default value: None
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
None,
<xref:msrest.pipeline.ClientRawResponse>
|
None or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
exists
Checks the specified Job Schedule exists.
exists(job_schedule_id, job_schedule_exists_options=None, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
job_schedule_id
Required
|
The ID of the Job Schedule which you want to check. |
|
job_schedule_exists_options
|
Additional parameters for the operation default value: None
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
bool,
<xref:msrest.pipeline.ClientRawResponse>
|
bool or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
get
Gets information about the specified Job Schedule.
get(job_schedule_id, job_schedule_get_options=None, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
job_schedule_id
Required
|
The ID of the Job Schedule to get. |
|
job_schedule_get_options
|
Additional parameters for the operation default value: None
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
CloudJobSchedule or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
list
Lists all of the Job Schedules in the specified Account.
list(job_schedule_list_options=None, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
job_schedule_list_options
|
Additional parameters for the operation default value: None
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of CloudJobSchedule |
Exceptions
| Type | Description |
|---|---|
patch
Updates the properties of the specified Job Schedule.
This replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.
patch(job_schedule_id, job_schedule_patch_parameter, job_schedule_patch_options=None, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
job_schedule_id
Required
|
The ID of the Job Schedule to update. |
|
job_schedule_patch_parameter
Required
|
The parameters for the request. |
|
job_schedule_patch_options
|
Additional parameters for the operation default value: None
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
None,
<xref:msrest.pipeline.ClientRawResponse>
|
None or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
terminate
Terminates a Job Schedule.
terminate(job_schedule_id, job_schedule_terminate_options=None, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
job_schedule_id
Required
|
The ID of the Job Schedule to terminates. |
|
job_schedule_terminate_options
|
Additional parameters for the operation default value: None
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
None,
<xref:msrest.pipeline.ClientRawResponse>
|
None or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
update
Updates the properties of the specified Job Schedule.
This fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.
update(job_schedule_id, job_schedule_update_parameter, job_schedule_update_options=None, custom_headers=None, raw=False, **operation_config)Parameters
| Name | Description |
|---|---|
|
job_schedule_id
Required
|
The ID of the Job Schedule to update. |
|
job_schedule_update_parameter
Required
|
The parameters for the request. |
|
job_schedule_update_options
|
Additional parameters for the operation default value: None
|
|
custom_headers
|
headers that will be added to the request default value: None
|
|
raw
|
returns the direct response alongside the deserialized response default value: False
|
|
operation_config
Required
|
Operation configuration overrides. |
Returns
| Type | Description |
|---|---|
|
None,
<xref:msrest.pipeline.ClientRawResponse>
|
None or ClientRawResponse if raw=true |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for