Alerts interface
Interface representing a Alerts.
Methods
| dismiss(string, string, Dismiss |
Dismisses the specified alert |
| get(string, string, Alerts |
Gets the alert for the scope by alert ID. |
| list(string, Alerts |
Lists the alerts for scope defined. |
| list |
Lists the Alerts for external cloud provider type defined. |
Method Details
dismiss(string, string, DismissAlertPayload, AlertsDismissOptionalParams)
Dismisses the specified alert
function dismiss(scope: string, alertId: string, parameters: DismissAlertPayload, options?: AlertsDismissOptionalParams): Promise<Alert>Parameters
- scope
-
string
The scope associated with alerts operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.
- alertId
-
string
Alert ID
- parameters
- DismissAlertPayload
Parameters supplied to the Dismiss Alert operation.
- options
- AlertsDismissOptionalParams
The options parameters.
Returns
Promise<Alert>
get(string, string, AlertsGetOptionalParams)
Gets the alert for the scope by alert ID.
function get(scope: string, alertId: string, options?: AlertsGetOptionalParams): Promise<Alert>Parameters
- scope
-
string
The scope associated with alerts operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.
- alertId
-
string
Alert ID
- options
- AlertsGetOptionalParams
The options parameters.
Returns
Promise<Alert>
list(string, AlertsListOptionalParams)
Lists the alerts for scope defined.
function list(scope: string, options?: AlertsListOptionalParams): Promise<AlertsResult>Parameters
- scope
-
string
The scope associated with alerts operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.
- options
- AlertsListOptionalParams
The options parameters.
Returns
Promise<AlertsResult>
listExternal(string, string, AlertsListExternalOptionalParams)
Lists the Alerts for external cloud provider type defined.
function listExternal(externalCloudProviderType: string, externalCloudProviderId: string, options?: AlertsListExternalOptionalParams): Promise<AlertsResult>Parameters
- externalCloudProviderType
-
string
The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.
- externalCloudProviderId
-
string
This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.
- options
- AlertsListExternalOptionalParams
The options parameters.
Returns
Promise<AlertsResult>
Azure SDK for JavaScript