Budgets - Create Or Update

Operasi untuk membuat atau memperbarui anggaran. Anda dapat secara opsional memberikan eTag jika diinginkan sebagai bentuk kontrol konkurensi. Untuk mendapatkan eTag terbaru untuk anggaran tertentu, lakukan operasi get sebelum operasi put Anda.

PUT https://management.azure.com/{scope}/providers/Microsoft.Consumption/budgets/{budgetName}?api-version=2021-10-01

Parameter URI

Name In Required Type Description
budgetName
path True
  • string

Nama Anggaran.

scope
path True
  • string

Cakupan yang terkait dengan operasi anggaran. Ini termasuk '/subscriptions/{subscriptionId}/' untuk cakupan langganan, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' untuk cakupan resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' untuk cakupan EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' untuk cakupan Grup Manajemen, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' untuk cakupan billingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' untuk cakupan invoiceSection.

api-version
query True
  • string

Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah 2021-10-01.

Isi Permintaan

Name Required Type Description
properties.amount True
  • number

Jumlah total biaya untuk dilacak dengan anggaran

properties.category True

Kategori anggaran, apakah anggaran melacak biaya atau penggunaan.

properties.timeGrain True

Waktu yang dicakup oleh anggaran. Pelacakan jumlah akan diatur ulang berdasarkan butir waktu. BillingMonth, BillingQuarter, dan BillingAnnual hanya didukung oleh pelanggan WD

properties.timePeriod True

Memiliki tanggal mulai dan berakhirnya anggaran. Tanggal mulai harus pertama dari bulan dan harus kurang dari tanggal selesai. Tanggal mulai anggaran harus pada atau setelah 1 Juni 2017. Tanggal mulai di masa mendatang tidak boleh lebih dari dua belas bulan. Tanggal mulai sebelumnya harus dipilih dalam periode timegrain. Tidak ada batasan pada tanggal selesai.

eTag
  • string

eTag sumber daya. Untuk menangani skenario pembaruan bersamaan, bidang ini akan digunakan untuk menentukan apakah pengguna memperbarui versi terbaru atau tidak.

properties.filter

Dapat digunakan untuk memfilter anggaran menurut dimensi dan/atau tag yang ditentukan pengguna.

properties.notifications

Kamus pemberitahuan yang terkait dengan anggaran. Anggaran dapat memiliki hingga lima pemberitahuan.

Respons

Name Type Description
200 OK

OK. Permintaan telah berhasil.

201 Created

Dibuat.

Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

CreateOrUpdateBudget

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget?api-version=2021-10-01

{
  "eTag": "\"1d34d016a593709\"",
  "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"
            ]
          }
        }
      ]
    },
    "notifications": {
      "Actual_GreaterThan_80_Percent": {
        "enabled": true,
        "operator": "GreaterThan",
        "threshold": 80,
        "locale": "en-us",
        "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"
      }
    }
  }
}

Sample Response

{
  "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,
        "locale": "en-us",
        "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": 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,
        "locale": "en-us",
        "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"
      }
    }
  }
}

Definisi

Budget

Sumber daya anggaran.

BudgetComparisonExpression

Ekspresi perbandingan yang akan digunakan dalam anggaran.

BudgetFilter

Dapat digunakan untuk memfilter anggaran menurut grup sumber daya, sumber daya, atau meteran.

BudgetFilterProperties

Dimensi atau Tag untuk memfilter anggaran.

BudgetOperatorType

Operator yang digunakan untuk perbandingan.

BudgetTimePeriod

Tanggal mulai dan berakhir untuk anggaran.

CategoryType

Kategori anggaran, apakah anggaran melacak biaya atau penggunaan.

CultureCode

Bahasa di mana penerima akan menerima pemberitahuan

CurrentSpend

Jumlah biaya saat ini yang sedang dilacak untuk anggaran.

ErrorDetails

Detail kesalahan.

ErrorResponse

Respons kesalahan menunjukkan bahwa layanan tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

Beberapa respons Kesalahan:

  • 429 TooManyRequests - Permintaan dibatasi. Coba lagi setelah menunggu waktu yang ditentukan di header "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable - Layanan sementara tidak tersedia. Coba lagi setelah menunggu selama waktu yang ditentukan di header "Coba Lagi Setelah".

ForecastSpend

Perkiraan biaya yang sedang dilacak untuk anggaran.

Notification

Pemberitahuan yang terkait dengan anggaran.

OperatorType

Operator perbandingan.

ThresholdType

Jenis ambang batas

TimeGrainType

Waktu yang dicakup oleh anggaran. Pelacakan jumlah akan diatur ulang berdasarkan butir waktu. BillingMonth, BillingQuarter, dan BillingAnnual hanya didukung oleh pelanggan WD

Budget

Sumber daya anggaran.

Name Type Description
eTag
  • string

eTag sumber daya. Untuk menangani skenario pembaruan bersamaan, bidang ini akan digunakan untuk menentukan apakah pengguna memperbarui versi terbaru atau tidak.

id
  • string

Id Sumber Daya.

name
  • string

Nama sumber daya.

properties.amount
  • number

Jumlah total biaya untuk dilacak dengan anggaran

properties.category

Kategori anggaran, apakah anggaran melacak biaya atau penggunaan.

properties.currentSpend

Jumlah biaya saat ini yang sedang dilacak untuk anggaran.

properties.filter

Dapat digunakan untuk memfilter anggaran menurut dimensi dan/atau tag yang ditentukan pengguna.

properties.forecastSpend

Perkiraan biaya yang sedang dilacak untuk anggaran.

properties.notifications

