Partilhar via


Microsoft.Orçamentos de consumo

Definição de recursos do bíceps

O tipo de recurso de orçamentos pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Consumption/budgets, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Consumption/budgets@2024-08-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'
        ]
      }
      tags: {
        name: 'string'
        operator: 'string'
        values: [
          'string'
        ]
      }
    }
    notifications: {
      {customized property}: {
        contactEmails: [
          'string'
        ]
        contactGroups: [
          'string'
        ]
        contactRoles: [
          'string'
        ]
        enabled: bool
        locale: 'string'
        operator: 'string'
        threshold: int
        thresholdType: 'string'
      }
    }
    timeGrain: 'string'
    timePeriod: {
      endDate: 'string'
      startDate: 'string'
    }
  }
}

Valores de propriedade

OrçamentoComparaçãoExpressão

Designação Descrição Valor
Designação O nome da coluna a ser usada na comparação. string (obrigatório)
Operador O operador a utilizar para comparação. 'In' (obrigatório)
valores Matriz de valores a ser usada para comparação string[] (obrigatório)

OrçamentoFiltrar

Designação Descrição Valor
e ainda A expressão lógica "E". Deve ter pelo menos 2 itens. BudgetFilterProperties []
Dimensões Tem expressão de comparação para uma dimensão BudgetComparisonExpression
Etiquetas Tem expressão de comparação para uma tag BudgetComparisonExpression

BudgetFilterProperties

Designação Descrição Valor
Dimensões Tem expressão de comparação para uma dimensão BudgetComparisonExpression
Etiquetas Tem expressão de comparação para uma tag BudgetComparisonExpression

BudgetProperties

Designação Descrição Valor
Montante O valor total do custo a acompanhar com o orçamento int (obrigatório)
categoria A categoria do orçamento, se o orçamento controla o custo ou o uso. 'Custo' (obrigatório)
filtrar Pode ser usado para filtrar orçamentos por dimensões e/ou tags especificadas pelo usuário. BudgetFilter
Notificações Dicionário de notificações associadas ao orçamento. O orçamento pode ter até cinco notificações. BudgetPropertiesNotifications
timeGrain O tempo coberto por um orçamento. O rastreamento do valor será redefinido com base no grão de tempo. BillingMonth, BillingQuarter e BillingAnnual são suportados apenas por clientes WD 'Anualmente'
'FaturamentoAnual'
'Mês de Faturação'
'BillingQuarter'
'Mensal'
«Trimestral» (obrigatório)
tempoPeríodo Tem data de início e fim do orçamento. A data de início deve ser a primeira do mês e deve ser inferior à data de fim. A data de início do orçamento deve ser em ou após 1º de junho de 2017. A data de início futura não deve ser superior a doze meses. A data de início anterior deve ser selecionada dentro do período de tempo. Não há restrições quanto à data de término. BudgetTimePeriod (obrigatório)

BudgetPropertiesNotifications

Designação Descrição Valor

BudgetTimePeriod

Designação Descrição Valor
Data de fim A data final do orçamento. Se não for fornecido, o padrão será de 10 anos a partir da data de início. string
data de início A data de início do orçamento. string (obrigatório)

Microsoft.Consumo/orçamentos

Designação Descrição Valor
eTag eTag do recurso. Para lidar com o cenário de atualização simultânea, esse campo será usado para determinar se o usuário está atualizando a versão mais recente ou não. string
Designação O nome do recurso string (obrigatório)
propriedades As propriedades do orçamento. BudgetProperties
Âmbito de aplicação Use ao criar um recurso em um escopo diferente do escopo de implantação. Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .

Notificação

