Budgets - Get

Referens

Service:: Consumption

API Version:: 2023-05-01

Hämtar budgeten för omfånget efter budgetnamn.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
budgetName	path	True	string	Budgetnamn.
scope	path	True	string	Omfånget som är associerat med budgetåtgärder. Detta inkluderar "/subscriptions/{subscriptionId}/" för prenumerationsomfånget "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" för resourceGroup-omfånget, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" för faktureringskontoomfånget "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" för avdelningens omfång, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} för EnrollmentAccount-omfång, "/providers/Microsoft.Management/managementGroups/{managementGroupId}" för hanteringsgruppens omfång, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" för billingProfile-omfång, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" för invoiceSection-omfånget.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2023-03-01.

Svar

Name	Typ	Description
200 OK	Budget	OK. Begäran har slutförts.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
Budget	En budgetresurs.
BudgetComparisonExpression	Jämförelseuttrycket som ska användas i budgetarna.
BudgetFilter	Kan användas för att filtrera budgetar efter resursgrupp, resurs eller mätare.
BudgetFilterProperties	De dimensioner eller taggar som en budget ska filtreras efter.
BudgetOperatorType	Operatorn som ska användas för jämförelse.
BudgetTimePeriod	Start- och slutdatum för en budget.
CategoryType	Kategorin för budgeten, oavsett om budgeten spårar kostnad eller användning.
CultureCode	Språk där mottagaren får meddelandet
CurrentSpend	Det aktuella kostnadsbeloppet som spåras för en budget.
ErrorDetails	Information om felet.
ErrorResponse	Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet. Några felsvar: 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken ”Retry-After” och försök igen.
ForecastSpend	Den prognostiserade kostnaden som spåras för en budget.
Notification	Meddelandet som är kopplat till en budget.
OperatorType	Jämförelseoperatorn.
ThresholdType	Typ av tröskelvärde
TimeGrainType	Den tid som täcks av en budget. Spårning av mängden återställs baserat på tidsintervallet. BillingMonth, BillingQuarter och Billing Annual stöds endast av WD-kunder

Budget

En budgetresurs.

Name	Typ	Description
eTag	string	eTag för resursen. För att hantera samtidiga uppdateringsscenarion används det här fältet för att avgöra om användaren uppdaterar den senaste versionen eller inte.
id	string	Resurs-ID.
name	string	Resursnamn.
properties.amount	number	Den totala kostnaden som ska spåras med budgeten
properties.category	CategoryType	Kategorin för budgeten, oavsett om budgeten spårar kostnad eller användning.
properties.currentSpend	CurrentSpend	Det aktuella kostnadsbeloppet som spåras för en budget.
properties.filter	BudgetFilter	Kan användas för att filtrera budgetar efter användardefinierade dimensioner och/eller taggar.
properties.forecastSpend	ForecastSpend	Den prognostiserade kostnaden som spåras för en budget.
properties.notifications	<string, Notification>	Ordlista med meddelanden som är associerade med budgeten. Budget kan ha upp till fem meddelanden.
properties.timeGrain	TimeGrainType	Den tid som täcks av en budget. Spårning av mängden återställs baserat på tidsintervallet. BillingMonth, BillingQuarter och Billing Annual stöds endast av WD-kunder
properties.timePeriod	BudgetTimePeriod	Har start- och slutdatum för budgeten. Startdatumet måste vara det första i månaden och bör vara mindre än slutdatumet. Budgetstartdatumet måste vara den 1 juni 2017 eller senare. Det framtida startdatumet får inte vara längre än tolv månader. Tidigare startdatum bör väljas inom tidsintervallet. Det finns inga begränsningar för slutdatumet.
type	string	Resurstyp.

BudgetComparisonExpression

Jämförelseuttrycket som ska användas i budgetarna.

Name	Typ	Description
name	string	Namnet på kolumnen som ska användas vid jämförelse.
operator	BudgetOperatorType	Operatorn som ska användas för jämförelse.
values	string[]	Matris med värden som ska användas för jämförelse

BudgetFilter

Kan användas för att filtrera budgetar efter resursgrupp, resurs eller mätare.

Name	Typ	Description
and	BudgetFilterProperties[]	Det logiska "AND"-uttrycket. Måste ha minst 2 objekt.
dimensions	BudgetComparisonExpression	Har jämförelseuttryck för en dimension
tags	BudgetComparisonExpression	Har jämförelseuttryck för en tagg

