Compartir a través de


GlobalSchedules interface

Interface representing a GlobalSchedules.

Methods

beginExecute(string, string, GlobalSchedulesExecuteOptionalParams)

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

beginExecuteAndWait(string, string, GlobalSchedulesExecuteOptionalParams)

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

beginRetarget(string, string, RetargetScheduleProperties, GlobalSchedulesRetargetOptionalParams)

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

beginRetargetAndWait(string, string, RetargetScheduleProperties, GlobalSchedulesRetargetOptionalParams)

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

createOrUpdate(string, string, Schedule, GlobalSchedulesCreateOrUpdateOptionalParams)

Create or replace an existing schedule.

delete(string, string, GlobalSchedulesDeleteOptionalParams)

Delete schedule.

get(string, string, GlobalSchedulesGetOptionalParams)

Get schedule.

listByResourceGroup(string, GlobalSchedulesListByResourceGroupOptionalParams)

List schedules in a resource group.

listBySubscription(GlobalSchedulesListBySubscriptionOptionalParams)

List schedules in a subscription.

update(string, string, ScheduleFragment, GlobalSchedulesUpdateOptionalParams)

Allows modifying tags of schedules. All other properties will be ignored.

Method Details

beginExecute(string, string, GlobalSchedulesExecuteOptionalParams)

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

function beginExecute(resourceGroupName: string, name: string, options?: GlobalSchedulesExecuteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the schedule.

options
GlobalSchedulesExecuteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginExecuteAndWait(string, string, GlobalSchedulesExecuteOptionalParams)

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

function beginExecuteAndWait(resourceGroupName: string, name: string, options?: GlobalSchedulesExecuteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the schedule.

options
GlobalSchedulesExecuteOptionalParams

The options parameters.

Returns

Promise<void>

beginRetarget(string, string, RetargetScheduleProperties, GlobalSchedulesRetargetOptionalParams)

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

function beginRetarget(resourceGroupName: string, name: string, retargetScheduleProperties: RetargetScheduleProperties, options?: GlobalSchedulesRetargetOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

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.

options
GlobalSchedulesRetargetOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginRetargetAndWait(string, string, RetargetScheduleProperties, GlobalSchedulesRetargetOptionalParams)

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

function beginRetargetAndWait(resourceGroupName: string, name: string, retargetScheduleProperties: RetargetScheduleProperties, options?: GlobalSchedulesRetargetOptionalParams): Promise<void>

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.

options
GlobalSchedulesRetargetOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, Schedule, GlobalSchedulesCreateOrUpdateOptionalParams)

Create or replace an existing schedule.

function createOrUpdate(resourceGroupName: string, name: string, schedule: Schedule, options?: GlobalSchedulesCreateOrUpdateOptionalParams): Promise<Schedule>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the schedule.

schedule
Schedule

A schedule.

options
GlobalSchedulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Schedule>

delete(string, string, GlobalSchedulesDeleteOptionalParams)

Delete schedule.

function delete(resourceGroupName: string, name: string, options?: GlobalSchedulesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the schedule.

options
GlobalSchedulesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, GlobalSchedulesGetOptionalParams)

Get schedule.

function get(resourceGroupName: string, name: string, options?: GlobalSchedulesGetOptionalParams): Promise<Schedule>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the schedule.

options
GlobalSchedulesGetOptionalParams

The options parameters.

Returns

Promise<Schedule>

listByResourceGroup(string, GlobalSchedulesListByResourceGroupOptionalParams)

List schedules in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: GlobalSchedulesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Schedule, Schedule[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options
GlobalSchedulesListByResourceGroupOptionalParams

The options parameters.

Returns

listBySubscription(GlobalSchedulesListBySubscriptionOptionalParams)

List schedules in a subscription.

function listBySubscription(options?: GlobalSchedulesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Schedule, Schedule[], PageSettings>

Parameters

options
GlobalSchedulesListBySubscriptionOptionalParams

The options parameters.

Returns

update(string, string, ScheduleFragment, GlobalSchedulesUpdateOptionalParams)

Allows modifying tags of schedules. All other properties will be ignored.

function update(resourceGroupName: string, name: string, schedule: ScheduleFragment, options?: GlobalSchedulesUpdateOptionalParams): Promise<Schedule>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the schedule.

schedule
ScheduleFragment

A schedule.

options
GlobalSchedulesUpdateOptionalParams

The options parameters.

Returns

Promise<Schedule>