Budgets - Get

Riferimento

Service:: Consumption

API Version:: 2023-05-01

Ottiene il budget per l'ambito in base al nome del budget.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
budgetName	path	True	string	Nome budget.
scope	path	True	string	Ambito associato alle operazioni di budget. Sono inclusi '/subscriptions/{subscriptionId}/' per l'ambito della sottoscrizione, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' per ambito resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' per ambito account di fatturazione, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' per ambito reparto, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' per ambito EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' per ambito del gruppo di gestione, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' per billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' per l'ambito invoiceSection.
api-version	query	True	string	Versione dell'API da usare con la richiesta client. La versione corrente è 2023-03-01.

Risposte

Nome	Tipo	Descrizione
200 OK	Budget	OK. La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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"
      }
    }
  }
}

Definizioni

Nome	Descrizione
Budget	Una risorsa di budget.
BudgetComparisonExpression	Espressione di confronto da utilizzare nei budget.
BudgetFilter	Può essere usato per filtrare i budget in base a gruppo di risorse, risorsa o contatore.
BudgetFilterProperties	Dimensioni o tag per filtrare un budget.
BudgetOperatorType	Operatore da utilizzare per il confronto.
BudgetTimePeriod	Data di inizio e fine per un budget.
CategoryType	Categoria del budget, indipendentemente dal fatto che il budget tenga traccia dei costi o dell'utilizzo.
CultureCode	Lingua in cui il destinatario riceverà la notifica
CurrentSpend	Importo corrente del costo che viene monitorato per un budget.
ErrorDetails	Dettagli dell'errore.
ErrorResponse	La risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore. Alcune risposte di errore: 429 TooManyRequests - La richiesta è limitata. Riprovare dopo l'attesa del tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver atteso il tempo specificato nell'intestazione "Retry-After".
ForecastSpend	Costo previsto che viene monitorato per un budget.
Notification	Notifica associata a un budget.
OperatorType	Operatore di confronto.
ThresholdType	Tipo di soglia
TimeGrainType	Tempo coperto da un budget. Il rilevamento dell'importo verrà reimpostato in base all'intervallo di tempo. BillingMonth, BillingQuarter e BillingAnnual sono supportati solo dai clienti WD

Budget

Una risorsa di budget.

Nome	Tipo	Descrizione
eTag	string	eTag della risorsa. Per gestire lo scenario di aggiornamento simultaneo, questo campo verrà usato per determinare se l'utente sta aggiornando o meno la versione più recente.
id	string	ID risorsa.
name	string	Nome risorsa.
properties.amount	number	Importo totale dei costi da tenere traccia del budget
properties.category	CategoryType	Categoria del budget, indipendentemente dal fatto che il budget tenga traccia dei costi o dell'utilizzo.
properties.currentSpend	CurrentSpend	Importo corrente del costo che viene monitorato per un budget.
properties.filter	BudgetFilter	Può essere usato per filtrare i budget in base alle dimensioni e/o ai tag specificati dall'utente.
properties.forecastSpend	ForecastSpend	Costo previsto che viene monitorato per un budget.
properties.notifications	<string, Notification>	Dizionario delle notifiche associate al budget. Il budget può avere fino a cinque notifiche.
properties.timeGrain	TimeGrainType	Tempo coperto da un budget. Il rilevamento dell'importo verrà reimpostato in base all'intervallo di tempo. BillingMonth, BillingQuarter e BillingAnnual sono supportati solo dai clienti WD
properties.timePeriod	BudgetTimePeriod	Data di inizio e fine del budget. La data di inizio deve essere la prima del mese e deve essere minore della data di fine. La data di inizio del budget deve essere il 1° giugno 2017. La data di inizio futura non deve essere superiore a dodici mesi. La data di inizio precedente deve essere selezionata entro il periodo di tempo. Non sono previste restrizioni per la data di fine.
type	string	Tipo di risorsa.

BudgetComparisonExpression

Espressione di confronto da utilizzare nei budget.

Nome	Tipo	Descrizione
name	string	Nome della colonna da utilizzare in confronto.
operator	BudgetOperatorType	Operatore da utilizzare per il confronto.
values	string[]	Matrice di valori da usare per il confronto

BudgetFilter

Può essere usato per filtrare i budget in base a gruppo di risorse, risorsa o contatore.

Nome	Tipo	Descrizione
and	BudgetFilterProperties[]	Espressione logica "AND". Deve contenere almeno 2 elementi.
dimensions	BudgetComparisonExpression	Espressione di confronto per una dimensione
tags	BudgetComparisonExpression	Espressione di confronto per un tag

