Views - Create Or Update By Scope

Referensi

Service:: Cost Management

API Version:: 2023-11-01

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=2023-11-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
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 digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
properties.query.timeframe	True	ReportTimeframeType	Jangka waktu untuk menarik data untuk laporan. Jika kustom, maka periode waktu tertentu harus disediakan.
properties.query.type	True	ReportType	Jenis laporan. Penggunaan mewakili penggunaan aktual, prakiraan mewakili data yang diperkirakan dan UsageAndForecast mewakili penggunaan dan data yang diperkirakan. Penggunaan aktual dan data yang diperkirakan 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		AccumulatedType	Tampilkan akumulasi biaya dari waktu ke waktu.
properties.chart		ChartType	Jenis bagan tampilan utama dalam Analisis Biaya. Wajib diisi.
properties.dateRange		string	Rentang tanggal tampilan saat ini.
properties.displayName		string	Nama input pengguna tampilan. Wajib diisi.
properties.kpis		KpiProperties[]	Daftar KPI yang akan ditampilkan di UI Analisis Biaya.
properties.metric		MetricType	Metrik yang digunakan saat menampilkan biaya.
properties.modifiedOn		string	Tanggal saat pengguna terakhir mengubah tampilan ini.
properties.pivots		PivotProperties[]	Konfigurasi 3 sub-tampilan di UI Analisis Biaya.
properties.query.dataSet		ReportConfigDataset	Memiliki definisi untuk data dalam konfigurasi laporan ini.
properties.query.includeMonetaryCommitment		boolean	Jika true, laporan menyertakan komitmen moneter.
properties.query.timePeriod		ReportConfigTimePeriod	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

Nama	Jenis	Deskripsi
200 OK	View	OK. Permintaan telah berhasil.
201 Created	View	Dibuat.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ResourceGroupCreateOrUpdateView

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample?api-version=2023-11-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

Status code:: 201

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

Status code:: 200

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

Nama	Deskripsi
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.
QueryColumnType	Jenis kolom dalam ekspor.
ReportConfigAggregation	Ekspresi agregasi yang akan digunakan 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 yang diperkirakan 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.

Nama	Jenis	Deskripsi
false	string
true	string

ChartType

Jenis bagan tampilan utama dalam Analisis Biaya. Wajib diisi.

Nama	Jenis	Deskripsi
Area	string
GroupedColumn	string
Line	string
StackedColumn	string
Table	string

ErrorDetails

Detail kesalahan.

Nama	Jenis	Deskripsi
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".

Nama	Jenis	Deskripsi
error	ErrorDetails	Detail kesalahan.

FunctionType

Nama fungsi agregasi yang akan digunakan.

Nama	Jenis	Deskripsi
Sum	string

KpiProperties

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

Nama	Jenis	Deskripsi
enabled	boolean	tampilkan KPI di UI?
id	string	ID sumber daya yang terkait dengan metrik (anggaran).
type	KpiTypeType	Jenis KPI (Prakiraan, Anggaran).

KpiTypeType

Jenis KPI (Prakiraan, Anggaran).

Nama	Jenis	Deskripsi
Budget	string
Forecast	string

MetricType

Metrik yang digunakan saat menampilkan biaya.

Nama	Jenis	Deskripsi
AHUB	string
ActualCost	string
AmortizedCost	string

OperatorType

Operator yang digunakan untuk perbandingan.

Nama	Jenis	Deskripsi
Contains	string
In	string

PivotProperties

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

Nama	Jenis	Deskripsi
name	string	Bidang data untuk ditampilkan dalam tampilan.
type	PivotTypeType	Jenis data untuk ditampilkan dalam tampilan.

PivotTypeType

Jenis data untuk ditampilkan dalam tampilan.

Nama	Jenis	Deskripsi
Dimension	string
TagKey	string

QueryColumnType

Jenis kolom dalam ekspor.

Nama	Jenis	Deskripsi
Dimension	string	Dimensi data biaya.
TagKey	string	Tag yang terkait dengan data biaya.

ReportConfigAggregation

Ekspresi agregasi yang akan digunakan dalam laporan.

Nama	Jenis	Deskripsi
function	FunctionType	Nama fungsi agregasi yang akan digunakan.
name	string	Nama kolom yang akan diagregasi.

ReportConfigComparisonExpression