Designação Descrição Valor
contatoE-mails Endereços de e-mail para enviar a notificação de orçamento quando o limite for excedido. Deve ter pelo menos um email de contato ou grupo de contatos especificado nos escopos Assinatura ou Grupo de Recursos. Todos os outros escopos devem ter pelo menos um e-mail de contato especificado. string[] (obrigatório)
contatoGrupos Grupos de ação para enviar a notificação de orçamento quando o limite for excedido. Deve ser fornecido como uma ID de recurso do Azure totalmente qualificada. Suportado apenas nos âmbitos de Subscrição ou Grupo de Recursos. string[]
contatoFunções Funções de contato para enviar a notificação de orçamento quando o limite for excedido. string[]
ativado A notificação está habilitada ou não. bool (obrigatório)
localidade Língua em que o destinatário receberá a notificação 'cs-cz'
'da-dk'
'de-de'
'en-gb'
'en-us'
'es-es'
'fr-fr'
'hu-hu'
'it-it'
'ja-jp'
'ko-kr'
'nb-no'
'nl-nl'
'pl-pl'
'pt-br'
'pt-pt'
'ru-ru'
'sv-se'
'tr-tr'
'zh-cn'
'zh-tw'
Operador O operador de comparação. 'Igual'
'MaiorQue'
'GreaterThanOrEqualTo' (obrigatório)
limiar Valor limite associado a uma notificação. A notificação é enviada quando o custo excede o limite. É sempre percentual e tem que estar entre 0 e 1000. int (obrigatório)
thresholdType O tipo de limiar 'Atual'
'Previsão'

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
Criar um orçamento Este modelo mostra como criar um orçamento sob uma assinatura.
Criar um orçamento com de filtro Este modelo mostra como criar um orçamento sob uma assinatura.
Criar um orçamento simples Este modelo mostra como criar um orçamento sob uma assinatura.

Definição de recurso de modelo ARM

O tipo de recurso de orçamentos pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Consumption/budgets, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Consumption/budgets",
  "apiVersion": "2024-08-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" ]
      },
      "tags": {
        "name": "string",
        "operator": "string",
        "values": [ "string" ]
      }
    },
    "notifications": {
      "{customized property}": {
        "contactEmails": [ "string" ],
        "contactGroups": [ "string" ],
        "contactRoles": [ "string" ],
        "enabled": "bool",
        "locale": "string",
        "operator": "string",
        "threshold": "int",
        "thresholdType": "string"
      }
    },
    "timeGrain": "string",
    "timePeriod": {
      "endDate": "string",
      "startDate": "string"
    }
  }
}

Valores de propriedade

OrçamentoComparaçãoExpressão

Designação Descrição Valor
Designação O nome da coluna a ser usada na comparação. string (obrigatório)
Operador O operador a utilizar para comparação. 'In' (obrigatório)
valores Matriz de valores a ser usada para comparação string[] (obrigatório)

OrçamentoFiltrar

Designação Descrição Valor
e ainda A expressão lógica "E". Deve ter pelo menos 2 itens. BudgetFilterProperties []
Dimensões Tem expressão de comparação para uma dimensão BudgetComparisonExpression
Etiquetas Tem expressão de comparação para uma tag BudgetComparisonExpression

BudgetFilterProperties

Designação Descrição Valor
Dimensões Tem expressão de comparação para uma dimensão BudgetComparisonExpression
Etiquetas Tem expressão de comparação para uma tag BudgetComparisonExpression

BudgetProperties

Designação Descrição Valor
Montante O valor total do custo a acompanhar com o orçamento int (obrigatório)
categoria A categoria do orçamento, se o orçamento controla o custo ou o uso. 'Custo' (obrigatório)
filtrar Pode ser usado para filtrar orçamentos por dimensões e/ou tags especificadas pelo usuário. BudgetFilter
Notificações Dicionário de notificações associadas ao orçamento. O orçamento pode ter até cinco notificações. BudgetPropertiesNotifications
timeGrain O tempo coberto por um orçamento. O rastreamento do valor será redefinido com base no grão de tempo. BillingMonth, BillingQuarter e BillingAnnual são suportados apenas por clientes WD 'Anualmente'
'FaturamentoAnual'
'Mês de Faturação'
'BillingQuarter'
'Mensal'
«Trimestral» (obrigatório)
tempoPeríodo Tem data de início e fim do orçamento. A data de início deve ser a primeira do mês e deve ser inferior à data de fim. A data de início do orçamento deve ser em ou após 1º de junho de 2017. A data de início futura não deve ser superior a doze meses. A data de início anterior deve ser selecionada dentro do período de tempo. Não há restrições quanto à data de término. BudgetTimePeriod (obrigatório)