BudgetFilterProperties

De dimensioner eller taggar som en budget ska filtreras efter.

Name	Typ	Description
dimensions	BudgetComparisonExpression	Har jämförelseuttryck för en dimension
tags	BudgetComparisonExpression	Har jämförelseuttryck för en tagg

BudgetOperatorType

Operatorn som ska användas för jämförelse.

Name	Typ	Description
In	string

BudgetTimePeriod

Start- och slutdatum för en budget.

Name	Typ	Description
endDate	string	Slutdatum för budgeten. Om detta inte anges är standardinställningen 10 år från startdatumet.
startDate	string	Startdatum för budgeten.

CategoryType

Kategorin för budgeten, oavsett om budgeten spårar kostnad eller användning.

Name	Typ	Description
Cost	string

CultureCode

Språk där mottagaren får meddelandet

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

Det aktuella kostnadsbeloppet som spåras för en budget.

Name	Typ	Description
amount	number	Det totala kostnadsbeloppet som spåras av budgeten.
unit	string	Måttenheten för budgetbeloppet.

ErrorDetails

Information om felet.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken ”Retry-After” och försök igen.

Name	Typ	Description
error	ErrorDetails	Information om felet.

ForecastSpend

Den prognostiserade kostnaden som spåras för en budget.

Name	Typ	Description
amount	number	Den prognostiserade kostnaden för den totala tidsperioden som spåras av budgeten. Det här värdet anges endast om budgeten innehåller en prognosaviseringstyp.
unit	string	Måttenheten för budgetbeloppet.

Notification

Meddelandet som är kopplat till en budget.

Name	Typ	Standardvärde	Description
contactEmails	string[]		Email adresser som budgetmeddelandet ska skickas till när tröskelvärdet överskrids. Minst en kontakt-e-post eller kontaktgrupp måste anges i omfånget Prenumeration eller Resursgrupp. Minst ett e-postmeddelande till kontakten måste anges för alla andra omfång.
contactGroups	string[]		Åtgärdsgrupper som budgetmeddelandet ska skickas till när tröskelvärdet överskrids. Måste anges som ett fullständigt kvalificerat Azure-resurs-ID. Stöds endast i prenumerations- eller resursgruppsomfång.
contactRoles	string[]		Kontakta roller för att skicka budgetmeddelandet till när tröskelvärdet överskrids.
enabled	boolean		Meddelandet är aktiverat eller inte.
locale	CultureCode		Språk där mottagaren får meddelandet
operator	OperatorType		Jämförelseoperatorn.
threshold	number		Tröskelvärde som är associerat med ett meddelande. Ett meddelande skickas när kostnaden överskred tröskelvärdet. Den är alltid procent och måste vara mellan 0 och 1 000.
thresholdType	ThresholdType	Actual	Typ av tröskelvärde

OperatorType

Jämförelseoperatorn.

Name	Typ	Description
EqualTo	string	Aviseringen utlöses om den utvärderade kostnaden är samma som tröskelvärdet. Obs! Vi rekommenderar inte att du använder den här OperatorType eftersom det är låg risk att kostnaden blir exakt samma som tröskelvärdet, vilket leder till att aviseringen saknas. Den här OperatorType kommer att bli inaktuell i framtiden.
GreaterThan	string	Aviseringen utlöses om den utvärderade kostnaden är större än tröskelvärdet. Obs! Detta är den rekommenderade OperatorType när du konfigurerar budgetavisering.
GreaterThanOrEqualTo	string	Aviseringen utlöses om den utvärderade kostnaden är större än eller lika med tröskelvärdet.

ThresholdType

Typ av tröskelvärde

Name	Typ	Description
Actual	string	Budgetaviseringar för faktiska kostnader meddelar när den faktiska ackumulerade kostnaden överskrider den allokerade budgeten.
Forecasted	string	Budgetaviseringar för prognostiserade kostnader ger ett avancerat meddelande om att dina utgiftstrender sannolikt kommer att överskrida din allokerade budget, eftersom den förlitar sig på prognostiserade kostnadsförutsägelser.

TimeGrainType

Den tid som täcks av en budget. Spårning av mängden återställs baserat på tidsintervallet. BillingMonth, BillingQuarter och Billing Annual stöds endast av WD-kunder

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

Dela via

Budgets - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Scopes

Exempel

Budget

Sample Request

Sample Response

Definitioner

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

Ytterligare resurser