Alerts - List External

リファレンス

Service:: Cost Management

API Version:: 2023-11-01

定義されている外部クラウドプロバイダーの種類のアラートを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	OK です。要求は成功しました。
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	ユーザーアカウントの借用

例

ExternalBillingAccountAlerts

ExternalSubscriptionAlerts

ExternalBillingAccountAlerts

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "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	datetime of enrollmentStartDate
invoicingThreshold	number	請求のしきい値
meterFilter	AlertProperties.details.MeterFilter[]	フィルター処理するメーターの配列
operator	AlertOperator	currentSpend と amount の比較に使用される演算子
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	使用されている通貨の単位

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

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

Share via

Alerts - List External

URI パラメーター

応答

セキュリティ

azure_auth

Scopes

例

ExternalBillingAccountAlerts

Sample Request

Sample Response

ExternalSubscriptionAlerts

Sample Request

Sample Response

定義

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertsResult

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

ErrorDetails

ErrorResponse

externalCloudProviderType

TagFilter

その他のリソース