BudgetPropertiesNotifications

Designação Descrição Valor

BudgetTimePeriod

Designação Descrição Valor
Data de fim A data final do orçamento. Se não for fornecido, o padrão será de 10 anos a partir da data de início. string
data de início A data de início do orçamento. string (obrigatório)

Microsoft.Consumo/orçamentos

Designação Descrição Valor
apiVersion A versão api '2024-08-01'
eTag eTag do recurso. Para lidar com o cenário de atualização simultânea, esse campo será usado para determinar se o usuário está atualizando a versão mais recente ou não. string
Designação O nome do recurso string (obrigatório)
propriedades As propriedades do orçamento. BudgetProperties
tipo O tipo de recurso 'Microsoft.Consumo/orçamentos'

Notificação

Designação Descrição Valor
contatoE-mails Endereços de e-mail para enviar a notificação de orçamento quando o limite for excedido. Deve ter pelo menos um email de contato ou grupo de contatos especificado nos escopos Assinatura ou Grupo de Recursos. Todos os outros escopos devem ter pelo menos um e-mail de contato especificado. string[] (obrigatório)
contatoGrupos Grupos de ação para enviar a notificação de orçamento quando o limite for excedido. Deve ser fornecido como uma ID de recurso do Azure totalmente qualificada. Suportado apenas nos âmbitos de Subscrição ou Grupo de Recursos. string[]
contatoFunções Funções de contato para enviar a notificação de orçamento quando o limite for excedido. string[]
ativado A notificação está habilitada ou não. bool (obrigatório)
localidade Língua em que o destinatário receberá a notificação 'cs-cz'
'da-dk'
'de-de'
'en-gb'
'en-us'
'es-es'
'fr-fr'
'hu-hu'
'it-it'
'ja-jp'
'ko-kr'
'nb-no'
'nl-nl'
'pl-pl'
'pt-br'
'pt-pt'
'ru-ru'
'sv-se'
'tr-tr'
'zh-cn'
'zh-tw'
Operador O operador de comparação. 'Igual'
'MaiorQue'
'GreaterThanOrEqualTo' (obrigatório)
limiar Valor limite associado a uma notificação. A notificação é enviada quando o custo excede o limite. É sempre percentual e tem que estar entre 0 e 1000. int (obrigatório)
thresholdType O tipo de limiar 'Atual'
'Previsão'

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar um orçamento

Implantar no Azure
Este modelo mostra como criar um orçamento sob uma assinatura.
Criar um orçamento com de filtro

Implantar no Azure
Este modelo mostra como criar um orçamento sob uma assinatura.
Criar um orçamento simples

Implantar no Azure
Este modelo mostra como criar um orçamento sob uma assinatura.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso de orçamentos pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Consumption/budgets, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Consumption/budgets@2024-08-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"
          ]
        }
        tags = {
          name = "string"
          operator = "string"
          values = [
            "string"
          ]
        }
      }
      notifications = {
        {customized property} = {
          contactEmails = [
            "string"
          ]
          contactGroups = [
            "string"
          ]
          contactRoles = [
            "string"
          ]
          enabled = bool
          locale = "string"
          operator = "string"
          threshold = int
          thresholdType = "string"
        }
      }
      timeGrain = "string"
      timePeriod = {
        endDate = "string"
        startDate = "string"
      }
    }
  })
}

Valores de propriedade

OrçamentoComparaçãoExpressão

Designação Descrição Valor
Designação O nome da coluna a ser usada na comparação. string (obrigatório)
Operador O operador a utilizar para comparação. 'In' (obrigatório)
valores Matriz de valores a ser usada para comparação string[] (obrigatório)

OrçamentoFiltrar

