Share via

VirtualMachineSchedulesOperations Class

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

Constructor

VirtualMachineSchedulesOperations(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.
create_or_update

Create or replace an existing schedule.
delete

Delete schedule.
get

Get schedule.
list

List schedules in a given virtual machine.
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, lab_name: str, virtual_machine_name: str, name: str, **kwargs) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
lab_name
Required
str

The name of the lab.
virtual_machine_name
Required
str

The name of the virtual machine.
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 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

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, lab_name: str, virtual_machine_name: str, name: str, schedule: Schedule, **kwargs) -> Schedule

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
lab_name
Required
str

The name of the lab.
virtual_machine_name
Required
str

The name of the virtual machine.
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.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
lab_name
Required
str

The name of the lab.
virtual_machine_name
Required
str

The name of the virtual machine.
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.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
lab_name
Required
str

The name of the lab.
virtual_machine_name
Required
str

The name of the virtual machine.
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

List schedules in a given virtual machine.

list(resource_group_name: str, lab_name: str, virtual_machine_name: str, expand: str | None = None, filter: str | None = None, top: int | None = None, orderby: str | None = None, **kwargs) -> AsyncIterable[ScheduleList]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
lab_name
Required
str

The name of the lab.
virtual_machine_name
Required
str

The name of the virtual machine.
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
AsyncItemPaged[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.

async update(resource_group_name: str, lab_name: str, virtual_machine_name: str, name: str, schedule: ScheduleFragment, **kwargs) -> Schedule

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
lab_name
Required
str

The name of the lab.
virtual_machine_name
Required
str

The name of the virtual machine.
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:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv120\\Lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>