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

Savings Plan Order Alias - Get

Service:

Billing Benefits

API Version:

2022-11-01

获取节省计划。

GET https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrderAliases/{savingsPlanOrderAliasName}?api-version=2022-11-01

URI 参数

名称	在	必需	类型	说明
savingsPlanOrderAliasName	path	True	string	节省计划订单别名的名称 Regex pattern: ^[a-zA-Z0-9_\-\.]+$
api-version	query	True	string	服务要使用的 api-version

响应

名称	类型	说明
200 OK	SavingsPlanOrderAliasModel	请求已完成。
Other Status Codes	ErrorResponse	意外错误。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

SavingsPlanOrderAliasGet

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrderAliases/spAlias123?api-version=2022-11-01

Java

/** Samples for SavingsPlanOrderAlias Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderAliasGet.json
     */
    /**
     * Sample code: SavingsPlanOrderAliasGet.
     *
     * @param manager Entry point to BillingBenefitsManager.
     */
    public static void savingsPlanOrderAliasGet(
        com.azure.resourcemanager.billingbenefits.BillingBenefitsManager manager) {
        manager.savingsPlanOrderAlias().getWithResponse("spAlias123", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.billingbenefits import BillingBenefitsRP

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billingbenefits
# USAGE
    python savings_plan_order_alias_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BillingBenefitsRP(
        credential=DefaultAzureCredential(),
    )

    response = client.savings_plan_order_alias.get(
        savings_plan_order_alias_name="spAlias123",
    )
    print(response)


# x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderAliasGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armbillingbenefits_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billingbenefits/armbillingbenefits/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderAliasGet.json
func ExampleSavingsPlanOrderAliasClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbillingbenefits.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSavingsPlanOrderAliasClient().Get(ctx, "spAlias123", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SavingsPlanOrderAliasModel = armbillingbenefits.SavingsPlanOrderAliasModel{
	// 	Name: to.Ptr("spAlias123"),
	// 	Type: to.Ptr("Microsoft.BillingBenefits/savingsPlanOrderAliases"),
	// 	ID: to.Ptr("/providers/microsoft.billingbenefits/savingsPlanOrderAliases/spAlias123"),
	// 	Properties: &armbillingbenefits.SavingsPlanOrderAliasProperties{
	// 		AppliedScopeProperties: &armbillingbenefits.AppliedScopeProperties{
	// 			ResourceGroupID: to.Ptr("/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/testrg"),
	// 		},
	// 		AppliedScopeType: to.Ptr(armbillingbenefits.AppliedScopeTypeSingle),
	// 		BillingPlan: to.Ptr(armbillingbenefits.BillingPlanP1M),
	// 		BillingScopeID: to.Ptr("/subscriptions/10000000-0000-0000-0000-000000000000"),
	// 		Commitment: &armbillingbenefits.Commitment{
	// 			Amount: to.Ptr[float64](15.23),
	// 			CurrencyCode: to.Ptr("USD"),
	// 			Grain: to.Ptr(armbillingbenefits.CommitmentGrainHourly),
	// 		},
	// 		DisplayName: to.Ptr("ComputeSavingsPlan_2021-07-01"),
	// 		ProvisioningState: to.Ptr(armbillingbenefits.ProvisioningStateSucceeded),
	// 		SavingsPlanOrderID: to.Ptr("/providers/Microsoft.BillingBenefits/savingsPlanOrders/30000000-0000-0000-0000-000000000000"),
	// 		Term: to.Ptr(armbillingbenefits.TermP1Y),
	// 	},
	// 	SKU: &armbillingbenefits.SKU{
	// 		Name: to.Ptr("Compute_Savings_Plan"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { BillingBenefitsRP } = require("@azure/arm-billingbenefits");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a savings plan.
 *
 * @summary Get a savings plan.
 * x-ms-original-file: specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/examples/SavingsPlanOrderAliasGet.json
 */
async function savingsPlanOrderAliasGet() {
  const savingsPlanOrderAliasName = "spAlias123";
  const credential = new DefaultAzureCredential();
  const client = new BillingBenefitsRP(credential);
  const result = await client.savingsPlanOrderAlias.get(savingsPlanOrderAliasName);
  console.log(result);
}

savingsPlanOrderAliasGet().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/providers/microsoft.billingbenefits/savingsPlanOrderAliases/spAlias123",
  "type": "Microsoft.BillingBenefits/savingsPlanOrderAliases",
  "kind": null,
  "name": "spAlias123",
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "properties": {
    "displayName": "ComputeSavingsPlan_2021-07-01",
    "savingsPlanOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/30000000-0000-0000-0000-000000000000",
    "provisioningState": "Created",
    "billingScopeId": "/subscriptions/10000000-0000-0000-0000-000000000000",
    "term": "P1Y",
    "billingPlan": "P1M",
    "appliedScopeType": "Single",
    "appliedScopeProperties": {
      "resourceGroupId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/testrg"
    },
    "commitment": {
      "currencyCode": "USD",
      "amount": 15.23,
      "grain": "Hourly"
    }
  }
}

定义

名称	说明
AppliedScopeProperties	特定于所应用范围类型的属性。 如果不适用，则不需要。
AppliedScopeType	应用范围的类型。
BillingPlan	表示 ISO 8601 格式的计费计划。 仅适用于按月计费计划。
Commitment	对权益的承诺。
CommitmentGrain	承诺粒度。
createdByType	创建资源的标识类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ProvisioningState	正在设置状态
SavingsPlanOrderAliasModel	节省计划订单别名
Sku	要为此资源应用的 SKU
systemData	与资源的创建和上次修改相关的元数据。
Term	以 ISO 8601 格式表示权益术语。

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	错误对象。

ProvisioningState

正在设置状态

名称	类型	说明
Cancelled	string
ConfirmedBilling	string
Created	string
Creating	string
Expired	string
Failed	string
PendingBilling	string
Succeeded	string

SavingsPlanOrderAliasModel

节省计划订单别名

名称	类型	默认值	说明
id	string		资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string		资源提供程序类型
name	string		资源的名称
properties.appliedScopeProperties	AppliedScopeProperties		特定于所应用范围类型的属性。 如果不适用，则不需要。
properties.appliedScopeType	AppliedScopeType		应用范围的类型。
properties.billingPlan	BillingPlan		表示 ISO 8601 格式的计费计划。 仅适用于按月计费计划。
properties.billingScopeId	string		购买权益时将收取费用的订阅
properties.commitment	Commitment		对权益的承诺。
properties.displayName	string		显示名称
properties.provisioningState	ProvisioningState		正在设置状态
properties.renew	boolean	False	将其设置为 true 将在到期日期时间自动购买新权益。
properties.savingsPlanOrderId	string		创建的节省计划的标识符
properties.term	Term		以 ISO 8601 格式表示权益术语。
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