Budgets - Get

Služba:: Consumption

Verze rozhraní API:: 2024-08-01

Získá rozpočet pro rozsah podle názvu rozpočtu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
budgetName	path	True	string	Název rozpočtu.
scope	path	True	string	Plně kvalifikovaný identifikátor Azure Resource Manageru prostředku.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	Budget	Operace Azure byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Budget

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

package armconsumption_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/consumption/armconsumption/v2"
)

// Generated from example definition: 2024-08-01/Budget.json
func ExampleBudgetsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armconsumption.NewClientFactory("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewBudgetsClient().Get(ctx, "subscriptions/00000000-0000-0000-0000-000000000000", "TestBudget", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armconsumption.BudgetsClientGetResponse{
	// 	Budget: &armconsumption.Budget{
	// 		Name: to.Ptr("TestBudget"),
	// 		Type: to.Ptr("Microsoft.Consumption/budgets"),
	// 		ETag: to.Ptr("\"1d34d012214157f\""),
	// 		ID: to.Ptr("subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget"),
	// 		Properties: &armconsumption.BudgetProperties{
	// 			Category: to.Ptr(armconsumption.CategoryTypeCost),
	// 			CurrentSpend: &armconsumption.CurrentSpend{
	// 				Unit: to.Ptr("USD"),
	// 			},
	// 			Filter: &armconsumption.BudgetFilter{
	// 				And: []*armconsumption.BudgetFilterProperties{
	// 					{
	// 						Dimensions: &armconsumption.BudgetComparisonExpression{
	// 							Name: to.Ptr("ResourceId"),
	// 							Operator: to.Ptr(armconsumption.BudgetOperatorTypeIn),
	// 							Values: []*string{
	// 								to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2"),
	// 								to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1"),
	// 							},
	// 						},
	// 					},
	// 					{
	// 						Tags: &armconsumption.BudgetComparisonExpression{
	// 							Name: to.Ptr("category"),
	// 							Operator: to.Ptr(armconsumption.BudgetOperatorTypeIn),
	// 							Values: []*string{
	// 								to.Ptr("Dev"),
	// 								to.Ptr("Prod"),
	// 							},
	// 						},
	// 					},
	// 					{
	// 						Tags: &armconsumption.BudgetComparisonExpression{
	// 							Name: to.Ptr("department"),
	// 							Operator: to.Ptr(armconsumption.BudgetOperatorTypeIn),
	// 							Values: []*string{
	// 								to.Ptr("engineering"),
	// 								to.Ptr("sales"),
	// 							},
	// 						},
	// 					},
	// 				},
	// 			},
	// 			Notifications: map[string]*armconsumption.Notification{
	// 				"Actual_GreaterThan_80_Percent": &armconsumption.Notification{
	// 					ContactEmails: []*string{
	// 						to.Ptr("johndoe@contoso.com"),
	// 						to.Ptr("janesmith@contoso.com"),
	// 					},
	// 					ContactGroups: []*string{
	// 						to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"),
	// 					},
	// 					ContactRoles: []*string{
	// 						to.Ptr("Contributor"),
	// 						to.Ptr("Reader"),
	// 					},
	// 					Enabled: to.Ptr(true),
	// 					Operator: to.Ptr(armconsumption.OperatorTypeGreaterThan),
	// 					ThresholdType: to.Ptr(armconsumption.ThresholdTypeActual),
	// 				},
	// 			},
	// 			TimeGrain: to.Ptr(armconsumption.TimeGrainTypeMonthly),
	// 			TimePeriod: &armconsumption.BudgetTimePeriod{
	// 				EndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-31T00:00:00Z"); return t}()),
	// 				StartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-10-01T00:00:00Z"); return t}()),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:: 200

{
  "name": "TestBudget",
  "type": "Microsoft.Consumption/budgets",
  "eTag": "\"1d34d012214157f\"",
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget",
  "properties": {
    "amount": 100.65,
    "category": "Cost",
    "currentSpend": {
      "amount": 80.89,
      "unit": "USD"
    },
    "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": {
        "contactEmails": [
          "johndoe@contoso.com",
          "janesmith@contoso.com"
        ],
        "contactGroups": [
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup"
        ],
        "contactRoles": [
          "Contributor",
          "Reader"
        ],
        "enabled": true,
        "operator": "GreaterThan",
        "threshold": 80,
        "thresholdType": "Actual"
      }
    },
    "timeGrain": "Monthly",
    "timePeriod": {
      "endDate": "2018-10-31T00:00:00Z",
      "startDate": "2017-10-01T00:00:00Z"
    }
  }
}

