AlertDefinitions interface

Package:

@azure/arm-authorization

Interface representing a AlertDefinitions.

Methods

get(string, string, AlertDefinitionsGetOptionalParams)	Get the specified alert definition.
listForScope(string, AlertDefinitionsListForScopeOptionalParams)	Gets alert definitions for a resource scope.

Method Details

get(string, string, AlertDefinitionsGetOptionalParams)

Get the specified alert definition.

function get(scope: string, alertDefinitionId: string, options?: AlertDefinitionsGetOptionalParams): Promise<AlertDefinition>

Parameters

scope

string

The scope of the alert definition. 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.

alertDefinitionId

string

The name of the alert definition to get.

options

AlertDefinitionsGetOptionalParams

The options parameters.

Returns

Promise<AlertDefinition>

listForScope(string, AlertDefinitionsListForScopeOptionalParams)

Gets alert definitions for a resource scope.

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

Parameters

scope

string

The scope of the alert definition.

options

AlertDefinitionsListForScopeOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AlertDefinition, AlertDefinition[], PageSettings>