Benefit Recommendations - List

Referensi

Layanan:: Cost Management

Versi API:: 2023-11-01

Daftar rekomendasi untuk membeli paket penghematan.

GET https://management.azure.com/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations?api-version=2023-11-01

Dengan parameter opsional:

GET https://management.azure.com/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations?$filter={$filter}&$orderby={$orderby}&$expand={$expand}&api-version=2023-11-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
billingScope	path	True	string	Cakupan yang terkait dengan operasi rekomendasi manfaat. Ini termasuk '/subscriptions/{subscriptionId}/' untuk cakupan langganan, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' untuk cakupan grup sumber daya, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' untuk cakupan perjanjian perusahaan, dan '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' untuk cakupan profil penagihan
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.
$expand	query		string	Dapat digunakan untuk memperluas properti dengan: properties/usage, properties/allRecommendationDetails
$filter	query		string	Dapat digunakan untuk memfilter benefitRecommendations dengan: properties/scope dengan nilai yang diizinkan ['Single', 'Shared'] dan nilai default 'Shared'; dan properti/lookBackPeriod dengan nilai yang diizinkan ['Last7Days', 'Last30Days', 'Last60Days'] dan nilai default 'Last60Days'; properti/istilah dengan nilai yang diizinkan ['P1Y', 'P3Y'] dan nilai default 'P3Y'; properties/subscriptionId; properties/resourceGroup
$orderby	query		string	Dapat digunakan untuk memesan rekomendasi dengan: properties/armSkuName. Untuk paket penghematan, hasilnya berurutan secara default. Tidak perlu menggunakan klausul ini.

Respons

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

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

BenefitRecommendationsBillingAccountList

Permintaan sampel

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations?$filter=properties/lookBackPeriod eq 'Last7Days' AND properties/term eq 'P1Y'&$expand=properties/usage,properties/allRecommendationDetails&api-version=2023-11-01

Respon sampel

Kode status:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations/00000000-0000-0000-0000-000000000000",
      "name": "00000000-0000-0000-0000-000000000000",
      "type": "Microsoft.CostManagement/benefitRecommendations",
      "kind": "SavingsPlan",
      "properties": {
        "firstConsumptionDate": "2022-10-18T00:00:00Z",
        "lastConsumptionDate": "2022-10-25T00:00:00Z",
        "lookBackPeriod": "Last7Days",
        "totalHours": 168,
        "usage": {
          "usageGrain": "Hourly",
          "charges": [
            1,
            1,
            0,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            2,
            2,
            2,
            2
          ]
        },
        "armSkuName": "Compute_Savings_Plan",
        "term": "P1Y",
        "commitmentGranularity": "Hourly",
        "currencyCode": "USD",
        "costWithoutBenefit": 218.267,
        "scope": "Shared",
        "recommendationDetails": {
          "averageUtilizationPercentage": 99.33,
          "coveragePercentage": 54.609,
          "commitmentAmount": 0.164,
          "overageCost": 144.841,
          "benefitCost": 52.002,
          "savingsAmount": 21.424,
          "savingsPercentage": 9.815,
          "totalCost": 196.843,
          "wastageCost": 0.035
        },
        "allRecommendationDetails": {
          "value": [
            {
              "averageUtilizationPercentage": 99.33,
              "coveragePercentage": 54.609,
              "commitmentAmount": 0.164,
              "overageCost": 144.841,
              "benefitCost": 52.002,
              "savingsAmount": 21.424,
              "savingsPercentage": 9.815,
              "totalCost": 196.843,
              "wastageCost": 0.035
            },
            {
              "averageUtilizationPercentage": 81.474,
              "coveragePercentage": 56.748,
              "commitmentAmount": 0.161,
              "overageCost": 120.389,
              "benefitCost": 83.754,
              "savingsAmount": 14.124,
              "savingsPercentage": 6.47,
              "totalCost": 204.143,
              "wastageCost": 0.1
            }
          ]
        }
      }
    }
  ]
}

Definisi

