你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.消耗预算 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 （必需） |
| 类别 | 预算类别，无论是预算跟踪成本还是使用情况。 | “成本” “使用情况”（必需） |
| 过滤 器 | 可用于按资源组、资源或计量筛选预算。 | 筛选器 |
| 通知 | 与预算关联的通知字典。 预算最多可以有五个通知。 | BudgetPropertiesNotifications |
| timeGrain | 预算涵盖的时间。 将根据时间粒度重置对金额的跟踪。 | “每年” “BillingAnnual” “BillingMonth” “BillingQuarter” “Monthly” “季度”（必需） |
| timePeriod | 预算的开始日期和结束日期。 开始日期必须是月份的第一个，并且应小于结束日期。 预算开始日期必须在 2017 年 6 月 1 日或之后。 未来的开始日期不应超过三个月。 应在时间段内选择过去的开始日期。 结束日期没有限制。 | BudgetTimePeriod （必需） |
BudgetPropertiesNotifications
| 名字 | 描述 | 价值 |
|---|
BudgetTimePeriod
| 名字 | 描述 | 价值 |
|---|---|---|
| endDate | 预算的结束日期。 如果未提供，则从开始日期默认为 10 年。 | 字符串 |
| startDate | 预算的开始日期。 | string （必需） |
过滤 器
| 名字 | 描述 | 价值 |
|---|---|---|
| 米 | 计量（GUID）的筛选器列表，对于使用类别的预算是必需的。 | 字符串 约束： 最小长度 = 36 最大长度 = 36 Pattern = ^[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 （必需） |
用法示例
Azure 验证模块
以下 Azure 验证模块 可用于部署此资源类型。
| 模块 | 描述 |
|---|---|
| 消费预算 | 用于消耗预算的 AVM 资源模块 |
Azure 快速入门示例
以下 Azure 快速入门模板 包含用于部署此资源类型的 Bicep 示例。
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 （必需） |
| 类别 | 预算类别，无论是预算跟踪成本还是使用情况。 | “成本” “使用情况”（必需） |
| 过滤 器 | 可用于按资源组、资源或计量筛选预算。 | 筛选器 |
| 通知 | 与预算关联的通知字典。 预算最多可以有五个通知。 | BudgetPropertiesNotifications |
| timeGrain | 预算涵盖的时间。 将根据时间粒度重置对金额的跟踪。 | “每年” “BillingAnnual” “BillingMonth” “BillingQuarter” “Monthly” “季度”（必需） |
| timePeriod | 预算的开始日期和结束日期。 开始日期必须是月份的第一个，并且应小于结束日期。 预算开始日期必须在 2017 年 6 月 1 日或之后。 未来的开始日期不应超过三个月。 应在时间段内选择过去的开始日期。 结束日期没有限制。 | BudgetTimePeriod （必需） |
BudgetPropertiesNotifications
| 名字 | 描述 | 价值 |
|---|
BudgetTimePeriod
| 名字 | 描述 | 价值 |
|---|---|---|
| endDate | 预算的结束日期。 如果未提供，则从开始日期默认为 10 年。 | 字符串 |
| startDate | 预算的开始日期。 | string （必需） |
过滤 器
| 名字 | 描述 | 价值 |
|---|---|---|
| 米 | 计量（GUID）的筛选器列表，对于使用类别的预算是必需的。 | 字符串 约束： 最小长度 = 36 最大长度 = 36 Pattern = ^[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 （必需） |
用法示例
Azure 快速入门模板
以下 Azure 快速入门模板 部署此资源类型。
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 （必需） |
| 类别 | 预算类别，无论是预算跟踪成本还是使用情况。 | “成本” “使用情况”（必需） |
| 过滤 器 | 可用于按资源组、资源或计量筛选预算。 | 筛选器 |
| 通知 | 与预算关联的通知字典。 预算最多可以有五个通知。 | BudgetPropertiesNotifications |
| timeGrain | 预算涵盖的时间。 将根据时间粒度重置对金额的跟踪。 | “每年” “BillingAnnual” “BillingMonth” “BillingQuarter” “Monthly” “季度”（必需） |
| timePeriod | 预算的开始日期和结束日期。 开始日期必须是月份的第一个，并且应小于结束日期。 预算开始日期必须在 2017 年 6 月 1 日或之后。 未来的开始日期不应超过三个月。 应在时间段内选择过去的开始日期。 结束日期没有限制。 | BudgetTimePeriod （必需） |
BudgetPropertiesNotifications
| 名字 | 描述 | 价值 |
|---|
BudgetTimePeriod
| 名字 | 描述 | 价值 |
|---|---|---|
| endDate | 预算的结束日期。 如果未提供，则从开始日期默认为 10 年。 | 字符串 |
| startDate | 预算的开始日期。 | string （必需） |
过滤 器
| 名字 | 描述 | 价值 |
|---|---|---|
| 米 | 计量（GUID）的筛选器列表，对于使用类别的预算是必需的。 | 字符串 约束： 最小长度 = 36 最大长度 = 36 Pattern = ^[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 （必需） |
用法示例
Azure 验证模块
以下 Azure 验证模块 可用于部署此资源类型。
| 模块 | 描述 |
|---|---|
| 消费预算 | 用于消耗预算的 AVM 资源模块 |