Budgets - Create Or Update

リファレンス

サービス:: Consumption

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

予算を作成または更新する操作。必要に応じて、コンカレンシー制御の形式として eTag を指定できます。特定の予算の最新の eTag を取得するには、put 操作の前に get 操作を実行します。

PUT https://management.azure.com/{scope}/providers/Microsoft.Consumption/budgets/{budgetName}?api-version=2024-08-01

URI パラメーター

名前	/	必須	型	説明
budgetName	path	True	string	予算名。
scope	path	True	string	予算操作に関連付けられているスコープ。これには、サブスクリプションスコープの '/subscriptions/{subscriptionId}/'、resourceGroup スコープの '/subscriptionId}/{subscriptionId}/resourceGroups/{resourceGroupName}' が含まれます。 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/{billingAccountId}/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccount スコープの enrollmentAccountId}' '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/{billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope.
api-version	query	True	string	クライアント要求で使用する API のバージョン。現在のバージョンは 2023-03-01 です。

要求本文

名前	必須	型	説明
properties.amount	True	number (decimal)	予算で追跡するコストの合計
properties.category	True	CategoryType	予算のカテゴリ。予算がコストと使用量のどちらを追跡するか。
properties.timeGrain	True	TimeGrainType	予算の対象となる時間。量の追跡は、時間グレインに基づいてリセットされます。 BillingMonth、BillingQuarter、BillingAnnual は WD のお客様のみがサポートしています
properties.timePeriod	True	BudgetTimePeriod	予算の開始日と終了日を指定します。開始日は月の最初の日付にする必要があり、終了日より小さくする必要があります。予算開始日は、2017 年 6 月 1 日以降である必要があります。将来の開始日は 12 か月を超えてはなりません。過去の開始日は、タイムグレイン期間内に選択する必要があります。終了日に制限はありません。
eTag		string	リソースの eTag。同時更新シナリオを処理するために、このフィールドを使用して、ユーザーが最新バージョンを更新しているかどうかを判断します。
properties.filter		BudgetFilter	ユーザー指定のディメンションやタグで予算をフィルター処理するために使用できます。
properties.notifications		<string, Notification>	予算に関連付けられている通知の辞書。予算には最大 5 つの通知を含めることができます。

応答

名前	型	説明
200 OK	Budget	わかりました。要求は成功しました。
201 Created	Budget	作成。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

CreateOrUpdateBudget

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget?api-version=2024-08-01

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "category": "Cost",
    "amount": 100.65,
    "timeGrain": "Monthly",
    "timePeriod": {
      "startDate": "2017-10-01T00:00:00Z",
      "endDate": "2018-10-31T00:00:00Z"
    },
    "filter": {
      "and": [
        {
          "dimensions": {
            "name": "ResourceId",
            "operator": "In",
            "values": [
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1"
            ]
          }
        },
        {
          "tags": {
            "name": "category",
            "operator": "In",
            "values": [
              "Dev",
              "Prod"
            ]
          }
        },
        {
          "tags": {
            "name": "department",
            "operator": "In",
            "values": [
              "engineering",
              "sales"
            ]
          }
        }
      ]
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "enabled": true,
        "operator": "GreaterThan",
        "threshold": 80,
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "thresholdType": "Actual"
      }
    }
  }
}

応答のサンプル

状態コード:: 201

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget",
  "name": "TestBudget",
  "type": "Microsoft.Consumption/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "Cost",
    "amount": 100.65,
    "timeGrain": "Monthly",
    "timePeriod": {
      "startDate": "2017-10-01T00:00:00Z",
      "endDate": "2018-10-31T00:00:00Z"
    },
    "filter": {
      "and": [
        {
          "dimensions": {
            "name": "ResourceId",
            "operator": "In",
            "values": [
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1"
            ]
          }
        },
        {
          "tags": {
            "name": "category",
            "operator": "In",
            "values": [
              "Dev",
              "Prod"
            ]
          }
        },
        {
          "tags": {
            "name": "department",
            "operator": "In",
            "values": [
              "engineering",
              "sales"
            ]
          }
        }
      ]
    },
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "enabled": true,
        "operator": "GreaterThan",
        "threshold": 80,
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "thresholdType": "Actual"
      }
    }
  }
}

