Budgets - Get

Reference

Service:: Consumption

API Version:: 2023-05-01

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

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
budgetName	path	True	string	Název rozpočtu.
scope	path	True	string	Rozsah přidružený k rozpočtovým operacím. To zahrnuje /subscriptions/{subscriptionId}/ pro rozsah předplatného, /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} pro obor resourceGroup, /providers/Microsoft.Billing/billingAccounts/{billingAccountId} pro rozsah fakturačního účtu, /providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId}/departments/{departmentId} pro obor oddělení, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} pro obor EnrollmentAccount, /providers/Microsoft.Management/managementGroups/{managementGroupId} pro rozsah skupiny pro správu, /providers/Microsoft.Billing/billingAccounts/{billingId}/billingProfiles/{billingProfiles/{billingProfileId} pro rozsah billingProfile, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId} pro rozsah invoiceSection.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuální verze je 2023-03-01.

Odpovědi

Name	Typ	Description
200 OK	Budget	OK. Žádost byla úspěšná.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

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

Příklady

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

Definice

Name	Description
Budget	Rozpočtový zdroj.
BudgetComparisonExpression	Výraz porovnání, který se má použít v rozpočtech.
BudgetFilter	Může se použít k filtrování rozpočtů podle skupiny prostředků, prostředku nebo měřiče.
BudgetFilterProperties	Dimenze nebo značky, podle které chcete filtrovat rozpočet.
BudgetOperatorType	Operátor, který se má použít pro porovnání.
BudgetTimePeriod	Počáteční a koncové datum rozpočtu.
CategoryType	Kategorie rozpočtu, bez ohledu na to, jestli rozpočet sleduje náklady nebo využití.
CultureCode	Jazyk, ve kterém příjemce obdrží oznámení
CurrentSpend	Aktuální částka nákladů, která se sleduje pro rozpočet.
ErrorDetails	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uveden v chybové zprávě. Některé chybové odpovědi: 429 TooManyRequests – Požadavek je omezený. Zkuste to znovu po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable – Služba je dočasně nedostupná. Po uplynutí časového limitu uvedeného v hlavičce Retry-After zkuste operaci zopakovat.
ForecastSpend	Předpokládané náklady, které jsou sledovány pro rozpočet.
Notification	Oznámení přidružené k rozpočtu
OperatorType	Operátor porovnání.
ThresholdType	Typ prahové hodnoty
TimeGrainType	Čas, na který se vztahuje rozpočet. Sledování množství se resetuje na základě časového intervalu. BillingMonth, BillingQuarter a BillingAnnual jsou podporovány pouze zákazníky wd.

Budget

Rozpočtový zdroj.

Name	Typ	Description
eTag	string	eTag prostředku. Pro zpracování scénáře souběžných aktualizací se toto pole použije k určení, jestli uživatel aktualizuje nejnovější verzi nebo ne.
id	string	ID prostředku.
name	string	Název prostředku.
properties.amount	number	Celková částka nákladů, které se mají sledovat s rozpočtem
properties.category	CategoryType	Kategorie rozpočtu, bez ohledu na to, jestli rozpočet sleduje náklady nebo využití.
properties.currentSpend	CurrentSpend	Aktuální částka nákladů, která se sleduje pro rozpočet.
properties.filter	BudgetFilter	Lze použít k filtrování rozpočtů podle dimenzí a/nebo značek zadaných uživatelem.
properties.forecastSpend	ForecastSpend	Předpokládané náklady, které jsou sledovány pro rozpočet.
properties.notifications	<string, Notification>	Slovník oznámení přidružených k rozpočtu. Rozpočet může obsahovat až pět oznámení.
properties.timeGrain	TimeGrainType	Čas, na který se vztahuje rozpočet. Sledování množství se resetuje na základě časového intervalu. BillingMonth, BillingQuarter a BillingAnnual jsou podporovány pouze zákazníky wd.
properties.timePeriod	BudgetTimePeriod	Má počáteční a koncové datum rozpočtu. Počáteční datum musí být první v měsíci a musí být menší než koncové datum. Počáteční datum rozpočtu musí být 1. června 2017 nebo později. Budoucí počáteční datum 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 není nijak omezeno.
type	string	Typ prostředku.

