AlertConfigurations interface

Package:

@azure/arm-authorization

Interface representing a AlertConfigurations.

Methods

get(string, string, AlertConfigurationsGetOptionalParams)	Get the specified alert configuration.
listForScope(string, AlertConfigurationsListForScopeOptionalParams)	Gets alert configurations for a resource scope.
update(string, string, AlertConfiguration, AlertConfigurationsUpdateOptionalParams)	Update an alert configuration.

Method Details

get(string, string, AlertConfigurationsGetOptionalParams)

Get the specified alert configuration.

function get(scope: string, alertId: string, options?: AlertConfigurationsGetOptionalParams): Promise<AlertConfiguration>

Parameters

scope

string

The scope of the alert configuration. The scope can be any REST resource instance. For example, use '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/' for a subscription, '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.

alertId

string

The name of the alert configuration to get.

options

AlertConfigurationsGetOptionalParams

The options parameters.

Returns

Promise<AlertConfiguration>

listForScope(string, AlertConfigurationsListForScopeOptionalParams)

Gets alert configurations for a resource scope.

function listForScope(scope: string, options?: AlertConfigurationsListForScopeOptionalParams): PagedAsyncIterableIterator<AlertConfiguration, AlertConfiguration[], PageSettings>

Parameters

scope

string

The scope of the alert configuration.

options

AlertConfigurationsListForScopeOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AlertConfiguration, AlertConfiguration[], PageSettings>

update(string, string, AlertConfiguration, AlertConfigurationsUpdateOptionalParams)

Update an alert configuration.

function update(scope: string, alertId: string, parameters: AlertConfiguration, options?: AlertConfigurationsUpdateOptionalParams): Promise<void>

Parameters

scope

string

The scope of the alert configuration.

alertId

string

The name of the alert configuration to update.

parameters

AlertConfiguration

Parameters for the alert configuration.

options

AlertConfigurationsUpdateOptionalParams

The options parameters.

Returns

Promise<void>