Views - Create Or Update By Scope

Operasi untuk membuat atau memperbarui tampilan. Operasi pembaruan memerlukan eTag terbaru untuk diatur dalam permintaan. Anda dapat memperoleh eTag terbaru dengan melakukan operasi get. Operasi buat tidak memerlukan eTag.

PUT https://management.azure.com/{scope}/providers/Microsoft.CostManagement/views/{viewName}?api-version=2021-10-01

Parameter URI

Name In Required Type Description
scope
path True
  • string

Cakupan yang terkait dengan operasi tampilan. 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.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' untuk cakupan BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' untuk cakupan InvoiceSection, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' untuk cakupan Grup Manajemen, 'providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}' untuk cakupan Akun Penagihan Eksternal dan 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' untuk cakupan Langganan Eksternal.

viewName
path True
  • string

Melihat nama

api-version
query True
  • string

Versi API yang akan digunakan dengan permintaan klien.

Isi Permintaan

Name Required Type Description
properties.query.timeframe True

Jangka waktu untuk menarik data untuk laporan. Jika kustom, maka periode waktu tertentu harus disediakan.

properties.query.type True

Jenis laporan. Penggunaan mewakili penggunaan aktual, prakiraan mewakili data prakiraan dan UsageAndForecast mewakili penggunaan dan data yang diperkirakan. Penggunaan aktual dan data prakiraan dapat dibedakan berdasarkan tanggal.

eTag
  • string

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

properties.accumulated

Tampilkan biaya yang terakumulasi dari waktu ke waktu.

properties.chart

Jenis bagan tampilan utama dalam Analisis Biaya. Wajib diisi.

properties.displayName
  • string

Nama input pengguna tampilan. Wajib diisi.

properties.kpis

Daftar KPI yang akan ditampilkan di Antarmuka Pengguna Analisis Biaya.

properties.metric

Metrik yang akan digunakan saat menampilkan biaya.

properties.pivots

Konfigurasi 3 sub-tampilan di antarmuka pengguna Analisis Biaya.

properties.query.dataSet

Memiliki definisi untuk data dalam konfigurasi laporan ini.

properties.query.includeMonetaryCommitment
  • boolean

Jika true, laporan menyertakan komitmen moneter.

properties.query.timePeriod

Memiliki periode waktu untuk menarik data untuk laporan.

properties.scope
  • string

Cakupan Cost Management untuk menyimpan tampilan. 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.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' untuk cakupan BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' untuk cakupan InvoiceSection, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' untuk cakupan Grup Manajemen, '/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}' untuk cakupan ExternalBillingAccount, dan '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' untuk cakupan ExternalSubscription.

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

ResourceGroupCreateOrUpdateView

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample?api-version=2021-10-01

{
  "eTag": "\"1d4ff9fe66f1d10\"",
  "properties": {
    "displayName": "swagger Example",
    "query": {
      "type": "Usage",
      "timeframe": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "aggregation": {
          "totalCost": {
            "name": "PreTaxCost",
            "function": "Sum"
          }
        },
        "grouping": [],
        "sorting": [
          {
            "direction": "Ascending",
            "name": "UsageDate"
          }
        ]
      }
    },
    "chart": "Table",
    "accumulated": "true",
    "metric": "ActualCost",
    "kpis": [
      {
        "type": "Forecast",
        "id": null,
        "enabled": true
      },
      {
        "type": "Budget",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo",
        "enabled": true
      }
    ],
    "pivots": [
      {
        "type": "Dimension",
        "name": "ServiceName"
      },
      {
        "type": "Dimension",
        "name": "MeterCategory"
      },
      {
        "type": "TagKey",
        "name": "swaggerTagKey"
      }
    ]
  }
}

Sample Response

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.CostManagement/Views",
  "eTag": "\"1d4ffa5a9c2430c\"",
  "properties": {
    "displayName": "swagger Example",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG",
    "query": {
      "type": "Usage",
      "timeframe": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "aggregation": {
          "totalCost": {
            "name": "PreTaxCost",
            "function": "Sum"
          }
        },
        "grouping": [],
        "sorting": [
          {
            "direction": "Ascending",
            "name": "UsageDate"
          }
        ]
      }
    },
    "chart": "Table",
    "accumulated": "true",
    "metric": "ActualCost",
    "kpis": [
      {
        "type": "Forecast",
        "id": null,
        "enabled": true
      },
      {
        "type": "Budget",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo",
        "enabled": true
      }
    ],
    "pivots": [
      {
        "type": "Dimension",
        "name": "ServiceName"
      },
      {
        "type": "Dimension",
        "name": "MeterCategory"
      },
      {
        "type": "TagKey",
        "name": "swaggerTagKey"
      }
    ]
  }
}
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample",
  "name": "swaggerExample",
  "type": "Microsoft.CostManagement/Views",
  "eTag": "\"1d4ffa5a9c2430c\"",
  "properties": {
    "displayName": "swagger Example",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG",
    "query": {
      "type": "Usage",
      "timeframe": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "aggregation": {
          "totalCost": {
            "name": "PreTaxCost",
            "function": "Sum"
          }
        },
        "grouping": [],
        "sorting": [
          {
            "direction": "Ascending",
            "name": "UsageDate"
          }
        ]
      }
    },
    "chart": "Table",
    "accumulated": "true",
    "metric": "ActualCost",
    "kpis": [
      {
        "type": "Forecast",
        "id": null,
        "enabled": true
      },
      {
        "type": "Budget",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo",
        "enabled": true
      }
    ],
    "pivots": [
      {
        "type": "Dimension",
        "name": "ServiceName"
      },
      {
        "type": "Dimension",
        "name": "MeterCategory"
      },
      {
        "type": "TagKey",
        "name": "swaggerTagKey"
      }
    ]
  }
}

