Savings Plans - Get By Billing Account

Servizio:: Billing

Versione API:: 2024-04-01

Ottenere il piano di risparmio in base all'account di fatturazione.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
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 che identifica in modo univoco un account di fatturazione.
savingsPlanId	path	True	string	ID del piano di risparmio
savingsPlanOrderId	path	True	string	ID ordine del piano di risparmio
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
expand	query		string	Può essere usato per espandere il pianoInformation.

Risposte

Nome	Tipo	Descrizione
200 OK	SavingsPlanModel	Operazione Azure completata con successo.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

SavingsPlanGet

SavingsPlanGetExpandRenewProperties

SavingsPlanGet

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
AppliedScopeProperties	Proprietà specifiche del tipo di ambito applicato. Non obbligatorio se non applicabile.
AppliedScopeType	Tipo dell'ambito applicato.
BillingPlan	Rappresenta il piano di fatturazione in formato ISO 8601. Obbligatorio solo per gli acquisti mensili.
Commitment	Impegno verso il beneficio.
CommitmentGrain	Granularità dell'impegno.
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
ExtendedStatusInfo	Informazioni sullo stato esteso
ProvisioningState	Lo stato di provisioning della risorsa durante un'operazione di lunga durata.
PurchaseRequest	Richiesta di acquisto.
RenewProperties	Proprietà specifiche per il rinnovo.
SavingsPlanModel	Piano di risparmio
SavingsPlanTerm	Rappresenta il termine del piano di risparmio in formato ISO 8601.
Sku	SKU da applicare per questa risorsa
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
Utilization	Utilizzo del piano di risparmio
UtilizationAggregates	Valori aggregati dell'utilizzo del piano di risparmio

AppliedScopeProperties

Oggetto

Proprietà specifiche del tipo di ambito applicato. Non obbligatorio se non applicabile.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato
managementGroupId	string	Identificatore completo del gruppo di gestione in cui viene applicato il vantaggio.
resourceGroupId	string	Identificatore completo del gruppo di risorse in cui viene applicato il vantaggio.
subscriptionId	string	Identificatore completo della sottoscrizione in cui viene applicato il vantaggio.
tenantId	string	ID tenant in cui viene applicato il piano di risparmio in cui viene applicato il vantaggio.

AppliedScopeType

Enumerazione

Tipo dell'ambito applicato.

Valore	Descrizione
Single	Single
Shared	Shared
ManagementGroup	ManagementGroup

BillingPlan

Enumerazione

Rappresenta il piano di fatturazione in formato ISO 8601. Obbligatorio solo per gli acquisti mensili.

Valore	Descrizione
P1M	P1M

Commitment

Oggetto

Impegno verso il beneficio.

Nome	Tipo	Descrizione
amount	number (double)
currencyCode	string	Codice valuta ISO 4217 a 3 lettere per la valuta utilizzata da questo record di acquisto.
grain	CommitmentGrain	Granularità dell'impegno.

CommitmentGrain

Enumerazione

Granularità dell'impegno.

Valore	Descrizione
Hourly	Su base oraria

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

ExtendedStatusInfo

Oggetto

Informazioni sullo stato esteso

Nome	Tipo	Descrizione
message	string	Messaggio che fornisce informazioni dettagliate sul codice di stato.
properties.subscriptionId	string	Sottoscrizione che non ha superato il controllo della riga di credito.
statusCode	string	Codice di stato che fornisce informazioni aggiuntive.

ProvisioningState

Enumerazione

Lo stato di provisioning della risorsa durante un'operazione di lunga durata.

Valore	Descrizione
Succeeded	Succeeded
Canceled	Annullato
Failed	Non riuscito
New	Nuova
Pending	In sospeso
Provisioning	Provisioning
PendingBilling	PendingBilling
ConfirmedBilling	Fatturazione confermataFattura
Creating	Creazione
Created	Creato
Expired	Scaduto

PurchaseRequest

Oggetto

Richiesta di acquisto.

Nome	Tipo	Valore predefinito	Descrizione
properties.appliedScopeProperties	AppliedScopeProperties		Proprietà specifiche del tipo di ambito applicato. Non obbligatorio se non applicabile.
properties.appliedScopeType	AppliedScopeType		Tipo dell'ambito applicato.
properties.billingPlan	BillingPlan		Rappresenta il piano di fatturazione in formato ISO 8601. Obbligatorio solo per gli acquisti mensili.
properties.billingScopeId	string		Sottoscrizione che verrà addebitata per l'acquisto di SavingsPlan
properties.commitment	Commitment		Impegno verso il beneficio.
properties.displayName	string		Nome descrittivo del piano di risparmio
properties.renew	boolean	False	L'impostazione di questo valore su true acquisterà automaticamente un nuovo vantaggio alla data di scadenza.
properties.term	SavingsPlanTerm		Rappresenta il termine del piano di risparmio in formato ISO 8601.
sku	Sku		SKU da applicare per questa risorsa

