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

Alerts - Dismiss

参考

Service:: Cost Management

API Version:: 2023-11-01

消除指定的警报

PATCH https://management.azure.com/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}?api-version=2023-11-01

URI 参数

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

请求正文

名称	类型	说明
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	上次修改警报的用户

响应

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

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

PatchResourceGroupAlerts

PatchSubscriptionAlerts

PatchResourceGroupAlerts

Sample Request

HTTP

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

{
  "properties": {
    "status": "Dismissed"
  }
}

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": "Dismissed",
    "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"
  }
}

PatchSubscriptionAlerts

Sample Request

HTTP

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

{
  "properties": {
    "status": "Dismissed"
  }
}

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": "Dismissed",
    "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	警报详细信息
DismissAlertPayload	用于更新警报的请求有效负载
ErrorDetails	错误的详细信息。
ErrorResponse	错误响应指示服务无法处理传入请求。错误消息中提供了原因。某些错误响应： 429 TooManyRequests - 请求受到限制。等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。 503 ServiceUnavailable - 服务暂时不可用。等待“Retry-After”标头中指定的时间后重试。
TagFilter	要筛选的标记

Alert

单个警报。

名称	类型	说明
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	string
Cost	string
System	string
Usage	string

AlertCriteria

触发警报的条件

名称	类型	说明
CostThresholdExceeded	string
CreditThresholdApproaching	string
CreditThresholdReached	string
CrossCloudCollectionError	string
CrossCloudNewDataAvailable	string
ForecastCostThresholdExceeded	string
ForecastUsageThresholdExceeded	string
GeneralThresholdError	string
InvoiceDueDateApproaching	string
InvoiceDueDateReached	string
MultiCurrency	string
QuotaThresholdApproaching	string
QuotaThresholdReached	string
UsageThresholdExceeded	string

AlertOperator

运算符用于比较 currentSpend 与 amount

名称	类型	说明
EqualTo	string
GreaterThan	string
GreaterThanOrEqualTo	string
LessThan	string
LessThanOrEqualTo	string
None	string

AlertSource

警报源

名称	类型	说明
Preset	string
User	string

AlertStatus

警报状态

名称	类型	说明
Active	string
Dismissed	string
None	string
Overridden	string
Resolved	string

AlertTimeGrainType

时间基数节奏的类型

名称	类型	说明
Annually	string
BillingAnnual	string
BillingMonth	string
BillingQuarter	string
Monthly	string
None	string
Quarterly	string

AlertType

警报类型

名称	类型	说明
Budget	string
BudgetForecast	string
Credit	string
General	string
Invoice	string
Quota	string
xCloud	string

Definition

定义警报的类型

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

Details

警报详细信息

名称	类型	说明
amount	number	预算阈值金额
companyName	string	公司名称
contactEmails	string[]	要联系的电子邮件列表
contactGroups	string[]	要广播到的操作组列表
contactRoles	string[]	联系人角色列表
currentSpend	number	当前支出
departmentName	string	部门名称
enrollmentEndDate	string	enrollmentEndDate 的 datetime
enrollmentNumber	string	注册号
enrollmentStartDate	string	enrollmentStartDate 的 datetime
invoicingThreshold	number	开票阈值
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	通知阈值百分比作为激活此警报的十进制数
timeGrainType	AlertTimeGrainType	时间基数节奏的类型
triggeredBy	string	触发此警报的 notificationId
unit	string	使用的货币单位

DismissAlertPayload

用于更新警报的请求有效负载

名称	类型	说明
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	上次修改警报的用户

ErrorDetails

错误的详细信息。

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

ErrorResponse

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

某些错误响应：

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

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

TagFilter

要筛选的标记

Share via

Alerts - Dismiss

URI 参数

请求正文

响应

安全性

azure_auth

Scopes

示例

PatchResourceGroupAlerts

Sample Request

Sample Response

PatchSubscriptionAlerts

Sample Request

Sample Response

定义

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

DismissAlertPayload

ErrorDetails

ErrorResponse

TagFilter

其他资源