Alerts - Get

參考

服務:: Cost Management

API 版本:: 2024-08-01

依警示標識碼取得範圍警示。

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

URI 參數

名稱	位於	必要	類型	Description
alertId	path	True	string	警示標識碼
scope	path	True	string	與警示作業相關聯的範圍。這包括訂用帳戶範圍的 '/subscriptions/{subscriptionId}/' 、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 資源群組範圍、計費帳戶範圍的 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' 和 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope， '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{EnrollmentAccount 範圍的 enrollmentAccount 範圍，'/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope， billingProfile 範圍的 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}'、'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfileId}/{billingProfileId}/invoiceSections/{invoiceSectionId}' 和 '/providers/Microsoft。Billing/billingAccounts/{billingAccountId}/customers/{customerId}' 特定合作夥伴。
api-version	query	True	string	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	Alert	還行。要求已成功。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
  }
}

定義

名稱	Description
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

個別警示。

名稱	類型	Description
eTag	string	資源的 eTag。若要處理並行更新案例，此字段將用來判斷使用者是否要更新最新版本。
id	string	資源標識碼。
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

警示類別

名稱	類型	Description
Billing	string
Cost	string
System	string
Usage	string

AlertCriteria

觸發警示的準則

名稱	類型	Description
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 的運算符

名稱	類型	Description
EqualTo	string
GreaterThan	string
GreaterThanOrEqualTo	string
LessThan	string
LessThanOrEqualTo	string
None	string

AlertSource

警示來源

名稱	類型	Description
Preset	string
User	string

AlertStatus

警示狀態

名稱	類型	Description
Active	string
Dismissed	string
None	string
Overridden	string
Resolved	string

AlertTimeGrainType

時間根頻率的類型

名稱	類型	Description
Annually	string
BillingAnnual	string
BillingMonth	string
BillingQuarter	string
Monthly	string
None	string
Quarterly	string

AlertType

警示類型

名稱	類型	Description
Budget	string
BudgetForecast	string
Credit	string
General	string
Invoice	string
Quota	string
xCloud	string

Definition

定義警示的類型

名稱	類型	Description
category	AlertCategory	警示類別
criteria	AlertCriteria	觸發警示的準則
type	AlertType	警示類型

Details

警示詳細數據

名稱	類型	Description
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[]	要篩選依據的 resourceGroups 陣列
tagFilter	TagFilter	要篩選依據的標籤
threshold	number	通知閾值百分比作為啟用此警示的十進位
timeGrainType	AlertTimeGrainType	時間根頻率的類型
triggeredBy	string	觸發此警示的 notificationId
unit	string	使用的貨幣單位

ErrorDetails

錯誤的詳細數據。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息，指出作業失敗的原因。

ErrorResponse

錯誤回應表示服務無法處理傳入要求。錯誤訊息中會提供原因。

某些錯誤回應：

429 TooManyRequests - 要求已節流。等候「x-ms-ratelimit-microsoft.consumption-retry-after」標頭中指定的時間後重試。
503 ServiceUnavailable - 服務暫時無法使用。等候「Retry-After」標頭中指定的時間後重試。

名稱	類型	Description
error	ErrorDetails	錯誤的詳細數據。

TagFilter

要篩選依據的標籤

共用方式為

Alerts - Get

URI 參數

回應

安全性

azure_auth

範圍

範例

SingleResourceGroupAlerts

範例要求

範例回覆

SingleSubscriptionAlerts

範例要求

範例回覆

定義

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

ErrorDetails

ErrorResponse

TagFilter

其他資源