Budgets - Create Or Update

Riferimento

Servizio:: Consumption

Versione API:: 2024-08-01

Operazione per creare o aggiornare un budget. Facoltativamente, è possibile specificare un eTag se necessario come forma di controllo della concorrenza. Per ottenere l'eTag più recente per un determinato budget, eseguire un'operazione get prima dell'operazione put.

PUT https://management.azure.com/{scope}/providers/Microsoft.Consumption/budgets/{budgetName}?api-version=2024-08-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 gruppo di gestione, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' per ambito billingProfile, '/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.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.amount	True	number (decimal)	Importo totale dei costi da tenere traccia del budget
properties.category	True	CategoryType	Categoria del budget, indipendentemente dal fatto che il budget tenga traccia dei costi o dell'utilizzo.
properties.timeGrain	True	TimeGrainType	Tempo coperto da un budget. Il rilevamento della quantità verrà reimpostato in base all'intervallo di tempo. BillingMonth, BillingQuarter e BillingAnnual sono supportati solo dai clienti WD
properties.timePeriod	True	BudgetTimePeriod	Data di inizio e fine del budget. La data di inizio deve essere prima del mese e deve essere minore della data di fine. La data di inizio del budget deve essere attiva o successiva al 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.
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.
properties.filter		BudgetFilter	Può essere usato per filtrare i budget in base alle dimensioni e/o ai tag specificati dall'utente.
properties.notifications		<string, Notification>	Dizionario delle notifiche associate al budget. Il budget può avere fino a cinque notifiche.

Risposte

Nome	Tipo	Descrizione
200 OK	Budget	OK. La richiesta ha avuto esito positivo.
201 Created	Budget	Creato.
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.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

CreateOrUpdateBudget

Esempio di richiesta

HTTP

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

{
  "eTag": "\"1d34d016a593709\"",
  "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"
            ]
          }
        }
      ]
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "enabled": true,
        "operator": "GreaterThan",
        "threshold": 80,
        "locale": "en-us",
        "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"
      }
    }
  }
}

Risposta di esempio

Codice di stato:: 201

{
  "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,
        "locale": "en-us",
        "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"
      }
    }
  }
}

Codice di stato:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/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,
        "locale": "en-us",
        "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 in base a .
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 aver aspettato il tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "Retry-After". Timeout del gateway 504 - Timeout del servizio durante l'elaborazione della richiesta. Ridurre l'intervallo di date nella richiesta, se possibile.
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 della quantità verrà reimpostato in base all'intervallo di tempo. BillingMonth, BillingQuarter e BillingAnnual sono supportati solo dai clienti WD

Budget

Object

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 (decimal)	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 della quantità 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 prima del mese e deve essere minore della data di fine. La data di inizio del budget deve essere attiva o successiva al 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

Object

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

Object

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	Ha un'espressione di confronto per un tag

BudgetFilterProperties

Object

Dimensioni o tag per filtrare un budget in base a .

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

BudgetOperatorType

Enumerazione

Operatore da utilizzare per il confronto.

Valore	Descrizione
In

BudgetTimePeriod

Object

Data di inizio e fine per un budget.

Nome	Tipo	Descrizione
endDate	string (date-time)	Data di fine del budget. Se non specificato, per impostazione predefinita viene impostato su 10 anni dalla data di inizio.
startDate	string (date-time)	Data di inizio del budget.

CategoryType

Enumerazione

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

Valore	Descrizione
Cost

CultureCode

Enumerazione

Lingua in cui il destinatario riceverà la notifica

Valore	Descrizione
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

Object

Importo corrente del costo che viene monitorato per un budget.

Nome	Tipo	Descrizione
amount	number (decimal)	Importo totale dei costi monitorati dal budget.
unit	string	Unità di misura per l'importo del budget.

ErrorDetails

Object

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

Object

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 aver aspettato il tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "Retry-After".
Timeout del gateway 504 - Timeout del servizio durante l'elaborazione della richiesta. Ridurre l'intervallo di date nella richiesta, se possibile.

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore.

ForecastSpend

Object

Costo previsto che viene monitorato per un budget.

Nome	Tipo	Descrizione
amount	number (decimal)	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

Object

Notifica associata a un budget.

Nome	Tipo	Valore predefinito	Descrizione
contactEmails	string[]		Indirizzi di posta elettronica a cui inviare la notifica del 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 del budget quando viene superata la soglia. Deve essere fornito come ID risorsa di Azure completo. Supportato solo in ambiti sottoscrizione o gruppo di risorse.
contactRoles	string[]		Contattare i ruoli per inviare la notifica del 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 (decimal)		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

Enumerazione

Operatore di confronto.

Valore	Descrizione
EqualTo	L'avviso verrà attivato se il costo valutato corrisponde al valore soglia. Nota: non è consigliabile usare questo OperatorType perché esiste una bassa probabilità di costi esattamente uguale al valore soglia, causando la mancanza dell'avviso. Questo OperatorType verrà deprecato in futuro.
GreaterThan	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	L'avviso verrà attivato se il costo valutato è maggiore o uguale al valore soglia.

ThresholdType

Enumerazione

Tipo di soglia

Valore	Descrizione
Actual	Gli avvisi effettivi relativi al budget dei costi notificano quando il costo effettivo accumulato supera il budget allocato.
Forecasted	Gli avvisi relativi al budget dei costi previsti forniscono notifiche avanzate che è probabile che le tendenze di spesa superino il budget allocato, in quanto si basa su stime dei costi previste.

TimeGrainType

Enumerazione

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

Valore	Descrizione
Annually
BillingAnnual
BillingMonth
BillingQuarter
Monthly
Quarterly

Condividi tramite

Budgets - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

CreateOrUpdateBudget

Esempio di richiesta

Risposta di esempio

Definizioni

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

Risorse aggiuntive