ScheduleOperations interface

Package:

@azure/arm-automation

Interface representing a ScheduleOperations.

Methods

createOrUpdate(string, string, string, ScheduleCreateOrUpdateParameters, ScheduleCreateOrUpdateOptionalParams)	Create a schedule.
delete(string, string, string, ScheduleDeleteOptionalParams)	Delete the schedule identified by schedule name.
get(string, string, string, ScheduleGetOptionalParams)	Retrieve the schedule identified by schedule name.
listByAutomationAccount(string, string, ScheduleListByAutomationAccountOptionalParams)	Retrieve a list of schedules.
update(string, string, string, ScheduleUpdateParameters, ScheduleUpdateOptionalParams)	Update the schedule identified by schedule name.

Method Details

createOrUpdate(string, string, string, ScheduleCreateOrUpdateParameters, ScheduleCreateOrUpdateOptionalParams)

Create a schedule.

function createOrUpdate(resourceGroupName: string, automationAccountName: string, scheduleName: string, parameters: ScheduleCreateOrUpdateParameters, options?: ScheduleCreateOrUpdateOptionalParams): Promise<Schedule>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

scheduleName

string

The schedule name.

parameters

ScheduleCreateOrUpdateParameters

The parameters supplied to the create or update schedule operation.

options

ScheduleCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Schedule>

delete(string, string, string, ScheduleDeleteOptionalParams)

Delete the schedule identified by schedule name.

function delete(resourceGroupName: string, automationAccountName: string, scheduleName: string, options?: ScheduleDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

scheduleName

string

The schedule name.

options

ScheduleDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ScheduleGetOptionalParams)

Retrieve the schedule identified by schedule name.

function get(resourceGroupName: string, automationAccountName: string, scheduleName: string, options?: ScheduleGetOptionalParams): Promise<Schedule>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

scheduleName

string

The schedule name.

options

ScheduleGetOptionalParams

The options parameters.

Returns

Promise<Schedule>

listByAutomationAccount(string, string, ScheduleListByAutomationAccountOptionalParams)

Retrieve a list of schedules.

function listByAutomationAccount(resourceGroupName: string, automationAccountName: string, options?: ScheduleListByAutomationAccountOptionalParams): PagedAsyncIterableIterator<Schedule, Schedule[], PageSettings>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

options

ScheduleListByAutomationAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Schedule, Schedule[], PageSettings>

update(string, string, string, ScheduleUpdateParameters, ScheduleUpdateOptionalParams)

Update the schedule identified by schedule name.

function update(resourceGroupName: string, automationAccountName: string, scheduleName: string, parameters: ScheduleUpdateParameters, options?: ScheduleUpdateOptionalParams): Promise<Schedule>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

scheduleName

string

The schedule name.

parameters

ScheduleUpdateParameters

The parameters supplied to the update schedule operation.

options

ScheduleUpdateOptionalParams

The options parameters.

Returns

Promise<Schedule>