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
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- api_version
The API version to use for the request. Constant value: "2022-01-01.15.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
- job_schedule_add_options
- JobScheduleAddOptions
Additional parameters for the operation
- operation_config
Operation configuration overrides.
Returns
None or ClientRawResponse if raw=true
Return type
Exceptions
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
- job_schedule_delete_options
- JobScheduleDeleteOptions
Additional parameters for the operation
- operation_config
Operation configuration overrides.
Returns
None or ClientRawResponse if raw=true
Return type
Exceptions
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
- job_schedule_disable_options
- JobScheduleDisableOptions
Additional parameters for the operation
- operation_config
Operation configuration overrides.
Returns
None or ClientRawResponse if raw=true
Return type
Exceptions
enable
Enables a Job Schedule.
enable(job_schedule_id, job_schedule_enable_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- job_schedule_enable_options
- JobScheduleEnableOptions
Additional parameters for the operation
- operation_config
Operation configuration overrides.
Returns
None or ClientRawResponse if raw=true
Return type
Exceptions
exists
Checks the specified Job Schedule exists.
exists(job_schedule_id, job_schedule_exists_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- job_schedule_exists_options
- JobScheduleExistsOptions
Additional parameters for the operation
- operation_config
Operation configuration overrides.
Returns
bool or ClientRawResponse if raw=true
Return type
Exceptions
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
- job_schedule_get_options
- JobScheduleGetOptions
Additional parameters for the operation
- operation_config
Operation configuration overrides.
Returns
CloudJobSchedule or ClientRawResponse if raw=true
Return type
Exceptions
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
- job_schedule_list_options
- JobScheduleListOptions
Additional parameters for the operation
- operation_config
Operation configuration overrides.
Returns
An iterator like instance of CloudJobSchedule
Return type
Exceptions
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
- job_schedule_patch_options
- JobSchedulePatchOptions
Additional parameters for the operation
- operation_config
Operation configuration overrides.
Returns
None or ClientRawResponse if raw=true
Return type
Exceptions
terminate
Terminates a Job Schedule.
terminate(job_schedule_id, job_schedule_terminate_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- job_schedule_terminate_options
- JobScheduleTerminateOptions
Additional parameters for the operation
- operation_config
Operation configuration overrides.
Returns
None or ClientRawResponse if raw=true
Return type
Exceptions
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
- job_schedule_update_options
- JobScheduleUpdateOptions
Additional parameters for the operation
- operation_config
Operation configuration overrides.
Returns
None or ClientRawResponse if raw=true
Return type
Exceptions
Attributes
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\batch\\models\\__init__.py'>Feedback
Submit and view feedback for