Savings Plans - Get By Billing Account

Service:: Billing

API-versie:: 2024-04-01

Ontvang een spaarplan per factureringsrekening.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
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})?)$	De id waarmee een factureringsrekening uniek wordt geïdentificeerd.
savingsPlanId	path	True	string	Id van het spaarplan
savingsPlanOrderId	path	True	string	Order-id van het spaarplan
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
expand	query		string	Kan worden gebruikt om het planInformation uit te breiden.

Antwoorden

Name	Type	Description
200 OK	SavingsPlanModel	Azure-operatie succesvol voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

SavingsPlanGet

SavingsPlanGetExpandRenewProperties

SavingsPlanGet

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AppliedScopeProperties	Eigenschappen die specifiek zijn voor het toegepaste bereiktype. Niet vereist indien niet van toepassing.
AppliedScopeType	Type van het toegepaste bereik.
BillingPlan	Vertegenwoordigt het factureringsplan in ISO 8601-indeling. Alleen vereist voor maandelijkse aankopen.
Commitment	Toezegging ten behoeve van het voordeel.
CommitmentGrain	Toezeggingskorrel.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
ExtendedStatusInfo	Uitgebreide statusinformatie
ProvisioningState	De provisioningstatus van de resource tijdens een langdurige operatie.
PurchaseRequest	Aankoopaanvraag.
RenewProperties	Eigenschappen die specifiek zijn voor vernieuwing.
SavingsPlanModel	Besparingsplan
SavingsPlanTerm	Vertegenwoordigt de term Spaarplan in ISO 8601-indeling.
Sku	De SKU die moet worden toegepast op deze resource
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
Utilization	Besparingsplangebruik
UtilizationAggregates	De cumulatieve waarden van het besparingsplangebruik

AppliedScopeProperties

Object

Eigenschappen die specifiek zijn voor het toegepaste bereiktype. Niet vereist indien niet van toepassing.

Name	Type	Description
displayName	string	Weergavenaam
managementGroupId	string	Volledig gekwalificeerde id van de beheergroep waarop het voordeel wordt toegepast.
resourceGroupId	string	Volledig gekwalificeerde id van de resourcegroep waarop het voordeel wordt toegepast.
subscriptionId	string	Volledig gekwalificeerde id van het abonnement waarop het voordeel wordt toegepast.
tenantId	string	Tenant-id waarbij het spaarplan waar het voordeel wordt toegepast.

AppliedScopeType

Opsomming

Type van het toegepaste bereik.

Waarde	Description
Single	Enkel
Shared	Shared
ManagementGroup	ManagementGroup

BillingPlan

Opsomming

Vertegenwoordigt het factureringsplan in ISO 8601-indeling. Alleen vereist voor maandelijkse aankopen.

Waarde	Description
P1M	P1M

Commitment

Object

Toezegging ten behoeve van het voordeel.

Name	Type	Description
amount	number (double)
currencyCode	string	De ISO 4217 3-letter valutacode voor de valuta die door deze aankooprecord wordt gebruikt.
grain	CommitmentGrain	Toezeggingskorrel.

CommitmentGrain

Opsomming

Toezeggingskorrel.

Waarde	Description
Hourly	Uurlijks

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ExtendedStatusInfo

Object

Uitgebreide statusinformatie

Name	Type	Description
message	string	Het bericht met gedetailleerde informatie over de statuscode.
properties.subscriptionId	string	Het abonnement waarvoor een kredietregelcontrole is mislukt.
statusCode	string	Statuscode die aanvullende informatie biedt.

ProvisioningState

Opsomming

De provisioningstatus van de resource tijdens een langdurige operatie.

Waarde	Description
Succeeded	Geslaagd
Canceled	Geannuleerd
Failed	Mislukt
New	Nieuw
Pending	In afwachting
Provisioning	Provisioning
PendingBilling	In behandelingFacturering
ConfirmedBilling	Bevestigdefacturering
Creating	Creëren
Created	Gecreëerd
Expired	Verlopen

PurchaseRequest

Object

Aankoopaanvraag.

Name	Type	Default value	Description
properties.appliedScopeProperties	AppliedScopeProperties		Eigenschappen die specifiek zijn voor het toegepaste bereiktype. Niet vereist indien niet van toepassing.
properties.appliedScopeType	AppliedScopeType		Type van het toegepaste bereik.
properties.billingPlan	BillingPlan		Vertegenwoordigt het factureringsplan in ISO 8601-indeling. Alleen vereist voor maandelijkse aankopen.
properties.billingScopeId	string		Abonnement dat in rekening wordt gebracht voor de aankoop van SavingsPlan
properties.commitment	Commitment		Toezegging ten behoeve van het voordeel.
properties.displayName	string		Beschrijvende naam van het spaarplan
properties.renew	boolean	False	Als u dit instelt op True, wordt automatisch een nieuw voordeel aangeschaft op de vervaldatum.
properties.term	SavingsPlanTerm		Vertegenwoordigt de term Spaarplan in ISO 8601-indeling.
sku	Sku		De SKU die moet worden toegepast op deze resource