RenewProperties

Oggetto

Proprietà specifiche per il rinnovo.

Nome	Tipo	Descrizione
purchaseProperties	PurchaseRequest	Richiesta di acquisto.

SavingsPlanModel

Oggetto

Piano di risparmio

Nome	Tipo	Valore predefinito	Descrizione
id	string (arm-id)		ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Nome della risorsa
properties.appliedScopeProperties	AppliedScopeProperties		Proprietà specifiche del tipo di ambito applicato. Non obbligatorio se non applicabile.
properties.appliedScopeType	AppliedScopeType		Tipo dell'ambito applicato.
properties.benefitStartTime	string (date-time)		DateTime all'avvio del vantaggio del piano di risparmio.
properties.billingAccountId	string		Identificatore completo dell'account di fatturazione in cui viene applicato il piano di risparmio.
properties.billingPlan	BillingPlan		Rappresenta il piano di fatturazione in formato ISO 8601. Obbligatorio solo per gli acquisti mensili.
properties.billingProfileId	string		Identificatore completo del profilo di fatturazione in cui viene applicato il piano di risparmio. Presente solo per i clienti con led field o clienti con cliente.
properties.billingScopeId	string		Sottoscrizione che verrà addebitata per l'acquisto di SavingsPlan
properties.commitment	Commitment		Impegno verso il beneficio.
properties.customerId	string		Identificatore completo del cliente in cui viene applicato il piano di risparmio. Presente solo per i clienti con partner.
properties.displayName	string		Nome visualizzato
properties.displayProvisioningState	string		Stato di provisioning del piano di risparmio per la visualizzazione, ad esempio Succeeded
properties.effectiveDateTime	string (date-time)		DateTime del piano di risparmio a partire da quando questa versione è effettiva.
properties.expiryDateTime	string (date-time)		Questa è la data di scadenza del piano di risparmio.
properties.extendedStatusInfo	ExtendedStatusInfo		Informazioni sullo stato esteso
properties.productCode	string		Rappresenta l'UPN
properties.provisioningState	ProvisioningState		Lo stato di provisioning della risorsa durante un'operazione di lunga durata.
properties.purchaseDateTime	string (date-time)		Data di acquisto del piano di risparmio.
properties.renew	boolean	False	L'impostazione di questo valore su true acquisterà automaticamente un nuovo vantaggio alla data di scadenza.
properties.renewDestination	string		SavingsPlan Id dell'oggetto SavingsPlan acquistato a causa del rinnovo.
properties.renewProperties	RenewProperties		Proprietà specifiche per il rinnovo.
properties.renewSource	string		SavingsPlan Id dell'oggetto SavingsPlan da cui viene rinnovato il piano di risparmio.
properties.term	SavingsPlanTerm		Rappresenta il termine del piano di risparmio in formato ISO 8601.
properties.userFriendlyAppliedScopeType	string		Tipo di ambito applicato del piano di risparmio per la visualizzazione, ad esempio Condiviso
properties.utilization	Utilization		Utilizzo del piano di risparmio
sku	Sku		SKU del piano di risparmio
systemData	systemData		Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
tags	object		Dizionario dei metadati associati alla risorsa. Potrebbe non essere popolato per tutti i tipi di risorse. Lunghezza massima chiave/valore supportata di 256 caratteri. Chiavi/valore non deve essere vuoto né null. Le chiavi non possono contenere <> % & \ ? /
type	string		Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SavingsPlanTerm

Enumerazione

Rappresenta il termine del piano di risparmio in formato ISO 8601.

Valore	Descrizione
P1Y	P1Y
P3Y	P3Y
P5Y	P5Y

Sku

Oggetto

SKU da applicare per questa risorsa

Nome	Tipo	Descrizione
name	string	Nome dello SKU da applicare

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Utilization

Oggetto

Utilizzo del piano di risparmio

Nome	Tipo	Descrizione
aggregates	UtilizationAggregates[]	Matrice di aggregazioni dell'utilizzo di un piano di risparmio
trend	string	La tendenza all'utilizzo di un piano di risparmio

UtilizationAggregates

Oggetto

Valori aggregati dell'utilizzo del piano di risparmio

Nome	Tipo	Descrizione
grain	number (float)	Granularità dell'aggregazione
grainUnit	string	Unità di granularità dell'aggregazione
value	number (float)	Valore aggregato
valueUnit	string	Unità valore aggregato

Condividi tramite

Savings Plans - Get By Billing Account

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

SavingsPlanGet

Esempio di richiesta

Risposta di esempio

SavingsPlanGetExpandRenewProperties

Esempio di richiesta

Risposta di esempio

Definizioni

AppliedScopeProperties

AppliedScopeType

BillingPlan

Commitment

CommitmentGrain

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedStatusInfo

ProvisioningState

PurchaseRequest

RenewProperties

SavingsPlanModel

SavingsPlanTerm

Sku

systemData

Utilization

UtilizationAggregates