Definisi

AccumulatedType

Tampilkan akumulasi biaya dari waktu ke waktu.

ChartType

Jenis bagan tampilan utama dalam Analisis Biaya. Wajib diisi.

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

FunctionType

Nama fungsi agregasi yang akan digunakan.

KpiProperties

Setiap KPI harus berisi kunci 'type' dan 'enabled'.

KpiTypeType

Jenis KPI (Prakiraan, Anggaran).

MetricType

Metrik yang digunakan saat menampilkan biaya.

OperatorType

Operator yang digunakan untuk perbandingan.

PivotProperties

Setiap pivot harus berisi 'jenis' dan 'nama'.

PivotTypeType

Jenis data untuk ditampilkan dalam tampilan.

ReportConfigAggregation

Ekspresi agregasi yang akan digunakan dalam laporan.

ReportConfigColumnType

Jenis kolom dalam laporan.

ReportConfigComparisonExpression

Ekspresi perbandingan yang akan digunakan dalam laporan.

ReportConfigDataset

Definisi data yang ada dalam laporan.

ReportConfigDatasetConfiguration

Konfigurasi himpunan data dalam laporan.

ReportConfigFilter

Ekspresi filter yang akan digunakan dalam laporan.

ReportConfigGrouping

Grup menurut ekspresi yang akan digunakan dalam laporan.

ReportConfigSorting

Urutan berdasarkan ekspresi yang akan digunakan dalam laporan.

ReportConfigSortingType

Arah semacam itu.

ReportConfigTimePeriod

Tanggal mulai dan berakhir untuk menarik data untuk laporan.

ReportGranularityType

Granularitas baris dalam laporan.

ReportTimeframeType

Jangka waktu untuk menarik data untuk laporan. Jika kustom, maka periode waktu tertentu harus disediakan.

ReportType

Jenis laporan. Penggunaan mewakili penggunaan aktual, prakiraan mewakili data prakiraan dan UsageAndForecast mewakili penggunaan dan data yang diperkirakan. Penggunaan aktual dan data yang diperkirakan dapat dibedakan berdasarkan tanggal.

View

Status dan konfigurasi Analisis Biaya.

AccumulatedType

Tampilkan akumulasi biaya dari waktu ke waktu.

Name Type Description
false
  • string
true
  • string

ChartType

Jenis bagan tampilan utama dalam Analisis Biaya. Wajib diisi.

Name Type Description
Area
  • string
GroupedColumn
  • string
Line
  • string
StackedColumn
  • string
Table
  • string

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.

FunctionType

Nama fungsi agregasi yang akan digunakan.

Name Type Description
Sum
  • string

KpiProperties

Setiap KPI harus berisi kunci 'type' dan 'enabled'.

Name Type Description
enabled
  • boolean

tampilkan KPI di UI?

id
  • string

ID sumber daya yang terkait dengan metrik (anggaran).

type

Jenis KPI (Prakiraan, Anggaran).

KpiTypeType

Jenis KPI (Prakiraan, Anggaran).

Name Type Description
Budget
  • string
Forecast
  • string

MetricType

Metrik yang digunakan saat menampilkan biaya.

Name Type Description
AHUB
  • string
ActualCost
  • string
AmortizedCost
  • string

OperatorType

Operator yang digunakan untuk perbandingan.

Name Type Description
Contains
  • string
In
  • string

PivotProperties

Setiap pivot harus berisi 'jenis' dan 'nama'.

Name Type Description
name
  • string

Bidang data untuk ditampilkan dalam tampilan.

type

Jenis data untuk ditampilkan dalam tampilan.

PivotTypeType

Jenis data untuk ditampilkan dalam tampilan.

Name Type Description
Dimension
  • string
TagKey
  • string

ReportConfigAggregation

Ekspresi agregasi yang akan digunakan dalam laporan.

Name Type Description
function

Nama fungsi agregasi yang akan digunakan.

name
  • string

Nama kolom yang akan diagregasi.

ReportConfigColumnType

Jenis kolom dalam laporan.

Name Type Description
Dimension
  • string
Tag
  • string

ReportConfigComparisonExpression

Ekspresi perbandingan yang akan digunakan dalam laporan.

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

ReportConfigDataset

Definisi data yang ada dalam laporan.