Ekspresi perbandingan yang akan digunakan dalam laporan.

Nama	Jenis	Deskripsi
name	string	Nama kolom yang akan digunakan sebagai perbandingan.
operator	OperatorType	Operator yang digunakan untuk perbandingan.
values	string[]	Array nilai yang akan digunakan untuk perbandingan

ReportConfigDataset

Definisi data yang ada dalam laporan.

Nama	Jenis	Deskripsi
aggregation	<string, ReportConfigAggregation>	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	ReportConfigDatasetConfiguration	Memiliki informasi konfigurasi untuk data dalam laporan. Konfigurasi akan diabaikan jika agregasi dan pengelompokan disediakan.
filter	ReportConfigFilter	Memiliki ekspresi filter untuk digunakan dalam laporan.
granularity	ReportGranularityType	Granularitas baris dalam laporan.
grouping	ReportConfigGrouping[]	Array grup menurut ekspresi untuk digunakan dalam laporan. Laporan dapat memiliki hingga 2 kelompokkan menurut klausul.
sorting	ReportConfigSorting[]	Array urutan menurut ekspresi untuk digunakan dalam laporan.

ReportConfigDatasetConfiguration

Konfigurasi himpunan data dalam laporan.

Nama	Jenis	Deskripsi
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.

Nama	Jenis	Deskripsi
and	ReportConfigFilter[]	Ekspresi "AND" logis. Harus memiliki setidaknya 2 item.
dimensions	ReportConfigComparisonExpression	Memiliki ekspresi perbandingan untuk dimensi
or	ReportConfigFilter[]	Ekspresi "OR" logis. Harus memiliki setidaknya 2 item.
tags	ReportConfigComparisonExpression	Memiliki ekspresi perbandingan untuk tag

ReportConfigGrouping

Grup menurut ekspresi yang akan digunakan dalam laporan.

Nama	Jenis	Deskripsi
name	string	Nama kolom yang akan dikelompokkan. Versi ini mendukung langganan dengan kemungkinan grain terendah.
type	QueryColumnType	Memiliki jenis kolom untuk dikelompokkan.

ReportConfigSorting

Urutan berdasarkan ekspresi yang akan digunakan dalam laporan.

Nama	Jenis	Deskripsi
direction	ReportConfigSortingType	Arah semacam itu.
name	string	Nama kolom yang akan diurutkan.

ReportConfigSortingType

Arah semacam itu.

Nama	Jenis	Deskripsi
Ascending	string
Descending	string

ReportConfigTimePeriod

Tanggal mulai dan berakhir untuk menarik data untuk laporan.

Nama	Jenis	Deskripsi
from	string	Tanggal mulai untuk menarik data.
to	string	Tanggal akhir untuk menarik data.

ReportGranularityType

Granularitas baris dalam laporan.

Nama	Jenis	Deskripsi
Daily	string
Monthly	string

ReportTimeframeType

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

Nama	Jenis	Deskripsi
Custom	string
MonthToDate	string
WeekToDate	string
YearToDate	string

ReportType

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

Nama	Jenis	Deskripsi
Usage	string

View

Status dan konfigurasi Analisis Biaya.

Nama	Jenis	Deskripsi
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	AccumulatedType	Tampilkan akumulasi biaya dari waktu ke waktu.
properties.chart	ChartType	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	KpiProperties[]	Daftar KPI yang akan ditampilkan di UI Analisis Biaya.
properties.metric	MetricType	Metrik yang digunakan saat menampilkan biaya.
properties.modifiedOn	string	Tanggal saat pengguna terakhir mengubah tampilan ini.
properties.pivots	PivotProperties[]	Konfigurasi 3 sub-tampilan di UI Analisis Biaya.
properties.query.dataSet	ReportConfigDataset	Memiliki definisi untuk data dalam konfigurasi laporan ini.
properties.query.includeMonetaryCommitment	boolean	Jika true, laporan menyertakan komitmen moneter.
properties.query.timePeriod	ReportConfigTimePeriod	Memiliki periode waktu untuk menarik data untuk laporan.
properties.query.timeframe	ReportTimeframeType	Jangka waktu untuk menarik data untuk laporan. Jika kustom, maka periode waktu tertentu harus disediakan.
properties.query.type	ReportType	Jenis laporan. Penggunaan mewakili penggunaan aktual, prakiraan mewakili data yang diperkirakan 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