Alerts - Dismiss

リファレンス

サービス:: Cost Management

API バージョン:: 2024-08-01

指定したアラートを無視します。

PATCH 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 スコープの '/subscriptionId}/{subscriptionId}/resourceGroups/{resourceGroupName}' が含まれます。 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/{billingAccountId}/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccount スコープの enrollmentAccountId}'、管理グループスコープの '/providers/Microsoft.Management/managementGroups/{managementGroupId} '/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	この操作に使用する 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 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

PatchResourceGroupAlerts

PatchSubscriptionAlerts

PatchResourceGroupAlerts

要求のサンプル

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=2024-08-01

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

応答のサンプル

状態コード:: 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

要求のサンプル

HTTP

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

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

応答のサンプル

状態コード:: 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

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[]	フィルター処理する resourceGroups の配列
tagFilter	TagFilter	でフィルター処理するタグ
threshold	number (decimal)	このアラートをアクティブ化した 10 進数としての通知しきい値の割合
timeGrainType	AlertTimeGrainType	タイムグレイン周期の種類
triggeredBy	string	このアラートをトリガーした notificationId
unit	string	使用されている通貨の単位

DismissAlertPayload

Object

アラートを更新するための要求ペイロード

名前	型	説明
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

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 - Dismiss

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

PatchResourceGroupAlerts

要求のサンプル

応答のサンプル

PatchSubscriptionAlerts

要求のサンプル

応答のサンプル

定義

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

DismissAlertPayload

ErrorDetails

ErrorResponse

TagFilter

その他のリソース