Name Type Description
aggregation

Kamus ekspresi agregasi untuk digunakan dalam laporan. Kunci setiap item dalam kamus adalah alias untuk kolom agregat. Laporan dapat memiliki hingga 2 klausa agregasi.

configuration

Memiliki informasi konfigurasi untuk data dalam laporan. Konfigurasi akan diabaikan jika agregasi dan pengelompokan disediakan.

filter

Memiliki ekspresi filter untuk digunakan dalam laporan.

granularity

Granularitas baris dalam laporan.

grouping

Array grup menurut ekspresi untuk digunakan dalam laporan. Laporan dapat memiliki hingga 2 kelompokkan menurut klausul.

sorting

Array urutan menurut ekspresi untuk digunakan dalam laporan.

ReportConfigDatasetConfiguration

Konfigurasi himpunan data dalam laporan.

Name Type Description
columns
  • string[]

Array nama kolom yang akan disertakan dalam laporan. Nama kolom laporan yang valid diperbolehkan. Jika tidak disediakan, maka laporan menyertakan semua kolom.

ReportConfigFilter

Ekspresi filter yang akan digunakan dalam laporan.

Name Type Description
and

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

dimensions

Memiliki ekspresi perbandingan untuk dimensi

or

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

tags

Memiliki ekspresi perbandingan untuk tag

ReportConfigGrouping

Grup menurut ekspresi yang akan digunakan dalam laporan.

Name Type Description
name
  • string

Nama kolom yang akan dikelompokkan. Versi ini mendukung langganan dengan kemungkinan grain terendah.

type

Memiliki jenis kolom untuk dikelompokkan.

ReportConfigSorting

Urutan berdasarkan ekspresi yang akan digunakan dalam laporan.

Name Type Description
direction

Arah semacam itu.

name
  • string

Nama kolom yang akan diurutkan.

ReportConfigSortingType

Arah semacam itu.

Name Type Description
Ascending
  • string
Descending
  • string

ReportConfigTimePeriod

Tanggal mulai dan berakhir untuk menarik data untuk laporan.

Name Type Description
from
  • string

Tanggal mulai untuk menarik data.

to
  • string

Tanggal akhir untuk menarik data.

ReportGranularityType

Granularitas baris dalam laporan.

Name Type Description
Daily
  • string
Monthly
  • string

ReportTimeframeType

Jangka waktu untuk menarik data untuk laporan. Jika kustom, maka periode waktu tertentu harus disediakan.

Name Type Description
Custom
  • string
MonthToDate
  • string
WeekToDate
  • string
YearToDate
  • string

ReportType

Jenis laporan. Penggunaan mewakili penggunaan aktual, prakiraan mewakili data prakiraan dan UsageAndForecast mewakili penggunaan dan data yang diperkirakan. Penggunaan aktual dan data yang diperkirakan dapat dibedakan berdasarkan tanggal.

Name Type Description
Usage
  • string

View

Status dan konfigurasi Analisis Biaya.

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.accumulated

Tampilkan akumulasi biaya dari waktu ke waktu.

properties.chart

Jenis bagan tampilan utama dalam Analisis Biaya. Wajib diisi.

properties.createdOn
  • string

Tanggal pengguna membuat tampilan ini.

properties.currency
  • string

Mata uang tampilan saat ini.

properties.dateRange
  • string

Rentang tanggal tampilan saat ini.

properties.displayName
  • string

Nama input pengguna tampilan. Wajib diisi.

properties.kpis

Daftar KPI yang akan ditampilkan di UI Analisis Biaya.

properties.metric

Metrik yang digunakan saat menampilkan biaya.

properties.modifiedOn
  • string

Tanggal saat pengguna terakhir mengubah tampilan ini.

properties.pivots

Konfigurasi 3 sub-tampilan di UI Analisis Biaya.

properties.query.dataSet

Memiliki definisi untuk data dalam konfigurasi laporan ini.

properties.query.includeMonetaryCommitment
  • boolean

Jika true, laporan menyertakan komitmen moneter.

properties.query.timePeriod

Memiliki periode waktu untuk menarik data untuk laporan.

properties.query.timeframe

Jangka waktu untuk menarik data untuk laporan. Jika kustom, maka periode waktu tertentu harus disediakan.

properties.query.type

Jenis laporan. Penggunaan mewakili penggunaan aktual, prakiraan mewakili data prakiraan dan UsageAndForecast mewakili penggunaan dan data yang diperkirakan. Penggunaan aktual dan data yang diperkirakan dapat dibedakan berdasarkan tanggal.

properties.scope
  • string

Cakupan Cost Management untuk menyimpan tampilan. 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.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' untuk cakupan BillingProfile, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' untuk cakupan InvoiceSection, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' untuk cakupan Grup Manajemen, '/providers/Microsoft.CostManagement/externalBillingAccounts/{ externalBillingAccountName}' untuk cakupan ExternalBillingAccount, dan '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' untuk cakupan ExternalSubscription.

type
  • string

Jenis sumber daya