Budgets - Get

Başvuru

Service:: Consumption

API Version:: 2023-05-01

Kapsamın bütçesini bütçe adına göre alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
budgetName	path	True	string	Bütçe Adı.
scope	path	True	string	Bütçe işlemleriyle ilişkili kapsam. Buna abonelik kapsamı için '/subscriptions/{subscriptionId}/' dahildir, resourceGroup kapsamı için '/subscriptions/{subscriptionId}/resourceGroupName}', Faturalama Hesabı kapsamı için '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}', '/providers/Microsoft.Billing/billingAccountId}/departments/{departmentId}' Bölüm kapsamı için '/providers/Microsoft.Billing/billingAccountId}', '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/{ enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}'.
api-version	query	True	string	İstemci isteğiyle kullanılacak API sürümü. Geçerli sürüm 2023-03-01'dir.

Yanıtlar

Name	Tür	Description
200 OK	Budget	Tamam ögesini seçin. İstek başarılı oldu.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Tanımlar

Name	Description
Budget	Bütçe kaynağı.
BudgetComparisonExpression	Bütçelerde kullanılacak karşılaştırma ifadesi.
BudgetFilter	Bütçeleri kaynak grubuna, kaynağa veya ölçüme göre filtrelemek için kullanılabilir.
BudgetFilterProperties	Bütçeyi filtrelemek için Boyutlar veya Etiketler.
BudgetOperatorType	Karşılaştırma için kullanılacak işleç.
BudgetTimePeriod	Bütçenin başlangıç ve bitiş tarihi.
CategoryType	Bütçenin, maliyeti veya kullanımı izlediği bütçe kategorisi.
CultureCode	Alıcının bildirimi alacağı dil
CurrentSpend	Bütçe için izlenen geçerli maliyet miktarı.
ErrorDetails	Hatanın ayrıntıları.
ErrorResponse	Hata yanıtı, hizmetin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir. Bazı Hata yanıtları: 429 TooManyRequests - İstek kısıtlandı. "x-ms-ratelimit-microsoft.consumption-retry-after" üst bilgisinde belirtilen süreyi bekledikten sonra yeniden deneyin. 503 ServiceUnavailable - Hizmet geçici olarak kullanılamıyor. "Retry-After" üst bilgisinde belirtilen süre bekledikten sonra yeniden deneyin.
ForecastSpend	Bütçe için izlenen tahmini maliyet.
Notification	Bütçeyle ilişkili bildirim.
OperatorType	Karşılaştırma işleci.
ThresholdType	Eşiğin türü
TimeGrainType	Bütçe kapsamındaki süre. Miktarın izlenmesi zaman dilimine göre sıfırlanır. BillingMonth, BillingQuarter ve BillingAnnual yalnızca WD müşterileri tarafından desteklenir

Budget

Bütçe kaynağı.

Name	Tür	Description
eTag	string	Kaynağın eTag'i. Eşzamanlı güncelleştirme senaryolarını işlemek için, kullanıcının en son sürümü güncelleştirip güncelleştirmediğini belirlemek için bu alan kullanılır.
id	string	Kaynak Kimliği.
name	string	Kaynak adı.
properties.amount	number	Bütçeyle izlenen toplam maliyet miktarı
properties.category	CategoryType	Bütçenin, maliyeti veya kullanımı izlediği bütçe kategorisi.
properties.currentSpend	CurrentSpend	Bütçe için izlenen geçerli maliyet miktarı.
properties.filter	BudgetFilter	Bütçeleri kullanıcı tarafından belirtilen boyutlara ve/veya etiketlere göre filtrelemek için kullanılabilir.
properties.forecastSpend	ForecastSpend	Bütçe için izlenen tahmini maliyet.
properties.notifications	<string, Notification>	Bütçeyle ilişkili bildirimlerin sözlüğü. Bütçede en fazla beş bildirim olabilir.
properties.timeGrain	TimeGrainType	Bütçe kapsamındaki süre. Miktarın izlenmesi zaman dilimine göre sıfırlanır. BillingMonth, BillingQuarter ve BillingAnnual yalnızca WD müşterileri tarafından desteklenir
properties.timePeriod	BudgetTimePeriod	Bütçenin başlangıç ve bitiş tarihidir. Başlangıç tarihi ayın ilki olmalı ve bitiş tarihinden küçük olmalıdır. Bütçe başlangıç tarihi 1 Haziran 2017 tarihinde veya sonrasında olmalıdır. Gelecek başlangıç tarihi on iki aydan uzun olmamalıdır. Geçmiş başlangıç tarihi, zaman dilimi içinde seçilmelidir. Bitiş tarihinde herhangi bir kısıtlama yoktur.
type	string	Kaynak türü.

BudgetComparisonExpression

Bütçelerde kullanılacak karşılaştırma ifadesi.

Name	Tür	Description
name	string	Karşılaştırmada kullanılacak sütunun adı.
operator	BudgetOperatorType	Karşılaştırma için kullanılacak işleç.
values	string[]	Karşılaştırma için kullanılacak değer dizisi

BudgetFilter

Bütçeleri kaynak grubuna, kaynağa veya ölçüme göre filtrelemek için kullanılabilir.

Name	Tür	Description
and	BudgetFilterProperties[]	Mantıksal "AND" ifadesi. En az 2 öğe olmalıdır.
dimensions	BudgetComparisonExpression	Boyut için karşılaştırma ifadesi var
tags	BudgetComparisonExpression	Etiket için karşılaştırma ifadesi var

BudgetFilterProperties

Bütçeyi filtrelemek için Boyutlar veya Etiketler.

