GlobalSchedulesOperations Class
GlobalSchedulesOperations 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.objectGlobalSchedulesOperations
Constructor
GlobalSchedulesOperations(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_execute |
Execute a schedule. This operation can take a while to complete. |
| begin_retarget |
Updates a schedule's target resource Id. This operation can take a while to complete. |
| create_or_update |
Create or replace an existing schedule. |
| delete |
Delete schedule. |
| get |
Get schedule. |
| list_by_resource_group |
List schedules in a resource group. |
| list_by_subscription |
List schedules in a subscription. |
| update |
Allows modifying tags of schedules. All other properties will be ignored. |
begin_execute
Execute a schedule. This operation can take a while to complete.
begin_execute(resource_group_name: str, name: str, **kwargs: Any) -> LROPoller[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 PollingMethod
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 LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_retarget
Updates a schedule's target resource Id. This operation can take a while to complete.
begin_retarget(resource_group_name: str, name: str, current_resource_id: Optional[str] = None, target_resource_id: Optional[str] = None, **kwargs: Any) -> LROPoller[None]Parameters
- current_resource_id
- str
The resource Id of the virtual machine on which the schedule operates.
- target_resource_id
- str
The resource Id of the virtual machine that the schedule should be retargeted to.
- 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 PollingMethod
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 LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
create_or_update
Create or replace an existing schedule.
create_or_update(resource_group_name: str, name: str, schedule: _models.Schedule, **kwargs: Any) -> _models.ScheduleParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Schedule, or the result of cls(response)
Return type
Exceptions
delete
Delete schedule.
delete(resource_group_name: str, name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
get
Get schedule.
get(resource_group_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) -> _models.ScheduleParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Schedule, or the result of cls(response)
Return type
Exceptions
list_by_resource_group
List schedules in a resource group.
list_by_resource_group(resource_group_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) -> Iterable[_models.ScheduleList]Parameters
- filter
- str
The filter to apply to the operation. Example: '$filter=contains(name,'myName').
- top
- int
The maximum number of resources to return from the operation. Example: '$top=10'.
- orderby
- str
The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ScheduleList or the result of cls(response)
Return type
Exceptions
list_by_subscription
List schedules in a subscription.
list_by_subscription(expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) -> Iterable[_models.ScheduleList]Parameters
- filter
- str
The filter to apply to the operation. Example: '$filter=contains(name,'myName').
- top
- int
The maximum number of resources to return from the operation. Example: '$top=10'.
- orderby
- str
The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ScheduleList or the result of cls(response)
Return type
Exceptions
update
Allows modifying tags of schedules. All other properties will be ignored.
update(resource_group_name: str, name: str, schedule: _models.ScheduleFragment, **kwargs: Any) -> _models.ScheduleParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Schedule, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.devtestlabs.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>Feedback
Submit and view feedback for