Nama	Deskripsi
allSavingsBenefitDetails	Detail rekomendasi manfaat.
allSavingsList	Daftar semua rekomendasi manfaat dengan detail rekomendasi.
benefitKind	Reservasi atau SavingsPlan.
benefitRecommendationModel	detail rekomendasi rencana manfaat.
benefitRecommendationsListResult	Hasil daftar rekomendasi manfaat.
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 untuk sementara tidak tersedia. Coba lagi setelah menunggu selama waktu yang ditentukan di header "Coba Lagi Setelah".
grain	Butir penggunaan. Nilai yang didukung: 'Per Jam'
lookBackPeriod	Jumlah hari penggunaan yang dievaluasi untuk menghitung rekomendasi.
recommendationUsageDetails	Biaya sesuai permintaan antara firstConsumptionDate dan lastConsumptionDate yang digunakan untuk menghitung rekomendasi manfaat.
sharedScopeBenefitRecommendationProperties	Properti rekomendasi manfaat saat cakupan adalah 'Bersama'.
singleScopeBenefitRecommendationProperties	Properti rekomendasi manfaat saat cakupan adalah 'Tunggal'.
term	Periode jangka waktu manfaat. Misalnya, P1Y atau P3Y.

allSavingsBenefitDetails

Detail rekomendasi manfaat.

Nama	Jenis	Deskripsi
averageUtilizationPercentage	number	Estimasi persentase pemanfaatan rata-rata untuk 'totalHours' dalam periode look-back, dengan komitmen ini.
benefitCost	number	Perkiraan biaya dengan manfaat untuk 'totalHours' dalam periode look-back. Ini sama dengan (commitmentAmount * totalHours)
commitmentAmount	number	Jumlah komitmen pada commitmentGranularity.
coveragePercentage	number	Estimasi persentase cakupan manfaat untuk 'totalHours' dalam periode look-back, dengan komitmen ini.
overageCost	number	Perbedaan antara total biaya dan biaya manfaat untuk 'totalHours' dalam periode look-back.
savingsAmount	number	Jumlah yang disimpan untuk 'totalHours' dalam periode look-back, dengan membeli kuantitas manfaat yang direkomendasikan.
savingsPercentage	number	Penghematan persentase untuk 'totalHours' dalam periode look-back, dengan membeli kuantitas manfaat yang direkomendasikan.
totalCost	number	Total biaya, yang merupakan jumlah biaya manfaat dan biaya kelebihan penggunaan.
wastageCost	number	Estimasi bagian yang tidak digunakan dari 'benefitCost'.

allSavingsList

Daftar semua rekomendasi manfaat dengan detail rekomendasi.

Nama	Jenis	Deskripsi
nextLink	string	Tautan (URL) ke halaman hasil berikutnya.
value	allSavingsBenefitDetails[]	Daftar rekomendasi manfaat dengan detail rekomendasi..

benefitKind

Reservasi atau SavingsPlan.

Nama	Jenis	Deskripsi
IncludedQuantity	string	Manfaatnya adalah IncludedQuantity.
Reservation	string	Manfaatnya adalah Reservasi.
SavingsPlan	string	Manfaatnya adalah SavingsPlan.

benefitRecommendationModel

detail rekomendasi rencana manfaat.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	benefitKind	Reservasi atau SavingsPlan.
name	string	Nama sumber daya.
properties	benefitRecommendationProperties: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	Properti rekomendasi manfaat.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

benefitRecommendationsListResult

Hasil daftar rekomendasi manfaat.

Nama	Jenis	Deskripsi
nextLink	string	Tautan (URL) ke halaman hasil berikutnya.
value	benefitRecommendationModel[]	Daftar rekomendasi manfaat.

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 untuk sementara tidak tersedia. Coba lagi setelah menunggu selama waktu yang ditentukan di header "Coba Lagi Setelah".

Nama	Jenis	Deskripsi
error	ErrorDetails	Detail kesalahan.

grain

Butir penggunaan. Nilai yang didukung: 'Per Jam'

Nama	Jenis	Deskripsi
Daily	string	Butir per jam sesuai dengan nilai per hari.
Hourly	string	Butir per jam sesuai dengan nilai per jam.
Monthly	string	Butir per jam sesuai dengan nilai per bulan.

lookBackPeriod

Jumlah hari penggunaan yang dievaluasi untuk menghitung rekomendasi.

Nama	Jenis	Deskripsi
Last30Days	string	30 hari digunakan untuk melihat ke belakang.
Last60Days	string	60 hari digunakan untuk melihat ke belakang.
Last7Days	string	7 hari digunakan untuk melihat ke belakang.

recommendationUsageDetails

Biaya sesuai permintaan antara firstConsumptionDate dan lastConsumptionDate yang digunakan untuk menghitung rekomendasi manfaat.