Definice

Name	Description
Budget	Rozpočtový zdroj.
BudgetComparisonExpression	Výraz porovnání, který se má použít v rozpočtech.
BudgetFilter	Dá se použít k filtrování rozpočtů podle skupiny prostředků, prostředku nebo měřiče.
BudgetFilterProperties	Dimenze nebo značky pro filtrování rozpočtu podle.
BudgetOperatorType	Operátor, který se má použít pro porovnání.
BudgetTimePeriod	Počáteční a koncové datum rozpočtu.
CategoryType	Kategorie rozpočtu, ať už rozpočet sleduje náklady nebo využití.
createdByType	Typ identity, která prostředek vytvořila.
CultureCode	Jazyk, ve kterém příjemce obdrží oznámení
CurrentSpend	Aktuální částka nákladů, které se sledují pro rozpočet.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ForecastSpend	Předpokládané náklady, které se sledují pro rozpočet.
Notification	Oznámení přidružené k rozpočtu.
OperatorType	Relační operátor.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
ThresholdType	Typ prahové hodnoty
TimeGrainType	Doba, na kterou se vztahuje rozpočet. Sledování množství se resetuje na základě časového intervalu. Zákazníci WD podporují jenom fakturaci, BillingQuarter a BillingAnnual.

Budget

Objekt

Rozpočtový zdroj.

Name	Typ	Description
eTag	string	eTag prostředku. Pro zpracování scénáře souběžné aktualizace se toto pole použije k určení, jestli uživatel aktualizuje nejnovější verzi, nebo ne.
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.amount	number (decimal)	Celková částka nákladů, které se mají sledovat s rozpočtem
properties.category	CategoryType	Kategorie rozpočtu, ať už rozpočet sleduje náklady nebo využití.
properties.currentSpend	CurrentSpend	Aktuální částka nákladů, které se sledují pro rozpočet.
properties.filter	BudgetFilter	Lze použít k filtrování rozpočtů podle uživatelsky zadaných dimenzí nebo značek.
properties.forecastSpend	ForecastSpend	Předpokládané náklady, které se sledují pro rozpočet.
properties.notifications	<string, Notification>	Slovník oznámení přidružených k rozpočtu Rozpočet může mít až pět oznámení.
properties.timeGrain	TimeGrainType	Doba, na kterou se vztahuje rozpočet. Sledování množství se resetuje na základě časového intervalu. Zákazníci WD podporují jenom fakturaci, BillingQuarter a BillingAnnual.
properties.timePeriod	BudgetTimePeriod	Má počáteční a koncové datum rozpočtu. Počáteční datum musí být první z měsíce a mělo by být menší než koncové datum. Datum zahájení rozpočtu musí být 1. června 2017 nebo po 1. červnu 2017. Datum zahájení budoucnosti by nemělo být delší než dvanáct měsíců. Datum zahájení by mělo být vybráno v časovém intervalu. Koncové datum neobsahuje žádná omezení.
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
type	string	Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

BudgetComparisonExpression

Objekt

Výraz porovnání, který se má použít v rozpočtech.

Name	Typ	Description
name	string	Název sloupce, který se má použít při porovnání.
operator	BudgetOperatorType	Operátor, který se má použít pro porovnání.
values	string[]	Pole hodnot, které se mají použít k porovnání

BudgetFilter

Objekt

Dá se použít k filtrování rozpočtů podle skupiny prostředků, prostředku nebo měřiče.

Name	Typ	Description
and	BudgetFilterProperties[]	Logický výraz AND. Musí obsahovat alespoň 2 položky.
dimensions	BudgetComparisonExpression	Obsahuje porovnávací výraz pro dimenzi.
tags	BudgetComparisonExpression	Obsahuje výraz porovnání pro značku.

BudgetFilterProperties

Objekt

Dimenze nebo značky pro filtrování rozpočtu podle.

Name	Typ	Description
dimensions	BudgetComparisonExpression	Obsahuje porovnávací výraz pro dimenzi.
tags	BudgetComparisonExpression	Obsahuje výraz porovnání pro značku.

