JobCollectionsOperations Class
JobCollectionsOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectJobCollectionsOperations
Constructor
JobCollectionsOperations(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
- models
Alias to model classes used in this operation group.
Methods
| begin_delete |
Deletes a job collection. |
| begin_disable |
Disables all of the jobs in the job collection. |
| begin_enable |
Enables all of the jobs in the job collection. |
| create_or_update |
Provisions a new job collection or updates an existing job collection. |
| get |
Gets a job collection. |
| list_by_resource_group |
Gets all job collections under specified resource group. |
| list_by_subscription |
Gets all job collections under specified subscription. |
| patch |
Patches an existing job collection. |
begin_delete
Deletes a job collection.
async begin_delete(resource_group_name: str, job_collection_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_disable
Disables all of the jobs in the job collection.
async begin_disable(resource_group_name: str, job_collection_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_enable
Enables all of the jobs in the job collection.
async begin_enable(resource_group_name: str, job_collection_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or AsyncPollingMethod
True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
create_or_update
Provisions a new job collection or updates an existing job collection.
async create_or_update(resource_group_name: str, job_collection_name: str, job_collection: azure.mgmt.scheduler.models._models_py3.JobCollectionDefinition, **kwargs) -> azure.mgmt.scheduler.models._models_py3.JobCollectionDefinitionParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
JobCollectionDefinition, or the result of cls(response)
Return type
Exceptions
get
Gets a job collection.
async get(resource_group_name: str, job_collection_name: str, **kwargs) -> azure.mgmt.scheduler.models._models_py3.JobCollectionDefinitionParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
JobCollectionDefinition, or the result of cls(response)
Return type
Exceptions
list_by_resource_group
Gets all job collections under specified resource group.
list_by_resource_group(resource_group_name: str, **kwargs) -> AsyncIterable[azure.mgmt.scheduler.models._models_py3.JobCollectionListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either JobCollectionListResult or the result of cls(response)
Return type
Exceptions
list_by_subscription
Gets all job collections under specified subscription.
list_by_subscription(**kwargs) -> AsyncIterable[azure.mgmt.scheduler.models._models_py3.JobCollectionListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either JobCollectionListResult or the result of cls(response)
Return type
Exceptions
patch
Patches an existing job collection.
async patch(resource_group_name: str, job_collection_name: str, job_collection: azure.mgmt.scheduler.models._models_py3.JobCollectionDefinition, **kwargs) -> azure.mgmt.scheduler.models._models_py3.JobCollectionDefinitionParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
JobCollectionDefinition, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.scheduler.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\scheduler\\models\\__init__.py'>Feedback
Submit and view feedback for