Savings Plans - Get By Billing Account

Tjänst:: Billing

API-version:: 2024-04-01

Hämta sparplan per faktureringskonto.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	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})?)$	Det ID som unikt identifierar ett faktureringskonto.
savingsPlanId	path	True	string	ID för sparplanen
savingsPlanOrderId	path	True	string	Order-ID för sparplanen
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
expand	query		string	Kan användas för att expandera planInformation.

Svar

Name	Typ	Description
200 OK	SavingsPlanModel	Azure-operationen slutfördes framgångsrikt.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

SavingsPlanGet

SavingsPlanGetExpandRenewProperties

SavingsPlanGet

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
AppliedScopeProperties	Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt.
AppliedScopeType	Typ av tillämpat omfång.
BillingPlan	Representerar faktureringsplanen i ISO 8601-format. Krävs endast för månatliga köp.
Commitment	Engagemang för förmånen.
CommitmentGrain	Åtagandeintervall.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ExtendedStatusInfo	Utökad statusinformation
ProvisioningState	Provisioneringstillståndet för resursen under en långvarig operation.
PurchaseRequest	Inköpsbegäran.
RenewProperties	Egenskaper som är specifika för förnyelse.
SavingsPlanModel	Sparplan
SavingsPlanTerm	Representerar termen Sparplan i ISO 8601-format.
Sku	Den SKU som ska användas för den här resursen
systemData	Metadata som rör skapande och senaste ändring av resursen.
Utilization	Användning av sparplan
UtilizationAggregates	Aggregerade värden för användning av sparplan

AppliedScopeProperties

Objekt

Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt.

Name	Typ	Description
displayName	string	Visningsnamn
managementGroupId	string	Fullständigt kvalificerad identifierare för den hanteringsgrupp där förmånen tillämpas.
resourceGroupId	string	Fullständigt kvalificerad identifierare för resursgruppen där förmånen tillämpas.
subscriptionId	string	Fullständigt kvalificerad identifierare för prenumerationen där förmånen tillämpas.
tenantId	string	Klientorganisations-ID där sparplanen där förmånen tillämpas.

AppliedScopeType

Uppräkning

Typ av tillämpat omfång.

Värde	Description
Single	Single
Shared	Delad
ManagementGroup	ManagementGroup

BillingPlan

Uppräkning

Representerar faktureringsplanen i ISO 8601-format. Krävs endast för månatliga köp.

Värde	Description
P1M	P1M

Commitment

Objekt

Engagemang för förmånen.

Name	Typ	Description
amount	number (double)
currencyCode	string	ISO 4217 3-bokstavs valutakod för den valuta som används av den här inköpsposten.
grain	CommitmentGrain	Åtagandeintervall.

CommitmentGrain

Uppräkning

Åtagandeintervall.

Värde	Description
Hourly	Varje timme

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ExtendedStatusInfo

Objekt

Utökad statusinformation

Name	Typ	Description
message	string	Meddelandet med detaljerad information om statuskoden.
properties.subscriptionId	string	Prenumerationen som har misslyckats med kreditradskontrollen.
statusCode	string	Statuskod som ger ytterligare information.

ProvisioningState

Uppräkning

Provisioneringstillståndet för resursen under en långvarig operation.

Värde	Description
Succeeded	lyckades
Canceled	Annullerad
Failed	Misslyckades
New	Nytt
Pending	Avvaktan
Provisioning	Provisioning
PendingBilling	VäntandeFakturering
ConfirmedBilling	BekräftadFakturering
Creating	Skapar
Created	Skapades
Expired	Utgånget

PurchaseRequest

Objekt

Inköpsbegäran.

Name	Typ	Standardvärde	Description
properties.appliedScopeProperties	AppliedScopeProperties		Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt.
properties.appliedScopeType	AppliedScopeType		Typ av tillämpat omfång.
properties.billingPlan	BillingPlan		Representerar faktureringsplanen i ISO 8601-format. Krävs endast för månatliga köp.
properties.billingScopeId	string		Prenumeration som debiteras för köp av SavingsPlan
properties.commitment	Commitment		Engagemang för förmånen.
properties.displayName	string		Eget namn på sparplanen
properties.renew	boolean	False	Om du anger värdet true köps automatiskt en ny förmån på förfallodatumtiden.
properties.term	SavingsPlanTerm		Representerar termen Sparplan i ISO 8601-format.
sku	Sku		Den SKU som ska användas för den här resursen

