VirtualMachineSchedules interface
Interface representing a VirtualMachineSchedules.
Methods
| begin |
Execute a schedule. This operation can take a while to complete. |
| begin |
Execute a schedule. This operation can take a while to complete. |
| create |
Create or replace an existing schedule. |
| delete(string, string, string, string, Virtual |
Delete schedule. |
| get(string, string, string, string, Virtual |
Get schedule. |
| list(string, string, string, Virtual |
List schedules in a given virtual machine. |
| update(string, string, string, string, Schedule |
Allows modifying tags of schedules. All other properties will be ignored. |
Method Details
beginExecute(string, string, string, string, VirtualMachineSchedulesExecuteOptionalParams)
Execute a schedule. This operation can take a while to complete.
function beginExecute(resourceGroupName: string, labName: string, virtualMachineName: string, name: string, options?: VirtualMachineSchedulesExecuteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- virtualMachineName
-
string
The name of the virtual machine.
- name
-
string
The name of the schedule.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginExecuteAndWait(string, string, string, string, VirtualMachineSchedulesExecuteOptionalParams)
Execute a schedule. This operation can take a while to complete.
function beginExecuteAndWait(resourceGroupName: string, labName: string, virtualMachineName: string, name: string, options?: VirtualMachineSchedulesExecuteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- virtualMachineName
-
string
The name of the virtual machine.
- name
-
string
The name of the schedule.
The options parameters.
Returns
Promise<void>
createOrUpdate(string, string, string, string, Schedule, VirtualMachineSchedulesCreateOrUpdateOptionalParams)
Create or replace an existing schedule.
function createOrUpdate(resourceGroupName: string, labName: string, virtualMachineName: string, name: string, schedule: Schedule, options?: VirtualMachineSchedulesCreateOrUpdateOptionalParams): Promise<Schedule>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- virtualMachineName
-
string
The name of the virtual machine.
- name
-
string
The name of the schedule.
- schedule
- Schedule
A schedule.
The options parameters.
Returns
Promise<Schedule>
delete(string, string, string, string, VirtualMachineSchedulesDeleteOptionalParams)
Delete schedule.
function delete(resourceGroupName: string, labName: string, virtualMachineName: string, name: string, options?: VirtualMachineSchedulesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- virtualMachineName
-
string
The name of the virtual machine.
- name
-
string
The name of the schedule.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, VirtualMachineSchedulesGetOptionalParams)
Get schedule.
function get(resourceGroupName: string, labName: string, virtualMachineName: string, name: string, options?: VirtualMachineSchedulesGetOptionalParams): Promise<Schedule>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- virtualMachineName
-
string
The name of the virtual machine.
- name
-
string
The name of the schedule.
The options parameters.
Returns
Promise<Schedule>
list(string, string, string, VirtualMachineSchedulesListOptionalParams)
List schedules in a given virtual machine.
function list(resourceGroupName: string, labName: string, virtualMachineName: string, options?: VirtualMachineSchedulesListOptionalParams): PagedAsyncIterableIterator<Schedule, Schedule[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- virtualMachineName
-
string
The name of the virtual machine.
The options parameters.
Returns
update(string, string, string, string, ScheduleFragment, VirtualMachineSchedulesUpdateOptionalParams)
Allows modifying tags of schedules. All other properties will be ignored.
function update(resourceGroupName: string, labName: string, virtualMachineName: string, name: string, schedule: ScheduleFragment, options?: VirtualMachineSchedulesUpdateOptionalParams): Promise<Schedule>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- virtualMachineName
-
string
The name of the virtual machine.
- name
-
string
The name of the schedule.
- schedule
- ScheduleFragment
A schedule.
The options parameters.
Returns
Promise<Schedule>