你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Savings Plan - Get

获取节省计划。

GET https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}?api-version=2022-11-01
GET https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}?api-version=2022-11-01&$expand={$expand}

URI 参数

名称 必需 类型 说明
savingsPlanId
path True

string

节省计划的 ID

savingsPlanOrderId
path True

string

节省计划的订单 ID

api-version
query True

string

服务要使用的 api 版本

$expand
query

string

可用于扩展某些属性的详细信息。

响应

名称 类型 说明
200 OK

SavingsPlanModel

请求已完成。

Other Status Codes

ErrorResponse

意外错误。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

SavingsPlanItemGet
SavingsPlanItemWithExpandedRenewPropertiesGet

SavingsPlanItemGet

示例请求

GET https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000?api-version=2022-11-01

示例响应

{
  "id": "/providers/microsoft.billingbenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000",
  "name": "20000000-0000-0000-0000-000000000000/30000000-0000-0000-0000-000000000000",
  "type": "Microsoft.BillingBenefits/savingsPlanOrders/savingsPlans",
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "properties": {
    "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000009",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31/billingProfiles/KPSV-DWNE-BG7-TGB",
    "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31",
    "billingPlan": "P1M",
    "commitment": {
      "grain": "Hourly",
      "currencyCode": "USD",
      "amount": 0.001
    },
    "renew": true,
    "appliedScopeType": "Shared",
    "displayName": "Compute_SavingsPlan_patch_rename2",
    "provisioningState": "Succeeded",
    "term": "P3Y",
    "displayProvisioningState": "Succeeded",
    "userFriendlyAppliedScopeType": "Shared",
    "expiryDateTime": "2025-10-18T21:16:13.1854959Z",
    "purchaseDateTime": "2022-10-18T21:14:26.8279361Z",
    "effectiveDateTime": "2022-10-21T18:15:42.4098626Z",
    "utilization": {
      "trend": "",
      "aggregates": [
        {
          "grain": 1,
          "grainUnit": "days",
          "value": 100,
          "valueUnit": "percentage"
        },
        {
          "grain": 7,
          "grainUnit": "days",
          "value": 84,
          "valueUnit": "percentage"
        },
        {
          "grain": 30,
          "grainUnit": "days",
          "value": 83.87,
          "valueUnit": "percentage"
        }
      ]
    }
  }
}

SavingsPlanItemWithExpandedRenewPropertiesGet

示例请求

GET https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000?api-version=2022-11-01&$expand=renewProperties

示例响应

{
  "id": "/providers/microsoft.billingbenefits/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000",
  "name": "20000000-0000-0000-0000-000000000000/30000000-0000-0000-0000-000000000000",
  "type": "Microsoft.BillingBenefits/savingsPlanOrders/savingsPlans",
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "properties": {
    "billingScopeId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000009",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31/billingProfiles/KPSV-DWNE-BG7-TGB",
    "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/20000000-1000-0000-0000-000000000000:20000000-0000-3000-0000-000000000000_2019-05-31",
    "billingPlan": "P1M",
    "commitment": {
      "grain": "Hourly",
      "currencyCode": "USD",
      "amount": 0.001
    },
    "renew": true,
    "appliedScopeType": "Shared",
    "displayName": "Compute_SavingsPlan_patch_rename2",
    "provisioningState": "Succeeded",
    "term": "P3Y",
    "displayProvisioningState": "Succeeded",
    "userFriendlyAppliedScopeType": "Shared",
    "expiryDateTime": "2025-10-18T21:16:13.1854959Z",
    "purchaseDateTime": "2022-10-18T21:14:26.8279361Z",
    "effectiveDateTime": "2022-10-21T18:15:42.4098626Z",
    "utilization": {
      "trend": "",
      "aggregates": [
        {
          "grain": 1,
          "grainUnit": "days",
          "value": 100,
          "valueUnit": "percentage"
        },
        {
          "grain": 7,
          "grainUnit": "days",
          "value": 84,
          "valueUnit": "percentage"
        },
        {
          "grain": 30,
          "grainUnit": "days",
          "value": 83.87,
          "valueUnit": "percentage"
        }
      ]
    },
    "renewProperties": {
      "purchaseProperties": {
        "sku": {
          "name": "Compute_Savings_Plan"
        },
        "properties": {
          "billingScopeId": "/subscriptions/eef82110-c91b-4395-9420-fcfcbefc5a47",
          "term": "P1Y",
          "billingPlan": "Upfront",
          "displayName": "Compute_SavingsPlan_patch_rename2_renewed",
          "appliedScopeType": "Shared",
          "commitment": {
            "grain": "Hourly",
            "currencyCode": "USD",
            "amount": 0.001
          }
        }
      }
    }
  }
}

定义

名称 说明
AppliedScopeProperties

特定于所应用范围类型的属性。 如果不适用,则不需要。

AppliedScopeType

应用范围的类型。

BillingPlan

表示 ISO 8601 格式的计费计划。 仅适用于按月计费计划。

Commitment

对权益的承诺。

CommitmentGrain

承诺粒度。

createdByType

创建资源的标识类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ExtendedStatusInfo
ProvisioningState

正在设置状态

