Budgets - Get

Referencia

Service:: Consumption

API Version:: 2023-05-01

Lekéri a hatókör költségvetését a költségvetés neve alapján.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
budgetName	path	True	string	Költségvetés neve.
scope	path	True	string	A költségvetési műveletekhez társított hatókör. Ide tartozik a resourceGroup-hatókör "/subscriptions/{subscriptionId}/" előfizetési hatóköre, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}", "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" a számlázási fiók hatóköréhez, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" a részleg hatóköréhez, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}" a EnrollmentAccount hatókörhöz, "/providers/Microsoft.Management/managementGroups/{managementGroups/{managementGroupId}" a felügyeleti csoport hatóköréhez, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" a billingProfile hatókörhöz, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" a invoiceSection hatókörhöz.
api-version	query	True	string	Az ügyfélkéréshez használni kívánt API verziója. A jelenlegi verzió: 2023-03-01.

Válaszok

Name	Típus	Description
200 OK	Budget	OK gombra. A kérés sikeres volt.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

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	felhasználói fiók megszemélyesítése

Példák

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

Definíciók

Name	Description
Budget	Költségvetési erőforrás.
BudgetComparisonExpression	A költségvetésekben használandó összehasonlító kifejezés.
BudgetFilter	A költségvetések erőforráscsoport, erőforrás vagy fogyasztásmérő szerinti szűrésére használhatók.
BudgetFilterProperties	A Költségvetés szűréséhez használandó dimenziók vagy címkék.
BudgetOperatorType	Az összehasonlításhoz használni kívánt operátor.
BudgetTimePeriod	A költségvetés kezdési és befejezési dátuma.
CategoryType	A költségvetés kategóriája, függetlenül attól, hogy a költségvetés nyomon követi-e a költségeket vagy a használatot.
CultureCode	Az a nyelv, amelyben a címzett megkapja az értesítést
CurrentSpend	A költségvetéshez nyomon követett aktuális költségmennyiség.
ErrorDetails	A hiba részletei.
ErrorResponse	A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg. Néhány hibaválasz: 429 TooManyRequests – A kérés szabályozva van. Próbálkozzon újra az "x-ms-ratelimit-microsoft.consumption-retry-after" fejlécben megadott időpontra való várakozás után. 503 ServiceUnavailable – A szolgáltatás átmenetileg nem érhető el. Várjon a „Retry-After” fejlécben megadott ideig, majd próbálkozzon újra.
ForecastSpend	Az előrejelzett költség, amely nyomon követi a költségvetést.
Notification	A költségvetéshez társított értesítés.
OperatorType	Az összehasonlító operátor.
ThresholdType	A küszöbérték típusa
TimeGrainType	A költségvetés által lefedett idő. Az összeg nyomon követése az időérték alapján lesz visszaállítva. A BillingMonth, a BillingQuarter és a BillingAnnual szolgáltatást csak a WD-ügyfelek támogatják

Budget

Költségvetési erőforrás.

Name	Típus	Description
eTag	string	Az erőforrás eTagje. Az egyidejű frissítési forgatókönyv kezeléséhez ez a mező határozza meg, hogy a felhasználó frissíti-e a legújabb verziót.
id	string	Erőforrás-azonosító.
name	string	Erőforrás neve.
properties.amount	number	A költségvetéssel nyomon követendő költségek teljes összege
properties.category	CategoryType	A költségvetés kategóriája, függetlenül attól, hogy a költségvetés nyomon követi-e a költségeket vagy a használatot.
properties.currentSpend	CurrentSpend	A költségvetéshez nyomon követett aktuális költségmennyiség.
properties.filter	BudgetFilter	A költségvetések felhasználó által megadott dimenziók és/vagy címkék szerinti szűrésére használhatók.
properties.forecastSpend	ForecastSpend	Az előrejelzett költség, amely nyomon követi a költségvetést.
properties.notifications	<string, Notification>	A költségvetéshez társított értesítések szótára. A költségvetés legfeljebb öt értesítésből áll.
properties.timeGrain	TimeGrainType	A költségvetés által lefedett idő. Az összeg nyomon követése az időérték alapján lesz visszaállítva. A BillingMonth, a BillingQuarter és a BillingAnnual szolgáltatást csak a WD-ügyfelek támogatják
properties.timePeriod	BudgetTimePeriod	A költségvetés kezdő és záró dátuma. A kezdő dátumnak a hónap első napjának kell lennie, és kisebbnek kell lennie, mint a záró dátum. A költségvetés kezdési dátumának 2017. június 1-jén vagy azt követően kell lennie. A jövőbeli kezdési dátum legfeljebb tizenkét hónap lehet. A korábbi kezdési dátumot az időtartományon belül kell kijelölni. A befejezési dátumra nincsenek korlátozások.
type	string	Erőforrástípus.

BudgetComparisonExpression

A költségvetésekben használandó összehasonlító kifejezés.

Name	Típus	Description
name	string	Az összehasonlításban használni kívánt oszlop neve.
operator	BudgetOperatorType	Az összehasonlításhoz használni kívánt operátor.
values	string[]	Összehasonlításhoz használandó értékek tömbje

BudgetFilter

A költségvetések erőforráscsoport, erőforrás vagy fogyasztásmérő szerinti szűrésére használhatók.

Name	Típus	Description
and	BudgetFilterProperties[]	A logikai "AND" kifejezés. Legalább 2 elemnek kell lennie.
dimensions	BudgetComparisonExpression	Dimenzió összehasonlító kifejezéssel rendelkezik
tags	BudgetComparisonExpression	Címkéhez tartozó összehasonlító kifejezéssel rendelkezik

BudgetFilterProperties

A Költségvetés szűréséhez használandó dimenziók vagy címkék.

Name	Típus	Description
dimensions	BudgetComparisonExpression	Dimenzió összehasonlító kifejezéssel rendelkezik
tags	BudgetComparisonExpression	Címkéhez tartozó összehasonlító kifejezéssel rendelkezik

BudgetOperatorType

Az összehasonlításhoz használni kívánt operátor.

Name	Típus	Description
In	string

BudgetTimePeriod

A költségvetés kezdési és befejezési dátuma.

Name	Típus	Description
endDate	string	A költségvetés záró dátuma. Ha nincs megadva, ez alapértelmezés szerint a kezdési dátumtól számított 10 év.
startDate	string	A költségvetés kezdő dátuma.

CategoryType

A költségvetés kategóriája, függetlenül attól, hogy a költségvetés nyomon követi-e a költségeket vagy a használatot.

Name	Típus	Description
Cost	string

CultureCode

Az a nyelv, amelyben a címzett megkapja az értesítést

Name	Típus	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

A költségvetéshez nyomon követett aktuális költségmennyiség.

Name	Típus	Description
amount	number	A költségvetés által nyomon követett költség teljes összege.
unit	string	A költségvetési összeg mértékegysége.

ErrorDetails

A hiba részletei.

Name	Típus	Description
code	string	Hibakód.
message	string	Hibaüzenet jelzi, hogy a művelet miért nem sikerült.

ErrorResponse

A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Néhány hibaválasz:

429 TooManyRequests – A kérés szabályozva van. Próbálkozzon újra az "x-ms-ratelimit-microsoft.consumption-retry-after" fejlécben megadott időpontra való várakozás után.
503 ServiceUnavailable – A szolgáltatás átmenetileg nem érhető el. Várjon a „Retry-After” fejlécben megadott ideig, majd próbálkozzon újra.

Name	Típus	Description
error	ErrorDetails	A hiba részletei.

ForecastSpend

Az előrejelzett költség, amely nyomon követi a költségvetést.

Name	Típus	Description
amount	number	A költségvetés által nyomon követett teljes időszak előrejelzett költsége. Ez az érték csak akkor érhető el, ha a költségvetés előrejelzési riasztástípust tartalmaz.
unit	string	A költségvetési összeg mértékegysége.

Notification

A költségvetéshez társított értesítés.

Name	Típus	Alapértelmezett érték	Description
contactEmails	string[]		Email címeket, hogy elküldjék a költségvetési értesítést a küszöbérték túllépésekor. Rendelkeznie kell legalább egy kapcsolattartó e-mail-címével vagy partnercsoporttal, amely az előfizetés vagy az erőforráscsoport hatókörében van megadva. Minden más hatókörnek legalább egy megadott kapcsolattartó e-mail-címével kell rendelkeznie.
contactGroups	string[]		Műveletcsoportok, hogy elküldjék a költségvetési értesítést a küszöbérték túllépésének időpontjára. Teljes körű Azure-erőforrás-azonosítóként kell megadni. Csak előfizetési vagy erőforráscsoport-hatókörök esetén támogatott.
contactRoles	string[]		Vegye fel a kapcsolatot a szerepkörökvel, hogy elküldje a költségvetési értesítést a küszöbérték túllépésének időpontjára.
enabled	boolean		Az értesítés engedélyezve van vagy nincs.
locale	CultureCode		Az a nyelv, amelyben a címzett megkapja az értesítést
operator	OperatorType		Az összehasonlító operátor.
threshold	number		Értesítéshez társított küszöbérték. A rendszer értesítést küld, ha a költség túllépte a küszöbértéket. Ez mindig százalékos érték, és 0 és 1000 között kell lennie.
thresholdType	ThresholdType	Actual	A küszöbérték típusa

OperatorType

Az összehasonlító operátor.

Name	Típus	Description
EqualTo	string	A riasztás akkor aktiválódik, ha a kiértékelt költség megegyezik a küszöbérték értékével. Megjegyzés: Nem ajánlott ezt az Operátortípust használni, mivel alacsony az esélye annak, hogy a költség pontosan megegyezik a küszöbérték értékével, ami a riasztás hiányához vezet. Ez az operátortípus a jövőben elavult lesz.
GreaterThan	string	A riasztás akkor aktiválódik, ha a kiértékelt költség nagyobb, mint a küszöbérték. Megjegyzés: Ez az ajánlott Operátortípus a költségvetési riasztás konfigurálásakor.
GreaterThanOrEqualTo	string	A riasztás akkor aktiválódik, ha a kiértékelt költség nagyobb vagy egyenlő a küszöbértéknél.

ThresholdType

A küszöbérték típusa

Name	Típus	Description
Actual	string	A tényleges költségek költségvetési riasztásai értesítik, ha a tényleges felhalmozott költség meghaladja a lefoglalt költségvetést.
Forecasted	string	Az előrejelzett költségkeret-riasztások speciális értesítést biztosítanak arról, hogy a költségtrendek valószínűleg meghaladják a lefoglalt költségvetést, mivel az előrejelzett költség-előrejelzésekre támaszkodik.

TimeGrainType

A költségvetés által lefedett idő. Az összeg nyomon követése az időérték alapján lesz visszaállítva. A BillingMonth, a BillingQuarter és a BillingAnnual szolgáltatást csak a WD-ügyfelek támogatják

Name	Típus	Description
Annually	string
BillingAnnual	string
BillingMonth	string
BillingQuarter	string
Monthly	string
Quarterly	string

Budgets - Get

URI-paraméterek

Válaszok

Biztonság

azure_auth

Scopes

Példák

Budget

Sample Request

Sample Response

Definíciók

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

További források