RenewProperties

Object

Eigenschappen die specifiek zijn voor vernieuwing.

Name	Type	Description
purchaseProperties	PurchaseRequest	Aankoopaanvraag.

SavingsPlanModel

Object

Besparingsplan

Name	Type	Default value	Description
id	string (arm-id)		Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string		De naam van de resource
properties.appliedScopeProperties	AppliedScopeProperties		Eigenschappen die specifiek zijn voor het toegepaste bereiktype. Niet vereist indien niet van toepassing.
properties.appliedScopeType	AppliedScopeType		Type van het toegepaste bereik.
properties.benefitStartTime	string (date-time)		Dit is de DateTime wanneer het voordeel van het spaarplan begint.
properties.billingAccountId	string		Volledig gekwalificeerde id van de factureringsrekening waarop het spaarplan wordt toegepast.
properties.billingPlan	BillingPlan		Vertegenwoordigt het factureringsplan in ISO 8601-indeling. Alleen vereist voor maandelijkse aankopen.
properties.billingProfileId	string		Volledig gekwalificeerde id van het factureringsprofiel waarop het spaarplan wordt toegepast. Alleen aanwezig voor klanten met veld- of klantgestuurde klanten.
properties.billingScopeId	string		Abonnement dat in rekening wordt gebracht voor de aankoop van SavingsPlan
properties.commitment	Commitment		Toezegging ten behoeve van het voordeel.
properties.customerId	string		Volledig gekwalificeerde id van de klant waarop het spaarplan wordt toegepast. Alleen aanwezig voor door partners geleide klanten.
properties.displayName	string		Weergavenaam
properties.displayProvisioningState	string		De inrichtingsstatus van het spaarplan voor weergave, bijvoorbeeld Geslaagd
properties.effectiveDateTime	string (date-time)		DateTime van het spaarplan vanaf wanneer deze versie van kracht is.
properties.expiryDateTime	string (date-time)		Dit is de datum en tijd waarop het spaarplan verloopt.
properties.extendedStatusInfo	ExtendedStatusInfo		Uitgebreide statusinformatie
properties.productCode	string		Vertegenwoordigt UPN
properties.provisioningState	ProvisioningState		De provisioningstatus van de resource tijdens een langdurige operatie.
properties.purchaseDateTime	string (date-time)		Datum waarop het spaarplan is gekocht.
properties.renew	boolean	False	Als u dit instelt op True, wordt automatisch een nieuw voordeel aangeschaft op de vervaldatum.
properties.renewDestination	string		SavingsPlan-id van het SavingsPlan dat wordt aangeschaft vanwege verlenging.
properties.renewProperties	RenewProperties		Eigenschappen die specifiek zijn voor vernieuwing.
properties.renewSource	string		SavingsPlan-id van het Spaarplan waaruit dit Spaarplan wordt verlengd.
properties.term	SavingsPlanTerm		Vertegenwoordigt de term Spaarplan in ISO 8601-indeling.
properties.userFriendlyAppliedScopeType	string		Het toegepaste bereiktype van het spaarplan voor weergave, bijvoorbeeld Gedeeld
properties.utilization	Utilization		Besparingsplangebruik
sku	Sku		Spaarplan-SKU
systemData	systemData		Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object		Woordenlijst met metagegevens die zijn gekoppeld aan de resource. Deze kan niet worden ingevuld voor alle resourcetypen. Maximale lengte van sleutel/waarde die wordt ondersteund door 256 tekens. Sleutels/waarde mogen geen lege waarde of null zijn. Sleutels kunnen geen <> % & \ bevatten? /
type	string		Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

SavingsPlanTerm

Opsomming

Vertegenwoordigt de term Spaarplan in ISO 8601-indeling.

Waarde	Description
P1Y	P1Y
P3Y	P3Y
P5Y	P5Y

Sku

Object

De SKU die moet worden toegepast op deze resource

Name	Type	Description
name	string	Naam van de SKU die moet worden toegepast

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Utilization

Object

Besparingsplangebruik

Name	Type	Description
aggregates	UtilizationAggregates[]	De matrix van aggregaties van het gebruik van een spaarplan
trend	string	De trend voor het gebruik van een spaarplan

UtilizationAggregates

Object

De cumulatieve waarden van het besparingsplangebruik

Name	Type	Description
grain	number (float)	Het korreltje van de aggregaties
grainUnit	string	De graaneenheid van de aggregaties
value	number (float)	De statistische waarde
valueUnit	string	De eenheid van de geaggregeerde waarde

Delen via

Savings Plans - Get By Billing Account

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

SavingsPlanGet

Voorbeeldaanvraag

Voorbeeldrespons

SavingsPlanGetExpandRenewProperties

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AppliedScopeProperties

AppliedScopeType

BillingPlan

Commitment

CommitmentGrain

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedStatusInfo

ProvisioningState

PurchaseRequest

RenewProperties

SavingsPlanModel

SavingsPlanTerm

Sku

systemData

Utilization

UtilizationAggregates