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 o eTag mais recente para um determinado orçamento, execute uma operação get antes da operação put.

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

Parâmetros do URI

Name	Em	Necessá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 utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.amount	True	number (decimal)	O valor total do custo a acompanhar com o orçamento
properties.category	True	CategoryType	A categoria do orçamento, se o orçamento controla o custo ou o uso.
properties.timeGrain	True	TimeGrainType	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
properties.timePeriod	True	BudgetTimePeriod	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.
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 e/ou tags especificadas pelo usuário.
properties.notifications		<string, Notification>	Dicionário de notificações associadas ao orçamento. O orçamento pode ter até cinco notificações.

Respostas

Name	Tipo	Description
200 OK	Budget	Operação de atualização do 'Orçamento' de recursos bem-sucedida
201 Created	Budget	Recurso 'Orçamento' criar operação bem-sucedida
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

CreateOrUpdateBudget

Pedido de amostra

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 da amostra

Código de estado:: 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 estado:: 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

Name	Description
Budget	Um recurso orçamental.
BudgetComparisonExpression	A expressão de comparação a utilizar nos orçamentos.
BudgetFilter	Pode ser usado para filtrar orçamentos por grupo de recursos, recurso ou medidor.
BudgetFilterProperties	As Dimensões ou Tags pelas quais filtrar um orçamento.
BudgetOperatorType	O operador a utilizar para comparação.
BudgetTimePeriod	As datas de início e fim de um orçamento.
CategoryType	A categoria do orçamento, se o orçamento controla o custo ou o uso.
createdByType	O tipo de identidade que criou o recurso.
CultureCode	Língua em que o destinatário receberá a notificação
CurrentSpend	O valor atual do custo que está sendo rastreado para um orçamento.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ForecastSpend	O custo previsto que está sendo rastreado para um orçamento.
Notification	A notificação associada a um orçamento.
OperatorType	O operador de comparação.
systemData	Metadados referentes à criação e última modificação do recurso.
ThresholdType	O tipo de limiar
TimeGrainType	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

Budget

Object

Um recurso orçamental.

Name	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 qualificado 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 acompanhar com o orçamento
properties.category	CategoryType	A categoria do orçamento, se o orçamento controla o custo ou o uso.
properties.currentSpend	CurrentSpend	O valor atual do custo que está sendo rastreado para um orçamento.
properties.filter	BudgetFilter	Pode ser usado para filtrar orçamentos por dimensões e/ou tags especificadas pelo usuário.
properties.forecastSpend	ForecastSpend	O custo previsto que está sendo rastreado 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 rastreamento do valor será redefinido com base no grão de tempo. BillingMonth, BillingQuarter e BillingAnnual são suportados apenas por clientes WD
properties.timePeriod	BudgetTimePeriod	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.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BudgetComparisonExpression

Object

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

Name	Tipo	Description
name	string	O nome da coluna a ser usada na comparação.
operator	BudgetOperatorType	O operador a utilizar para comparação.
values	string[]	Matriz de valores a ser usada para comparação

BudgetFilter

Object

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

Name	Tipo	Description
and	BudgetFilterProperties[]	A expressão lógica "E". 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 tag

BudgetFilterProperties

Object

As Dimensões ou Tags pelas quais filtrar um orçamento.

Name	Tipo	Description
dimensions	BudgetComparisonExpression	Tem expressão de comparação para uma dimensão
tags	BudgetComparisonExpression	Tem expressão de comparação para uma tag

BudgetOperatorType

Enumeração

O operador a utilizar para comparação.

Valor	Description
In

BudgetTimePeriod

Object

As datas de início e fim de um orçamento.

Name	Tipo	Description
endDate	string (date-time)	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.
startDate	string (date-time)	A data de início do orçamento.

CategoryType

Enumeração

A categoria do orçamento, se o orçamento controla 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

Língua em que 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

Object

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

Name	Tipo	Description
amount	number (decimal)	O montante total do custo que está a ser controlado pelo orçamento.
unit	string	A unidade de medida para o montante do orçamento.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ForecastSpend

Object

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

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

Notification

Object

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

Name	Tipo	Default value	Description
contactEmails	string[]		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.
contactGroups	string[]		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.
contactRoles	string[]		Funções de contato para enviar a notificação de orçamento quando o limite for excedido.
enabled	boolean		A notificação está habilitada ou não.
locale	CultureCode		Língua em que o destinatário receberá a notificação
operator	OperatorType		O operador de comparação.
threshold	number (decimal)		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.
thresholdType	ThresholdType	Actual	O tipo de limiar

OperatorType

Enumeração

O operador de comparação.

Valor	Description
EqualTo	O alerta será acionado se o custo avaliado for igual ao valor limite. Nota: Não é recomendado usar este OperatorType, pois há baixa chance de o custo ser exatamente o mesmo que o valor limite, levando à falta do seu alerta. Este OperatorType será preterido no futuro.
GreaterThan	O alerta será acionado se o custo avaliado for maior que o valor limite. Nota: Este é o OperatorType recomendado durante a configuração do Budget Alert.
GreaterThanOrEqualTo	O alerta será acionado se o custo avaliado for maior ou igual ao valor limite.

systemData

Object

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

Name	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 limiar

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 o orçamento alocado, pois dependem de previsões de custos previstos.

TimeGrainType

Enumeração

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

Valor	Description
Monthly
Quarterly
Annually
BillingMonth
BillingQuarter
BillingAnnual

Partilhar via

Budgets - Create Or Update

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

CreateOrUpdateBudget

Pedido de amostra

Resposta da amostra

Definições

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

createdByType

CultureCode

CurrentSpend

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ForecastSpend

Notification

OperatorType

systemData

ThresholdType

TimeGrainType