状態コード:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget",
  "name": "TestBudget",
  "type": "Microsoft.Consumption/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "Cost",
    "amount": 100.65,
    "timeGrain": "Monthly",
    "timePeriod": {
      "startDate": "2017-10-01T00:00:00Z",
      "endDate": "2018-10-31T00:00:00Z"
    },
    "filter": {
      "and": [
        {
          "dimensions": {
            "name": "ResourceId",
            "operator": "In",
            "values": [
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1"
            ]
          }
        },
        {
          "tags": {
            "name": "category",
            "operator": "In",
            "values": [
              "Dev",
              "Prod"
            ]
          }
        },
        {
          "tags": {
            "name": "department",
            "operator": "In",
            "values": [
              "engineering",
              "sales"
            ]
          }
        }
      ]
    },
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "enabled": true,
        "operator": "GreaterThan",
        "threshold": 80,
        "locale": "en-us",
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "thresholdType": "Actual"
      }
    }
  }
}

定義

名前	説明
Budget	予算リソース。
BudgetComparisonExpression	予算で使用する比較式。
BudgetFilter	リソースグループ、リソース、またはメーターで予算をフィルター処理するために使用できます。
BudgetFilterProperties	予算をフィルター処理するディメンションまたはタグ。
BudgetOperatorType	比較に使用する演算子。
BudgetTimePeriod	予算の開始日と終了日。
CategoryType	予算のカテゴリ。予算がコストと使用量のどちらを追跡するか。
CultureCode	受信者が通知を受信する言語
CurrentSpend	予算に対して追跡されている現在のコストの量。
ErrorDetails	エラーの詳細。
ErrorResponse	エラー応答は、サービスが受信要求を処理できないことを示します。エラーメッセージに理由が示されます。いくつかのエラー応答: 429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時刻を待機した後に再試行します。 503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻を待機した後に再試行します。 504 ゲートウェイタイムアウト - 要求の処理中にサービスがタイムアウトしました。可能であれば、要求の日付範囲を減らします。
ForecastSpend	予算の追跡対象となる予測コスト。
Notification	予算に関連付けられている通知。
OperatorType	比較演算子。
ThresholdType	しきい値の種類
TimeGrainType	予算の対象となる時間。量の追跡は、時間グレインに基づいてリセットされます。 BillingMonth、BillingQuarter、BillingAnnual は WD のお客様のみがサポートしています

Budget

Object

予算リソース。

名前	型	説明
eTag	string	リソースの eTag。同時更新シナリオを処理するために、このフィールドを使用して、ユーザーが最新バージョンを更新しているかどうかを判断します。
id	string	リソース ID。
name	string	リソース名。
properties.amount	number (decimal)	予算で追跡するコストの合計
properties.category	CategoryType	予算のカテゴリ。予算がコストと使用量のどちらを追跡するか。
properties.currentSpend	CurrentSpend	予算に対して追跡されている現在のコストの量。
properties.filter	BudgetFilter	ユーザー指定のディメンションやタグで予算をフィルター処理するために使用できます。
properties.forecastSpend	ForecastSpend	予算の追跡対象となる予測コスト。
properties.notifications	<string, Notification>	予算に関連付けられている通知の辞書。予算には最大 5 つの通知を含めることができます。
properties.timeGrain	TimeGrainType	予算の対象となる時間。量の追跡は、時間グレインに基づいてリセットされます。 BillingMonth、BillingQuarter、BillingAnnual は WD のお客様のみがサポートしています
properties.timePeriod	BudgetTimePeriod	予算の開始日と終了日を指定します。開始日は月の最初の日付にする必要があり、終了日より小さくする必要があります。予算開始日は、2017 年 6 月 1 日以降である必要があります。将来の開始日は 12 か月を超えてはなりません。過去の開始日は、タイムグレイン期間内に選択する必要があります。終了日に制限はありません。
type	string	リソースの種類。

BudgetComparisonExpression

Object

予算で使用する比較式。

名前	型	説明
name	string	比較に使用する列の名前。
operator	BudgetOperatorType	比較に使用する演算子。
values	string[]	比較に使用する値の配列

BudgetFilter

Object

リソースグループ、リソース、またはメーターで予算をフィルター処理するために使用できます。

名前	型	説明
and	BudgetFilterProperties[]	論理 "AND" 式。少なくとも 2 つの項目が必要です。
dimensions	BudgetComparisonExpression	ディメンションの比較式を持つ
tags	BudgetComparisonExpression	タグの比較式を持つ

BudgetFilterProperties

Object

予算をフィルター処理するディメンションまたはタグ。

名前	型	説明
dimensions	BudgetComparisonExpression	ディメンションの比較式を持つ
tags	BudgetComparisonExpression	タグの比較式を持つ

