Budgets - Create Or Update

Serviço:: Consumption

Versão da API:: 2024-08-01

A operação para criar ou atualizar um orçamento. Opcionalmente, você pode fornecer uma eTag se desejar como uma forma de controle de simultaneidade. Para obter a eTag mais recente para um determinado orçamento, execute uma operação get antes da operação de colocação.

PUT https://management.azure.com/{scope}/providers/Microsoft.Consumption/budgets/{budgetName}?api-version=2024-08-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
budgetName	path	True	string	Nome do Orçamento.
scope	path	True	string	O identificador totalmente qualificado do Azure Resource Manager do recurso.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.amount	True	number (decimal)	O valor total do custo a ser acompanhado com o orçamento
properties.category	True	CategoryType	A categoria do orçamento, independentemente de o orçamento controlar o custo ou o uso.
properties.timeGrain	True	TimeGrainType	O tempo coberto por um orçamento. O acompanhamento da quantidade será redefinido com base na granulação de tempo. BillingMonth, BillingQuarter e BillingAnnual só têm suporte para clientes do WD
properties.timePeriod	True	BudgetTimePeriod	Tem a data de início e término do orçamento. A data de início deve ser a primeira do mês e deve ser menor que a data de término. 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 temporais. Não há restrições na data de término.
eTag		string	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.
properties.filter		BudgetFilter	Pode ser usado para filtrar orçamentos por dimensões especificadas pelo usuário e/ou marcas.
properties.notifications		<string, Notification>	Dicionário de notificações associadas ao orçamento. O orçamento pode ter até cinco notificações.

Respostas

Nome	Tipo	Description
200 OK	Budget	Operação de atualização de 'Orçamento' do recurso bem-sucedida
201 Created	Budget	Operação de criação de recurso 'Orçamento' bem-sucedida
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

CreateOrUpdateBudget

Solicitação de exemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget?api-version=2024-08-01

{
  "eTag": "\"1d34d016a593709\"",
  "properties": {
    "amount": 100.65,
    "category": "Cost",
    "filter": {
      "and": [
        {
          "dimensions": {
            "name": "ResourceId",
            "operator": "In",
            "values": [
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1"
            ]
          }
        },
        {
          "tags": {
            "name": "category",
            "operator": "In",
            "values": [
              "Dev",
              "Prod"
            ]
          }
        },
        {
          "tags": {
            "name": "department",
            "operator": "In",
            "values": [
              "engineering",
              "sales"
            ]
          }
        }
      ]
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "enabled": true,
        "locale": "en-us",
        "operator": "GreaterThan",
        "threshold": 80,
        "thresholdType": "Actual"
      }
    },
    "timeGrain": "Monthly",
    "timePeriod": {
      "endDate": "2018-10-31T00:00:00Z",
      "startDate": "2017-10-01T00:00:00Z"
    }
  }
}

Resposta de exemplo

Código de status:: 200

{
  "name": "TestBudget",
  "type": "Microsoft.Consumption/budgets",
  "eTag": "\"1d34d012214157f\"",
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget",
  "properties": {
    "amount": 100.65,
    "category": "Cost",
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "filter": {
      "and": [
        {
          "dimensions": {
            "name": "ResourceId",
            "operator": "In",
            "values": [
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1"
            ]
          }
        },
        {
          "tags": {
            "name": "category",
            "operator": "In",
            "values": [
              "Dev",
              "Prod"
            ]
          }
        },
        {
          "tags": {
            "name": "department",
            "operator": "In",
            "values": [
              "engineering",
              "sales"
            ]
          }
        }
      ]
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "enabled": true,
        "locale": "en-us",
        "operator": "GreaterThan",
        "threshold": 80,
        "thresholdType": "Actual"
      }
    },
    "timeGrain": "Monthly",
    "timePeriod": {
      "endDate": "2018-10-31T00:00:00Z",
      "startDate": "2017-10-01T00:00:00Z"
    }
  }
}

Código de status:: 201

