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 バージョン

応答

名前	型	説明
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	リソースを作成した ID の種類。
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

リソースを作成した ID の種類。

名前	型	説明
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	error オブジェクト。

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 Resource Manager メタデータ。
type	string		リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

Sku

このリソースに適用する SKU

名前	型	説明
name	string	適用する SKU の名前

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

Term

特典用語を ISO 8601 形式で表します。

名前	型	説明
P1Y	string
P3Y	string
P5Y	string