Schedules interface

Interface representing a Schedules.

Methods

beginCreateOrUpdate(string, string, string, string, Schedule, SchedulesCreateOrUpdateOptionalParams)

Creates or updates a Schedule.

beginCreateOrUpdateAndWait(string, string, string, string, Schedule, SchedulesCreateOrUpdateOptionalParams)

Creates or updates a Schedule.

beginDelete(string, string, string, string, SchedulesDeleteOptionalParams)

Deletes a Scheduled.

beginDeleteAndWait(string, string, string, string, SchedulesDeleteOptionalParams)

Deletes a Scheduled.

beginUpdate(string, string, string, string, ScheduleUpdate, SchedulesUpdateOptionalParams)

Partially updates a Scheduled.

beginUpdateAndWait(string, string, string, string, ScheduleUpdate, SchedulesUpdateOptionalParams)

Partially updates a Scheduled.

get(string, string, string, string, SchedulesGetOptionalParams)

Gets a schedule resource.

listByPool(string, string, string, SchedulesListByPoolOptionalParams)

Lists schedules for a pool

Method Details

beginCreateOrUpdate(string, string, string, string, Schedule, SchedulesCreateOrUpdateOptionalParams)

Creates or updates a Schedule.

function beginCreateOrUpdate(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, body: Schedule, options?: SchedulesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Schedule>, Schedule>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

poolName

string

Name of the pool.

scheduleName

string

The name of the schedule that uniquely identifies it.

body
Schedule

Represents a scheduled task

options
SchedulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Schedule>, Schedule>>

beginCreateOrUpdateAndWait(string, string, string, string, Schedule, SchedulesCreateOrUpdateOptionalParams)

Creates or updates a Schedule.

function beginCreateOrUpdateAndWait(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, body: Schedule, options?: SchedulesCreateOrUpdateOptionalParams): Promise<Schedule>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

poolName

string

Name of the pool.

scheduleName

string

The name of the schedule that uniquely identifies it.

body
Schedule

Represents a scheduled task

options
SchedulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Schedule>

beginDelete(string, string, string, string, SchedulesDeleteOptionalParams)

Deletes a Scheduled.

function beginDelete(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, options?: SchedulesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<SchedulesDeleteHeaders>, SchedulesDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

poolName

string

Name of the pool.

scheduleName

string

The name of the schedule that uniquely identifies it.

options
SchedulesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<SchedulesDeleteHeaders>, SchedulesDeleteHeaders>>

beginDeleteAndWait(string, string, string, string, SchedulesDeleteOptionalParams)

Deletes a Scheduled.

function beginDeleteAndWait(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, options?: SchedulesDeleteOptionalParams): Promise<SchedulesDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

poolName

string

Name of the pool.

scheduleName

string

The name of the schedule that uniquely identifies it.

options
SchedulesDeleteOptionalParams

The options parameters.

Returns

beginUpdate(string, string, string, string, ScheduleUpdate, SchedulesUpdateOptionalParams)

Partially updates a Scheduled.

function beginUpdate(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, body: ScheduleUpdate, options?: SchedulesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Schedule>, Schedule>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

poolName

string

Name of the pool.

scheduleName

string

The name of the schedule that uniquely identifies it.

body
ScheduleUpdate

Represents a scheduled task.

options
SchedulesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Schedule>, Schedule>>

beginUpdateAndWait(string, string, string, string, ScheduleUpdate, SchedulesUpdateOptionalParams)

Partially updates a Scheduled.

function beginUpdateAndWait(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, body: ScheduleUpdate, options?: SchedulesUpdateOptionalParams): Promise<Schedule>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

poolName

string

Name of the pool.

scheduleName

string

The name of the schedule that uniquely identifies it.

body
ScheduleUpdate

Represents a scheduled task.

options
SchedulesUpdateOptionalParams

The options parameters.

Returns

Promise<Schedule>

get(string, string, string, string, SchedulesGetOptionalParams)

Gets a schedule resource.

function get(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, options?: SchedulesGetOptionalParams): Promise<Schedule>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

poolName

string

Name of the pool.

scheduleName

string

The name of the schedule that uniquely identifies it.

options
SchedulesGetOptionalParams

The options parameters.

Returns

Promise<Schedule>

listByPool(string, string, string, SchedulesListByPoolOptionalParams)

Lists schedules for a pool

function listByPool(resourceGroupName: string, projectName: string, poolName: string, options?: SchedulesListByPoolOptionalParams): PagedAsyncIterableIterator<Schedule, Schedule[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

poolName

string

Name of the pool.

options
SchedulesListByPoolOptionalParams

The options parameters.

Returns