{
  "name": "TestBudget",
  "type": "Microsoft.Consumption/budgets",
  "eTag": "\"1d34d012214157f\"",
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget",
  "properties": {
    "amount": 100.65,
    "category": "Cost",
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "filter": {
      "and": [
        {
          "dimensions": {
            "name": "ResourceId",
            "operator": "In",
            "values": [
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2",
              "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1"
            ]
          }
        },
        {
          "tags": {
            "name": "category",
            "operator": "In",
            "values": [
              "Dev",
              "Prod"
            ]
          }
        },
        {
          "tags": {
            "name": "department",
            "operator": "In",
            "values": [
              "engineering",
              "sales"
            ]
          }
        }
      ]
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "enabled": true,
        "locale": "en-us",
        "operator": "GreaterThan",
        "threshold": 80,
        "thresholdType": "Actual"
      }
    },
    "timeGrain": "Monthly",
    "timePeriod": {
      "endDate": "2018-10-31T00:00:00Z",
      "startDate": "2017-10-01T00:00:00Z"
    }
  }
}

Definições

Nome	Description
Budget	Um recurso de orçamento.
BudgetComparisonExpression	A expressão de comparação a ser usada nos orçamentos.
BudgetFilter	Pode ser usado para filtrar orçamentos por grupo de recursos, recurso ou medidor.
BudgetFilterProperties	As Dimensões ou Marcas para filtrar um orçamento.
BudgetOperatorType	O operador a ser usado para comparação.
BudgetTimePeriod	A data de início e término de um orçamento.
CategoryType	A categoria do orçamento, independentemente de o orçamento controlar o custo ou o uso.
createdByType	O tipo de identidade que criou o recurso.
CultureCode	Idioma no qual o destinatário receberá a notificação
CurrentSpend	O valor atual do custo que está sendo acompanhado para um orçamento.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ForecastSpend	O custo previsto que está sendo acompanhado para um orçamento.
Notification	A notificação associada a um orçamento.
OperatorType	O operador de comparação.
systemData	Metadados relativos à criação e última modificação do recurso.
ThresholdType	O tipo de limite
TimeGrainType	O tempo coberto por um orçamento. O acompanhamento da quantidade será redefinido com base na granulação de tempo. BillingMonth, BillingQuarter e BillingAnnual só têm suporte para clientes do WD

Budget

Objeto

Um recurso de orçamento.

Nome	Tipo	Description
eTag	string	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.
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.amount	number (decimal)	O valor total do custo a ser acompanhado com o orçamento
properties.category	CategoryType	A categoria do orçamento, independentemente de o orçamento controlar o custo ou o uso.
properties.currentSpend	CurrentSpend	O valor atual do custo que está sendo acompanhado para um orçamento.
properties.filter	BudgetFilter	Pode ser usado para filtrar orçamentos por dimensões especificadas pelo usuário e/ou marcas.
properties.forecastSpend	ForecastSpend	O custo previsto que está sendo acompanhado para um orçamento.
properties.notifications	<string, Notification>	Dicionário de notificações associadas ao orçamento. O orçamento pode ter até cinco notificações.
properties.timeGrain	TimeGrainType	O tempo coberto por um orçamento. O acompanhamento da quantidade será redefinido com base na granulação de tempo. BillingMonth, BillingQuarter e BillingAnnual só têm suporte para clientes do WD
properties.timePeriod	BudgetTimePeriod	Tem a data de início e término do orçamento. A data de início deve ser a primeira do mês e deve ser menor que a data de término. 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 temporais. Não há restrições na data de término.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BudgetComparisonExpression

Objeto

A expressão de comparação a ser usada nos orçamentos.

Nome	Tipo	Description
name	string	O nome da coluna a ser usada em comparação.
operator	BudgetOperatorType	O operador a ser usado para comparação.
values	string[]	Matriz de valores a serem usados para comparação

BudgetFilter

Objeto

Pode ser usado para filtrar orçamentos por grupo de recursos, recurso ou medidor.

Nome	Tipo	Description
and	BudgetFilterProperties[]	A expressão lógica "AND". Deve ter pelo menos 2 itens.
dimensions	BudgetComparisonExpression	Tem expressão de comparação para uma dimensão
tags	BudgetComparisonExpression	Tem expressão de comparação para uma marca

BudgetFilterProperties

Objeto

As Dimensões ou Marcas para filtrar um orçamento.

Nome	Tipo	Description
dimensions	BudgetComparisonExpression	Tem expressão de comparação para uma dimensão
tags	BudgetComparisonExpression	Tem expressão de comparação para uma marca