Designação Descrição Valor
e ainda A expressão lógica "E". Deve ter pelo menos 2 itens. BudgetFilterProperties []
Dimensões Tem expressão de comparação para uma dimensão BudgetComparisonExpression
Etiquetas Tem expressão de comparação para uma tag BudgetComparisonExpression

BudgetFilterProperties

Designação Descrição Valor
Dimensões Tem expressão de comparação para uma dimensão BudgetComparisonExpression
Etiquetas Tem expressão de comparação para uma tag BudgetComparisonExpression

BudgetProperties

Designação Descrição Valor
Montante O valor total do custo a acompanhar com o orçamento int (obrigatório)
categoria A categoria do orçamento, se o orçamento controla o custo ou o uso. 'Custo' (obrigatório)
filtrar Pode ser usado para filtrar orçamentos por dimensões e/ou tags especificadas pelo usuário. BudgetFilter
Notificações Dicionário de notificações associadas ao orçamento. O orçamento pode ter até cinco notificações. BudgetPropertiesNotifications
timeGrain O tempo coberto por um orçamento. O rastreamento do valor será redefinido com base no grão de tempo. BillingMonth, BillingQuarter e BillingAnnual são suportados apenas por clientes WD 'Anualmente'
'FaturamentoAnual'
'Mês de Faturação'
'BillingQuarter'
'Mensal'
«Trimestral» (obrigatório)
tempoPeríodo Tem data de início e fim do orçamento. A data de início deve ser a primeira do mês e deve ser inferior à data de fim. A data de início do orçamento deve ser em ou após 1º de junho de 2017. A data de início futura não deve ser superior a doze meses. A data de início anterior deve ser selecionada dentro do período de tempo. Não há restrições quanto à data de término. BudgetTimePeriod (obrigatório)

BudgetPropertiesNotifications

Designação Descrição Valor

BudgetTimePeriod

Designação Descrição Valor
Data de fim A data final do orçamento. Se não for fornecido, o padrão será de 10 anos a partir da data de início. string
data de início A data de início do orçamento. string (obrigatório)

Microsoft.Consumo/orçamentos

Designação Descrição Valor
eTag eTag do recurso. Para lidar com o cenário de atualização simultânea, esse campo será usado para determinar se o usuário está atualizando a versão mais recente ou não. string
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. string (obrigatório)
propriedades As propriedades do orçamento. BudgetProperties
tipo O tipo de recurso "Microsoft.Consumption/budgets@2024-08-01"

Notificação

Designação Descrição Valor
contatoE-mails Endereços de e-mail para enviar a notificação de orçamento quando o limite for excedido. Deve ter pelo menos um email de contato ou grupo de contatos especificado nos escopos Assinatura ou Grupo de Recursos. Todos os outros escopos devem ter pelo menos um e-mail de contato especificado. string[] (obrigatório)
contatoGrupos Grupos de ação para enviar a notificação de orçamento quando o limite for excedido. Deve ser fornecido como uma ID de recurso do Azure totalmente qualificada. Suportado apenas nos âmbitos de Subscrição ou Grupo de Recursos. string[]
contatoFunções Funções de contato para enviar a notificação de orçamento quando o limite for excedido. string[]
ativado A notificação está habilitada ou não. bool (obrigatório)
localidade Língua em que o destinatário receberá a notificação 'cs-cz'
'da-dk'
'de-de'
'en-gb'
'en-us'
'es-es'
'fr-fr'
'hu-hu'
'it-it'
'ja-jp'
'ko-kr'
'nb-no'
'nl-nl'
'pl-pl'
'pt-br'
'pt-pt'
'ru-ru'
'sv-se'
'tr-tr'
'zh-cn'
'zh-tw'
Operador O operador de comparação. 'Igual'
'MaiorQue'
'GreaterThanOrEqualTo' (obrigatório)
limiar Valor limite associado a uma notificação. A notificação é enviada quando o custo excede o limite. É sempre percentual e tem que estar entre 0 e 1000. int (obrigatório)
thresholdType O tipo de limiar 'Atual'
'Previsão'