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

Alerts - List External

Lists定义的外部云提供商的警报类型。

GET https://management.azure.com/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts?api-version=2023-11-01

URI 参数

名称 必需 类型 说明
externalCloudProviderId
path True

string

对于链接帐户,这可以是“{externalSubscriptionId}”,对于用于维度/查询操作的合并帐户,可以是“{externalBillingAccountId}”。

externalCloudProviderType
path True

externalCloudProviderType

与维度/查询操作关联的外部云提供程序类型。 这包括链接帐户的“externalSubscriptions”和合并帐户的“externalBillingAccounts”。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

AlertsResult

没问题。 请求已成功。

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ExternalBillingAccountAlerts
ExternalSubscriptionAlerts

ExternalBillingAccountAlerts

示例请求

GET https://management.azure.com/providers/Microsoft.CostManagement/externalBillingAccounts/100/alerts?api-version=2023-11-01

示例响应

{
  "value": [
    {
      "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000",
      "name": "00000000-0000-0000-0000-000000000000",
      "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": "00000000-0000-0000-0000-000000000000_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"
      }
    },
    {
      "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111",
      "name": "11111111-1111-1111-111111111111",
      "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": "11111111-1111-1111-111111111111_1_01",
          "resourceGroupFilter": [],
          "resourceFilter": [],
          "meterFilter": [],
          "tagFilter": {},
          "threshold": 0.8,
          "operator": "GreaterThan",
          "amount": 200000,
          "unit": "USD",
          "currentSpend": 171000.32,
          "contactEmails": [
            "1234@contoso.com"
          ],
          "contactGroups": [],
          "contactRoles": [],
          "overridingAlert": null
        },
        "costEntityId": "budget1",
        "status": "Active",
        "creationTime": "2019-06-24T05:51:52.8713179Z",
        "closeTime": "0001-01-01T00:00:00",
        "modificationTime": "2019-08-31T17:51:55.1808807Z",
        "statusModificationUserName": null,
        "statusModificationTime": "0001-01-01T00:00:00"
      }
    }
  ],
  "nextLink": null
}

ExternalSubscriptionAlerts

示例请求

GET https://management.azure.com/providers/Microsoft.CostManagement/externalSubscriptions/100/alerts?api-version=2023-11-01

示例响应

{
  "value": [
    {
      "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000",
      "name": "00000000-0000-0000-0000-000000000000",
      "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": "00000000-0000-0000-0000-000000000000_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"
      }
    },
    {
      "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111",
      "name": "11111111-1111-1111-111111111111",
      "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": "11111111-1111-1111-111111111111_1_01",
          "resourceGroupFilter": [],
          "resourceFilter": [],
          "meterFilter": [],
          "tagFilter": {},
          "threshold": 0.8,
          "operator": "GreaterThan",
          "amount": 200000,
          "unit": "USD",
          "currentSpend": 171000.32,
          "contactEmails": [
            "1234@contoso.com"
          ],
          "contactGroups": [],
          "contactRoles": [],
          "overridingAlert": null
        },
        "costEntityId": "budget1",
        "status": "Active",
        "creationTime": "2019-06-24T05:51:52.8713179Z",
        "closeTime": "0001-01-01T00:00:00",
        "modificationTime": "2019-08-31T17:51:55.1808807Z",
        "statusModificationUserName": null,
        "statusModificationTime": "0001-01-01T00:00:00"
      }
    }
  ],
  "nextLink": null
}

定义

名称 说明
Alert

单个警报。

AlertCategory

警报类别

AlertCriteria

触发警报的条件

AlertOperator

运算符用于比较 currentSpend 与 amount

AlertSource

警报源

AlertsResult

警报的结果。

AlertStatus

警报状态

AlertTimeGrainType

时间基数节奏的类型

AlertType

警报类型

Definition

定义警报的类型

Details

警报详细信息

ErrorDetails

错误的详细信息。

ErrorResponse

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

某些错误响应:

  • 429 TooManyRequests - 请求受到限制。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 等待“Retry-After”标头中指定的时间后重试。

externalCloudProviderType

与维度/查询操作关联的外部云提供程序类型。 这包括链接帐户的“externalSubscriptions”和合并帐户的“externalBillingAccounts”。

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

AlertsResult

警报的结果。

名称 类型 说明
nextLink

string

用于获取下一组警报结果的 URL(如果有)。

value

Alert[]

警报列表。

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

使用的货币单位

ErrorDetails

错误的详细信息。

名称 类型 说明
code

string

错误代码。

message

string

指示操作失败原因的错误消息。

ErrorResponse

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

某些错误响应:

  • 429 TooManyRequests - 请求受到限制。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 等待“Retry-After”标头中指定的时间后重试。

名称 类型 说明
error

ErrorDetails

错误的详细信息。

externalCloudProviderType

与维度/查询操作关联的外部云提供程序类型。 这包括链接帐户的“externalSubscriptions”和合并帐户的“externalBillingAccounts”。

名称 类型 说明
externalBillingAccounts

string

externalSubscriptions

string

TagFilter

要筛选的标记