Microsoft.消費預算 2019-05-01

發行項
12/21/2024

Bicep 資源定義

預算資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Consumption/budgets 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Consumption/budgets@2019-05-01' = {
  scope: resourceSymbolicName or scope
  eTag: 'string'
  name: 'string'
  properties: {
    amount: int
    category: 'string'
    filter: {
      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
        thresholdType: 'string'
      }
    }
    timeGrain: 'string'
    timePeriod: {
      endDate: 'string'
      startDate: 'string'
    }
  }
}

屬性值

BudgetProperties

名字	描述	價值
量	使用預算追蹤的總成本量	int （必要）
類別	預算的類別，無論是預算追蹤成本還是使用量。	'Cost' 'Usage' （必要）
濾波器	可用來依使用者指定的維度和/或標籤來篩選預算。	篩選
通知	與預算相關聯的通知字典。預算最多可以有五個通知。	BudgetPropertiesNotifications
timeGrain	預算涵蓋的時間。追蹤數量將會根據時間粒紋重設。	'每年' 'BillingAnnual' 'BillingMonth' 'BillingQuarter' 'Monthly' '每季' （必要）
timePeriod	具有預算的開始和結束日期。開始日期必須是月份的第一個，而且應該小於結束日期。預算開始日期必須是 2017 年 6 月 1 日或之後。未來的開始日期不應超過三個月。應該在時間根期間內選取過去的開始日期。結束日期沒有任何限制。	BudgetTimePeriod （必要）

BudgetPropertiesNotifications

名字	描述	價值

BudgetTimePeriod

名字	描述	價值
endDate	預算的結束日期。如果未提供，我們預設為開始日期的10年。	字串
startDate	預算的開始日期。	字串（必要）

濾波器

名字	描述	價值
米	計量（GUID）的篩選清單，這是使用量類別預算的必要專案。	字串約束：最小長度 = 36 最大長度 = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`[]
resourceGroups	僅限訂用帳戶層級所允許的資源群組篩選清單。	string[]
資源	資源上的篩選清單。	string[]
標籤	標記上篩選的字典。	FilterTags

FilterTags

名字	描述	價值

Microsoft.Consumption/budgets

名字	描述	價值
eTag	資源的 eTag。若要處理並行更新案例，此字段將用來判斷使用者是否要更新最新版本。	字串
名字	資源名稱	字串（必要）
性能	預算的屬性。	BudgetProperties
範圍	在與部署範圍不同的範圍內建立資源時，請使用。	將此屬性設定為資源的符號名稱，以套用擴充資源。

通知

名字	描述	價值
contactEmails	超過臨界值時，要傳送預算通知的電子郵件位址。在訂用帳戶或資源群組範圍中至少必須指定一個聯繫人電子郵件或聯繫人群組。所有其他範圍必須至少指定一個聯繫人電子郵件。	string[] （必要）
contactGroups	當超過臨界值時，要傳送預算通知的動作群組。必須以完整 Azure 資源標識碼的形式提供。只有訂用帳戶或資源群組範圍才支援。	string[]
contactRoles	連絡角色，以在超過臨界值時將預算通知傳送至。	string[]
啟用	通知已啟用或未啟用。	布林（必要）
算子	比較運算子。	'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' （必要）
門檻	與通知相關聯的臨界值。當成本超過閾值時，就會傳送通知。一律為百分比，且必須介於 0 到 1000 之間。	int （必要）
thresholdType	臨界值的類型	'Actual'

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案	描述
建立預算	此範本示範如何在訂用帳戶下建立預算。
使用篩選建立預算	此範本示範如何在訂用帳戶下建立預算。
建立簡單預算	此範本示範如何在訂用帳戶下建立預算。

ARM 樣本資源定義

預算資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Consumption/budgets 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Consumption/budgets",
  "apiVersion": "2019-05-01",
  "name": "string",
  "eTag": "string",
  "properties": {
    "amount": "int",
    "category": "string",
    "filter": {
      "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",
        "thresholdType": "string"
      }
    },
    "timeGrain": "string",
    "timePeriod": {
      "endDate": "string",
      "startDate": "string"
    }
  }
}

屬性值

BudgetProperties

名字	描述	價值
量	使用預算追蹤的總成本量	int （必要）
類別	預算的類別，無論是預算追蹤成本還是使用量。	'Cost' 'Usage' （必要）
濾波器	可用來依使用者指定的維度和/或標籤來篩選預算。	篩選
通知	與預算相關聯的通知字典。預算最多可以有五個通知。	BudgetPropertiesNotifications
timeGrain	預算涵蓋的時間。追蹤數量將會根據時間粒紋重設。	'每年' 'BillingAnnual' 'BillingMonth' 'BillingQuarter' 'Monthly' '每季' （必要）
timePeriod	具有預算的開始和結束日期。開始日期必須是月份的第一個，而且應該小於結束日期。預算開始日期必須是 2017 年 6 月 1 日或之後。未來的開始日期不應超過三個月。應該在時間根期間內選取過去的開始日期。結束日期沒有任何限制。	BudgetTimePeriod （必要）

BudgetPropertiesNotifications

名字	描述	價值

BudgetTimePeriod

名字	描述	價值
endDate	預算的結束日期。如果未提供，我們預設為開始日期的10年。	字串
startDate	預算的開始日期。	字串（必要）

濾波器

名字	描述	價值
米	計量（GUID）的篩選清單，這是使用量類別預算的必要專案。	字串約束：最小長度 = 36 最大長度 = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`[]
resourceGroups	僅限訂用帳戶層級所允許的資源群組篩選清單。	string[]
資源	資源上的篩選清單。	string[]
標籤	標記上篩選的字典。	FilterTags

