Savings Plans - Get By Billing Account

Layanan:: Billing

Versi API:: 2024-04-01

Dapatkan paket penghematan dengan akun penagihan.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}?api-version=2024-04-01

Dengan parameter opsional:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}?api-version=2024-04-01&expand={expand}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
billingAccountName	path	True	string pattern: ^([0-9]+\|([Pp][Cc][Nn]\.[A-Za-z0-9]+)\|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$	ID yang secara unik mengidentifikasi akun penagihan.
savingsPlanId	path	True	string	ID dari paket penghematan
savingsPlanOrderId	path	True	string	ID Pesanan dari paket penghematan
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.
expand	query		string	Dapat digunakan untuk memperluas planInformation.

Respons

Nama	Jenis	Deskripsi
200 OK	SavingsPlanModel	Operasi Azure berhasil diselesaikan.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

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

SavingsPlanGet

SavingsPlanGetExpandRenewProperties

SavingsPlanGet

Permintaan sampel

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000?api-version=2024-04-01

Respon sampel

Kode status:: 200

{
  "name": "30000000-0000-0000-0000-000000000000",
  "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans",
  "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000",
  "properties": {
    "appliedScopeProperties": {
      "displayName": "TestRg",
      "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg",
      "tenantId": "70000000-0000-0000-0000-000000000000"
    },
    "appliedScopeType": "ManagementGroup",
    "benefitStartTime": "2022-11-16T02:25:11.7183866Z",
    "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
    "billingPlan": "P1M",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD",
    "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000",
    "commitment": {
      "amount": 0.001,
      "currencyCode": "USD",
      "grain": "Hourly"
    },
    "displayName": "SP1",
    "displayProvisioningState": "NoBenefit",
    "effectiveDateTime": "2022-12-16T01:35:36.2909462Z",
    "expiryDateTime": "2025-11-16T02:25:11.7183866Z",
    "productCode": "20000000-0000-0000-0000-000000000005",
    "provisioningState": "Succeeded",
    "purchaseDateTime": "2022-11-16T02:23:21.3864783Z",
    "renew": false,
    "term": "P3Y",
    "userFriendlyAppliedScopeType": "ManagementGroup",
    "utilization": {
      "aggregates": [
        {
          "grain": 1,
          "grainUnit": "days",
          "value": 0,
          "valueUnit": "percentage"
        },
        {
          "grain": 7,
          "grainUnit": "days",
          "value": 0,
          "valueUnit": "percentage"
        },
        {
          "grain": 30,
          "grainUnit": "days",
          "value": 0,
          "valueUnit": "percentage"
        }
      ],
      "trend": "SAME"
    }
  },
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "tags": {
    "key1": "value1",
    "key2": "value2"
  }
}

SavingsPlanGetExpandRenewProperties

Permintaan sampel

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000?api-version=2024-04-01

Respon sampel

Kode status:: 200

{
  "name": "30000000-0000-0000-0000-000000000000",
  "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans",
  "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000",
  "properties": {
    "appliedScopeProperties": {
      "displayName": "TestRg",
      "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg",
      "tenantId": "70000000-0000-0000-0000-000000000000"
    },
    "appliedScopeType": "ManagementGroup",
    "benefitStartTime": "2022-11-16T02:25:11.7183866Z",
    "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
    "billingPlan": "P1M",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD",
    "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000",
    "commitment": {
      "amount": 0.001,
      "currencyCode": "USD",
      "grain": "Hourly"
    },
    "displayName": "SP1",
    "displayProvisioningState": "NoBenefit",
    "effectiveDateTime": "2022-12-16T01:35:36.2909462Z",
    "expiryDateTime": "2025-11-16T02:25:11.7183866Z",
    "productCode": "20000000-0000-0000-0000-000000000005",
    "provisioningState": "Succeeded",
    "purchaseDateTime": "2022-11-16T02:23:21.3864783Z",
    "renew": false,
    "renewProperties": {
      "purchaseProperties": {
        "properties": {
          "appliedScopeProperties": {
            "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg",
            "tenantId": "70000000-0000-0000-0000-000000000000"
          },
          "appliedScopeType": "ManagementGroup",
          "billingPlan": "Monthly",
          "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000",
          "commitment": {
            "amount": 0.001,
            "currencyCode": "USD",
            "grain": "Hourly"
          },
          "displayName": "SP1_renewed",
          "term": "P3Y"
        },
        "sku": {
          "name": "Compute_Savings_Plan"
        }
      }
    },
    "term": "P3Y",
    "userFriendlyAppliedScopeType": "ManagementGroup",
    "utilization": {
      "aggregates": [
        {
          "grain": 1,
          "grainUnit": "days",
          "value": 0,
          "valueUnit": "percentage"
        },
        {
          "grain": 7,
          "grainUnit": "days",
          "value": 0,
          "valueUnit": "percentage"
        },
        {
          "grain": 30,
          "grainUnit": "days",
          "value": 0,
          "valueUnit": "percentage"
        }
      ],
      "trend": "SAME"
    }
  },
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "tags": {
    "key1": "value1",
    "key2": "value2"
  }
}

Definisi

Nama	Deskripsi
AppliedScopeProperties	Properti khusus untuk jenis cakupan yang diterapkan. Tidak diperlukan jika tidak berlaku.
AppliedScopeType	Jenis Cakupan yang Diterapkan.
BillingPlan	Mewakili paket penagihan dalam format ISO 8601. Diperlukan hanya untuk pembelian bulanan.
Commitment	Komitmen terhadap manfaat.
CommitmentGrain	Biji-bijian komitmen.
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
ExtendedStatusInfo	Informasi status diperpanjang
ProvisioningState	Status provisi sumber daya selama operasi yang berjalan lama.
PurchaseRequest	Permintaan pembelian.
RenewProperties	Properti khusus untuk diperpanjang.
SavingsPlanModel	Paket penghematan
SavingsPlanTerm	Mewakili istilah Savings plan dalam format ISO 8601.
Sku	SKU yang akan diterapkan untuk sumber daya ini
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
Utilization	Pemanfaatan rencana penghematan
UtilizationAggregates	Nilai agregat pemanfaatan rencana penghematan

AppliedScopeProperties

Objek

Properti khusus untuk jenis cakupan yang diterapkan. Tidak diperlukan jika tidak berlaku.

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan
managementGroupId	string	Pengidentifikasi yang sepenuhnya memenuhi syarat dari grup manajemen tempat manfaat diterapkan.
resourceGroupId	string	Pengidentifikasi yang sepenuhnya memenuhi syarat dari grup sumber daya tempat manfaat diterapkan.
subscriptionId	string	Pengidentifikasi langganan yang sepenuhnya memenuhi syarat tempat manfaat diterapkan.
tenantId	string	ID Penyewa tempat paket penghematan tempat manfaat diterapkan.

AppliedScopeType

Enumerasi

Jenis Cakupan yang Diterapkan.

Nilai	Deskripsi
Single	Single
Shared	Dibagikan
ManagementGroup	ManagementGroup

BillingPlan

Enumerasi

Mewakili paket penagihan dalam format ISO 8601. Diperlukan hanya untuk pembelian bulanan.

Nilai	Deskripsi
P1M	P1M

Commitment

Objek

Komitmen terhadap manfaat.

Nama	Jenis	Deskripsi
amount	number (double)
currencyCode	string	Kode mata uang ISO 4217 3 huruf untuk mata uang yang digunakan oleh catatan pembelian ini.
grain	CommitmentGrain	Biji-bijian komitmen.

CommitmentGrain

Enumerasi

Biji-bijian komitmen.

Nilai	Deskripsi
Hourly	Per jam kerja

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ExtendedStatusInfo

Objek

Informasi status diperpanjang

Nama	Jenis	Deskripsi
message	string	Pesan yang memberikan informasi terperinci tentang kode status.
properties.subscriptionId	string	Langganan yang gagal melakukan pemeriksaan baris kredit.
statusCode	string	Kode status yang memberikan informasi tambahan.

ProvisioningState

Enumerasi

Status provisi sumber daya selama operasi yang berjalan lama.

Nilai	Deskripsi
Succeeded	Berhasil
Canceled	Dibatalkan
Failed	Kegagalan
New	Baru
Pending	Pending
Provisioning	Provisioning
PendingBilling	Penagihan Tertunda
ConfirmedBilling	Penagihan yang Dikonfirmasi
Creating	Membuat
Created	Telah dibuat
Expired	Kedaluwarsa

PurchaseRequest

Objek

Permintaan pembelian.

Nama	Jenis	Nilai default	Deskripsi
properties.appliedScopeProperties	AppliedScopeProperties		Properti khusus untuk jenis cakupan yang diterapkan. Tidak diperlukan jika tidak berlaku.
properties.appliedScopeType	AppliedScopeType		Jenis Cakupan yang Diterapkan.
properties.billingPlan	BillingPlan		Mewakili paket penagihan dalam format ISO 8601. Diperlukan hanya untuk pembelian bulanan.
properties.billingScopeId	string		Langganan yang akan dikenakan untuk pembelian SavingsPlan
properties.commitment	Commitment		Komitmen terhadap manfaat.
properties.displayName	string		Nama yang mudah diingat dari rencana penghematan
properties.renew	boolean	False	Mengatur ini ke true akan secara otomatis membeli manfaat baru pada waktu tanggal kedaluwarsa.
properties.term	SavingsPlanTerm		Mewakili istilah Savings plan dalam format ISO 8601.
sku	Sku		SKU yang akan diterapkan untuk sumber daya ini

RenewProperties

Objek

Properti khusus untuk diperpanjang.

Nama	Jenis	Deskripsi
purchaseProperties	PurchaseRequest	Permintaan pembelian.

SavingsPlanModel

Objek

Paket penghematan

Nama	Jenis	Nilai default	Deskripsi
id	string (arm-id)		ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Nama sumber daya
properties.appliedScopeProperties	AppliedScopeProperties		Properti khusus untuk jenis cakupan yang diterapkan. Tidak diperlukan jika tidak berlaku.
properties.appliedScopeType	AppliedScopeType		Jenis Cakupan yang Diterapkan.
properties.benefitStartTime	string (date-time)		Ini adalah DateTime ketika manfaat paket penghematan dimulai.
properties.billingAccountId	string		Pengidentifikasi akun penagihan yang sepenuhnya memenuhi syarat tempat paket penghematan diterapkan.
properties.billingPlan	BillingPlan		Mewakili paket penagihan dalam format ISO 8601. Diperlukan hanya untuk pembelian bulanan.
properties.billingProfileId	string		Pengidentifikasi profil penagihan yang sepenuhnya memenuhi syarat tempat paket penghematan diterapkan. Hadir hanya untuk pelanggan yang dipimpin Lapangan atau yang dipimpin Pelanggan.
properties.billingScopeId	string		Langganan yang akan dikenakan untuk pembelian SavingsPlan
properties.commitment	Commitment		Komitmen terhadap manfaat.
properties.customerId	string		Pengidentifikasi pelanggan yang sepenuhnya memenuhi syarat tempat paket penghematan diterapkan. Hadir hanya untuk pelanggan yang dipimpin Mitra.
properties.displayName	string		Nama tampilan
properties.displayProvisioningState	string		Status penyediaan paket penghematan untuk ditampilkan, misalnya Berhasil
properties.effectiveDateTime	string (date-time)		TanggalWaktu dari paket penghematan dimulai ketika versi ini berlaku.
properties.expiryDateTime	string (date-time)		Ini adalah tanggal-waktu ketika paket penghematan akan kedaluwarsa.
properties.extendedStatusInfo	ExtendedStatusInfo		Informasi status diperpanjang
properties.productCode	string		Mewakili UPN
properties.provisioningState	ProvisioningState		Status provisi sumber daya selama operasi yang berjalan lama.
properties.purchaseDateTime	string (date-time)		Waktu tanggal ketika paket penghematan dibeli.
properties.renew	boolean	False	Mengatur ini ke true akan secara otomatis membeli manfaat baru pada waktu tanggal kedaluwarsa.
properties.renewDestination	string		SavingsPlan Id dari SavingsPlan yang dibeli karena perpanjangan.
properties.renewProperties	RenewProperties		Properti khusus untuk diperpanjang.
properties.renewSource	string		SavingsPlan Id dari SavingsPlan tempat SavingsPlan ini diperpanjang.
properties.term	SavingsPlanTerm		Mewakili istilah Savings plan dalam format ISO 8601.
properties.userFriendlyAppliedScopeType	string		Jenis cakupan yang diterapkan dari paket penghematan untuk tampilan, misalnya Bersama
properties.utilization	Utilization		Pemanfaatan rencana penghematan
sku	Sku		SKU paket penghematan
systemData	systemData		Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
tags	object		Kamus metadata yang terkait dengan sumber daya. Ini mungkin tidak diisi untuk semua jenis sumber daya. Panjang kunci/nilai maksimum yang didukung 256 karakter. Kunci/nilai tidak boleh kosong nilai atau null. Kunci tidak dapat berisi <> % & \ ? /
type	string		Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

SavingsPlanTerm

Enumerasi

Mewakili istilah Savings plan dalam format ISO 8601.

Nilai	Deskripsi
P1Y	P1Y
P3Y	P3Y
P5Y	P5Y

Sku

Objek

SKU yang akan diterapkan untuk sumber daya ini

Nama	Jenis	Deskripsi
name	string	Nama SKU yang akan diterapkan

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

Utilization

Objek

Pemanfaatan rencana penghematan

Nama	Jenis	Deskripsi
aggregates	UtilizationAggregates[]	Array agregat pemanfaatan paket penghematan
trend	string	Tren untuk pemanfaatan paket penghematan

UtilizationAggregates

Objek

Nilai agregat pemanfaatan rencana penghematan

Nama	Jenis	Deskripsi
grain	number (float)	Butir agregat
grainUnit	string	Unit butir agregat
value	number (float)	Nilai agregat
valueUnit	string	Unit nilai agregat

Bagikan melalui

Savings Plans - Get By Billing Account

Parameter URI

Respons

Keamanan

azure_auth

Cakupan

Contoh

SavingsPlanGet

Permintaan sampel

Respon sampel

SavingsPlanGetExpandRenewProperties

Permintaan sampel

Respon sampel

Definisi

AppliedScopeProperties

AppliedScopeType

BillingPlan

Commitment

CommitmentGrain

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedStatusInfo

ProvisioningState

PurchaseRequest

RenewProperties

SavingsPlanModel

SavingsPlanTerm

Sku

systemData

Utilization

UtilizationAggregates