Budgets - List

Referens

Tjänst:: Consumption

API-version:: 2024-08-01

Visar en lista över alla budgetar för det definierade omfånget.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
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ång, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" för avdelningsomfång, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} för EnrollmentAccount-omfång, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' för hanteringsgruppsomfång, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" för billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' för invoiceSection-omfång.
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	BudgetsListResult	OKEJ. 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.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

BudgetsList

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

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

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.
BudgetsListResult	Resultat av att lista budgetar. Den innehåller en lista över tillgängliga budgetar i det angivna omfånget.
BudgetTimePeriod	Start- och slutdatum för en budget.
CategoryType	Kategorin för budgeten, oavsett om budgeten spårar kostnader 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. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen". 504 Gateway Timeout – Tidsgränsen för tjänsten uppnåddes när begäran bearbetades. Minska datumintervallet i begäran, om möjligt.
ForecastSpend	Den prognostiserade kostnad som spåras för en budget.
Notification	Meddelandet som är associerat med en budget.
OperatorType	Jämförelseoperatorn.
ThresholdType	Typ av tröskelvärde
TimeGrainType	Den tid som omfattas av en budget. Spårning av beloppet återställs baserat på tidsintervallet. BillingMonth, BillingQuarter och Billing Annual stöds endast av WD-kunder

Budget

Objekt

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 (decimal)	Den totala kostnaden som ska spåras med budgeten
properties.category	CategoryType	Kategorin för budgeten, oavsett om budgeten spårar kostnader 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 kostnad 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 omfattas av en budget. Spårning av beloppet å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. Budgetstartdatum 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

Objekt

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

Name	Typ	Description
name	string	Namnet på kolumnen som ska användas i 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

Objekt

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

Objekt

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

Uppräkning

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

Värde	Description
In

BudgetsListResult

Objekt

Resultat av att lista budgetar. Den innehåller en lista över tillgängliga budgetar i det angivna omfånget.

Name	Typ	Description
nextLink	string	Länken (url) till nästa resultatsida.
value	Budget[]	Listan över budgetar.

BudgetTimePeriod

Objekt

Start- och slutdatum för en budget.

Name	Typ	Description
endDate	string (date-time)	Slutdatum för budgeten. Om det inte anges är standardinställningen 10 år från startdatumet.
startDate	string (date-time)	Startdatum för budgeten.

CategoryType

Uppräkning

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

Värde	Description
Cost

CultureCode

Uppräkning

Språk där mottagaren får meddelandet

Värde	Description
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

Objekt

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

Name	Typ	Description
amount	number (decimal)	Den totala kostnad som spåras av budgeten.
unit	string	Måttenheten för budgetbeloppet.

ErrorDetails

Objekt

Information om felet.

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

ErrorResponse

Objekt

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. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen".
504 Gateway Timeout – Tidsgränsen för tjänsten uppnåddes när begäran bearbetades. Minska datumintervallet i begäran, om möjligt.

Name	Typ	Description
error	ErrorDetails	Information om felet.

ForecastSpend

Objekt

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

Name	Typ	Description
amount	number (decimal)	Den prognostiserade kostnaden för den totala tidsperiod 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

Objekt

Meddelandet som är associerat med en budget.

Name	Typ	Standardvärde	Description
contactEmails	string[]		E-postadresser för att skicka budgetmeddelandet till när tröskelvärdet överskrids. Minst en kontakt-e-post eller kontaktgrupp måste anges i omfånget Prenumeration eller Resursgrupp. Alla andra omfång måste ha minst en e-postadress för kontakten angiven.
contactGroups	string[]		Åtgärdsgrupper som ska skicka budgetmeddelandet 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 (decimal)		Tröskelvärde som är associerat med ett meddelande. Meddelande skickas när kostnaden överskred tröskelvärdet. Det är alltid procent och måste vara mellan 0 och 1000.
thresholdType	ThresholdType	Actual	Typ av tröskelvärde

OperatorType

Uppräkning

Jämförelseoperatorn.

Värde	Description
EqualTo	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. OperatorType kommer att bli inaktuell i framtiden.
GreaterThan	Aviseringen utlöses om den utvärderade kostnaden är större än tröskelvärdet. Obs! Det här är den rekommenderade OperatorType när du konfigurerar budgetavisering.
GreaterThanOrEqualTo	Aviseringen utlöses om den utvärderade kostnaden är större än eller lika med tröskelvärdet.

ThresholdType

Uppräkning

Typ av tröskelvärde

Värde	Description
Actual	Budgetaviseringar för faktiska kostnader meddelar när den faktiska upplupna kostnaden överskrider den allokerade budgeten .
Forecasted	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

Uppräkning

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

Värde	Description
Annually
BillingAnnual
BillingMonth
BillingQuarter
Monthly
Quarterly

Dela via

Budgets - List

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

BudgetsList

Exempelbegäran

Exempelsvar

Definitioner

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetsListResult

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

Ytterligare resurser