BudgetComparisonExpression

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 pro porovnání

BudgetFilter

Může 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í mít alespoň 2 položky.
dimensions	BudgetComparisonExpression	Obsahuje porovnávaný výraz pro dimenzi.
tags	BudgetComparisonExpression	Obsahuje porovnávaný výraz pro značku.

BudgetFilterProperties

Dimenze nebo značky, podle které chcete filtrovat rozpočet.

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

BudgetOperatorType

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

Name	Typ	Description
In	string

BudgetTimePeriod

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

Name	Typ	Description
endDate	string	Koncové datum rozpočtu. Pokud není k dispozici, nastavíme výchozí hodnotu na 10 let od data zahájení.
startDate	string	Počáteční datum rozpočtu.

CategoryType

Kategorie rozpočtu, bez ohledu na to, jestli rozpočet sleduje náklady nebo využití.

Name	Typ	Description
Cost	string

CultureCode

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

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

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

Name	Typ	Description
amount	number	Celková částka nákladů, kterou rozpočet sleduje.
unit	string	Měrná jednotka pro částku rozpočtu.

ErrorDetails

Podrobnosti o chybě.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

ErrorResponse

Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uveden v chybové zprávě.

Některé chybové odpovědi:

429 TooManyRequests – Požadavek je omezený. Zkuste to znovu po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable – Služba je dočasně nedostupná. Po uplynutí časového limitu uvedeného v hlavičce Retry-After zkuste operaci zopakovat.

Name	Typ	Description
error	ErrorDetails	Podrobnosti o chybě.

ForecastSpend

Předpokládané náklady, které jsou sledovány pro rozpočet.

Name	Typ	Description
amount	number	Předpokládané náklady na celkové časové období, které rozpočet sleduje. Tato hodnota se zadává jenom v případě, že rozpočet obsahuje typ upozornění prognózy.
unit	string	Měrná jednotka pro částku rozpočtu.

Notification

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

Name	Typ	Výchozí hodnota	Description
contactEmails	string[]		Email adresy pro odeslání oznámení o rozpočtu při překročení prahové hodnoty. Musí mít aspoň jeden kontaktní e-mail nebo skupinu kontaktů zadaný 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í pro odeslání oznámení o rozpočtu při překročení prahové hodnoty Musí být zadané jako plně kvalifikované ID prostředku Azure. Podporováno pouze v rozsahech předplatného nebo skupiny prostředků.
contactRoles	string[]		Obraťte se na role a odešlete oznámení o rozpočtu při překročení prahové hodnoty.
enabled	boolean		Oznámení je nebo není povolené.
locale	CultureCode		Jazyk, ve kterém příjemce obdrží oznámení
operator	OperatorType		Operátor porovnání.
threshold	number		Prahová hodnota přidružená k oznámení. Když náklady překročí prahovou hodnotu, odešle se oznámení. Vždy je to procento a musí být mezi 0 a 1 000.
thresholdType	ThresholdType	Actual	Typ prahové hodnoty

OperatorType

Operátor porovnání.

Name	Typ	Description
EqualTo	string	Upozornění se aktivuje, pokud jsou vyhodnocené náklady stejné jako prahová hodnota. Poznámka: Tento typ operátoru se nedoporučuje používat, protože existuje malá 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	string	Upozornění se aktivuje, pokud jsou vyhodnocené náklady vyšší než prahová hodnota. Poznámka: Toto je doporučený typ operátoru při konfiguraci upozornění rozpočtu.
GreaterThanOrEqualTo	string	Výstraha se aktivuje, pokud jsou vyhodnocené náklady vyšší než nebo rovny prahové hodnotě.

ThresholdType

Typ prahové hodnoty

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

TimeGrainType

Čas, na který se vztahuje rozpočet. Sledování množství se resetuje na základě časového intervalu. BillingMonth, BillingQuarter a BillingAnnual jsou podporovány pouze zákazníky wd.

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

Sdílet prostřednictvím

Budgets - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

Budget

Sample Request

Sample Response

Definice

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

Další materiály