Nama	Jenis	Deskripsi
charges	number[]	Biaya sesuai permintaan untuk setiap jam antara firstConsumptionDate dan lastConsumptionDate yang digunakan untuk menghitung rekomendasi manfaat.
usageGrain	grain	Butir penggunaan. Nilai yang didukung: 'Per Jam'

sharedScopeBenefitRecommendationProperties

Properti rekomendasi manfaat saat cakupan adalah 'Bersama'.

Nama	Jenis	Deskripsi
allRecommendationDetails	allSavingsList	Daftar semua rekomendasi manfaat dengan detail rekomendasi.
armSkuName	string	Nama ARM SKU. 'Compute_Savings_Plan' untuk SavingsPlan.
commitmentGranularity	grain	Butir dari jumlah komitmen yang diusulkan. Nilai yang didukung: 'Per Jam'
costWithoutBenefit	number	Biaya saat ini tanpa manfaat, sesuai dengan 'totalHours' dalam periode look-back.
currencyCode	string	Pengidentifikasi kode mata uang ISO 4217 untuk biaya dan jumlah penghematan.
firstConsumptionDate	string	Tanggal penggunaan pertama yang digunakan untuk mencari kembali komputasi rekomendasi.
lastConsumptionDate	string	Tanggal penggunaan terakhir yang digunakan untuk mencari kembali komputasi rekomendasi.
lookBackPeriod	lookBackPeriod	Jumlah hari penggunaan yang dievaluasi untuk menghitung rekomendasi.
recommendationDetails	allSavingsBenefitDetails	Detail rekomendasi yang diusulkan.
scope	string: Shared	Cakupan manfaat. Misalnya, Tunggal atau Bersama.
term	term	Periode jangka waktu manfaat. Misalnya, P1Y atau P3Y.
totalHours	integer	Total jam yang biayanya tercakup. Sama dengan jumlah rekaman dalam properti 'properties/usage/charges'.
usage	recommendationUsageDetails	Biaya sesuai permintaan antara firstConsumptionDate dan lastConsumptionDate yang digunakan untuk menghitung rekomendasi manfaat.

singleScopeBenefitRecommendationProperties

Properti rekomendasi manfaat saat cakupan adalah 'Tunggal'.

Nama	Jenis	Deskripsi
allRecommendationDetails	allSavingsList	Daftar semua rekomendasi manfaat dengan detail rekomendasi.
armSkuName	string	Nama ARM SKU. 'Compute_Savings_Plan' untuk SavingsPlan.
commitmentGranularity	grain	Butir dari jumlah komitmen yang diusulkan. Nilai yang didukung: 'Per Jam'
costWithoutBenefit	number	Biaya saat ini tanpa manfaat, sesuai dengan 'totalHours' dalam periode look-back.
currencyCode	string	Pengidentifikasi kode mata uang ISO 4217 untuk biaya dan jumlah penghematan.
firstConsumptionDate	string	Tanggal penggunaan pertama yang digunakan untuk mencari kembali komputasi rekomendasi.
lastConsumptionDate	string	Tanggal penggunaan terakhir yang digunakan untuk mencari kembali komputasi rekomendasi.
lookBackPeriod	lookBackPeriod	Jumlah hari penggunaan yang dievaluasi untuk menghitung rekomendasi.
recommendationDetails	allSavingsBenefitDetails	Detail rekomendasi yang diusulkan.
resourceGroup	string	Grup sumber daya untuk rekomendasi cakupan tunggal ini. Hanya berlaku jika rekomendasi adalah untuk cakupan 'Tunggal' dan cakupan permintaan 'ResourceGroup'.
scope	string: Single	Cakupan manfaat. Misalnya, Tunggal atau Bersama.
subscriptionId	string	ID langganan untuk rekomendasi cakupan tunggal ini. Hanya berlaku jika rekomendasi adalah untuk cakupan 'Tunggal'.
term	term	Periode jangka waktu manfaat. Misalnya, P1Y atau P3Y.
totalHours	integer	Total jam yang biayanya tercakup. Sama dengan jumlah rekaman dalam properti 'properties/usage/charges'.
usage	recommendationUsageDetails	Biaya sesuai permintaan antara firstConsumptionDate dan lastConsumptionDate yang digunakan untuk menghitung rekomendasi manfaat.

term

Periode jangka waktu manfaat. Misalnya, P1Y atau P3Y.

Nama	Jenis	Deskripsi
P1Y	string	Jangka waktu manfaat adalah 1 tahun.
P3Y	string	Jangka waktu manfaat adalah 3 tahun.

Bagikan melalui