Kamus pemberitahuan yang terkait dengan anggaran. Anggaran dapat memiliki hingga lima pemberitahuan.

properties.timeGrain

Waktu yang dicakup oleh anggaran. Pelacakan jumlah akan diatur ulang berdasarkan butir waktu. BillingMonth, BillingQuarter, dan BillingAnnual hanya didukung oleh pelanggan WD

properties.timePeriod

Memiliki tanggal mulai dan berakhirnya anggaran. Tanggal mulai harus pertama dari bulan dan harus kurang dari tanggal selesai. Tanggal mulai anggaran harus pada atau setelah 1 Juni 2017. Tanggal mulai di masa mendatang tidak boleh lebih dari dua belas bulan. Tanggal mulai sebelumnya harus dipilih dalam periode timegrain. Tidak ada batasan pada tanggal selesai.

type
  • string

Jenis sumber daya

BudgetComparisonExpression

Ekspresi perbandingan yang akan digunakan dalam anggaran.

Name Type Description
name
  • string

Nama kolom yang akan digunakan sebagai perbandingan.

operator

Operator yang digunakan untuk perbandingan.

values
  • string[]

Array nilai yang akan digunakan untuk perbandingan

BudgetFilter

Dapat digunakan untuk memfilter anggaran menurut grup sumber daya, sumber daya, atau meteran.

Name Type Description
and

Ekspresi "AND" logis. Harus memiliki setidaknya 2 item.

dimensions

Memiliki ekspresi perbandingan untuk dimensi

tags

Memiliki ekspresi perbandingan untuk tag

BudgetFilterProperties

Dimensi atau Tag untuk memfilter anggaran.

Name Type Description
dimensions

Memiliki ekspresi perbandingan untuk dimensi

tags

Memiliki ekspresi perbandingan untuk tag

BudgetOperatorType

Operator yang digunakan untuk perbandingan.

Name Type Description
In
  • string

BudgetTimePeriod

Tanggal mulai dan berakhir untuk anggaran.

Name Type Description
endDate
  • string

Tanggal akhir untuk anggaran. Jika tidak disediakan, kami default ini menjadi 10 tahun dari tanggal mulai.

startDate
  • string

Tanggal mulai untuk anggaran.

CategoryType

Kategori anggaran, apakah anggaran melacak biaya atau penggunaan.

Name Type Description
Cost
  • string

CultureCode

Bahasa di mana penerima akan menerima pemberitahuan

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

Jumlah biaya saat ini yang sedang dilacak untuk anggaran.

Name Type Description
amount
  • number

Jumlah total biaya yang sedang dilacak oleh anggaran.

unit
  • string

Satuan ukuran untuk jumlah anggaran.

ErrorDetails

Detail kesalahan.

Name Type Description
code
  • string

Kode Kesalahan.

message
  • string

Pesan kesalahan yang menunjukkan mengapa operasi gagal.

ErrorResponse

Respons kesalahan menunjukkan bahwa layanan tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

Beberapa respons Kesalahan:

  • 429 TooManyRequests - Permintaan dibatasi. Coba lagi setelah menunggu waktu yang ditentukan di header "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable - Layanan sementara tidak tersedia. Coba lagi setelah menunggu selama waktu yang ditentukan di header "Coba Lagi Setelah".

Name Type Description
error

Detail kesalahan.

ForecastSpend

Perkiraan biaya yang sedang dilacak untuk anggaran.

Name Type Description
amount
  • number

Perkiraan biaya untuk periode total waktu yang sedang dilacak oleh anggaran. Nilai ini hanya disediakan jika anggaran berisi jenis pemberitahuan prakiraan.

unit
  • string

Satuan ukuran untuk jumlah anggaran.

Notification

Pemberitahuan yang terkait dengan anggaran.

Name Type Default Value Description
contactEmails
  • string[]

Alamat email untuk mengirim pemberitahuan anggaran ke saat ambang batas terlampaui. Harus memiliki setidaknya satu email kontak atau grup kontak yang ditentukan di cakupan Langganan atau Grup Sumber Daya. Semua cakupan lainnya harus memiliki setidaknya satu email kontak yang ditentukan.

contactGroups
  • string[]

Grup tindakan untuk mengirim pemberitahuan anggaran ke saat ambang batas terlampaui. Harus disediakan sebagai id sumber daya Azure yang sepenuhnya memenuhi syarat. Hanya didukung pada cakupan Langganan atau Grup Sumber Daya.

contactRoles
  • string[]

Hubungi peran untuk mengirim pemberitahuan anggaran ke saat ambang batas terlampaui.

enabled
  • boolean

Pemberitahuan diaktifkan atau tidak.

locale

Bahasa di mana penerima akan menerima pemberitahuan

operator

Operator perbandingan.

threshold
  • number

Nilai ambang yang terkait dengan pemberitahuan. Pemberitahuan dikirim ketika biaya melebihi ambang batas. Itu selalu persen dan harus antara 0 dan 1000.

thresholdType Actual

Jenis ambang batas

OperatorType

Operator perbandingan.

Name Type Description
EqualTo
  • string
GreaterThan
  • string
GreaterThanOrEqualTo
  • string

ThresholdType

Jenis ambang batas

Name Type Description
Actual
  • string
Forecasted
  • string

TimeGrainType

Waktu yang dicakup oleh anggaran. Pelacakan jumlah akan diatur ulang berdasarkan butir waktu. BillingMonth, BillingQuarter, dan BillingAnnual hanya didukung oleh pelanggan WD

Name Type Description
Annually
  • string
BillingAnnual
  • string
BillingMonth
  • string
BillingQuarter
  • string
Monthly
  • string
Quarterly
  • string