Alerts interface
Interface representing a Alerts.
Methods
| begin |
Refresh an alert. |
| begin |
Refresh all alerts for a resource scope. |
| begin |
Refresh all alerts for a resource scope. |
| begin |
Refresh an alert. |
| get(string, string, Alerts |
Get the specified alert. |
| list |
Gets alerts for a resource scope. |
| update(string, string, Alert, Alerts |
Update an alert. |
Method Details
beginRefresh(string, string, AlertsRefreshOptionalParams)
Refresh an alert.
function beginRefresh(scope: string, alertId: string, options?: AlertsRefreshOptionalParams): Promise<SimplePollerLike<OperationState<AlertsRefreshResponse>, AlertsRefreshResponse>>Parameters
- scope
-
string
The scope of the alert.
- alertId
-
string
The name of the alert to refresh.
- options
- AlertsRefreshOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AlertsRefreshResponse>, AlertsRefreshResponse>>
beginRefreshAll(string, AlertsRefreshAllOptionalParams)
Refresh all alerts for a resource scope.
function beginRefreshAll(scope: string, options?: AlertsRefreshAllOptionalParams): Promise<SimplePollerLike<OperationState<AlertsRefreshAllResponse>, AlertsRefreshAllResponse>>Parameters
- scope
-
string
The scope of the alert.
- options
- AlertsRefreshAllOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AlertsRefreshAllResponse>, AlertsRefreshAllResponse>>
beginRefreshAllAndWait(string, AlertsRefreshAllOptionalParams)
Refresh all alerts for a resource scope.
function beginRefreshAllAndWait(scope: string, options?: AlertsRefreshAllOptionalParams): Promise<AlertsRefreshAllResponse>Parameters
- scope
-
string
The scope of the alert.
- options
- AlertsRefreshAllOptionalParams
The options parameters.
Returns
Promise<AlertsRefreshAllResponse>
beginRefreshAndWait(string, string, AlertsRefreshOptionalParams)
Refresh an alert.
function beginRefreshAndWait(scope: string, alertId: string, options?: AlertsRefreshOptionalParams): Promise<AlertsRefreshResponse>Parameters
- scope
-
string
The scope of the alert.
- alertId
-
string
The name of the alert to refresh.
- options
- AlertsRefreshOptionalParams
The options parameters.
Returns
Promise<AlertsRefreshResponse>
get(string, string, AlertsGetOptionalParams)
Get the specified alert.
function get(scope: string, alertId: string, options?: AlertsGetOptionalParams): Promise<Alert>Parameters
- scope
-
string
The scope of the alert. 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 to get.
- options
- AlertsGetOptionalParams
The options parameters.
Returns
Promise<Alert>
listForScope(string, AlertsListForScopeOptionalParams)
Gets alerts for a resource scope.
function listForScope(scope: string, options?: AlertsListForScopeOptionalParams): PagedAsyncIterableIterator<Alert, Alert[], PageSettings>Parameters
- scope
-
string
The scope of the alert.
- options
- AlertsListForScopeOptionalParams
The options parameters.
Returns
update(string, string, Alert, AlertsUpdateOptionalParams)
Update an alert.
function update(scope: string, alertId: string, parameters: Alert, options?: AlertsUpdateOptionalParams): Promise<void>Parameters
- scope
-
string
The scope of the alert.
- alertId
-
string
The name of the alert to dismiss.
- parameters
- Alert
Parameters for the alert.
- options
- AlertsUpdateOptionalParams
The options parameters.
Returns
Promise<void>
