Savings Plan Order Alias - Get

Referência

Service:: Billing Benefits

API Version:: 2022-11-01

Obtenha um plano de economia.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description

Nome	Em	Obrigatório	Tipo	Description
savingsPlanOrderAliasName	path	True	string	Nome do alias do pedido do plano de economia Regex pattern: `^[a-zA-Z0-9_\-\.]+$`
api-version	query	True	string	A versão da API a ser usada pelo serviço

savingsPlanOrderAliasName

path

True

string

Nome do alias do pedido do plano de economia

Regex pattern: ^[a-zA-Z0-9_\-\.]+$

api-version

query

True

string

A versão da API a ser usada pelo serviço

Respostas

Nome	Tipo	Description
200 OK	SavingsPlanOrderAliasModel	A solicitação foi concluída.
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

SavingsPlanOrderAliasGet

Sample Request

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

/** 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

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

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

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"
    }
  }
}

Definições

Nome	Description
AppliedScopeProperties	Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável.
AppliedScopeType	Tipo do Escopo Aplicado.
BillingPlan	Representa o plano de cobrança no formato ISO 8601. Necessário apenas para planos de cobrança mensais.
Commitment	Compromisso com o benefício.
CommitmentGrain	Grão de compromisso.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ProvisioningState	Estado de provisionamento
SavingsPlanOrderAliasModel	Alias da ordem do plano de economia
Sku	O SKU a ser aplicado a esse recurso
systemData	Metadados relativos à criação e à última modificação do recurso.
Term	Represente o termo do benefício no formato ISO 8601.

AppliedScopeProperties

Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável.

Nome	Tipo	Description
displayName	string	Nome de exibição
managementGroupId	string	Identificador totalmente qualificado do grupo de gerenciamento em que o benefício deve ser aplicado.
resourceGroupId	string	Identificador totalmente qualificado do grupo de recursos.
subscriptionId	string	Identificador totalmente qualificado da assinatura.
tenantId	string	ID do locatário em que o benefício é aplicado.

AppliedScopeType

Tipo do Escopo Aplicado.

Nome	Tipo	Description
ManagementGroup	string
Shared	string
Single	string

BillingPlan

Representa o plano de cobrança no formato ISO 8601. Necessário apenas para planos de cobrança mensais.

Nome	Tipo	Description
P1M	string

Commitment

Compromisso com o benefício.

Nome	Tipo	Description
amount	number
currencyCode	string	O código de moeda iso 4217 de 3 letras para a moeda usada por este registro de compra.
grain	CommitmentGrain	Grão de compromisso.

CommitmentGrain

Grão de compromisso.

Nome	Tipo	Description
Hourly	string

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ProvisioningState

Estado de provisionamento

Nome	Tipo	Description
Cancelled	string
ConfirmedBilling	string
Created	string
Creating	string
Expired	string
Failed	string
PendingBilling	string
Succeeded	string

SavingsPlanOrderAliasModel

Alias da ordem do plano de economia

Nome	Tipo	Valor padrão	Description
id	string		ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string		Tipo de provedor de recursos
name	string		O nome do recurso
properties.appliedScopeProperties	AppliedScopeProperties		Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável.
properties.appliedScopeType	AppliedScopeType		Tipo do Escopo Aplicado.
properties.billingPlan	BillingPlan		Representa o plano de cobrança no formato ISO 8601. Necessário apenas para planos de cobrança mensais.
properties.billingScopeId	string		Assinatura que será cobrada pela compra do benefício
properties.commitment	Commitment		Compromisso com o benefício.
properties.displayName	string		Nome de exibição
properties.provisioningState	ProvisioningState		Estado de provisionamento
properties.renew	boolean	False	Definir isso como true comprará automaticamente um novo benefício na data de validade.
properties.savingsPlanOrderId	string		Identificador do plano de economia criado
properties.term	Term		Represente o termo do benefício no formato ISO 8601.
sku	Sku		SKU do plano de economia
systemData	systemData		Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
type	string		Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

Sku

O SKU a ser aplicado a esse recurso

Nome	Tipo	Description
name	string	Nome do SKU a ser aplicado

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Term

Represente o termo do benefício no formato ISO 8601.

Nome	Tipo	Description
P1Y	string
P3Y	string
P5Y	string

Share via

Savings Plan Order Alias - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

SavingsPlanOrderAliasGet

Sample Request

Sample Response

Definições

AppliedScopeProperties

AppliedScopeType

BillingPlan

Commitment

CommitmentGrain

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

SavingsPlanOrderAliasModel

Sku

systemData

Term

Recursos adicionais