Schedules interface
Interface representing a Schedules.
Methods
| begin |
Creates or updates a Schedule. |
| begin |
Creates or updates a Schedule. |
| begin |
Deletes a Scheduled. |
| begin |
Deletes a Scheduled. |
| begin |
Partially updates a Scheduled. |
| begin |
Partially updates a Scheduled. |
| get(string, string, string, string, Schedules |
Gets a schedule resource. |
| list |
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
The options parameters.
Returns
Promise<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
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<void>, void>>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<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, SchedulesDeleteOptionalParams)
Deletes a Scheduled.
function beginDeleteAndWait(resourceGroupName: string, projectName: string, poolName: string, scheduleName: string, options?: SchedulesDeleteOptionalParams): Promise<void>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<void>
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<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.
The options parameters.
Returns
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for