VirtualMachineSchedulesOperations Class

VirtualMachineSchedulesOperations 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

VirtualMachineSchedulesOperations

Constructor

VirtualMachineSchedulesOperations(client, config, serializer, deserializer)

Parameters

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

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.

begin_execute(resource_group_name: str, lab_name: str, virtual_machine_name: str, name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

virtual_machine_name

str

Required

The name of the virtual machine.

name

str

Required

The name of the schedule.

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

LROPoller[None]

Exceptions

HttpResponseError

create_or_update

Create or replace an existing schedule.

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

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

virtual_machine_name

str

Required

The name of the virtual machine.

name

str

Required

The name of the schedule.

schedule

Schedule

Required

A schedule.

cls

callable

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

Returns

Schedule, or the result of cls(response)

Return type

Schedule

Exceptions

HttpResponseError

delete

Delete schedule.

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

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

virtual_machine_name

str

Required

The name of the virtual machine.

name

str

Required

The name of the schedule.

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Get schedule.

get(resource_group_name: str, lab_name: str, virtual_machine_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) -> _models.Schedule

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

virtual_machine_name

str

Required

The name of the virtual machine.

name

str

Required

The name of the schedule.

expand

str

default value: None

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

cls

callable

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

Returns

Schedule, or the result of cls(response)

Return type

Schedule

Exceptions

HttpResponseError

list

List schedules in a given virtual machine.

list(resource_group_name: str, lab_name: str, virtual_machine_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) -> Iterable[_models.ScheduleList]

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

virtual_machine_name

str

Required

The name of the virtual machine.

expand

str

default value: None

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

filter

str

default value: None

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

top

int

default value: None

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

orderby

str

default value: None

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

ItemPaged[ScheduleList]

Exceptions

HttpResponseError

update

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

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

Parameters

resource_group_name

str

Required

The name of the resource group.

lab_name

str

Required

The name of the lab.

virtual_machine_name

str

Required

The name of the virtual machine.

name

str

Required

The name of the schedule.

schedule

ScheduleFragment

Required

A schedule.

cls

callable

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

Returns

Schedule, or the result of cls(response)

Return type

Schedule

Exceptions

HttpResponseError

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'>