Name	Tür	Description
dimensions	BudgetComparisonExpression	Boyut için karşılaştırma ifadesi var
tags	BudgetComparisonExpression	Etiket için karşılaştırma ifadesi var

BudgetOperatorType

Karşılaştırma için kullanılacak işleç.

Name	Tür	Description
In	string

BudgetTimePeriod

Bütçenin başlangıç ve bitiş tarihi.

Name	Tür	Description
endDate	string	Bütçenin bitiş tarihi. Sağlanmadıysa, bunu başlangıç tarihinden itibaren 10 yıl olarak varsayılan olarak kullanırız.
startDate	string	Bütçenin başlangıç tarihi.

CategoryType

Bütçenin, maliyeti veya kullanımı izlediği bütçe kategorisi.

Name	Tür	Description
Cost	string

CultureCode

Alıcının bildirimi alacağı dil

Name	Tür	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

Bütçe için izlenen geçerli maliyet miktarı.

Name	Tür	Description
amount	number	Bütçe tarafından izlenen toplam maliyet miktarı.
unit	string	Bütçe tutarı için ölçü birimi.

ErrorDetails

Hatanın ayrıntıları.

Name	Tür	Description
code	string	Hata kodu.
message	string	İşlemin neden başarısız olduğunu belirten hata iletisi.

ErrorResponse

Hata yanıtı, hizmetin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir.

Bazı Hata yanıtları:

429 TooManyRequests - İstek kısıtlandı. "x-ms-ratelimit-microsoft.consumption-retry-after" üst bilgisinde belirtilen süreyi bekledikten sonra yeniden deneyin.
503 ServiceUnavailable - Hizmet geçici olarak kullanılamıyor. "Retry-After" üst bilgisinde belirtilen süre bekledikten sonra yeniden deneyin.

Name	Tür	Description
error	ErrorDetails	Hatanın ayrıntıları.

ForecastSpend

Bütçe için izlenen tahmini maliyet.

Name	Tür	Description
amount	number	Bütçe tarafından izlenen toplam zaman aralığı için tahmini maliyet. Bu değer yalnızca bütçe bir tahmin uyarı türü içeriyorsa sağlanır.
unit	string	Bütçe tutarı için ölçü birimi.

Notification

Bütçeyle ilişkili bildirim.

Name	Tür	Varsayılan değer	Description
contactEmails	string[]		Eşik aşıldığında bütçe bildiriminin gönderilmesi için adresleri Email. Abonelik veya Kaynak Grubu kapsamlarında en az bir kişi e-postası veya kişi grubu belirtilmelidir. Diğer tüm kapsamlarda en az bir kişi e-postası belirtilmelidir.
contactGroups	string[]		Eşik aşıldığında bütçe bildiriminin gönderilmesi için eylem grupları. Tam Azure kaynak kimliği olarak sağlanmalıdır. Yalnızca Abonelik veya Kaynak Grubu kapsamlarında desteklenir.
contactRoles	string[]		Eşik aşıldığında bütçe bildirimini göndermek için ilgili kişi rolleri.
enabled	boolean		Bildirim etkinleştirildi veya etkinleştirilmedi.
locale	CultureCode		Alıcının bildirimi alacağı dil
operator	OperatorType		Karşılaştırma işleci.
threshold	number		Bildirimle ilişkili eşik değeri. Maliyet eşiği aştığında bildirim gönderilir. Her zaman yüzdedir ve 0 ile 1000 arasında olmalıdır.
thresholdType	ThresholdType	Actual	Eşiğin türü

OperatorType

Karşılaştırma işleci.

Name	Tür	Description
EqualTo	string	Değerlendirilen maliyet eşik değeriyle aynıysa uyarı tetiklenir. Not: Maliyetin eşik değeriyle tam olarak aynı olma olasılığı düşük olduğundan uyarınızın eksik olmasına neden olduğundan bu OperatorType'ın kullanılması önerilmez. Bu OperatorType gelecekte kullanım dışı bırakılacak.
GreaterThan	string	Değerlendirilen maliyet eşik değerinden büyükse uyarı tetiklenir. Not: Bütçe Uyarısı yapılandırılırken önerilen OperatorType budur.
GreaterThanOrEqualTo	string	Değerlendirilen maliyet eşik değerinden büyük veya buna eşitse uyarı tetiklenir.

ThresholdType

Eşiğin türü

Name	Tür	Description
Actual	string	Gerçek maliyetler bütçe uyarıları, tahakkuk eden gerçek maliyet ayrılan bütçeyi aştığında bunu bildirir.
Forecasted	string	Tahmin edilen maliyet bütçe uyarıları, tahmin edilen maliyet tahminlerine bağlı olduğundan harcama eğilimlerinizin ayrılmış bütçenizi aşma olasılığının yüksek olduğunu belirten gelişmiş bildirim sağlar.

TimeGrainType

Bütçe kapsamındaki süre. Miktarın izlenmesi zaman dilimine göre sıfırlanır. BillingMonth, BillingQuarter ve BillingAnnual yalnızca WD müşterileri tarafından desteklenir

Name	Tür	Description
Annually	string
BillingAnnual	string
BillingMonth	string
BillingQuarter	string
Monthly	string
Quarterly	string

Aracılığıyla paylaş

Budgets - Get

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

Budget

Sample Request

Sample Response

Tanımlar

Budget

BudgetComparisonExpression

BudgetFilter

BudgetFilterProperties

BudgetOperatorType

BudgetTimePeriod

CategoryType

CultureCode

CurrentSpend

ErrorDetails

ErrorResponse

ForecastSpend

Notification

OperatorType

ThresholdType

TimeGrainType

Ek kaynaklar