Budgets - List

Lista todos os orçamentos para o escopo definido.

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

Parâmetros de URI

Name In Required Type Description
scope
path True
  • string

O escopo associado a operações de orçamento. Isso inclui '/subscriptions/{subscriptionId}/' para o escopo da assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} ' para o escopo do resourcegroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId} ' para o escopo da conta de cobrança, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId} ' para o 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 o escopo billingProfile, ' Providers/Microsoft. billing/billingAccounts/{billingAccountId

api-version
query True
  • string

Versão da API a ser usada com a solicitação do cliente. A versão atual é 2019-10-01.

Respostas

Name Type Description
200 OK

OK. A solicitação foi bem-sucedida.

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo de OAuth2 de Azure Active Directory.

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

BudgetsList

Sample Request

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

Sample Response

{
  "value": [
    {
      "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"
            ]
          },
          "Actual_GreaterThanOrEqualTo_90_Percent": {
            "enabled": true,
            "operator": "GreaterThanOrEqualTo",
            "threshold": 90,
            "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"
        }
      }
    },
    {
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget",
      "name": "TestBudget",
      "type": "Microsoft.Consumption/budgets",
      "eTag": "\"1d34d012214157f\"",
      "properties": {
        "category": "Cost",
        "amount": 600.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": 120.89,
          "unit": "USD"
        },
        "notifications": {
          "Actual_GreaterThan_40_Percent": {
            "enabled": true,
            "operator": "GreaterThan",
            "threshold": 40,
            "contactEmails": [
              "johndoe@contoso.com",
              "janesmith@contoso.com"
            ],
            "contactRoles": [
              "Contributor",
              "Reader"
            ]
          },
          "Actual_GreaterThanOrEqualTo_60_Percent": {
            "enabled": true,
            "operator": "GreaterThanOrEqualTo",
            "threshold": 60,
            "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

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.

BudgetsListResult

Resultado da listagem de orçamentos. Ele contém uma lista de orçamentos disponíveis no escopo fornecido.

BudgetTimePeriod

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

CategoryType

A categoria do orçamento, se o orçamento controla o custo ou o uso.

CurrentSpend

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

ErrorDetails

Os detalhes do erro.

ErrorResponse

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

Algumas respostas de erro:

  • 429 TooManyRequests-a solicitação está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-MS-ratelimit-Microsoft. consumo-Retry-After".

  • 503 ServiceUnavailable-o serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "tentar novamente após".

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 controle do valor será redefinido com base no intervalo de tempo. BillingMonth, BillingQuarter e BillingAnnual só têm suporte por clientes do WD

Budget

Um recurso de orçamento.

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

A quantidade total de custos para acompanhar o orçamento

properties.category

A categoria do orçamento, se o orçamento controla o custo ou o uso.

properties.currentSpend

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

properties.filter

Pode ser usado para filtrar orçamentos por dimensões e/ou marcas especificadas pelo usuário.

properties.notifications

Dicionário de notificações associado ao orçamento. O orçamento pode ter até cinco notificações.

properties.timeGrain

O tempo coberto por um orçamento. O controle do valor será redefinido com base no intervalo de tempo. BillingMonth, BillingQuarter e BillingAnnual só têm suporte por clientes do WD

properties.timePeriod

Tem a data de início e de 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 intervalo. 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.

Name Type Description
name
  • string

O nome da coluna a ser usada na comparação.

operator

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.

Name Type Description
and

A expressão lógica "AND". Deve ter pelo menos 2 itens.

dimensions

Tem expressão de comparação para uma dimensão

not

A expressão "NOT" lógica.

tags

Tem expressão de comparação para uma marca

BudgetFilterProperties

As dimensões ou marcas para filtrar um orçamento.

Name Type Description
dimensions

Tem expressão de comparação para uma dimensão

tags

Tem expressão de comparação para uma marca

BudgetOperatorType

O operador a ser usado para comparação.

Name Type Description
In
  • string

BudgetsListResult

Resultado da listagem de orçamentos. Ele contém uma lista de orçamentos disponíveis no escopo fornecido.

Name Type Description
nextLink
  • string

O link (URL) para a próxima página de resultados.

value

A lista de orçamentos.

BudgetTimePeriod

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

Name Type Description
endDate
  • string

A data de término do orçamento. Se não for fornecido, o padrã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, se o orçamento controla o custo ou o uso.

Name Type Description
Cost
  • string

CurrentSpend

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

Name Type Description
amount
  • number

O valor total de 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.

Name Type 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 pode processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Algumas respostas de erro:

  • 429 TooManyRequests-a solicitação está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-MS-ratelimit-Microsoft. consumo-Retry-After".

  • 503 ServiceUnavailable-o serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "tentar novamente após".

Name Type Description
error

Os detalhes do erro.

Notification

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

Name Type Description
contactEmails
  • string[]

Endereços de email 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 do grupo de recursos ou da assinatura. Todos os outros escopos devem ter pelo menos um email de contato especificado.

contactGroups
  • string[]

Grupos de ação 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. Somente com suporte em escopos de grupo de recursos ou assinatura.

contactRoles
  • string[]

Funções de contato 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.

operator

O operador de comparação.

threshold
  • number

Valor de limite associado a uma notificação. A notificação é enviada quando o custo excede o limite. É sempre percentual e deve estar entre 0 e 1000.

thresholdType

O tipo de limite

OperatorType

O operador de comparação.

Name Type Description
EqualTo
  • string
GreaterThan
  • string
GreaterThanOrEqualTo
  • string

ThresholdType

O tipo de limite

Name Type Description
Actual
  • string

TimeGrainType

O tempo coberto por um orçamento. O controle do valor será redefinido com base no intervalo de tempo. BillingMonth, BillingQuarter e BillingAnnual só têm suporte por clientes do WD

Name Type Description
Annually
  • string
BillingAnnual
  • string
BillingMonth
  • string
BillingQuarter
  • string
Monthly
  • string
Quarterly
  • string