Microsoft.Consumption budgets 2021-05-01
Bicep リソース定義
予算リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Consumption/budgets リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Consumption/budgets@2021-05-01' = {
scope: resourceSymbolicName or scope
eTag: 'string'
name: 'string'
properties: {
amount: int
category: 'string'
filter: {
and: [
{
dimensions: {
name: 'string'
operator: 'string'
values: [
'string'
]
}
tags: {
name: 'string'
operator: 'string'
values: [
'string'
]
}
}
]
dimensions: {
name: 'string'
operator: 'string'
values: [
'string'
]
}
not: {
dimensions: {
name: 'string'
operator: 'string'
values: [
'string'
]
}
tags: {
name: 'string'
operator: 'string'
values: [
'string'
]
}
}
tags: {
name: 'string'
operator: 'string'
values: [
'string'
]
}
}
notifications: {
{customized property}: {
contactEmails: [
'string'
]
contactGroups: [
'string'
]
contactRoles: [
'string'
]
enabled: bool
operator: 'string'
threshold: int
thresholdType: 'string'
}
}
timeGrain: 'string'
timePeriod: {
endDate: 'string'
startDate: 'string'
}
}
}
プロパティ値
BudgetComparisonExpression
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | 比較に使用する列の名前。 | string (必須) |
| 演算子 | 比較に使用する演算子。 | 'In' (必須) |
| 価値観 | 比較に使用する値の配列 | string[] (必須) |
BudgetFilter
| 名前 | 形容 | 価値 |
|---|---|---|
| そして | 論理 "AND" 式。 少なくとも 2 つの項目が必要です。 | BudgetFilterProperties[] |
| 寸法 | ディメンションの比較式を持つ | BudgetComparisonExpression |
| じゃない | 論理 "NOT" 式。 | BudgetFilterProperties |
| タグ | タグの比較式を持つ | BudgetComparisonExpression |
BudgetFilterProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 寸法 | ディメンションの比較式を持つ | BudgetComparisonExpression |
| タグ | タグの比較式を持つ | BudgetComparisonExpression |
BudgetProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 量 | 予算で追跡するコストの合計 | int (必須) |
| カテゴリ | 予算のカテゴリ。予算がコストと使用量のどちらを追跡するか。 | 'Cost' (必須) |
| フィルター | ユーザー指定のディメンションやタグで予算をフィルター処理するために使用できます。 | BudgetFilter |
| 通知 | 予算に関連付けられている通知の辞書。 予算には最大 5 つの通知を含めることができます。 | BudgetPropertiesNotifications |
| timeGrain | 予算の対象となる時間。 量の追跡は、時間グレインに基づいてリセットされます。 BillingMonth、BillingQuarter、BillingAnnual は WD のお客様のみがサポートしています | 'Annually' 'BillingAnnual' 'BillingMonth' 'BillingQuarter' 'Monthly' '四半期' (必須) |
| timePeriod | 予算の開始日と終了日を指定します。 開始日は月の最初の日付にする必要があり、終了日より小さくする必要があります。 予算開始日は、2017 年 6 月 1 日以降である必要があります。 将来の開始日は 12 か月を超えてはなりません。 過去の開始日は、タイムグレイン期間内に選択する必要があります。 終了日に制限はありません。 | BudgetTimePeriod (必須) |
BudgetPropertiesNotifications
| 名前 | 形容 | 価値 |
|---|
BudgetTimePeriod
| 名前 | 形容 | 価値 |
|---|---|---|
| endDate | 予算の終了日。 指定しない場合、既定値は開始日から 10 年です。 | 糸 |
| startDate | 予算の開始日。 | string (必須) |
Microsoft.Consumption/budgets
| 名前 | 形容 | 価値 |
|---|---|---|
| eTag | リソースの eTag。 同時更新シナリオを処理するために、このフィールドを使用して、ユーザーが最新バージョンを更新しているかどうかを判断します。 | 糸 |
| 名前 | リソース名 | string (必須) |
| プロパティ | 予算のプロパティ。 | BudgetProperties |
| スコープ | デプロイ スコープとは異なるスコープでリソースを作成するときに使用します。 | このプロパティをリソースのシンボリック名に設定して、拡張リソースを適用します。 |
通知
| 名前 | 形容 | 価値 |
|---|---|---|
| contactEmails | しきい値を超えたときに予算通知を送信する電子メール アドレス。 サブスクリプションまたはリソース グループのスコープで少なくとも 1 つの連絡先メールまたは連絡先グループを指定する必要があります。 その他のすべてのスコープには、少なくとも 1 つの連絡先メールが指定されている必要があります。 | string[] (必須) |
| contactGroups | しきい値を超えたときに予算通知を送信するアクション グループ。 完全修飾 Azure リソース ID として指定する必要があります。サブスクリプションまたはリソース グループのスコープでのみサポートされます。 | string[] |
| contactRoles | しきい値を超えたときに予算通知を送信する連絡先ロール。 | string[] |
| 有効 | 通知が有効かどうか。 | bool (必須) |
| 演算子 | 比較演算子。 | 'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' (必須) |
| 閾 | 通知に関連付けられているしきい値。 コストがしきい値を超えたときに通知が送信されます。 これは常にパーセントであり、0 から 1000 の間である必要があります。 | int (必須) |
| thresholdType | しきい値の種類 | 'Actual' |
クイック スタートのサンプル
次のクイック スタート サンプルでは、このリソースの種類をデプロイします。
ARM テンプレート リソース定義
予算リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Consumption/budgets リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Consumption/budgets",
"apiVersion": "2021-05-01",
"name": "string",
"eTag": "string",
"properties": {
"amount": "int",
"category": "string",
"filter": {
"and": [
{
"dimensions": {
"name": "string",
"operator": "string",
"values": [ "string" ]
},
"tags": {
"name": "string",
"operator": "string",
"values": [ "string" ]
}
}
],
"dimensions": {
"name": "string",
"operator": "string",
"values": [ "string" ]
},
"not": {
"dimensions": {
"name": "string",
"operator": "string",
"values": [ "string" ]
},
"tags": {
"name": "string",
"operator": "string",
"values": [ "string" ]
}
},
"tags": {
"name": "string",
"operator": "string",
"values": [ "string" ]
}
},
"notifications": {
"{customized property}": {
"contactEmails": [ "string" ],
"contactGroups": [ "string" ],
"contactRoles": [ "string" ],
"enabled": "bool",
"operator": "string",
"threshold": "int",
"thresholdType": "string"
}
},
"timeGrain": "string",
"timePeriod": {
"endDate": "string",
"startDate": "string"
}
}
}
プロパティ値
BudgetComparisonExpression
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | 比較に使用する列の名前。 | string (必須) |
| 演算子 | 比較に使用する演算子。 | 'In' (必須) |
| 価値観 | 比較に使用する値の配列 | string[] (必須) |
BudgetFilter
| 名前 | 形容 | 価値 |
|---|---|---|
| そして | 論理 "AND" 式。 少なくとも 2 つの項目が必要です。 | BudgetFilterProperties[] |
| 寸法 | ディメンションの比較式を持つ | BudgetComparisonExpression |
| じゃない | 論理 "NOT" 式。 | BudgetFilterProperties |
| タグ | タグの比較式を持つ | BudgetComparisonExpression |
BudgetFilterProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 寸法 | ディメンションの比較式を持つ | BudgetComparisonExpression |
| タグ | タグの比較式を持つ | BudgetComparisonExpression |
BudgetProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 量 | 予算で追跡するコストの合計 | int (必須) |
| カテゴリ | 予算のカテゴリ。予算がコストと使用量のどちらを追跡するか。 | 'Cost' (必須) |
| フィルター | ユーザー指定のディメンションやタグで予算をフィルター処理するために使用できます。 | BudgetFilter |
| 通知 | 予算に関連付けられている通知の辞書。 予算には最大 5 つの通知を含めることができます。 | BudgetPropertiesNotifications |
| timeGrain | 予算の対象となる時間。 量の追跡は、時間グレインに基づいてリセットされます。 BillingMonth、BillingQuarter、BillingAnnual は WD のお客様のみがサポートしています | 'Annually' 'BillingAnnual' 'BillingMonth' 'BillingQuarter' 'Monthly' '四半期' (必須) |
| timePeriod | 予算の開始日と終了日を指定します。 開始日は月の最初の日付にする必要があり、終了日より小さくする必要があります。 予算開始日は、2017 年 6 月 1 日以降である必要があります。 将来の開始日は 12 か月を超えてはなりません。 過去の開始日は、タイムグレイン期間内に選択する必要があります。 終了日に制限はありません。 | BudgetTimePeriod (必須) |
BudgetPropertiesNotifications
| 名前 | 形容 | 価値 |
|---|
BudgetTimePeriod
| 名前 | 形容 | 価値 |
|---|---|---|
| endDate | 予算の終了日。 指定しない場合、既定値は開始日から 10 年です。 | 糸 |
| startDate | 予算の開始日。 | string (必須) |
Microsoft.Consumption/budgets
| 名前 | 形容 | 価値 |
|---|---|---|
| apiVersion | API のバージョン | '2021-05-01' |
| eTag | リソースの eTag。 同時更新シナリオを処理するために、このフィールドを使用して、ユーザーが最新バージョンを更新しているかどうかを判断します。 | 糸 |
| 名前 | リソース名 | string (必須) |
| プロパティ | 予算のプロパティ。 | BudgetProperties |
| 種類 | リソースの種類 | 'Microsoft.Consumption/budgets' |
通知
| 名前 | 形容 | 価値 |
|---|---|---|
| contactEmails | しきい値を超えたときに予算通知を送信する電子メール アドレス。 サブスクリプションまたはリソース グループのスコープで少なくとも 1 つの連絡先メールまたは連絡先グループを指定する必要があります。 その他のすべてのスコープには、少なくとも 1 つの連絡先メールが指定されている必要があります。 | string[] (必須) |
| contactGroups | しきい値を超えたときに予算通知を送信するアクション グループ。 完全修飾 Azure リソース ID として指定する必要があります。サブスクリプションまたはリソース グループのスコープでのみサポートされます。 | string[] |
| contactRoles | しきい値を超えたときに予算通知を送信する連絡先ロール。 | string[] |
| 有効 | 通知が有効かどうか。 | bool (必須) |
| 演算子 | 比較演算子。 | 'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' (必須) |
| 閾 | 通知に関連付けられているしきい値。 コストがしきい値を超えたときに通知が送信されます。 これは常にパーセントであり、0 から 1000 の間である必要があります。 | int (必須) |
| thresholdType | しきい値の種類 | 'Actual' |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
Terraform (AzAPI プロバイダー) リソース定義
予算リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.Consumption/budgets リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Consumption/budgets@2021-05-01"
name = "string"
parent_id = "string"
eTag = "string"
body = jsonencode({
properties = {
amount = int
category = "string"
filter = {
and = [
{
dimensions = {
name = "string"
operator = "string"
values = [
"string"
]
}
tags = {
name = "string"
operator = "string"
values = [
"string"
]
}
}
]
dimensions = {
name = "string"
operator = "string"
values = [
"string"
]
}
not = {
dimensions = {
name = "string"
operator = "string"
values = [
"string"
]
}
tags = {
name = "string"
operator = "string"
values = [
"string"
]
}
}
tags = {
name = "string"
operator = "string"
values = [
"string"
]
}
}
notifications = {
{customized property} = {
contactEmails = [
"string"
]
contactGroups = [
"string"
]
contactRoles = [
"string"
]
enabled = bool
operator = "string"
threshold = int
thresholdType = "string"
}
}
timeGrain = "string"
timePeriod = {
endDate = "string"
startDate = "string"
}
}
})
}
プロパティ値
BudgetComparisonExpression
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | 比較に使用する列の名前。 | string (必須) |
| 演算子 | 比較に使用する演算子。 | 'In' (必須) |
| 価値観 | 比較に使用する値の配列 | string[] (必須) |
BudgetFilter
| 名前 | 形容 | 価値 |
|---|---|---|
| そして | 論理 "AND" 式。 少なくとも 2 つの項目が必要です。 | BudgetFilterProperties[] |
| 寸法 | ディメンションの比較式を持つ | BudgetComparisonExpression |
| じゃない | 論理 "NOT" 式。 | BudgetFilterProperties |
| タグ | タグの比較式を持つ | BudgetComparisonExpression |
BudgetFilterProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 寸法 | ディメンションの比較式を持つ | BudgetComparisonExpression |
| タグ | タグの比較式を持つ | BudgetComparisonExpression |
BudgetProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 量 | 予算で追跡するコストの合計 | int (必須) |
| カテゴリ | 予算のカテゴリ。予算がコストと使用量のどちらを追跡するか。 | 'Cost' (必須) |
| フィルター | ユーザー指定のディメンションやタグで予算をフィルター処理するために使用できます。 | BudgetFilter |
| 通知 | 予算に関連付けられている通知の辞書。 予算には最大 5 つの通知を含めることができます。 | BudgetPropertiesNotifications |
| timeGrain | 予算の対象となる時間。 量の追跡は、時間グレインに基づいてリセットされます。 BillingMonth、BillingQuarter、BillingAnnual は WD のお客様のみがサポートしています | 'Annually' 'BillingAnnual' 'BillingMonth' 'BillingQuarter' 'Monthly' '四半期' (必須) |
| timePeriod | 予算の開始日と終了日を指定します。 開始日は月の最初の日付にする必要があり、終了日より小さくする必要があります。 予算開始日は、2017 年 6 月 1 日以降である必要があります。 将来の開始日は 12 か月を超えてはなりません。 過去の開始日は、タイムグレイン期間内に選択する必要があります。 終了日に制限はありません。 | BudgetTimePeriod (必須) |
BudgetPropertiesNotifications
| 名前 | 形容 | 価値 |
|---|
BudgetTimePeriod
| 名前 | 形容 | 価値 |
|---|---|---|
| endDate | 予算の終了日。 指定しない場合、既定値は開始日から 10 年です。 | 糸 |
| startDate | 予算の開始日。 | string (必須) |
Microsoft.Consumption/budgets
| 名前 | 形容 | 価値 |
|---|---|---|
| eTag | リソースの eTag。 同時更新シナリオを処理するために、このフィールドを使用して、ユーザーが最新バージョンを更新しているかどうかを判断します。 | 糸 |
| 名前 | リソース名 | string (必須) |
| parent_id | この拡張リソースを適用するリソースの ID。 | string (必須) |
| プロパティ | 予算のプロパティ。 | BudgetProperties |
| 種類 | リソースの種類 | "Microsoft.Consumption/budgets@2021-05-01" |
通知
| 名前 | 形容 | 価値 |
|---|---|---|
| contactEmails | しきい値を超えたときに予算通知を送信する電子メール アドレス。 サブスクリプションまたはリソース グループのスコープで少なくとも 1 つの連絡先メールまたは連絡先グループを指定する必要があります。 その他のすべてのスコープには、少なくとも 1 つの連絡先メールが指定されている必要があります。 | string[] (必須) |
| contactGroups | しきい値を超えたときに予算通知を送信するアクション グループ。 完全修飾 Azure リソース ID として指定する必要があります。サブスクリプションまたはリソース グループのスコープでのみサポートされます。 | string[] |
| contactRoles | しきい値を超えたときに予算通知を送信する連絡先ロール。 | string[] |
| 有効 | 通知が有効かどうか。 | bool (必須) |
| 演算子 | 比較演算子。 | 'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' (必須) |
| 閾 | 通知に関連付けられているしきい値。 コストがしきい値を超えたときに通知が送信されます。 これは常にパーセントであり、0 から 1000 の間である必要があります。 | int (必須) |
| thresholdType | しきい値の種類 | 'Actual' |