Microsoft.Consumption budgets 2018-10-01
Bicep リソース定義
予算リソースの種類は 拡張リソースです。つまり、別のリソースに適用できます。
このリソースの プロパティを scope 使用して、このリソースのスコープを設定します。 「Bicep で拡張機能リソースのスコープを設定する」を参照してください。
予算リソースの有効なデプロイ スコープは次のとおりです。
- サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Consumption/budgets リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Consumption/budgets@2018-10-01' = {
name: 'string'
scope: resourceSymbolicName
eTag: 'string'
properties: {
amount: int
category: 'string'
filters: {
meters: [
'string'
]
resourceGroups: [
'string'
]
resources: [
'string'
]
tags: {}
}
notifications: {}
timeGrain: 'string'
timePeriod: {
endDate: 'string'
startDate: 'string'
}
}
}
プロパティの値
budgets
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 | string (必須) 文字制限: 1 から 63 有効な文字: 英数字、ハイフン、およびアンダースコア。 |
| scope | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース Bicep の場合は、このプロパティをリソースのシンボリック名に設定して 、拡張機能リソースを適用します。 |
| eTag | リソースの eTag。 同時更新シナリオを処理するために、このフィールドを使用して、ユーザーが最新バージョンを更新しているかどうかを判断します。 | string |
| properties | 予算のプロパティ。 | BudgetProperties |
BudgetProperties
| 名前 | 説明 | 値 |
|---|---|---|
| 合計 | 予算で追跡するコストの合計 | int (必須) |
| category | 予算のカテゴリ。予算がコストと使用量のどちらを追跡するか。 | 'Cost' 'Usage' (必須) |
| filters | リソース グループ、リソース、またはメーターで予算をフィルター処理するために使用できます。 | フィルター |
| notifications | 予算に関連付けられている通知の辞書。 予算には最大 5 つの通知を設定できます。 | object |
| timeGrain | 予算の対象となる時間。 量の追跡は、時間グレインに基づいてリセットされます。 | "毎年" 'Monthly' 'Quarterly' (必須) |
| timePeriod | 予算の開始日と終了日を指定します。 開始日は月の最初の日付にする必要があり、終了日より小さくする必要があります。 予算開始日は、2017 年 6 月 1 日以降である必要があります。 今後の開始日は 3 か月を超えてはなりません。 過去の開始日は、タイムグレイン期間内に選択する必要があります。 終了日に制限はありません。 | BudgetTimePeriod (必須) |
フィルター
| 名前 | 説明 | 値 |
|---|---|---|
| メートル | 使用状況カテゴリの予算に必須のメーター (GUID) のフィルターの一覧。 | string[] |
| resourceGroups | サブスクリプション レベルでのみ許可されるリソース グループのフィルターの一覧。 | string[] |
| resources | リソースのフィルターの一覧。 | string[] |
| tags | タグのフィルターのディクショナリ。 | object |
BudgetTimePeriod
| 名前 | 説明 | 値 |
|---|---|---|
| endDate | 予算の終了日。 指定しない場合、既定値は開始日から 10 年です。 | string |
| startDate | 予算の開始日。 | string (必須) |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
予算を作成する |
このテンプレートは、サブスクリプションで予算を作成する方法を示しています。 |
| フィルターを使用して予算を作成する |
このテンプレートは、サブスクリプションで予算を作成する方法を示しています。 |
| 単純な予算を作成する |
このテンプレートは、サブスクリプションで予算を作成する方法を示しています。 |
ARM テンプレート リソース定義
予算リソースの種類は 拡張リソースです。つまり、別のリソースに適用できます。
このリソースの プロパティを scope 使用して、このリソースのスコープを設定します。 「ARM テンプレートで拡張機能リソースのスコープを設定する」を参照してください。
予算リソースの有効なデプロイ スコープは次のとおりです。
- サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Consumption/budgets リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Consumption/budgets",
"apiVersion": "2018-10-01",
"name": "string",
"scope": "string",
"eTag": "string",
"properties": {
"amount": "int",
"category": "string",
"filters": {
"meters": [ "string" ],
"resourceGroups": [ "string" ],
"resources": [ "string" ],
"tags": {}
},
"notifications": {},
"timeGrain": "string",
"timePeriod": {
"endDate": "string",
"startDate": "string"
}
}
}
プロパティの値
budgets
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.Consumption/budgets' |
| apiVersion | リソース API のバージョン | '2018-10-01' |
| name | リソース名 | string (必須) 文字制限: 1 から 63 有効な文字: 英数字、ハイフン、およびアンダースコア。 |
| scope | デプロイ スコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。 | ターゲット リソース JSON の場合は、拡張リソースを適用するリソースの完全な名前に値を設定 します 。 |
| eTag | リソースの eTag。 同時更新シナリオを処理するために、このフィールドを使用して、ユーザーが最新バージョンを更新しているかどうかを判断します。 | string |
| properties | 予算のプロパティ。 | BudgetProperties |
BudgetProperties
| 名前 | 説明 | 値 |
|---|---|---|
| 合計 | 予算で追跡するコストの合計 | int (必須) |
| category | 予算のカテゴリ。予算がコストと使用量のどちらを追跡するか。 | 'Cost' 'Usage' (必須) |
| filters | リソース グループ、リソース、またはメーターで予算をフィルター処理するために使用できます。 | フィルター |
| notifications | 予算に関連付けられている通知の辞書。 予算には最大 5 つの通知を設定できます。 | object |
| timeGrain | 予算の対象となる時間。 量の追跡は、時間グレインに基づいてリセットされます。 | "毎年" 'Monthly' 'Quarterly' (必須) |
| timePeriod | 予算の開始日と終了日を指定します。 開始日は月の最初の日付にする必要があり、終了日より小さくする必要があります。 予算開始日は、2017 年 6 月 1 日以降である必要があります。 今後の開始日は 3 か月を超えてはなりません。 過去の開始日は、タイムグレイン期間内に選択する必要があります。 終了日に制限はありません。 | BudgetTimePeriod (必須) |
フィルター
| 名前 | 説明 | 値 |
|---|---|---|
| メートル | 使用状況カテゴリの予算に必須のメーター (GUID) のフィルターの一覧。 | string[] |
| resourceGroups | リソース グループのフィルターの一覧。サブスクリプション レベルでのみ許可されます。 | string[] |
| resources | リソースのフィルターの一覧。 | string[] |
| tags | タグのフィルターのディクショナリ。 | object |
BudgetTimePeriod
| 名前 | 説明 | 値 |
|---|---|---|
| endDate | 予算の終了日。 指定しない場合、既定値は開始日から 10 年です。 | string |
| startDate | 予算の開始日。 | string (必須) |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
| 予算を作成する |
このテンプレートは、サブスクリプションで予算を作成する方法を示しています。 |
| フィルターを使用して予算を作成する |
このテンプレートは、サブスクリプションで予算を作成する方法を示しています。 |
| 単純な予算を作成する |
このテンプレートは、サブスクリプションで予算を作成する方法を示しています。 |
Terraform (AzAPI プロバイダー) リソース定義
budgets リソースの種類は 拡張リソースです。つまり、別のリソースに適用できます。
このリソースの スコープを parent_id 設定するには、このリソースの プロパティを使用します。
budgets リソースの有効なデプロイ スコープは次のとおりです。
- サブスクリプション
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Consumption/budgets リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Consumption/budgets@2018-10-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
amount = int
category = "string"
filters = {
meters = [
"string"
]
resourceGroups = [
"string"
]
resources = [
"string"
]
tags = {}
}
notifications = {}
timeGrain = "string"
timePeriod = {
endDate = "string"
startDate = "string"
}
}
eTag = "string"
})
}
プロパティの値
budgets
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.Consumption/budgets@2018-10-01" |
| name | リソース名 | string (必須) 文字数制限: 1 から 63 有効な文字: 英数字、ハイフン、およびアンダースコア。 |
| parent_id | この拡張機能リソースを適用するリソースの ID。 | string (必須) |
| eTag | リソースの eTag。 同時更新シナリオを処理するために、このフィールドを使用して、ユーザーが最新バージョンを更新しているかどうかを判断します。 | string |
| properties | 予算のプロパティ。 | BudgetProperties |
BudgetProperties
| 名前 | 説明 | 値 |
|---|---|---|
| 合計 | 予算で追跡するコストの合計金額 | int (必須) |
| category | 予算のカテゴリ。予算がコストと使用量のどちらを追跡するか。 | "コスト" "使用法" (必須) |
| filters | リソース グループ、リソース、またはメーターで予算をフィルター処理するために使用できます。 | フィルター |
| notifications | 予算に関連付けられている通知の辞書。 予算には最大 5 つの通知を含めることができます。 | object |
| timeGrain | 予算の対象となる時間。 量の追跡は、時間グレインに基づいてリセットされます。 | "毎年" "Monthly" "四半期" (必須) |
| timePeriod | 予算の開始日と終了日を指定します。 開始日は月の最初の日付にする必要があり、終了日より小さくする必要があります。 予算開始日は、2017 年 6 月 1 日以降である必要があります。 将来の開始日は 3 か月以下にする必要があります。 過去の開始日は、タイムグレイン期間内に選択する必要があります。 終了日に制限はありません。 | BudgetTimePeriod (必須) |
フィルター
| 名前 | 説明 | 値 |
|---|---|---|
| メートル | 使用状況カテゴリの予算に必須のメーター (GUID) のフィルターの一覧。 | string[] |
| resourceGroups | リソース グループのフィルターの一覧。サブスクリプション レベルでのみ許可されます。 | string[] |
| resources | リソースのフィルターの一覧。 | string[] |
| tags | タグのフィルターのディクショナリ。 | object |
BudgetTimePeriod
| 名前 | 説明 | 値 |
|---|---|---|
| endDate | 予算の終了日。 指定しない場合、既定値は開始日から 10 年です。 | string |
| startDate | 予算の開始日。 | string (必須) |