BudgetOperatorType

Enumeração

O operador a ser usado para comparação.

Valor	Description
In

BudgetTimePeriod

Objeto

A data de início e término de um orçamento.

Nome	Tipo	Description
endDate	string (date-time)	A data de término do orçamento. Se não for fornecido, o padrão será de 10 anos a partir da data de início.
startDate	string (date-time)	A data de início do orçamento.

CategoryType

Enumeração

A categoria do orçamento, independentemente de o orçamento controlar o custo ou o uso.

Valor	Description
Cost

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

CultureCode

Enumeração

Idioma no qual o destinatário receberá a notificação

Valor	Description
en-us
ja-jp
zh-cn
de-de
es-es
fr-fr
it-it
ko-kr
pt-br
ru-ru
zh-tw
cs-cz
pl-pl
tr-tr
da-dk
en-gb
hu-hu
nb-no
nl-nl
pt-pt
sv-se

CurrentSpend

Objeto

O valor atual do custo que está sendo acompanhado para um orçamento.

Nome	Tipo	Description
amount	number (decimal)	O valor total do custo que está sendo acompanhado pelo orçamento.
unit	string	A unidade de medida para o valor do orçamento.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ForecastSpend

Objeto

O custo previsto que está sendo acompanhado para um orçamento.

Nome	Tipo	Description
amount	number (decimal)	O custo previsto para o período de tempo total que está sendo acompanhado pelo orçamento. Esse valor só será fornecido se o orçamento contiver um tipo de alerta de previsão.
unit	string	A unidade de medida para o valor do orçamento.

Notification

Objeto

A notificação associada a um orçamento.

Nome	Tipo	Valor padrão	Description
contactEmails	string[]		Endereços de email para o qual 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 de Assinatura ou Grupo de Recursos. Todos os outros escopos devem ter pelo menos um email de contato especificado.
contactGroups	string[]		Grupos de ações para enviar a notificação de orçamento para quando o limite for excedido. Deve ser fornecido como uma ID de recurso do Azure totalmente qualificada. Só há suporte em escopos de Assinatura ou Grupo de Recursos.
contactRoles	string[]		Contate as funções para enviar a notificação de orçamento para quando o limite for excedido.
enabled	boolean		A notificação está habilitada ou não.
locale	CultureCode		Idioma no qual o destinatário receberá a notificação
operator	OperatorType		O operador de comparação.
threshold	number (decimal)		Valor de limite associado a uma notificação. A notificação é enviada quando o custo excede o limite. É sempre por cento e tem que estar entre 0 e 1000.
thresholdType	ThresholdType	Actual	O tipo de limite

OperatorType

Enumeração

O operador de comparação.

Valor	Description
EqualTo	O alerta será disparado se o custo avaliado for o mesmo que o valor limite. Observação: não é recomendável usar esse OperatorType, pois há pouca chance de o custo ser exatamente o mesmo que o valor limite, levando à falta do alerta. Este OperatorType será preterido no futuro.
GreaterThan	O alerta será disparado se o custo avaliado for maior que o valor limite. Observação: este é o OperatorType recomendado ao configurar o Alerta de Orçamento.
GreaterThanOrEqualTo	O alerta será disparado se o custo avaliado for maior ou igual ao valor limite.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

ThresholdType

Enumeração

O tipo de limite

Valor	Description
Actual	Os alertas de orçamento de custos reais notificam quando o custo real acumulado excede o orçamento alocado.
Forecasted	Os alertas de orçamento de custos previstos fornecem uma notificação avançada de que suas tendências de gastos provavelmente excederão seu orçamento alocado, pois depende de previsões de custos previstas.

TimeGrainType

Enumeração

O tempo coberto por um orçamento. O acompanhamento da quantidade será redefinido com base na granulação de tempo. BillingMonth, BillingQuarter e BillingAnnual só têm suporte para clientes do WD

Valor	Description
Monthly
Quarterly
Annually
BillingMonth
BillingQuarter
BillingAnnual

Compartilhar via

Budgets - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

CreateOrUpdateBudget

Solicitação de exemplo

Resposta de exemplo

Definições

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

createdByType

CultureCode

CurrentSpend

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ForecastSpend

Notification

OperatorType

systemData

ThresholdType

TimeGrainType