BudgetOperatorType

Výčet

Operátor, který se má použít pro porovnání.

Hodnota	Description
In

BudgetTimePeriod

Objekt

Počáteční a koncové datum rozpočtu.

Name	Typ	Description
endDate	string (date-time)	Koncové datum rozpočtu. Pokud ho nezadáme, výchozí hodnota je 10 let od data zahájení.
startDate	string (date-time)	Počáteční datum rozpočtu.

CategoryType

Výčet

Kategorie rozpočtu, ať už rozpočet sleduje náklady nebo využití.

Hodnota	Description
Cost

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

CultureCode

Výčet

Jazyk, ve kterém příjemce obdrží oznámení

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

CurrentSpend

Objekt

Aktuální částka nákladů, které se sledují pro rozpočet.

Name	Typ	Description
amount	number (decimal)	Celková částka nákladů, která je sledována rozpočtem.
unit	string	Měrná jednotka pro částku rozpočtu.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ForecastSpend

Objekt

Předpokládané náklady, které se sledují pro rozpočet.

Name	Typ	Description
amount	number (decimal)	Předpokládané náklady na celkové časové období, které je sledováno rozpočtem. Tato hodnota se poskytuje pouze v případě, že rozpočet obsahuje typ výstrahy prognózy.
unit	string	Měrná jednotka pro částku rozpočtu.

Notification

Objekt

Oznámení přidružené k rozpočtu.

Name	Typ	Default value	Description
contactEmails	string[]		E-mailové adresy, na které se mají odeslat oznámení o rozpočtu při překročení prahové hodnoty. Musí mít alespoň jeden kontaktní e-mail nebo skupinu kontaktů zadanou v rozsahech předplatného nebo skupiny prostředků. Všechny ostatní obory musí mít zadaný alespoň jeden kontaktní e-mail.
contactGroups	string[]		Skupiny akcí, do které se mají odeslat oznámení o rozpočtu při překročení prahové hodnoty Musí se zadat jako plně kvalifikované ID prostředku Azure. Podporováno pouze v oborech předplatného nebo skupiny prostředků.
contactRoles	string[]		Kontaktní role pro odeslání oznámení o rozpočtu při překročení prahové hodnoty.
enabled	boolean		Oznámení je povolené nebo není.
locale	CultureCode		Jazyk, ve kterém příjemce obdrží oznámení
operator	OperatorType		Relační operátor.
threshold	number (decimal)		Prahová hodnota přidružená k oznámení Oznámení se odešle, když náklady překročí prahovou hodnotu. Vždy je to procento a musí být mezi 0 a 1 000.
thresholdType	ThresholdType	Actual	Typ prahové hodnoty

OperatorType

Výčet

Relační operátor.

Hodnota	Description
EqualTo	Výstraha se aktivuje, pokud jsou vyhodnocené náklady stejné jako prahová hodnota. Poznámka: Nedoporučujeme používat tento typ operátoru, protože existuje nízká pravděpodobnost, že náklady budou přesně stejné jako prahová hodnota, což vede k chybějícímu upozornění. Tento typ operátoru bude v budoucnu zastaralý.
GreaterThan	Výstraha se aktivuje, pokud jsou vyhodnocené náklady větší než prahová hodnota. Poznámka: Toto je doporučený typ operátoru při konfiguraci upozornění rozpočtu.
GreaterThanOrEqualTo	Výstraha se aktivuje, pokud je vyhodnocená cena větší nebo rovna prahové hodnotě.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

ThresholdType

Výčet

Typ prahové hodnoty

Hodnota	Description
Actual	Upozornění na rozpočet skutečných nákladů upozorňují, když skutečné nabíhající náklady překročí přidělený rozpočet .
Forecasted	Upozornění rozpočtu prognózovaných nákladů poskytují upřesňující oznámení, že trendy útraty pravděpodobně překročí přidělený rozpočet, protože závisí na prognózovaných předpovědích nákladů.

TimeGrainType

Výčet

Doba, na kterou se vztahuje rozpočet. Sledování množství se resetuje na základě časového intervalu. Zákazníci WD podporují jenom fakturaci, BillingQuarter a BillingAnnual.

Hodnota	Description
Monthly
Quarterly
Annually
BillingMonth
BillingQuarter
BillingAnnual