次の方法で共有


Alerts - Dismiss

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

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}/'、resourceGroup スコープの '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' が含まれます。 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, billingProfile スコープの場合は '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/{billingProfileId}'、invoiceSection スコープの場合は '/providers/Microsoft.Billing/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

OK です。 要求は成功しました。

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

要求のサンプル

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"
  }
}

応答のサンプル

{
  "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

要求のサンプル

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"
  }
}

応答のサンプル

{
  "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 と金額を比較するために使用される演算子

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 と金額を比較するために使用される演算子

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

datetime of enrollmentEndDate

enrollmentNumber

string

登録番号

enrollmentStartDate

string

enrollmentStartDate の datetime

invoicingThreshold

number

請求しきい値

meterFilter

AlertProperties.details.MeterFilter[]

フィルター処理するメーターの配列

operator

AlertOperator

currentSpend と金額を比較するために使用される演算子

overridingAlert

string

アラートのオーバーライド

periodStartDate

string

datetime of periodStartDate

resourceFilter

AlertProperties.details.ResourceFilter[]

フィルター処理するリソースの配列

resourceGroupFilter

AlertProperties.details.ResourceGroupFilter[]

フィルター処理する resourceGroups の配列

tagFilter

TagFilter

でフィルター処理するタグ

threshold

number

このアラートをアクティブ化した 10 進数としての通知しきい値の割合

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

でフィルター処理するタグ