Share via

Schedules interface

  • Reference
Package:
@azure/arm-devtestlabs

Interface representing a Schedules.

Methods

beginExecute(string, string, string, SchedulesExecuteOptionalParams)

Execute a schedule. This operation can take a while to complete.
beginExecuteAndWait(string, string, string, SchedulesExecuteOptionalParams)

Execute a schedule. This operation can take a while to complete.
createOrUpdate(string, string, string, Schedule, SchedulesCreateOrUpdateOptionalParams)

Create or replace an existing schedule.
delete(string, string, string, SchedulesDeleteOptionalParams)

Delete schedule.
get(string, string, string, SchedulesGetOptionalParams)

Get schedule.
list(string, string, SchedulesListOptionalParams)

List schedules in a given lab.
listApplicable(string, string, string, SchedulesListApplicableOptionalParams)

Lists all applicable schedules
update(string, string, string, ScheduleFragment, SchedulesUpdateOptionalParams)

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

Method Details

beginExecute(string, string, string, SchedulesExecuteOptionalParams)

Execute a schedule. This operation can take a while to complete.

function beginExecute(resourceGroupName: string, labName: string, name: string, options?: SchedulesExecuteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the schedule.

options
SchedulesExecuteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginExecuteAndWait(string, string, string, SchedulesExecuteOptionalParams)

Execute a schedule. This operation can take a while to complete.

function beginExecuteAndWait(resourceGroupName: string, labName: string, name: string, options?: SchedulesExecuteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the schedule.

options
SchedulesExecuteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, string, Schedule, SchedulesCreateOrUpdateOptionalParams)

Create or replace an existing schedule.

function createOrUpdate(resourceGroupName: string, labName: string, name: string, schedule: Schedule, options?: SchedulesCreateOrUpdateOptionalParams): Promise<Schedule>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the schedule.

schedule
Schedule

A schedule.

options
SchedulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Schedule>

delete(string, string, string, SchedulesDeleteOptionalParams)

Delete schedule.

function delete(resourceGroupName: string, labName: string, name: string, options?: SchedulesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the schedule.

options
SchedulesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, SchedulesGetOptionalParams)

Get schedule.

function get(resourceGroupName: string, labName: string, name: string, options?: SchedulesGetOptionalParams): Promise<Schedule>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the schedule.

options
SchedulesGetOptionalParams

The options parameters.

Returns

Promise<Schedule>

list(string, string, SchedulesListOptionalParams)

List schedules in a given lab.

function list(resourceGroupName: string, labName: string, options?: SchedulesListOptionalParams): PagedAsyncIterableIterator<Schedule, Schedule[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

options
SchedulesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Schedule, Schedule[], PageSettings>

listApplicable(string, string, string, SchedulesListApplicableOptionalParams)

Lists all applicable schedules

function listApplicable(resourceGroupName: string, labName: string, name: string, options?: SchedulesListApplicableOptionalParams): PagedAsyncIterableIterator<Schedule, Schedule[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the schedule.

options
SchedulesListApplicableOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Schedule, Schedule[], PageSettings>

update(string, string, string, ScheduleFragment, SchedulesUpdateOptionalParams)

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

function update(resourceGroupName: string, labName: string, name: string, schedule: ScheduleFragment, options?: SchedulesUpdateOptionalParams): Promise<Schedule>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the schedule.

schedule
ScheduleFragment

A schedule.

options
SchedulesUpdateOptionalParams

The options parameters.

Returns

Promise<Schedule>