Package version:

Interface Schedules

Interface representing a Schedules.

Hierarchy

Schedules

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get listByPool

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, body: Schedule, options?: SchedulesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Schedule>, Schedule>>
Creates or updates a 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
- Optional options: SchedulesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<Schedule>, Schedule>>
- Defined in operationsInterfaces/schedules.ts:64

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, body: Schedule, options?: SchedulesCreateOrUpdateOptionalParams): Promise<Schedule>
Creates or updates a 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
- Optional options: SchedulesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<Schedule>
- Defined in operationsInterfaces/schedules.ts:86

beginDelete

beginDelete(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, options?: SchedulesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deletes a Scheduled.
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.
- Optional options: SchedulesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/schedules.ts:141

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, options?: SchedulesDeleteOptionalParams): Promise<void>
Deletes a Scheduled.
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.
- Optional options: SchedulesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/schedules.ts:156

beginUpdate

beginUpdate(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, body: ScheduleUpdate, options?: SchedulesUpdateOptionalParams): Promise<PollerLike<PollOperationState<Schedule>, Schedule>>
Partially updates a Scheduled.
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.
- Optional options: SchedulesUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<Schedule>, Schedule>>
- Defined in operationsInterfaces/schedules.ts:103

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, body: ScheduleUpdate, options?: SchedulesUpdateOptionalParams): Promise<Schedule>
Partially updates a Scheduled.
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.
- Optional options: SchedulesUpdateOptionalParams
  
  The options parameters.
Returns Promise<Schedule>
- Defined in operationsInterfaces/schedules.ts:125

get

get(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, options?: SchedulesGetOptionalParams): Promise<Schedule>
Gets a schedule resource.
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.
- Optional options: SchedulesGetOptionalParams
  
  The options parameters.
Returns Promise<Schedule>
- Defined in operationsInterfaces/schedules.ts:48

listByPool

listByPool(resourceGroupName: string, projectName: string, poolName: string, options?: SchedulesListByPoolOptionalParams): PagedAsyncIterableIterator<Schedule>
Lists schedules for a pool
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.
- Optional options: SchedulesListByPoolOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Schedule>
- Defined in operationsInterfaces/schedules.ts:34

Interface Schedules

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

projectName: string

poolName: string

scheduleName: string

body: Schedule

Optional options: SchedulesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<Schedule>, Schedule>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

projectName: string

poolName: string

scheduleName: string

body: Schedule

Optional options: SchedulesCreateOrUpdateOptionalParams

Returns Promise<Schedule>

beginDelete

Parameters

resourceGroupName: string

projectName: string

poolName: string

scheduleName: string

Optional options: SchedulesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

projectName: string

poolName: string

scheduleName: string

Optional options: SchedulesDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

projectName: string

poolName: string

scheduleName: string

body: ScheduleUpdate

Optional options: SchedulesUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<Schedule>, Schedule>>

beginUpdateAndWait

Parameters

resourceGroupName: string

projectName: string

poolName: string

scheduleName: string

body: ScheduleUpdate

Optional options: SchedulesUpdateOptionalParams

Returns Promise<Schedule>

get

Parameters

resourceGroupName: string

projectName: string

poolName: string

scheduleName: string

Optional options: SchedulesGetOptionalParams

Returns Promise<Schedule>

listByPool

Parameters

resourceGroupName: string

projectName: string

poolName: string

Optional options: SchedulesListByPoolOptionalParams

Returns PagedAsyncIterableIterator<Schedule>

Settings

Member Visibility

Theme

`Optional` options: SchedulesCreateOrUpdateOptionalParams

`Optional` options: SchedulesCreateOrUpdateOptionalParams

`Optional` options: SchedulesDeleteOptionalParams

`Optional` options: SchedulesDeleteOptionalParams

`Optional` options: SchedulesUpdateOptionalParams

`Optional` options: SchedulesUpdateOptionalParams

`Optional` options: SchedulesGetOptionalParams

`Optional` options: SchedulesListByPoolOptionalParams