Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GlobalSchedules

Package version

Class representing a GlobalSchedules.

Hierarchy

  • GlobalSchedules

Index

Constructors

Methods

Constructors

constructor

Methods

beginExecute

  • beginExecute(resourceGroupName: 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.

    • name: string

      The name of the schedule.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginRetarget

  • beginRetarget(resourceGroupName: string, name: string, retargetScheduleProperties: RetargetScheduleProperties, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Updates a schedule's target resource Id. This operation can take a while to complete.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • name: string

      The name of the schedule.

    • retargetScheduleProperties: RetargetScheduleProperties

      Properties for retargeting a virtual machine schedule.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(resourceGroupName: string, name: string, schedule: Schedule, options?: msRest.RequestOptionsBase): Promise<Models.GlobalSchedulesCreateOrUpdateResponse>
  • createOrUpdate(resourceGroupName: string, name: string, schedule: Schedule, callback: msRest.ServiceCallback<Schedule>): void
  • createOrUpdate(resourceGroupName: 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.

    • name: string

      The name of the schedule.

    • schedule: Schedule

      A schedule.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.GlobalSchedulesCreateOrUpdateResponse>

    Promise<Models.GlobalSchedulesCreateOrUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

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

    • 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, name: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, name: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, name: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Delete schedule.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

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

    • name: string

      The name of the schedule.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

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

    • name: string

      The name of the schedule.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

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

  • Get schedule.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • name: string

      The name of the schedule.

    • Optional options: Models.GlobalSchedulesGetOptionalParams

    Returns Promise<Models.GlobalSchedulesGetResponse>

    Promise<Models.GlobalSchedulesGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • name: string

      The name of the schedule.

    • callback: msRest.ServiceCallback<Schedule>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • name: string

      The name of the schedule.

    • options: GlobalSchedulesGetOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<Schedule>

      The callback

    Returns void

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: Models.GlobalSchedulesListByResourceGroupOptionalParams): Promise<Models.GlobalSchedulesListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<ScheduleList>): void
  • listByResourceGroup(resourceGroupName: string, options: GlobalSchedulesListByResourceGroupOptionalParams, callback: msRest.ServiceCallback<ScheduleList>): void

listByResourceGroupNext

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

  • List schedules in a resource group.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.GlobalSchedulesListByResourceGroupNextResponse>

    Promise<Models.GlobalSchedulesListByResourceGroupNextResponse>

  • 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

listBySubscription

listBySubscriptionNext

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

  • List schedules in a subscription.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.GlobalSchedulesListBySubscriptionNextResponse>

    Promise<Models.GlobalSchedulesListBySubscriptionNextResponse>

  • 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

retarget

  • retarget(resourceGroupName: string, name: string, retargetScheduleProperties: RetargetScheduleProperties, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Updates a schedule's target resource Id. This operation can take a while to complete.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • name: string

      The name of the schedule.

    • retargetScheduleProperties: RetargetScheduleProperties

      Properties for retargeting a virtual machine schedule.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

update

  • update(resourceGroupName: string, name: string, schedule: ScheduleFragment, options?: msRest.RequestOptionsBase): Promise<Models.GlobalSchedulesUpdateResponse>
  • update(resourceGroupName: string, name: string, schedule: ScheduleFragment, callback: msRest.ServiceCallback<Schedule>): void
  • update(resourceGroupName: 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.

    • name: string

      The name of the schedule.

    • schedule: ScheduleFragment

      A schedule.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.GlobalSchedulesUpdateResponse>

    Promise<Models.GlobalSchedulesUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

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

    • 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