BudgetFilterProperties

Dimensioni o tag per filtrare un budget.

Nome	Tipo	Descrizione
dimensions	BudgetComparisonExpression	Espressione di confronto per una dimensione
tags	BudgetComparisonExpression	Espressione di confronto per un tag

BudgetOperatorType

Operatore da utilizzare per il confronto.

Nome	Tipo	Descrizione
In	string

BudgetTimePeriod

Data di inizio e fine per un budget.

Nome	Tipo	Descrizione
endDate	string	Data di fine del budget. Se non specificato, per impostazione predefinita questo valore è 10 anni dalla data di inizio.
startDate	string	Data di inizio del budget.

CategoryType

Categoria del budget, indipendentemente dal fatto che il budget tenga traccia dei costi o dell'utilizzo.

Nome	Tipo	Descrizione
Cost	string

CultureCode

Lingua in cui il destinatario riceverà la notifica

Nome	Tipo	Descrizione
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

Importo corrente del costo che viene monitorato per un budget.

Nome	Tipo	Descrizione
amount	number	Importo totale del costo monitorato dal budget.
unit	string	Unità di misura per l'importo del budget.

ErrorDetails

Dettagli dell'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

ErrorResponse

La risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Alcune risposte di errore:

429 TooManyRequests - La richiesta è limitata. Riprovare dopo l'attesa del tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver atteso il tempo specificato nell'intestazione "Retry-After".

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore.

ForecastSpend

Costo previsto che viene monitorato per un budget.

Nome	Tipo	Descrizione
amount	number	Costo previsto per il periodo di tempo totale monitorato dal budget. Questo valore viene fornito solo se il budget contiene un tipo di avviso di previsione.
unit	string	Unità di misura per l'importo del budget.

Notification

Notifica associata a un budget.

Nome	Tipo	Valore predefinito	Descrizione
contactEmails	string[]		Email indirizzi a cui inviare la notifica di budget quando viene superata la soglia. Deve avere almeno un indirizzo di posta elettronica di contatto o un gruppo di contatti specificato negli ambiti sottoscrizione o gruppo di risorse. Tutti gli altri ambiti devono avere almeno un messaggio di posta elettronica di contatto specificato.
contactGroups	string[]		Gruppi di azioni a cui inviare la notifica di budget quando viene superata la soglia. Deve essere fornito come ID risorsa di Azure completo. Supportato solo per gli ambiti sottoscrizione o gruppo di risorse.
contactRoles	string[]		Contattare i ruoli per inviare la notifica di budget a quando viene superata la soglia.
enabled	boolean		La notifica è abilitata o meno.
locale	CultureCode		Lingua in cui il destinatario riceverà la notifica
operator	OperatorType		Operatore di confronto.
threshold	number		Valore soglia associato a una notifica. La notifica viene inviata quando il costo supera la soglia. È sempre la percentuale e deve essere compresa tra 0 e 1000.
thresholdType	ThresholdType	Actual	Tipo di soglia

OperatorType

Operatore di confronto.

Nome	Tipo	Descrizione
EqualTo	string	L'avviso verrà attivato se il costo valutato corrisponde al valore soglia. Nota: non è consigliabile usare questo OperatorType perché è possibile che il costo sia esattamente lo stesso del valore soglia, causando la mancanza dell'avviso. Questo OperatorType verrà deprecato in futuro.
GreaterThan	string	L'avviso verrà attivato se il costo valutato è maggiore del valore soglia. Nota: Questo è il valore OperatorType consigliato durante la configurazione dell'avviso budget.
GreaterThanOrEqualTo	string	L'avviso verrà attivato se il costo valutato è maggiore o uguale al valore soglia.

ThresholdType

Tipo di soglia

Nome	Tipo	Descrizione
Actual	string	Gli avvisi relativi al budget dei costi effettivi notificano quando il costo effettivo accumulato supera il budget allocato.
Forecasted	string	Gli avvisi relativi al budget dei costi previsti forniscono notifiche avanzate che le tendenze di spesa superano il budget allocato, perché si basa sulle stime dei costi previste.

TimeGrainType

Tempo coperto da un budget. Il rilevamento dell'importo verrà reimpostato in base all'intervallo di tempo. BillingMonth, BillingQuarter e BillingAnnual sono supportati solo dai clienti WD

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

Budgets - Get

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Scopes

Esempio

Budget

Sample Request

Sample Response

Definizioni

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

Risorse aggiuntive