Schedules interface
Interface representing a Schedules.
Methods
| begin |
Operation to delete a schedule resource. |
| begin |
Operation to delete a schedule resource. |
| create |
Operation to create or update a lab schedule. |
| get(string, string, string, Schedules |
Returns the properties of a lab Schedule. |
| list |
Returns a list of all schedules for a lab. |
| update(string, string, string, Schedule |
Operation to update a lab schedule. |
Method Details
beginDelete(string, string, string, SchedulesDeleteOptionalParams)
Operation to delete a schedule resource.
function beginDelete(resourceGroupName: string, labName: string, scheduleName: string, options?: SchedulesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- scheduleName
-
string
The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.
- options
- SchedulesDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, SchedulesDeleteOptionalParams)
Operation to delete a schedule resource.
function beginDeleteAndWait(resourceGroupName: string, labName: string, scheduleName: string, options?: SchedulesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- scheduleName
-
string
The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.
- options
- SchedulesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
createOrUpdate(string, string, string, Schedule, SchedulesCreateOrUpdateOptionalParams)
Operation to create or update a lab schedule.
function createOrUpdate(resourceGroupName: string, labName: string, scheduleName: string, body: Schedule, options?: SchedulesCreateOrUpdateOptionalParams): Promise<Schedule>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- scheduleName
-
string
The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.
- body
- Schedule
The request body.
The options parameters.
Returns
Promise<Schedule>
get(string, string, string, SchedulesGetOptionalParams)
Returns the properties of a lab Schedule.
function get(resourceGroupName: string, labName: string, scheduleName: string, options?: SchedulesGetOptionalParams): Promise<Schedule>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- scheduleName
-
string
The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.
- options
- SchedulesGetOptionalParams
The options parameters.
Returns
Promise<Schedule>
listByLab(string, string, SchedulesListByLabOptionalParams)
Returns a list of all schedules for a lab.
function listByLab(resourceGroupName: string, labName: string, options?: SchedulesListByLabOptionalParams): PagedAsyncIterableIterator<Schedule, Schedule[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- options
- SchedulesListByLabOptionalParams
The options parameters.
Returns
update(string, string, string, ScheduleUpdate, SchedulesUpdateOptionalParams)
Operation to update a lab schedule.
function update(resourceGroupName: string, labName: string, scheduleName: string, body: ScheduleUpdate, options?: SchedulesUpdateOptionalParams): Promise<Schedule>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- scheduleName
-
string
The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.
- body
- ScheduleUpdate
The request body.
- options
- SchedulesUpdateOptionalParams
The options parameters.
Returns
Promise<Schedule>