Budgets - Get

Referência

Service:: Consumption

API Version:: 2023-05-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=2023-05-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 o escopo resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o 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 o escopo EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' para o escopo do Grupo de Gerenciamento, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para billingProfile scope, '/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	OK. 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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Budget

Sample Request

HTTP

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

Sample Response

Status code:: 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 pelas quais 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 rastrear o custo ou o uso.
CultureCode	Idioma no qual o destinatário receberá a notificação
CurrentSpend	A quantidade atual de custo que está sendo controlada 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. Repita depois de aguardar o tempo especificado no cabeçalho "Retry-After".
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
ThresholdType	O tipo de limite
TimeGrainType	O tempo coberto por um orçamento. O acompanhamento da quantidade será redefinido com base na granularidade de tempo. BillingMonth, BillingQuarter e BillingAnnual só têm suporte de clientes do WD

Budget

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	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 rastrear o custo ou o uso.
properties.currentSpend	CurrentSpend	A quantidade atual de custo que está sendo controlada 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 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 acompanhamento da quantidade será redefinido com base na granularidade de tempo. BillingMonth, BillingQuarter e BillingAnnual só têm suporte de 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 timegrain. Não há restrições na data de término.
type	string	Tipo de recurso.

BudgetComparisonExpression

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

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

As Dimensões ou marcas pelas quais 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

O operador a ser usado para comparação.

Nome	Tipo	Description
In	string

BudgetTimePeriod

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

Nome	Tipo	Description
endDate	string	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	A data de início do orçamento.

CategoryType

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

Nome	Tipo	Description
Cost	string

CultureCode

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

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

CurrentSpend

A quantidade atual de custo que está sendo controlada para um orçamento.

Nome	Tipo	Description
amount	number	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

Os detalhes do erro.

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

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. Repita depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Nome	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

ForecastSpend

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

Nome	Tipo	Description
amount	number	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

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

Nome	Tipo	Valor padrão	Description
contactEmails	string[]		Email endereços para os quais 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 email de contato especificado.
contactGroups	string[]		Grupos de ações para os quais enviar a notificação de orçamento quando o limite for excedido. Deve ser fornecido como uma ID de recurso do Azure totalmente qualificada. Compatível apenas com escopos de Assinatura ou Grupo de Recursos.
contactRoles	string[]		Entre em contato com funções para as quais enviar a notificação de orçamento 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		Valor 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

O operador de comparação

Nome	Tipo	Description
EqualTo	string	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	string	O alerta será disparado se o custo avaliado for maior que o valor limite. Observação: esse é o OperatorType recomendado ao configurar o Alerta de Orçamento.
GreaterThanOrEqualTo	string	O alerta será disparado se o custo avaliado for maior ou igual ao valor limite.

ThresholdType

O tipo de limite

Nome	Tipo	Description
Actual	string	Os alertas de orçamento de custos reais notificam quando o custo real acumulado excede o orçamento alocado.
Forecasted	string	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 custo previstas.

TimeGrainType

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

Nome	Tipo	Description
Annually	string
BillingAnnual	string
BillingMonth	string
BillingQuarter	string
Monthly	string
Quarterly	string

Budgets - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

Budget

Sample Request

Sample Response

Definições

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

Recursos adicionais