Alerts - Get

Reference

Service:: Cost Management

API Version:: 2024-08-01

Gets the alert for the scope by alert ID.

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}?api-version=2024-08-01

URI Parameters

Name	In	Required	Type	Description
alertId	path	True	string	Alert ID
scope	path	True	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.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Alert	OK. The request has succeeded.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

SingleResourceGroupAlerts

SingleSubscriptionAlerts

SingleResourceGroupAlerts

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222?api-version=2024-08-01

Sample response

Status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222",
  "name": "22222222-2222-2222-2222-222222222222",
  "type": "Microsoft.CostManagement/alerts",
  "properties": {
    "definition": {
      "type": "Budget",
      "category": "Cost",
      "criteria": "CostThresholdExceeded"
    },
    "description": "",
    "source": "Preset",
    "details": {
      "timeGrainType": "Quarterly",
      "periodStartDate": "2020-03-01T00:00:00Z",
      "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01",
      "resourceGroupFilter": [],
      "resourceFilter": [],
      "meterFilter": [],
      "tagFilter": {},
      "threshold": 0.8,
      "operator": "GreaterThan",
      "amount": 200000,
      "unit": "USD",
      "currentSpend": 161000.12,
      "contactEmails": [
        "1234@contoso.com"
      ],
      "contactGroups": [],
      "contactRoles": [],
      "overridingAlert": null
    },
    "costEntityId": "budget1",
    "status": "Active",
    "creationTime": "2020-04-27T11:07:52.7143901Z",
    "closeTime": "0001-01-01T00:00:00",
    "modificationTime": "2020-04-28T11:06:02.8999373Z",
    "statusModificationUserName": null,
    "statusModificationTime": "0001-01-01T00:00:00"
  }
}

SingleSubscriptionAlerts

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222?api-version=2024-08-01

Sample response

Status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222",
  "name": "22222222-2222-2222-2222-222222222222",
  "type": "Microsoft.CostManagement/alerts",
  "properties": {
    "definition": {
      "type": "Budget",
      "category": "Cost",
      "criteria": "CostThresholdExceeded"
    },
    "description": "",
    "source": "Preset",
    "details": {
      "timeGrainType": "Quarterly",
      "periodStartDate": "2020-03-01T00:00:00Z",
      "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01",
      "resourceGroupFilter": [],
      "resourceFilter": [],
      "meterFilter": [],
      "tagFilter": {},
      "threshold": 0.8,
      "operator": "GreaterThan",
      "amount": 200000,
      "unit": "USD",
      "currentSpend": 161000.12,
      "contactEmails": [
        "1234@contoso.com"
      ],
      "contactGroups": [],
      "contactRoles": [],
      "overridingAlert": null
    },
    "costEntityId": "budget1",
    "status": "Active",
    "creationTime": "2020-04-27T11:07:52.7143901Z",
    "closeTime": "0001-01-01T00:00:00",
    "modificationTime": "2020-04-28T11:06:02.8999373Z",
    "statusModificationUserName": null,
    "statusModificationTime": "0001-01-01T00:00:00"
  }
}

Definitions

Name	Description
Alert	An individual alert.
AlertCategory	Alert category
AlertCriteria	Criteria that triggered alert
AlertOperator	operator used to compare currentSpend with amount
AlertSource	Source of alert
AlertStatus	alert status
AlertTimeGrainType	Type of timegrain cadence
AlertType	type of alert
Definition	defines the type of alert
Details	Alert details
ErrorDetails	The details of the error.
ErrorResponse	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. Some Error responses: 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header. 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.
TagFilter	tags to filter by

Alert

Object

An individual alert.

Name	Type	Description
eTag	string	eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
id	string	Resource Id.
name	string	Resource name.
properties.closeTime	string	dateTime in which alert was closed
properties.costEntityId	string	related budget
properties.creationTime	string	dateTime in which alert was created
properties.definition	Definition	defines the type of alert
properties.description	string	Alert description
properties.details	Details	Alert details
properties.modificationTime	string	dateTime in which alert was last modified
properties.source	AlertSource	Source of alert
properties.status	AlertStatus	alert status
properties.statusModificationTime	string	dateTime in which the alert status was last modified
properties.statusModificationUserName	string	User who last modified the alert
type	string	Resource type.

AlertCategory

Enumeration

Alert category

Value	Description
Billing
Cost
System
Usage

AlertCriteria

Enumeration

Criteria that triggered alert

Value	Description
CostThresholdExceeded
CreditThresholdApproaching
CreditThresholdReached
CrossCloudCollectionError
CrossCloudNewDataAvailable
ForecastCostThresholdExceeded
ForecastUsageThresholdExceeded
GeneralThresholdError
InvoiceDueDateApproaching
InvoiceDueDateReached
MultiCurrency
QuotaThresholdApproaching
QuotaThresholdReached
UsageThresholdExceeded

AlertOperator

Enumeration

operator used to compare currentSpend with amount

Value	Description
EqualTo
GreaterThan
GreaterThanOrEqualTo
LessThan
LessThanOrEqualTo
None

AlertSource

Enumeration

Source of alert

Value	Description
Preset
User

AlertStatus

Enumeration

alert status

Value	Description
Active
Dismissed
None
Overridden
Resolved

AlertTimeGrainType

Enumeration

Type of timegrain cadence

Value	Description
Annually
BillingAnnual
BillingMonth
BillingQuarter
Monthly
None
Quarterly

AlertType

Enumeration

type of alert

Value	Description
Budget
BudgetForecast
Credit
General
Invoice
Quota
xCloud

Definition

Object

defines the type of alert

Name	Type	Description
category	AlertCategory	Alert category
criteria	AlertCriteria	Criteria that triggered alert
type	AlertType	type of alert

Details

Object

Alert details

Name	Type	Description
amount	number (decimal)	budget threshold amount
companyName	string	company name
contactEmails	string[]	list of emails to contact
contactGroups	string[]	list of action groups to broadcast to
contactRoles	string[]	list of contact roles
currentSpend	number (decimal)	current spend
departmentName	string	department name
enrollmentEndDate	string	datetime of enrollmentEndDate
enrollmentNumber	string	enrollment number
enrollmentStartDate	string	datetime of enrollmentStartDate
invoicingThreshold	number (decimal)	invoicing threshold
meterFilter	AlertProperties.details.MeterFilter[]	array of meters to filter by
operator	AlertOperator	operator used to compare currentSpend with amount
overridingAlert	string	overriding alert
periodStartDate	string	datetime of periodStartDate
resourceFilter	AlertProperties.details.ResourceFilter[]	array of resources to filter by
resourceGroupFilter	AlertProperties.details.ResourceGroupFilter[]	array of resourceGroups to filter by
tagFilter	TagFilter	tags to filter by
threshold	number (decimal)	notification threshold percentage as a decimal which activated this alert
timeGrainType	AlertTimeGrainType	Type of timegrain cadence
triggeredBy	string	notificationId that triggered this alert
unit	string	unit of currency being used

ErrorDetails

Object

The details of the error.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

ErrorResponse

Object

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Some Error responses:

429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header.
503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.

Name	Type	Description
error	ErrorDetails	The details of the error.

TagFilter

Object

tags to filter by

Share via

Alerts - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

SingleResourceGroupAlerts

Sample request

Sample response

SingleSubscriptionAlerts

Sample request

Sample response

Definitions

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

ErrorDetails

ErrorResponse

TagFilter

Additional resources