GlobalSchedulesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:global_schedules> attribute.

Constructor

GlobalSchedulesOperations(*args, **kwargs)

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.

async begin_execute(resource_group_name: str, name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
name Required	str The name of the schedule. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller 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.

async begin_retarget(resource_group_name: str, name: str, current_resource_id: str | None = None, target_resource_id: str | None = None, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
name Required	str The name of the schedule. Required.
current_resource_id	str The resource Id of the virtual machine on which the schedule operates. Default value is None. Default value: None
target_resource_id	str The resource Id of the virtual machine that the schedule should be retargeted to. Default value is None. Default value: None

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update

Create or replace an existing schedule.

async create_or_update(resource_group_name: str, name: str, schedule: _models.Schedule, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Schedule

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
name Required	str The name of the schedule. Required.
schedule Required	Schedule or IO[bytes] A schedule. Is either a Schedule type or a IO[bytes] type. Required.

Returns

Type	Description
Schedule	Schedule or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Delete schedule.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
name Required	str The name of the schedule. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get schedule.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
name Required	str The name of the schedule. Required.
expand	str Specify the $expand query. Example: 'properties($select=status)'. Default value is None. Default value: None

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) -> AsyncItemPaged[Schedule]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
expand	str Specify the $expand query. Example: 'properties($select=status)'. Default value is None. Default value: None
filter	str The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None. Default value: None
top	int The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None. Default value: None
orderby	str The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None. Default value: None

Returns

Type	Description
AsyncItemPaged[Schedule]	An iterator like instance of either Schedule 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) -> AsyncItemPaged[Schedule]

Parameters

Name	Description
expand	str Specify the $expand query. Example: 'properties($select=status)'. Default value is None. Default value: None
filter	str The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None. Default value: None
top	int The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None. Default value: None
orderby	str The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None. Default value: None

Returns

Type	Description
AsyncItemPaged[Schedule]	An iterator like instance of either Schedule or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Allows modifying tags of schedules. All other properties will be ignored.

async update(resource_group_name: str, name: str, tags: dict[str, str] | None = None, **kwargs: Any) -> Schedule

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
name Required	str The name of the schedule. Required.
tags	dict[str, str] The tags of the resource. Default value is None. Default value: None

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:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv125\\Lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>

Feedback

Was this page helpful?