RenewProperties

Objekt

Egenskaper som är specifika för förnyelse.

Name	Typ	Description
purchaseProperties	PurchaseRequest	Inköpsbegäran.

SavingsPlanModel

Objekt

Sparplan

Name	Typ	Standardvärde	Description
id	string (arm-id)		Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Namnet på resursen
properties.appliedScopeProperties	AppliedScopeProperties		Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt.
properties.appliedScopeType	AppliedScopeType		Typ av tillämpat omfång.
properties.benefitStartTime	string (date-time)		Det här är DateTime när förmånen för sparplanen startar.
properties.billingAccountId	string		Fullständigt kvalificerad identifierare för faktureringskontot där sparplanen tillämpas.
properties.billingPlan	BillingPlan		Representerar faktureringsplanen i ISO 8601-format. Krävs endast för månatliga köp.
properties.billingProfileId	string		Fullständigt kvalificerad identifierare för faktureringsprofilen där sparplanen tillämpas. Finns endast för fältledda eller kundledda kunder.
properties.billingScopeId	string		Prenumeration som debiteras för köp av SavingsPlan
properties.commitment	Commitment		Engagemang för förmånen.
properties.customerId	string		Fullständigt kvalificerad identifierare för kunden där sparplanen tillämpas. Finns endast för partnerledda kunder.
properties.displayName	string		Visningsnamn
properties.displayProvisioningState	string		Etableringstillståndet för sparplanen för visning, t.ex. Lyckades
properties.effectiveDateTime	string (date-time)		DateTime för sparplanen som börjar när den här versionen gäller från.
properties.expiryDateTime	string (date-time)		Det här är den tidpunkt då sparplanen upphör att gälla.
properties.extendedStatusInfo	ExtendedStatusInfo		Utökad statusinformation
properties.productCode	string		Representerar UPN
properties.provisioningState	ProvisioningState		Provisioneringstillståndet för resursen under en långvarig operation.
properties.purchaseDateTime	string (date-time)		Datum då sparplanen köptes.
properties.renew	boolean	False	Om du anger värdet true köps automatiskt en ny förmån på förfallodatumtiden.
properties.renewDestination	string		SavingsPlan-ID för SavingsPlan som köps på grund av förnyelse.
properties.renewProperties	RenewProperties		Egenskaper som är specifika för förnyelse.
properties.renewSource	string		SavingsPlan-ID för SavingsPlan som sparplanen förnyas från.
properties.term	SavingsPlanTerm		Representerar termen Sparplan i ISO 8601-format.
properties.userFriendlyAppliedScopeType	string		Den tillämpade omfångstypen för sparplanen för visning, t.ex. Delad
properties.utilization	Utilization		Användning av sparplan
sku	Sku		SKU för sparplan
systemData	systemData		Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object		Ordlista med metadata som är associerade med resursen. Den kanske inte fylls i för alla resurstyper. Maximal nyckel/värdelängd som stöds på 256 tecken. Nycklar/värde får inte vara tomt eller null. Nycklar kan inte innehålla <> % & \ ? /
type	string		Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SavingsPlanTerm

Uppräkning

Representerar termen Sparplan i ISO 8601-format.

Värde	Description
P1Y	P1Y
P3Y	P3Y
P5Y	P5Y

Sku

Objekt

Den SKU som ska användas för den här resursen

Name	Typ	Description
name	string	Namnet på den SKU som ska tillämpas

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Utilization

Objekt

Användning av sparplan

Name	Typ	Description
aggregates	UtilizationAggregates[]	Matrisen med aggregeringar av en sparplans användning
trend	string	Trenden för en sparplans användning

UtilizationAggregates

Objekt

Aggregerade värden för användning av sparplan

Name	Typ	Description
grain	number (float)	Kornet för aggregerade
grainUnit	string	Kornenheten för aggregerade
value	number (float)	Aggregeringsvärdet
valueUnit	string	Den sammanställda värdeenheten

Dela via

Savings Plans - Get By Billing Account

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

SavingsPlanGet

Exempelbegäran

Exempelsvar

SavingsPlanGetExpandRenewProperties

Exempelbegäran

Exempelsvar

Definitioner

AppliedScopeProperties

AppliedScopeType

BillingPlan

Commitment

CommitmentGrain

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedStatusInfo

ProvisioningState

PurchaseRequest

RenewProperties

SavingsPlanModel

SavingsPlanTerm

Sku

systemData

Utilization

UtilizationAggregates