Savings Plans - Get By Billing Account
Erhalten Sie Einen Sparplan nach Abrechnungskonto.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}?api-version=2024-04-01
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}?api-version=2024-04-01&expand={expand}
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
billing
|
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})?)$ |
Die ID, die ein Abrechnungskonto eindeutig identifiziert. |
|
savings
|
path | True |
string |
ID des Sparplans |
|
savings
|
path | True |
string |
Auftrags-ID des Sparplans |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
|
expand
|
query |
string |
Kann verwendet werden, um die planInformation zu erweitern. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Azure-Operation erfolgreich abgeschlossen. |
|
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
|
Savings |
|
Savings |
SavingsPlanGet
Beispielanforderung
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
Beispiel für eine Antwort
{
"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
Beispielanforderung
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
Beispiel für eine Antwort
{
"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"
}
}
Definitionen
| Name | Beschreibung |
|---|---|
|
Applied |
Eigenschaften, die für den angewendeten Bereichstyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend. |
|
Applied |
Typ des angewendeten Bereichs. |
|
Billing |
Stellt den Abrechnungsplan im ISO 8601-Format dar. Nur für monatliche Einkäufe erforderlich. |
| Commitment |
Verpflichtung zum Nutzen. |
|
Commitment |
Bekenntniskorn. |
|
created |
Der Identitätstyp, der die Ressource erstellt hat. |
|
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
|
Error |
Das Fehlerdetails. |
|
Error |
Fehlerantwort |
|
Extended |
Erweiterte Statusinformationen |
|
Provisioning |
Der Bereitstellungszustand der Ressource während eines langlaufenden Betriebs. |
|
Purchase |
Kaufanfrage. |
|
Renew |
Eigenschaften, die für die Verlängerung spezifisch sind. |
|
Savings |
Sparplan |
|
Savings |
Stellt die Laufzeit des Sparplans im ISO 8601-Format dar. |
| Sku |
Die SKU, die für diese Ressource angewendet werden soll |
|
system |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
| Utilization |
Nutzung des Sparplans |
|
Utilization |
Die Aggregatwerte der Nutzung des Sparplans |
AppliedScopeProperties
Eigenschaften, die für den angewendeten Bereichstyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend.
| Name | Typ | Beschreibung |
|---|---|---|
| displayName |
string |
Anzeigename |
| managementGroupId |
string |
Vollqualifizierter Bezeichner der Verwaltungsgruppe, in der der Vorteil angewendet wird. |
| resourceGroupId |
string |
Vollqualifizierter Bezeichner der Ressourcengruppe, auf die der Vorteil angewendet wird. |
| subscriptionId |
string |
Vollqualifizierter Bezeichner des Abonnements, in dem der Vorteil angewendet wird. |
| tenantId |
string |
Mandanten-ID, bei der der Sparplan angewendet wird. |
AppliedScopeType
Typ des angewendeten Bereichs.
| Wert | Beschreibung |
|---|---|
| Single |
Ledig |
| Shared |
Shared |
| ManagementGroup |
ManagementGroup |
BillingPlan
Stellt den Abrechnungsplan im ISO 8601-Format dar. Nur für monatliche Einkäufe erforderlich.
| Wert | Beschreibung |
|---|---|
| P1M |
P1M |
Commitment
Verpflichtung zum Nutzen.
| Name | Typ | Beschreibung |
|---|---|---|
| amount |
number (double) |
|
| currencyCode |
string |
Der ISO 4217-3-Buchstaben-Währungscode für die währung, die von diesem Einkaufsdatensatz verwendet wird. |
| grain |
Bekenntniskorn. |
CommitmentGrain
Bekenntniskorn.
| Wert | Beschreibung |
|---|---|
| Hourly |
Stündlich |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
| Wert | Beschreibung |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
| Name | Typ | Beschreibung |
|---|---|---|
| info |
object |
Die zusätzlichen Informationen. |
| type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |
ExtendedStatusInfo
Erweiterte Statusinformationen
| Name | Typ | Beschreibung |
|---|---|---|
| message |
string |
Die Meldung, die detaillierte Informationen zum Statuscode enthält. |
| properties.subscriptionId |
string |
Das Abonnement, bei dem die Kreditlinienüberprüfung fehlgeschlagen ist. |
| statusCode |
string |
Statuscode, der zusätzliche Informationen bereitstellt. |
ProvisioningState
Der Bereitstellungszustand der Ressource während eines langlaufenden Betriebs.
| Wert | Beschreibung |
|---|---|
| Succeeded |
Erfolgreich |
| Canceled |
Abgesagt |
| Failed |
gescheitert |
| New |
Neu |
| Pending |
Ausstehend |
| Provisioning |
Provisioning |
| PendingBilling |
AusstehendeAbrechnung |
| ConfirmedBilling |
BestätigteAbrechnung |
| Creating |
Erstellen |
| Created |
Erstellt |
| Expired |
Abgelaufen |
PurchaseRequest
Kaufanfrage.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| properties.appliedScopeProperties |
Eigenschaften, die für den angewendeten Bereichstyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend. |
||
| properties.appliedScopeType |
Typ des angewendeten Bereichs. |
||
| properties.billingPlan |
Stellt den Abrechnungsplan im ISO 8601-Format dar. Nur für monatliche Einkäufe erforderlich. |
||
| properties.billingScopeId |
string |
Abonnement, das für den Kauf von SavingsPlan in Rechnung gestellt wird |
|
| properties.commitment |
Verpflichtung zum Nutzen. |
||
| properties.displayName |
string |
Anzeigename des Sparplans |
|
| properties.renew |
boolean |
False |
Wenn Sie diesen Wert auf "true" festlegen, wird automatisch ein neuer Vorteil für die Ablaufdatumszeit erworben. |
| properties.term |
Stellt die Laufzeit des Sparplans im ISO 8601-Format dar. |
||
| sku |
Die SKU, die für diese Ressource angewendet werden soll |
RenewProperties
Eigenschaften, die für die Verlängerung spezifisch sind.
| Name | Typ | Beschreibung |
|---|---|---|
| purchaseProperties |
Kaufanfrage. |
SavingsPlanModel
Sparplan
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| id |
string (arm-id) |
Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
|
| name |
string |
Der Name der Ressource |
|
| properties.appliedScopeProperties |
Eigenschaften, die für den angewendeten Bereichstyp spezifisch sind. Nicht erforderlich, falls nicht zutreffend. |
||
| properties.appliedScopeType |
Typ des angewendeten Bereichs. |
||
| properties.benefitStartTime |
string (date-time) |
Dies ist dateTime, wenn der Sparplanvorteil beginnt. |
|
| properties.billingAccountId |
string |
Vollqualifizierter Bezeichner des Abrechnungskontos, auf das der Sparplan angewendet wird. |
|
| properties.billingPlan |
Stellt den Abrechnungsplan im ISO 8601-Format dar. Nur für monatliche Einkäufe erforderlich. |
||
| properties.billingProfileId |
string |
Vollqualifizierter Bezeichner des Abrechnungsprofils, in dem der Sparplan angewendet wird. Nur für kundengeführte Kunden mit Feldführung oder Kunden vorhanden. |
|
| properties.billingScopeId |
string |
Abonnement, das für den Kauf von SavingsPlan in Rechnung gestellt wird |
|
| properties.commitment |
Verpflichtung zum Nutzen. |
||
| properties.customerId |
string |
Vollqualifizierter Bezeichner des Kunden, auf den der Sparplan angewendet wird. Nur für partnergeführte Kunden vorhanden. |
|
| properties.displayName |
string |
Anzeigename |
|
| properties.displayProvisioningState |
string |
Der Bereitstellungsstatus des Sparplans für die Anzeige, z. B. erfolgreich |
|
| properties.effectiveDateTime |
string (date-time) |
DateTime des Sparplans ab dem Zeitpunkt, an dem diese Version wirksam ist. |
|
| properties.expiryDateTime |
string (date-time) |
Dies ist der Zeitpunkt, zu dem der Sparplan abläuft. |
|
| properties.extendedStatusInfo |
Erweiterte Statusinformationen |
||
| properties.productCode |
string |
Stellt UPN dar |
|
| properties.provisioningState |
Der Bereitstellungszustand der Ressource während eines langlaufenden Betriebs. |
||
| properties.purchaseDateTime |
string (date-time) |
Datum, zu dem der Sparplan erworben wurde. |
|
| properties.renew |
boolean |
False |
Wenn Sie diesen Wert auf "true" festlegen, wird automatisch ein neuer Vorteil für die Ablaufdatumszeit erworben. |
| properties.renewDestination |
string |
SavingsPlan ID des Sparplans, der aufgrund der Verlängerung erworben wird. |
|
| properties.renewProperties |
Eigenschaften, die für die Verlängerung spezifisch sind. |
||
| properties.renewSource |
string |
SavingsPlan ID des Sparplans, aus dem dieser Sparplan erneuert wird. |
|
| properties.term |
Stellt die Laufzeit des Sparplans im ISO 8601-Format dar. |
||
| properties.userFriendlyAppliedScopeType |
string |
Der angewendete Bereichstyp des Sparplans für die Anzeige, z. B. Freigegeben |
|
| properties.utilization |
Nutzung des Sparplans |
||
| sku |
Sparplan-SKU |
||
| systemData |
Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten. |
||
| tags |
object |
Wörterbuch der Metadaten, die der Ressource zugeordnet sind. Möglicherweise wird sie nicht für alle Ressourcentypen aufgefüllt. Maximale Schlüssel-/Wertlänge unterstützt von 256 Zeichen. Schlüssel/Wert dürfen keinen leeren Wert oder null sein. Schlüssel können nicht <> % & \ enthalten? / |
|
| type |
string |
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
SavingsPlanTerm
Stellt die Laufzeit des Sparplans im ISO 8601-Format dar.
| Wert | Beschreibung |
|---|---|
| P1Y |
P1Y |
| P3Y |
P3Y |
| P5Y |
P5Y |
Sku
Die SKU, die für diese Ressource angewendet werden soll
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
Name der anzuwendenden SKU |
systemData
Metadaten zur Erstellung und letzten Änderung der Ressource.
| Name | Typ | Beschreibung |
|---|---|---|
| createdAt |
string (date-time) |
Der Zeitstempel der Ressourcenerstellung (UTC). |
| createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
| createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
| lastModifiedAt |
string (date-time) |
Der Zeitstempel der letzten Änderung der Ressource (UTC) |
| lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
| lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
Utilization
Nutzung des Sparplans
| Name | Typ | Beschreibung |
|---|---|---|
| aggregates |
Das Array von Aggregaten der Nutzung eines Sparplans |
|
| trend |
string |
Der Trend für die Nutzung eines Sparplans |
UtilizationAggregates
Die Aggregatwerte der Nutzung des Sparplans
| Name | Typ | Beschreibung |
|---|---|---|
| grain |
number (float) |
Das Korn des Aggregats |
| grainUnit |
string |
Die Korneinheit des Aggregats |
| value |
number (float) |
Der Aggregatwert |
| valueUnit |
string |
Die Aggregatwerteinheit |