PurchaseRequest
RenewProperties
SavingsPlanModel

节省计划

Sku

要为此资源应用的 SKU

systemData

与资源的创建和上次修改相关的元数据。

Term

以 ISO 8601 格式表示权益术语。

Utilization

节省计划利用率

UtilizationAggregates

节省计划利用率的聚合值

AppliedScopeProperties

特定于所应用范围类型的属性。 如果不适用,则不需要。

名称 类型 说明
displayName

string

显示名称

managementGroupId

string

必须应用权益的管理组的完全限定标识符。

resourceGroupId

string

资源组的完全限定标识符。

subscriptionId

string

订阅的完全限定标识符。

tenantId

string

应用权益的租户 ID。

AppliedScopeType

应用范围的类型。

名称 类型 说明
ManagementGroup

string

Shared

string

Single

string

BillingPlan

表示 ISO 8601 格式的计费计划。 仅适用于按月计费计划。

名称 类型 说明
P1M

string

Commitment

对权益的承诺。

名称 类型 说明
amount

number

currencyCode

string

此购买记录使用的货币的 ISO 4217 3 字母货币代码。

grain

CommitmentGrain

承诺粒度。

CommitmentGrain

承诺粒度。

名称 类型 说明
Hourly

string

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ExtendedStatusInfo

名称 类型 说明
message

string

提供有关状态代码的详细信息的消息。

statusCode

string

提供其他信息的状态代码。

ProvisioningState

正在设置状态

名称 类型 说明
Cancelled

string

ConfirmedBilling

string

Created

string

Creating

string

Expired

string

Failed

string

PendingBilling

string

Succeeded

string

PurchaseRequest

名称 类型 默认值 说明
properties.appliedScopeProperties

AppliedScopeProperties

特定于所应用范围类型的属性。 如果不适用,则不需要。

properties.appliedScopeType

AppliedScopeType

应用范围的类型。

properties.billingPlan

BillingPlan

表示 ISO 8601 格式的计费计划。 仅适用于按月计费计划。

properties.billingScopeId

string

购买权益时将收取费用的订阅

properties.commitment

Commitment

对权益的承诺。

properties.displayName

string

节省计划的友好名称

properties.effectiveDateTime

string

节省计划的 DateTime 开始提供权益。

properties.renew

boolean

False

将其设置为 true 将在到期日期时间自动购买新权益。

properties.term

Term

以 ISO 8601 格式表示权益术语。

sku

Sku

要为此资源应用的 SKU

RenewProperties

名称 类型 说明
purchaseProperties

PurchaseRequest

SavingsPlanModel

节省计划

名称 类型 默认值 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.appliedScopeProperties

AppliedScopeProperties

特定于所应用范围类型的属性。 如果不适用,则不需要。

properties.appliedScopeType

AppliedScopeType

应用范围的类型。

properties.benefitStartTime

string

这是节省计划权益开始时的 DateTime。

properties.billingAccountId

string

应用节省计划的计费帐户的完全限定标识符。 仅适用于企业协议客户。

properties.billingPlan

BillingPlan

表示 ISO 8601 格式的计费计划。 仅适用于按月计费计划。

properties.billingProfileId

string

应用节省计划的计费配置文件的完全限定标识符。 仅适用于现场引导或客户引导的客户。

properties.billingScopeId

string

购买权益时将收取费用的订阅

properties.commitment

Commitment

对权益的承诺。

properties.customerId

string

应用节省计划的客户的完全限定标识符。 仅向合作伙伴引导的客户提供。

properties.displayName

string

显示名称

properties.displayProvisioningState

string

要显示的节省计划的预配状态,例如成功

properties.effectiveDateTime

string

节省计划的 DateTime 开始提供权益。

properties.expiryDateTime

string

到期日期时间

properties.extendedStatusInfo

ExtendedStatusInfo

properties.provisioningState

ProvisioningState

正在设置状态

properties.purchaseDateTime

string

购买节省计划的日期时间

properties.renew

boolean

False

将其设置为 true 将在到期日期时间自动购买新权益。

properties.renewDestination

string

由于续订而购买的 SavingsPlan 的 SavingsPlan ID。

properties.renewProperties

RenewProperties

properties.renewSource

string

从中续订此 SavingsPlan 的 SavingsPlan 的 SavingsPlan ID。

properties.term

Term

以 ISO 8601 格式表示权益术语。

properties.userFriendlyAppliedScopeType

string

用于显示的节省计划的应用范围类型,例如共享

properties.utilization

Utilization

节省计划利用率

sku

Sku

节省计划 SKU

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

Sku

要为此资源应用的 SKU

名称 类型 说明
name

string

要应用的 SKU 的名称

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。

Term

以 ISO 8601 格式表示权益术语。

名称 类型 说明
P1Y

string

P3Y

string

P5Y

string

Utilization

节省计划利用率

名称 类型 说明
aggregates

UtilizationAggregates[]

节省计划利用率的聚合数组

trend

string

节省计划的天数趋势

UtilizationAggregates

节省计划利用率的聚合值

名称 类型 说明
grain

number

聚合的粒度

grainUnit

string

聚合的粒度单位

value

number

聚合值

valueUnit

string

聚合值单位