Share via

GlobalSchedulesOperations Class

  • Reference

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.object
GlobalSchedulesOperations

Constructor

GlobalSchedulesOperations(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
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

Name Description
resource_group_name
Required
str

The name of the resource group.
name
Required
str

The name of the schedule.

Keyword-Only Parameters

Name Description
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

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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: str | None = None, target_resource_id: str | None = None, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
name
Required
str

The name of the schedule.
current_resource_id
str

The resource Id of the virtual machine on which the schedule operates.

Default value: None
target_resource_id
str

The resource Id of the virtual machine that the schedule should be retargeted to.

Default value: None

Keyword-Only Parameters

Name Description
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

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

create_or_update

Create or replace an existing schedule.

create_or_update(resource_group_name: str, name: str, schedule: '_models.Schedule', **kwargs: Any) -> _models.Schedule

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
name
Required
str

The name of the schedule.
schedule
Required
Schedule

A schedule.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
Schedule

Schedule, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Delete schedule.

delete(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
name
Required
str

The name of the schedule.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
None

None, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get schedule.

get(resource_group_name: str, name: str, expand: str | None = None, **kwargs: Any) -> _models.Schedule

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
name
Required
str

The name of the schedule.
expand
str

Specify the $expand query. Example: 'properties($select=status)'.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
Schedule

Schedule, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_resource_group

List schedules in a resource group.

list_by_resource_group(resource_group_name: str, expand: str | None = None, filter: str | None = None, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> Iterable['_models.ScheduleList']

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
expand
str

Specify the $expand query. Example: 'properties($select=status)'.

Default value: None
filter
str

The filter to apply to the operation. Example: '$filter=contains(name,'myName').

Default value: None
top
int

The maximum number of resources to return from the operation. Example: '$top=10'.

Default value: None
orderby
str

The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[ScheduleList]

An iterator like instance of either ScheduleList or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_subscription

List schedules in a subscription.

list_by_subscription(expand: str | None = None, filter: str | None = None, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> Iterable['_models.ScheduleList']

Parameters

Name Description
expand
str

Specify the $expand query. Example: 'properties($select=status)'.

Default value: None
filter
str

The filter to apply to the operation. Example: '$filter=contains(name,'myName').

Default value: None
top
int

The maximum number of resources to return from the operation. Example: '$top=10'.

Default value: None
orderby
str

The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[ScheduleList]

An iterator like instance of either ScheduleList or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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.Schedule

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
name
Required
str

The name of the schedule.
schedule
Required
ScheduleFragment

A schedule.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
Schedule

Schedule, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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