Share via

WatcherOperations interface

  • Reference
Package:
@azure/arm-automation

Interface representing a WatcherOperations.

Methods

createOrUpdate(string, string, string, Watcher, WatcherCreateOrUpdateOptionalParams)

Create the watcher identified by watcher name.
delete(string, string, string, WatcherDeleteOptionalParams)

Delete the watcher by name.
get(string, string, string, WatcherGetOptionalParams)

Retrieve the watcher identified by watcher name.
listByAutomationAccount(string, string, WatcherListByAutomationAccountOptionalParams)

Retrieve a list of watchers.
start(string, string, string, WatcherStartOptionalParams)

Resume the watcher identified by watcher name.
stop(string, string, string, WatcherStopOptionalParams)

Resume the watcher identified by watcher name.
update(string, string, string, WatcherUpdateParameters, WatcherUpdateOptionalParams)

Update the watcher identified by watcher name.

Method Details

createOrUpdate(string, string, string, Watcher, WatcherCreateOrUpdateOptionalParams)

Create the watcher identified by watcher name.

function createOrUpdate(resourceGroupName: string, automationAccountName: string, watcherName: string, parameters: Watcher, options?: WatcherCreateOrUpdateOptionalParams): Promise<Watcher>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

watcherName

string

The watcher name.

parameters
Watcher

The create or update parameters for watcher.

options
WatcherCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Watcher>

delete(string, string, string, WatcherDeleteOptionalParams)

Delete the watcher by name.

function delete(resourceGroupName: string, automationAccountName: string, watcherName: string, options?: WatcherDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

watcherName

string

The watcher name.

options
WatcherDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, WatcherGetOptionalParams)

Retrieve the watcher identified by watcher name.

function get(resourceGroupName: string, automationAccountName: string, watcherName: string, options?: WatcherGetOptionalParams): Promise<Watcher>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

watcherName

string

The watcher name.

options
WatcherGetOptionalParams

The options parameters.

Returns

Promise<Watcher>

listByAutomationAccount(string, string, WatcherListByAutomationAccountOptionalParams)

Retrieve a list of watchers.

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

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

options
WatcherListByAutomationAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Watcher, Watcher[], PageSettings>

start(string, string, string, WatcherStartOptionalParams)

Resume the watcher identified by watcher name.

function start(resourceGroupName: string, automationAccountName: string, watcherName: string, options?: WatcherStartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

watcherName

string

The watcher name.

options
WatcherStartOptionalParams

The options parameters.

Returns

Promise<void>

stop(string, string, string, WatcherStopOptionalParams)

Resume the watcher identified by watcher name.

function stop(resourceGroupName: string, automationAccountName: string, watcherName: string, options?: WatcherStopOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

watcherName

string

The watcher name.

options
WatcherStopOptionalParams

The options parameters.

Returns

Promise<void>

update(string, string, string, WatcherUpdateParameters, WatcherUpdateOptionalParams)

Update the watcher identified by watcher name.

function update(resourceGroupName: string, automationAccountName: string, watcherName: string, parameters: WatcherUpdateParameters, options?: WatcherUpdateOptionalParams): Promise<Watcher>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

watcherName

string

The watcher name.

parameters
WatcherUpdateParameters

The update parameters for watcher.

options
WatcherUpdateOptionalParams

The options parameters.

Returns

Promise<Watcher>