Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Schedules

Package version

Class representing a Schedules.

Hierarchy

  • Schedules

Index

Constructors

Methods

Constructors

constructor

Methods

beginExecute

  • beginExecute(resourceGroupName: string, labName: string, name: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

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

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the schedule.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(resourceGroupName: string, labName: string, name: string, schedule: Schedule, options?: msRest.RequestOptionsBase): Promise<Models.SchedulesCreateOrUpdateResponse>
  • createOrUpdate(resourceGroupName: string, labName: string, name: string, schedule: Schedule, callback: msRest.ServiceCallback<Schedule>): void
  • createOrUpdate(resourceGroupName: string, labName: string, name: string, schedule: Schedule, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Schedule>): void

  • Create or replace an existing 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SchedulesCreateOrUpdateResponse>

    Promise<Models.SchedulesCreateOrUpdateResponse>

  • 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.

    • callback: msRest.ServiceCallback<Schedule>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Schedule>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, labName: string, name: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, labName: string, name: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, labName: string, name: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Delete schedule.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the schedule.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the schedule.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

execute

  • execute(resourceGroupName: string, labName: string, name: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

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

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the schedule.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(resourceGroupName: string, labName: string, name: string, options?: Models.SchedulesGetOptionalParams): Promise<Models.SchedulesGetResponse>
  • get(resourceGroupName: string, labName: string, name: string, callback: msRest.ServiceCallback<Schedule>): void
  • get(resourceGroupName: string, labName: string, name: string, options: SchedulesGetOptionalParams, callback: msRest.ServiceCallback<Schedule>): void

  • Get schedule.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the schedule.

    • Optional options: Models.SchedulesGetOptionalParams

    Returns Promise<Models.SchedulesGetResponse>

    Promise<Models.SchedulesGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the schedule.

    • callback: msRest.ServiceCallback<Schedule>

      The callback

    Returns 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: SchedulesGetOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<Schedule>

      The callback

    Returns void

list

  • list(resourceGroupName: string, labName: string, options?: Models.SchedulesListOptionalParams): Promise<Models.SchedulesListResponse>
  • list(resourceGroupName: string, labName: string, callback: msRest.ServiceCallback<ScheduleList>): void
  • list(resourceGroupName: string, labName: string, options: SchedulesListOptionalParams, callback: msRest.ServiceCallback<ScheduleList>): void

  • List schedules in a given lab.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • Optional options: Models.SchedulesListOptionalParams

    Returns Promise<Models.SchedulesListResponse>

    Promise<Models.SchedulesListResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • callback: msRest.ServiceCallback<ScheduleList>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • options: SchedulesListOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<ScheduleList>

      The callback

    Returns void

listApplicable

  • listApplicable(resourceGroupName: string, labName: string, name: string, options?: msRest.RequestOptionsBase): Promise<Models.SchedulesListApplicableResponse>
  • listApplicable(resourceGroupName: string, labName: string, name: string, callback: msRest.ServiceCallback<ScheduleList>): void
  • listApplicable(resourceGroupName: string, labName: string, name: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ScheduleList>): void

  • Lists all applicable schedules

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the schedule.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SchedulesListApplicableResponse>

    Promise<Models.SchedulesListApplicableResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the schedule.

    • callback: msRest.ServiceCallback<ScheduleList>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ScheduleList>

      The callback

    Returns void

listApplicableNext

  • listApplicableNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.SchedulesListApplicableNextResponse>
  • listApplicableNext(nextPageLink: string, callback: msRest.ServiceCallback<ScheduleList>): void
  • listApplicableNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ScheduleList>): void

  • Lists all applicable schedules

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SchedulesListApplicableNextResponse>

    Promise<Models.SchedulesListApplicableNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<ScheduleList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ScheduleList>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.SchedulesListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<ScheduleList>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ScheduleList>): void

  • List schedules in a given lab.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SchedulesListNextResponse>

    Promise<Models.SchedulesListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<ScheduleList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ScheduleList>

      The callback

    Returns void

update

  • update(resourceGroupName: string, labName: string, name: string, schedule: ScheduleFragment, options?: msRest.RequestOptionsBase): Promise<Models.SchedulesUpdateResponse>
  • update(resourceGroupName: string, labName: string, name: string, schedule: ScheduleFragment, callback: msRest.ServiceCallback<Schedule>): void
  • update(resourceGroupName: string, labName: string, name: string, schedule: ScheduleFragment, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Schedule>): void

  • Modify properties of schedules.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SchedulesUpdateResponse>

    Promise<Models.SchedulesUpdateResponse>

  • 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.

    • callback: msRest.ServiceCallback<Schedule>

      The callback

    Returns void

  • 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Schedule>

      The callback

    Returns void

Generated using TypeDoc