你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Alerts - Get

参考

服务:: Cost Management

API 版本:: 2024-08-01

按警报 ID 获取范围警报。

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

URI 参数

名称	在	必需	类型	说明
alertId	path	True	string	警报 ID
scope	path	True	string	与警报操作关联的范围。这包括订阅范围的“/subscriptions/{subscriptionId}/”、resourceGroup 范围的“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”、计费帐户范围的“/providers/Microsoft.Billing/billingAccounts/{billingAccountId}”和“/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}”，“/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{EnrollmentAccount 作用域的 enrollmentAccountId}，“/providers/Microsoft.Management/managementGroups/{managementGroupId}”，用于管理组范围， billingProfile 作用域的'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}'、'/providers/Microsoft.Billing/billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}'，以及'/providers/Microsoft'。Billing/billingAccounts/{billingAccountId}/customers/{customerId}特定于合作伙伴。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	Alert	还行。请求已成功。
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

SingleResourceGroupAlerts

SingleSubscriptionAlerts

SingleResourceGroupAlerts

示例请求

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

示例响应

状态代码:: 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

示例请求

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

示例响应

状态代码:: 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"
  }
}

定义

名称	说明
Alert	单个警报。
AlertCategory	警报类别
AlertCriteria	触发警报的条件
AlertOperator	用于将 currentSpend 与 amount 进行比较的运算符
AlertSource	警报源
AlertStatus	警报状态
AlertTimeGrainType	时间根节奏的类型
AlertType	警报类型
Definition	定义警报的类型
Details	警报详细信息
ErrorDetails	错误的详细信息。
ErrorResponse	错误响应指示服务无法处理传入请求。错误消息中提供了原因。一些错误响应： 429 TooManyRequests - 请求受到限制。等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。 503 ServiceUnavailable - 服务暂时不可用。在等待“Retry-After”标头中指定的时间后重试。
TagFilter	要筛选依据的标记

Alert

Object

单个警报。

名称	类型	说明
eTag	string	资源的 eTag。若要处理并发更新方案，此字段将用于确定用户是否正在更新最新版本。
id	string	资源 ID。
name	string	资源名称。
properties.closeTime	string	关闭警报的 dateTime
properties.costEntityId	string	相关预算
properties.creationTime	string	创建警报的 dateTime
properties.definition	Definition	定义警报的类型
properties.description	string	警报说明
properties.details	Details	警报详细信息
properties.modificationTime	string	上次修改警报的 dateTime
properties.source	AlertSource	警报源
properties.status	AlertStatus	警报状态
properties.statusModificationTime	string	上次修改警报状态的 dateTime
properties.statusModificationUserName	string	上次修改警报的用户
type	string	资源类型。

AlertCategory

枚举

警报类别

值	说明
Billing
Cost
System
Usage

AlertCriteria

枚举

触发警报的条件

值	说明
CostThresholdExceeded
CreditThresholdApproaching
CreditThresholdReached
CrossCloudCollectionError
CrossCloudNewDataAvailable
ForecastCostThresholdExceeded
ForecastUsageThresholdExceeded
GeneralThresholdError
InvoiceDueDateApproaching
InvoiceDueDateReached
MultiCurrency
QuotaThresholdApproaching
QuotaThresholdReached
UsageThresholdExceeded

AlertOperator

枚举

用于将 currentSpend 与 amount 进行比较的运算符

值	说明
EqualTo
GreaterThan
GreaterThanOrEqualTo
LessThan
LessThanOrEqualTo
None

AlertSource

枚举

警报源

值	说明
Preset
User

AlertStatus

枚举

警报状态

值	说明
Active
Dismissed
None
Overridden
Resolved

AlertTimeGrainType

枚举

时间根节奏的类型

值	说明
Annually
BillingAnnual
BillingMonth
BillingQuarter
Monthly
None
Quarterly

AlertType

枚举

警报类型

值	说明
Budget
BudgetForecast
Credit
General
Invoice
Quota
xCloud

Definition

Object

定义警报的类型

名称	类型	说明
category	AlertCategory	警报类别
criteria	AlertCriteria	触发警报的条件
type	AlertType	警报类型

Details

Object

警报详细信息

名称	类型	说明
amount	number (decimal)	预算阈值金额
companyName	string	公司名称
contactEmails	string[]	要联系的电子邮件列表
contactGroups	string[]	要广播到的操作组列表
contactRoles	string[]	联系人角色列表
currentSpend	number (decimal)	当前支出
departmentName	string	部门名称
enrollmentEndDate	string	enrollmentEndDate 的 datetime
enrollmentNumber	string	注册编号
enrollmentStartDate	string	enrollmentStartDate 的 datetime
invoicingThreshold	number (decimal)	开票阈值
meterFilter	AlertProperties.details.MeterFilter[]	要筛选依据的计量数组
operator	AlertOperator	用于将 currentSpend 与 amount 进行比较的运算符
overridingAlert	string	重写警报
periodStartDate	string	periodStartDate 的 datetime
resourceFilter	AlertProperties.details.ResourceFilter[]	要筛选的资源数组
resourceGroupFilter	AlertProperties.details.ResourceGroupFilter[]	要筛选依据的 resourceGroup 的数组
tagFilter	TagFilter	要筛选依据的标记
threshold	number (decimal)	通知阈值百分比作为激活此警报的十进制数
timeGrainType	AlertTimeGrainType	时间根节奏的类型
triggeredBy	string	触发此警报的 notificationId
unit	string	正在使用的货币单位

ErrorDetails

Object

错误的详细信息。

名称	类型	说明
code	string	错误代码。
message	string	指示操作失败的原因的错误消息。

ErrorResponse

Object

错误响应指示服务无法处理传入请求。错误消息中提供了原因。

一些错误响应：

429 TooManyRequests - 请求受到限制。等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。
503 ServiceUnavailable - 服务暂时不可用。在等待“Retry-After”标头中指定的时间后重试。

名称	类型	说明
error	ErrorDetails	错误的详细信息。

TagFilter

Object

要筛选依据的标记

通过

Alerts - Get

URI 参数

响应

安全性

azure_auth

作用域

示例

SingleResourceGroupAlerts

示例请求

示例响应

SingleSubscriptionAlerts

示例请求

示例响应

定义

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

ErrorDetails

ErrorResponse

TagFilter

其他资源