FilterTags

名字	描述	價值

Microsoft.Consumption/budgets

名字	描述	價值
apiVersion	API 版本	'2019-05-01'
eTag	資源的 eTag。若要處理並行更新案例，此字段將用來判斷使用者是否要更新最新版本。	字串
名字	資源名稱	字串（必要）
性能	預算的屬性。	BudgetProperties
類型	資源類型	'Microsoft.Consumption/budgets'

通知

名字	描述	價值
contactEmails	超過臨界值時，要傳送預算通知的電子郵件位址。在訂用帳戶或資源群組範圍中至少必須指定一個聯繫人電子郵件或聯繫人群組。所有其他範圍必須至少指定一個聯繫人電子郵件。	string[] （必要）
contactGroups	當超過臨界值時，要傳送預算通知的動作群組。必須以完整 Azure 資源標識碼的形式提供。只有訂用帳戶或資源群組範圍才支援。	string[]
contactRoles	連絡角色，以在超過臨界值時將預算通知傳送至。	string[]
啟用	通知已啟用或未啟用。	布林（必要）
算子	比較運算子。	'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' （必要）
門檻	與通知相關聯的臨界值。當成本超過閾值時，就會傳送通知。一律為百分比，且必須介於 0 到 1000 之間。	int （必要）
thresholdType	臨界值的類型	'Actual'

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
建立預算	此範本示範如何在訂用帳戶下建立預算。
使用篩選建立預算	此範本示範如何在訂用帳戶下建立預算。
建立簡單預算	此範本示範如何在訂用帳戶下建立預算。

Terraform （AzAPI 提供者）資源定義

預算資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Consumption/budgets 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Consumption/budgets@2019-05-01"
  name = "string"
  parent_id = "string"
  eTag = "string"
  body = jsonencode({
    properties = {
      amount = int
      category = "string"
      filter = {
        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
          thresholdType = "string"
        }
      }
      timeGrain = "string"
      timePeriod = {
        endDate = "string"
        startDate = "string"
      }
    }
  })
}

屬性值

BudgetProperties

