Budgets - Get

Referência

Service:: Consumption

API Version:: 2023-05-01

Obtém o orçamento para o âmbito por nome do orçamento.

GET https://management.azure.com/{scope}/providers/Microsoft.Consumption/budgets/{budgetName}?api-version=2023-05-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
budgetName	path	True	string	Nome do Orçamento.
scope	path	True	string	O âmbito associado às operações orçamentais. Isto inclui "/subscriptions/{subscriptionId}/" para o âmbito da subscrição, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" para o âmbito resourceGroup, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" para o âmbito da Conta de Faturação, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" para o âmbito do Departamento, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}" para o âmbito EnrollmentAccount, "/providers/Microsoft.Management/managementGroups/{managementGroupId}" para o âmbito do Grupo de Gestão, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" para o âmbito billingProfile, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" para o âmbito invoiceSection.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente. A versão atual é 2023-03-01.

Respostas

Name	Tipo	Description
200 OK	Budget	OK. O pedido foi efetuada com êxito.
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual 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

Name	Description
user_impersonation	representar a sua conta de utilizador

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

Name	Description
Budget	Um recurso orçamental.
BudgetComparisonExpression	A expressão de comparação a utilizar nos orçamentos.
BudgetFilter	Pode ser utilizado para filtrar orçamentos por grupo de recursos, recurso ou medidor.
BudgetFilterProperties	As Dimensões ou Etiquetas para filtrar um orçamento.
BudgetOperatorType	O operador a utilizar para comparação.
BudgetTimePeriod	A data de início e de fim de um orçamento.
CategoryType	A categoria do orçamento, quer o orçamento acompanhe o custo ou a utilização.
CultureCode	Idioma no qual o destinatário irá receber a notificação
CurrentSpend	O montante atual do custo que está a ser controlado para um orçamento.
ErrorDetails	Os detalhes do erro.
ErrorResponse	A resposta de erro indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro. Algumas Respostas de erro: 429 TooManyRequests – o pedido é limitado. Repita 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 após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.
ForecastSpend	O custo previsto que está a ser controlado para um orçamento.
Notification	A notificação associada a um orçamento.
OperatorType	O operador de comparação.
ThresholdType	O tipo de limiar
TimeGrainType	O tempo coberto por um orçamento. O controlo da quantidade será reposto com base no intervalo de tempo. BillingMonth, BillingQuarter e BillingAnnual só são suportados por clientes WD

Budget

Um recurso orçamental.

Name	Tipo	Description
eTag	string	eTag do recurso. Para lidar com o cenário de atualização simultânea, este campo será utilizado para determinar se o utilizador está ou não a atualizar a versão mais recente.
id	string	ID do Recurso.
name	string	Nome do recurso.
properties.amount	number	O montante total de custos a controlar com o orçamento
properties.category	CategoryType	A categoria do orçamento, quer o orçamento acompanhe o custo ou a utilização.
properties.currentSpend	CurrentSpend	O montante atual do custo que está a ser controlado para um orçamento.
properties.filter	BudgetFilter	Pode ser utilizado para filtrar orçamentos por dimensões e/ou etiquetas especificadas pelo utilizador.
properties.forecastSpend	ForecastSpend	O custo previsto que está a ser controlado 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 controlo da quantidade será reposto com base no intervalo de tempo. BillingMonth, BillingQuarter e BillingAnnual só são suportados por clientes WD
properties.timePeriod	BudgetTimePeriod	Tem a data de início e de fim do orçamento. A data de início tem de ser a primeira do mês e deve ser inferior à data de fim. A data de início do orçamento tem de ser em ou depois de 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 existem restrições na data de fim.
type	string	Tipo de recurso.

BudgetComparisonExpression

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

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

BudgetFilter

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

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

BudgetFilterProperties

As Dimensões ou Etiquetas para 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 etiqueta

BudgetOperatorType

O operador a utilizar para comparação.

Name	Tipo	Description
In	string

BudgetTimePeriod

A data de início e de fim de um orçamento.

Name	Tipo	Description
endDate	string	A data de fim do orçamento. Se não for fornecido, a predefinição é 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, quer o orçamento acompanhe o custo ou a utilização.

Name	Tipo	Description
Cost	string

CultureCode

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

Name	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

O montante atual do custo que está a ser controlado para um orçamento.

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

ErrorDetails

Os detalhes do erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro a indicar o motivo pela qual a operação falhou.

ErrorResponse

A resposta de erro indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Algumas Respostas de erro:

429 TooManyRequests – o pedido é limitado. Repita 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 após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.

Name	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

ForecastSpend

O custo previsto que está a ser controlado para um orçamento.

Name	Tipo	Description
amount	number	O custo previsto para o período de tempo total que está a ser controlado pelo orçamento. Este 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

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

Name	Tipo	Valor Predefinido	Description
contactEmails	string[]		Email endereços para enviar a notificação de orçamento para quando o limiar for excedido. Tem de ter, pelo menos, um e-mail de contacto ou grupo de contactos especificado nos âmbitos Subscrição ou Grupo de Recursos. Todos os outros âmbitos têm de ter, pelo menos, um e-mail de contacto especificado.
contactGroups	string[]		Grupos de ações para enviar a notificação de orçamento para quando o limiar for excedido. Tem de ser fornecido como um ID de recurso do Azure completamente qualificado. Suportada apenas em âmbitos de Subscrição ou Grupo de Recursos.
contactRoles	string[]		Contacte as funções para enviar a notificação de orçamento para quando o limiar for excedido.
enabled	boolean		A notificação está ativada ou não.
locale	CultureCode		Idioma no qual o destinatário irá receber a notificação
operator	OperatorType		O operador de comparação.
threshold	number		Valor de limiar associado a uma notificação. A notificação é enviada quando o custo excedeu o limiar. É sempre por cento e tem que estar entre 0 e 1000.
thresholdType	ThresholdType	Actual	O tipo de limiar

OperatorType

O operador de comparação.

Name	Tipo	Description
EqualTo	string	O alerta será acionado se o custo avaliado for igual ao valor de limiar. Nota: não é recomendado utilizar este OperatorType, uma vez que existe uma baixa probabilidade de o custo ser exatamente igual ao valor de limiar, o que leva à falta do alerta. Este OperatorType será preterido no futuro.
GreaterThan	string	O alerta será acionado se o custo avaliado for superior ao valor do limiar. Nota: este é o OperatorType recomendado ao configurar o Alerta orçamental.
GreaterThanOrEqualTo	string	O alerta será acionado se o custo avaliado for maior ou igual ao valor do limiar.

ThresholdType

O tipo de limiar

Name	Tipo	Description
Actual	string	Os alertas orçamentais de custos reais notificam quando o custo acumulado real excede o orçamento alocado.
Forecasted	string	Os alertas orçamentais de custos previstos fornecem uma notificação avançada de que é provável que as tendências de gastos excedam o orçamento alocado, uma vez que se baseia em previsões de custos previstos.

TimeGrainType

O tempo coberto por um orçamento. O controlo da quantidade será reposto com base no intervalo de tempo. BillingMonth, BillingQuarter e BillingAnnual só são suportados por clientes WD

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

Share via

Budgets - Get

Parâmetros do 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