Budgets - Get

Referência

Serviço:: Consumption

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

Obtém o orçamento do escopo pelo nome do orçamento.

GET 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 escopo associado às operações de orçamento. Isso inclui '/subscriptions/{subscriptionId}/' para escopo de assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para escopo resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para escopo da Conta de Cobrança, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para escopo do Departamento, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para escopo EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' para escopo do Grupo de Gerenciamento, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo billingProfile, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' para o escopo invoiceSection.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente. A versão atual é 2023-03-01.

Respostas

Nome	Tipo	Description
200 OK	Budget	OKEY. A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

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

Budget

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget",
  "name": "TestBudget",
  "type": "Microsoft.Consumption/budgets",
  "eTag": "\"1d34d012214157f\"",
  "properties": {
    "category": "Cost",
    "amount": 100.65,
    "timeGrain": "Monthly",
    "timePeriod": {
      "startDate": "2017-10-01T00:00:00Z",
      "endDate": "2018-10-31T00:00:00Z"
    },
    "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"
            ]
          }
        }
      ]
    },
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "enabled": true,
        "operator": "GreaterThan",
        "threshold": 80,
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "thresholdType": "Actual"
      }
    }
  }
}

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.
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.
ErrorDetails	Os detalhes do erro.
ErrorResponse	A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro. Algumas respostas de erro: 429 TooManyRequests – A solicitação é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable – O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After". Tempo limite do Gateway 504 – Tempo limite de serviço atingido durante o processamento da solicitação. Reduza o intervalo de datas na solicitação, se possível.
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.
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 do recurso.
name	string	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.
type	string	Tipo de recurso.

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

CultureCode

Enumeração

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

Valor	Description
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

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.

ErrorDetails

Objeto

Os detalhes do erro.

Nome	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

ErrorResponse

Objeto

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Algumas respostas de erro:

429 TooManyRequests – A solicitação é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable – O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".
Tempo limite do Gateway 504 – Tempo limite de serviço atingido durante o processamento da solicitação. Reduza o intervalo de datas na solicitação, se possível.

Nome	Tipo	Description
error	ErrorDetails	Os detalhes do 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.

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
Annually
BillingAnnual
BillingMonth
BillingQuarter
Monthly
Quarterly

Compartilhar via

Budgets - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Budget

Solicitação de exemplo

Resposta de exemplo

Definições

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

Recursos adicionais