名字	描述	價值
量	使用預算追蹤的總成本量	int （必要）
類別	預算的類別，無論是預算追蹤成本還是使用量。	'Cost' 'Usage' （必要）
濾波器	可用來依使用者指定的維度和/或標籤來篩選預算。	篩選
通知	與預算相關聯的通知字典。預算最多可以有五個通知。	BudgetPropertiesNotifications
timeGrain	預算涵蓋的時間。追蹤數量將會根據時間粒紋重設。	'每年' 'BillingAnnual' 'BillingMonth' 'BillingQuarter' 'Monthly' '每季' （必要）
timePeriod	具有預算的開始和結束日期。開始日期必須是月份的第一個，而且應該小於結束日期。預算開始日期必須是 2017 年 6 月 1 日或之後。未來的開始日期不應超過三個月。應該在時間根期間內選取過去的開始日期。結束日期沒有任何限制。	BudgetTimePeriod （必要）

BudgetPropertiesNotifications

名字	描述	價值

BudgetTimePeriod

名字	描述	價值
endDate	預算的結束日期。如果未提供，我們預設為開始日期的10年。	字串
startDate	預算的開始日期。	字串（必要）

濾波器

名字	描述	價值
米	計量（GUID）的篩選清單，這是使用量類別預算的必要專案。	字串約束：最小長度 = 36 最大長度 = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`[]
resourceGroups	僅限訂用帳戶層級所允許的資源群組篩選清單。	string[]
資源	資源上的篩選清單。	string[]
標籤	標記上篩選的字典。	FilterTags

FilterTags

名字	描述	價值

Microsoft.Consumption/budgets

名字	描述	價值
eTag	資源的 eTag。若要處理並行更新案例，此字段將用來判斷使用者是否要更新最新版本。	字串
名字	資源名稱	字串（必要）
parent_id	要套用此延伸模組資源之資源的標識碼。	字串（必要）
性能	預算的屬性。	BudgetProperties
類型	資源類型	“Microsoft.Consumption/budgets@2019-05-01”

通知

名字	描述	價值
contactEmails	超過臨界值時，要傳送預算通知的電子郵件位址。在訂用帳戶或資源群組範圍中至少必須指定一個聯繫人電子郵件或聯繫人群組。所有其他範圍必須至少指定一個聯繫人電子郵件。	string[] （必要）
contactGroups	當超過臨界值時，要傳送預算通知的動作群組。必須以完整 Azure 資源標識碼的形式提供。只有訂用帳戶或資源群組範圍才支援。	string[]
contactRoles	連絡角色，以在超過臨界值時將預算通知傳送至。	string[]
啟用	通知已啟用或未啟用。	布林（必要）
算子	比較運算子。	'EqualTo' 'GreaterThan' 'GreaterThanOrEqualTo' （必要）
門檻	與通知相關聯的臨界值。當成本超過閾值時，就會傳送通知。一律為百分比，且必須介於 0 到 1000 之間。	int （必要）
thresholdType	臨界值的類型	'Actual'

共用方式為

Microsoft.消費預算 2019-05-01

Bicep 資源定義

資源格式

屬性值

BudgetProperties

BudgetPropertiesNotifications

BudgetTimePeriod

濾波器

FilterTags

Microsoft.Consumption/budgets

通知

快速入門範例

ARM 樣本資源定義

資源格式

屬性值

BudgetProperties

BudgetPropertiesNotifications

BudgetTimePeriod

濾波器

FilterTags

Microsoft.Consumption/budgets

通知

快速入門範本

Terraform （AzAPI 提供者）資源定義

資源格式

屬性值

BudgetProperties

BudgetPropertiesNotifications

BudgetTimePeriod

濾波器

FilterTags

Microsoft.Consumption/budgets

通知

意見反應

其他資源

共用方式為

Microsoft.消費預算 2019-05-01

Bicep 資源定義

資源格式

屬性值

BudgetProperties

BudgetPropertiesNotifications

BudgetTimePeriod

濾波器

FilterTags

Microsoft.Consumption/budgets

通知

快速入門範例

ARM 樣本資源定義

資源格式

屬性值

BudgetProperties

BudgetPropertiesNotifications

BudgetTimePeriod

濾波器

FilterTags

Microsoft.Consumption/budgets

通知

快速入門範本

Terraform （AzAPI 提供者） 資源定義

資源格式

屬性值

BudgetProperties

BudgetPropertiesNotifications

BudgetTimePeriod

濾波器

FilterTags

Microsoft.Consumption/budgets

通知

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義