BudgetOperatorType

列挙

比較に使用する演算子。

値	説明
In

BudgetTimePeriod

Object

予算の開始日と終了日。

名前	型	説明
endDate	string (date-time)	予算の終了日。指定しない場合、既定値は開始日から 10 年です。
startDate	string (date-time)	予算の開始日。

CategoryType

列挙

予算のカテゴリ。予算がコストと使用量のどちらを追跡するか。

値	説明
Cost

CultureCode

列挙

受信者が通知を受信する言語

値	説明
cs-cz
da-dk
de-de
en-gb
en-us
es-es
fr-fr
hu-hu
it-it
ja-jp
ko-kr
nb-no
nl-nl
pl-pl
pt-br
pt-pt
ru-ru
sv-se
tr-tr
zh-cn
zh-tw

CurrentSpend

Object

予算に対して追跡されている現在のコストの量。

名前	型	説明
amount	number (decimal)	予算によって追跡されているコストの合計金額。
unit	string	予算金額の数量単位。

ErrorDetails

Object

エラーの詳細。

名前	型	説明
code	string	エラーコード。
message	string	操作が失敗した理由を示すエラーメッセージ。

ErrorResponse

Object

エラー応答は、サービスが受信要求を処理できないことを示します。エラーメッセージに理由が示されます。

いくつかのエラー応答:

429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時刻を待機した後に再試行します。
503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻を待機した後に再試行します。
504 ゲートウェイタイムアウト - 要求の処理中にサービスがタイムアウトしました。可能であれば、要求の日付範囲を減らします。

名前	型	説明
error	ErrorDetails	エラーの詳細。

ForecastSpend

Object

予算の追跡対象となる予測コスト。

名前	型	説明
amount	number (decimal)	予算によって追跡されている合計期間の予測コスト。この値は、予算に予測アラートの種類が含まれている場合にのみ提供されます。
unit	string	予算金額の数量単位。

Notification

Object

予算に関連付けられている通知。

名前	型	規定値	説明
contactEmails	string[]		しきい値を超えたときに予算通知を送信する電子メールアドレス。サブスクリプションまたはリソースグループのスコープで少なくとも 1 つの連絡先メールまたは連絡先グループを指定する必要があります。その他のすべてのスコープには、少なくとも 1 つの連絡先メールが指定されている必要があります。
contactGroups	string[]		しきい値を超えたときに予算通知を送信するアクショングループ。完全修飾 Azure リソース ID として指定する必要があります。サブスクリプションまたはリソースグループのスコープでのみサポートされます。
contactRoles	string[]		しきい値を超えたときに予算通知を送信する連絡先ロール。
enabled	boolean		通知が有効かどうか。
locale	CultureCode		受信者が通知を受信する言語
operator	OperatorType		比較演算子。
threshold	number (decimal)		通知に関連付けられているしきい値。コストがしきい値を超えたときに通知が送信されます。これは常にパーセントであり、0 から 1000 の間である必要があります。
thresholdType	ThresholdType	Actual	しきい値の種類

OperatorType

列挙

比較演算子。

値	説明
EqualTo	評価されたコストがしきい値と同じ場合、アラートがトリガーされます。注: コストがしきい値とまったく同じになる可能性が低く、アラートが欠落する可能性が低いので、この OperatorType を使用することはお勧めしません。この OperatorType は、今後非推奨となる予定です。
GreaterThan	評価されたコストがしきい値より大きい場合、アラートがトリガーされます。注: これは、予算アラートの構成時に推奨される OperatorType です。
GreaterThanOrEqualTo	評価されたコストがしきい値以上の場合、アラートがトリガーされます。

ThresholdType

列挙

しきい値の種類

値	説明
Actual	実績コスト予算アラートは、実績未収コストが割り当てられた予算を超えたときに通知します。
Forecasted	予測コスト予算アラートは、支出の傾向が予測コストの予測に依存するため、割り当てられた予算を超える可能性が高いという高度な通知を提供します。

TimeGrainType

列挙

予算の対象となる時間。量の追跡は、時間グレインに基づいてリセットされます。 BillingMonth、BillingQuarter、BillingAnnual は WD のお客様のみがサポートしています

値	説明
Annually
BillingAnnual
BillingMonth
BillingQuarter
Monthly
Quarterly

次の方法で共有

Budgets - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

CreateOrUpdateBudget

要求のサンプル

応答のサンプル

定義

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

その他のリソース