Microsoft.Consumption budgets 2019-06-01
Bicep リソース定義
予算リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Consumption/budgets リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Consumption/budgets@2019-06-01' = {
scope: resourceSymbolicName or scope
eTag: 'string'
name: 'string'
properties: {
amount: int
category: 'string'
filters: {
meters: [
'string'
]
resourceGroups: [
'string'
]
resources: [
'string'
]
tags: {
{customized property}: [
'string'
]
}
}
notifications: {
{customized property}: {
contactEmails: [
'string'
]
contactGroups: [
'string'
]
contactRoles: [
'string'
]
enabled: bool
operator: 'string'
threshold: int
}
}
timeGrain: 'string'
timePeriod: {
endDate: 'string'
startDate: 'string'
}
}
}
プロパティ値
BudgetProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 量 | 予算で追跡するコストの合計 | int (必須) |
| カテゴリ | 予算のカテゴリ。予算がコストと使用量のどちらを追跡するか。 | 'Cost' 'Usage' (必須) |
| フィルター | リソース グループ、リソース、またはメーターで予算をフィルター処理するために使用できます。 | フィルター |
| 通知 | 予算に関連付けられている通知の辞書。 予算には最大 5 つの通知を含めることができます。 | BudgetPropertiesNotifications |
| timeGrain | 予算の対象となる時間。 量の追跡は、時間グレインに基づいてリセットされます。 | 'Annually' 'BillingAnnual' 'BillingMonth' 'BillingQuarter' 'Monthly' '四半期' (必須) |
| timePeriod | 予算の開始日と終了日を指定します。 開始日は月の最初の日付にする必要があり、終了日より小さくする必要があります。 予算開始日は、2017 年 6 月 1 日以降である必要があります。 将来の開始日は 3 か月を超えてはなりません。 過去の開始日は、タイムグレイン期間内に選択する必要があります。 終了日に制限はありません。 | BudgetTimePeriod (必須) |
BudgetPropertiesNotifications
| 名前 | 形容 | 価値 |
|---|
BudgetTimePeriod
| 名前 | 形容 | 価値 |
|---|---|---|
| endDate | 予算の終了日。 指定しない場合、既定値は開始日から 10 年です。 | 糸 |
| startDate | 予算の開始日。 | string (必須) |
フィルター
| 名前 | 形容 | 価値 |
|---|---|---|
| メートル | 使用状況カテゴリの予算に必須のメーター (GUID) のフィルターの一覧。 | 糸 制約： 最小長 = 36 最大長 = 36 パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$[] |
| resourceGroups | リソース グループに対するフィルターの一覧。サブスクリプション レベルでのみ許可されます。 | string[] |
| リソース | リソースに対するフィルターの一覧。 | string[] |
| タグ | タグのフィルターのディクショナリ。 | FiltersTags |
FiltersTags
| 名前 | 形容 | 価値 |
|---|
Microsoft.Consumption/budgets
| 名前 | 形容 | 価値 |
|---|---|---|
| eTag | リソースの eTag。 同時更新シナリオを処理するために、このフィールドを使用して、ユーザーが最新バージョンを更新しているかどうかを判断します。 | 糸 |
| 名前 | リソース名 | string (必須) |
| プロパティ | 予算のプロパティ。 | BudgetProperties |
| スコープ | デプロイ スコープとは異なるスコープでリソースを作成するときに使用します。 | このプロパティをリソースのシンボリック名に設定して、拡張リソースを適用します。 |
通知
| 名前 | 形容 | 価値 |
|---|---|---|
| contactEmails | しきい値を超えたときに予算通知を送信する電子メール アドレス。 | string[] (必須) |
| contactGroups | しきい値を超えたときに予算通知を送信するアクション グループ。 | string[] |
| contactRoles | しきい値を超えたときに予算通知を送信する連絡先ロール。 | string[] |
| 有効 | 通知が有効かどうか。 | bool (必須) |
| 演算子 | 比較演算子。 | 'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' (必須) |
| 閾 | 通知に関連付けられているしきい値。 コストがしきい値を超えたときに通知が送信されます。 これは常にパーセントであり、0 から 1000 の間である必要があります。 | int (必須) |
クイック スタートのサンプル
次のクイック スタート サンプルでは、このリソースの種類をデプロイします。
ARM テンプレート リソース定義
予算リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Consumption/budgets リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Consumption/budgets",
"apiVersion": "2019-06-01",
"name": "string",
"eTag": "string",
"properties": {
"amount": "int",
"category": "string",
"filters": {
"meters": [ "string" ],
"resourceGroups": [ "string" ],
"resources": [ "string" ],
"tags": {
"{customized property}": [ "string" ]
}
},
"notifications": {
"{customized property}": {
"contactEmails": [ "string" ],
"contactGroups": [ "string" ],
"contactRoles": [ "string" ],
"enabled": "bool",
"operator": "string",
"threshold": "int"
}
},
"timeGrain": "string",
"timePeriod": {
"endDate": "string",
"startDate": "string"
}
}
}
プロパティ値
BudgetProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 量 | 予算で追跡するコストの合計 | int (必須) |
| カテゴリ | 予算のカテゴリ。予算がコストと使用量のどちらを追跡するか。 | 'Cost' 'Usage' (必須) |
| フィルター | リソース グループ、リソース、またはメーターで予算をフィルター処理するために使用できます。 | フィルター |
| 通知 | 予算に関連付けられている通知の辞書。 予算には最大 5 つの通知を含めることができます。 | BudgetPropertiesNotifications |
| timeGrain | 予算の対象となる時間。 量の追跡は、時間グレインに基づいてリセットされます。 | 'Annually' 'BillingAnnual' 'BillingMonth' 'BillingQuarter' 'Monthly' '四半期' (必須) |
| timePeriod | 予算の開始日と終了日を指定します。 開始日は月の最初の日付にする必要があり、終了日より小さくする必要があります。 予算開始日は、2017 年 6 月 1 日以降である必要があります。 将来の開始日は 3 か月を超えてはなりません。 過去の開始日は、タイムグレイン期間内に選択する必要があります。 終了日に制限はありません。 | BudgetTimePeriod (必須) |
BudgetPropertiesNotifications
| 名前 | 形容 | 価値 |
|---|
BudgetTimePeriod
| 名前 | 形容 | 価値 |
|---|---|---|
| endDate | 予算の終了日。 指定しない場合、既定値は開始日から 10 年です。 | 糸 |
| startDate | 予算の開始日。 | string (必須) |
フィルター
| 名前 | 形容 | 価値 |
|---|---|---|
| メートル | 使用状況カテゴリの予算に必須のメーター (GUID) のフィルターの一覧。 | 糸 制約： 最小長 = 36 最大長 = 36 パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$[] |
| resourceGroups | リソース グループに対するフィルターの一覧。サブスクリプション レベルでのみ許可されます。 | string[] |
| リソース | リソースに対するフィルターの一覧。 | string[] |
| タグ | タグのフィルターのディクショナリ。 | FiltersTags |
FiltersTags
| 名前 | 形容 | 価値 |
|---|
Microsoft.Consumption/budgets
| 名前 | 形容 | 価値 |
|---|---|---|
| apiVersion | API のバージョン | '2019-06-01' |
| eTag | リソースの eTag。 同時更新シナリオを処理するために、このフィールドを使用して、ユーザーが最新バージョンを更新しているかどうかを判断します。 | 糸 |
| 名前 | リソース名 | string (必須) |
| プロパティ | 予算のプロパティ。 | BudgetProperties |
| 種類 | リソースの種類 | 'Microsoft.Consumption/budgets' |
通知
| 名前 | 形容 | 価値 |
|---|---|---|
| contactEmails | しきい値を超えたときに予算通知を送信する電子メール アドレス。 | string[] (必須) |
| contactGroups | しきい値を超えたときに予算通知を送信するアクション グループ。 | string[] |
| contactRoles | しきい値を超えたときに予算通知を送信する連絡先ロール。 | string[] |
| 有効 | 通知が有効かどうか。 | bool (必須) |
| 演算子 | 比較演算子。 | 'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' (必須) |
| 閾 | 通知に関連付けられているしきい値。 コストがしきい値を超えたときに通知が送信されます。 これは常にパーセントであり、0 から 1000 の間である必要があります。 | int (必須) |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
Terraform (AzAPI プロバイダー) リソース定義
予算リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Consumption/budgets リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Consumption/budgets@2019-06-01"
name = "string"
parent_id = "string"
eTag = "string"
body = jsonencode({
properties = {
amount = int
category = "string"
filters = {
meters = [
"string"
]
resourceGroups = [
"string"
]
resources = [
"string"
]
tags = {
{customized property} = [
"string"
]
}
}
notifications = {
{customized property} = {
contactEmails = [
"string"
]
contactGroups = [
"string"
]
contactRoles = [
"string"
]
enabled = bool
operator = "string"
threshold = int
}
}
timeGrain = "string"
timePeriod = {
endDate = "string"
startDate = "string"
}
}
})
}
プロパティ値
BudgetProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 量 | 予算で追跡するコストの合計 | int (必須) |
| カテゴリ | 予算のカテゴリ。予算がコストと使用量のどちらを追跡するか。 | 'Cost' 'Usage' (必須) |
| フィルター | リソース グループ、リソース、またはメーターで予算をフィルター処理するために使用できます。 | フィルター |
| 通知 | 予算に関連付けられている通知の辞書。 予算には最大 5 つの通知を含めることができます。 | BudgetPropertiesNotifications |
| timeGrain | 予算の対象となる時間。 量の追跡は、時間グレインに基づいてリセットされます。 | 'Annually' 'BillingAnnual' 'BillingMonth' 'BillingQuarter' 'Monthly' '四半期' (必須) |
| timePeriod | 予算の開始日と終了日を指定します。 開始日は月の最初の日付にする必要があり、終了日より小さくする必要があります。 予算開始日は、2017 年 6 月 1 日以降である必要があります。 将来の開始日は 3 か月を超えてはなりません。 過去の開始日は、タイムグレイン期間内に選択する必要があります。 終了日に制限はありません。 | BudgetTimePeriod (必須) |
BudgetPropertiesNotifications
| 名前 | 形容 | 価値 |
|---|
BudgetTimePeriod
| 名前 | 形容 | 価値 |
|---|---|---|
| endDate | 予算の終了日。 指定しない場合、既定値は開始日から 10 年です。 | 糸 |
| startDate | 予算の開始日。 | string (必須) |
フィルター
| 名前 | 形容 | 価値 |
|---|---|---|
| メートル | 使用状況カテゴリの予算に必須のメーター (GUID) のフィルターの一覧。 | 糸 制約： 最小長 = 36 最大長 = 36 パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$[] |
| resourceGroups | リソース グループに対するフィルターの一覧。サブスクリプション レベルでのみ許可されます。 | string[] |
| リソース | リソースに対するフィルターの一覧。 | string[] |
| タグ | タグのフィルターのディクショナリ。 | FiltersTags |
FiltersTags
| 名前 | 形容 | 価値 |
|---|
Microsoft.Consumption/budgets
| 名前 | 形容 | 価値 |
|---|---|---|
| eTag | リソースの eTag。 同時更新シナリオを処理するために、このフィールドを使用して、ユーザーが最新バージョンを更新しているかどうかを判断します。 | 糸 |
| 名前 | リソース名 | string (必須) |
| parent_id | この拡張リソースを適用するリソースの ID。 | string (必須) |
| プロパティ | 予算のプロパティ。 | BudgetProperties |
| 種類 | リソースの種類 | "Microsoft.Consumption/budgets@2019-06-01" |
通知
| 名前 | 形容 | 価値 |
|---|---|---|
| contactEmails | しきい値を超えたときに予算通知を送信する電子メール アドレス。 | string[] (必須) |
| contactGroups | しきい値を超えたときに予算通知を送信するアクション グループ。 | string[] |
| contactRoles | しきい値を超えたときに予算通知を送信する連絡先ロール。 | string[] |
| 有効 | 通知が有効かどうか。 | bool (必須) |
| 演算子 | 比較演算子。 | 'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' (必須) |
| 閾 | 通知に関連付けられているしきい値。 コストがしきい値を超えたときに通知が送信されます。 これは常にパーセントであり、0 から 1000 の間である必要があります。 | int (必須) |