Freigeben über


Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

Löst die Generierung eines Zusammenfassungsberichts zur Vorteilsnutzung für den bereitgestellten Sparplan aus.

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2023-11-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
savingsPlanId
path True

string

Sparplan-ID.

savingsPlanOrderId
path True

string

Bestell-ID des Sparplans.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
endDate True

string

Das Enddatum der Zusammenfassungen enthält Daten, die im Bericht bereitgestellt werden.

grain True

grain

Die Körnung, für die die Zusammenfassungsdaten im Bericht bereitgestellt werden. Akzeptierte Werte sind "Daily" oder "Monthly".

startDate True

string

Das Startdatum der Zusammenfassungen enthält Daten, die im Bericht bereitgestellt werden.

benefitId

string

Vorteils-ID, für die der Bericht zur Leistungsnutzungszusammenfassung gilt. Erforderlich für den Leistungs-ID-Bereich. Wird für Leistungsbestellungen oder Abrechnungsbereiche nicht unterstützt.

benefitOrderId

string

Leistungsreihenfolge-ID, für die der Bericht zur Leistungsauslastungszusammenfassung verwendet wird. Erforderlich für Leistungsreihenfolge und Leistungs-ID-Bereiche. Wird für Abrechnungsbereiche nicht unterstützt.

billingAccountId

string

Abrechnungskonto, für das der Bericht zur Leistungsnutzungszusammenfassung gilt. Erforderlich für Abrechnungskonto- und Abrechnungsprofilbereiche. Wird für alle Leistungsbereiche nicht unterstützt.

billingProfileId

string

Abrechnungsprofil-ID, für die der Bericht zur Vorteilsnutzungszusammenfassung verwendet wird. Erforderlich für den Bereich des Abrechnungsprofils. Wird für Abrechnungskonten oder Leistungsbereiche nicht unterstützt.

kind

benefitKind

Der Typ der angeforderten Leistungsdaten. Erforderlich für Abrechnungskonto- und Abrechnungsprofilbereiche. Impliziert und nicht an Leistungsbereiche übergeben werden. Unterstützte Werte sind Reservation und SavingsPlan.

Antworten

Name Typ Beschreibung
200 OK

BenefitUtilizationSummariesOperationStatus

Die status der Generierung des Leistungsnutzungsberichts. Dies kann in Bearbeitung sein, fehlgeschlagen oder abgeschlossen sein.

202 Accepted

Akzeptiert: Die Anforderung wird verarbeitet. Verwenden Sie den Speicherortheader, um die status zu überprüfen.

Header

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

GenerateUtilizationSummariesReportBySavingsPlan

Beispielanforderung

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2023-11-01

{
  "endDate": "2022-08-31T00:00:00Z",
  "startDate": "2022-06-01T00:00:00Z",
  "grain": "Daily"
}

Beispiel für eine Antwort

Location: https://management.azure.com/providers/Microsoft.Capacity/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2023-11-01
Retry-After: 60
{
  "input": {
    "grain": "Daily",
    "benefitOrderId": "00000000-0000-0000-0000-000000000000",
    "benefitId": "00000000-0000-0000-0000-000000000000",
    "kind": "SavingsPlan",
    "endDate": "2022-08-31T00:00:00Z",
    "startDate": "2022-06-01T00:00:00Z"
  },
  "status": "Complete",
  "properties": {
    "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "validUntil": "2022-06-12T02:56:55.5021869Z"
  }
}

Definitionen

Name Beschreibung
AsyncOperationStatusProperties

Objekt, das die Berichts-URL darstellt und bis zum Datum des generierten asynchronen Berichts gültig ist.

benefitKind

Reservierung oder Sparplan.

BenefitUtilizationSummariesOperationStatus

Status eines Zusammenfassungsberichts für die Vorteilsnutzung. Stellt Async Benefit Utilization Summaries Request input, status, and report SAS URL bereit.

BenefitUtilizationSummariesRequest

Eigenschaften einer asynchronen Leistungsauslastungszusammenfassungsanforderung.

BenefitUtilizationSummaryReportSchema

Die CSV-Datei aus dem Bloblink reportUrl und secondaryReportUrl besteht aus den folgenden Spalten mit Daten zur Vorteilsnutzung. "UtilizedPercentage" wird für Sparplanberichte und Reservierungen ohne Datenbausteine 0 sein. Die Auslastungsprozentsätze sind für Data Bricks-Reservierungen 0.

ErrorDetails

Die Details des Fehlers.

ErrorResponse

Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Einige Fehlerantworten:

  • 429 TooManyRequests: Die Anforderung wird gedrosselt. Wiederholen Sie den Vorgang, nachdem Sie auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit gewartet haben.

  • 503 ServiceUnavailable: Der Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang, nachdem Sie die im Header „Retry-After“ angegebene Zeit abgewartet haben.

grain

Das Körnchen der Verwendung. Unterstützte Werte: "Stündlich"

OperationStatusType

Die status der Erstellung des Leistungsnutzungsberichts.

AsyncOperationStatusProperties

Objekt, das die Berichts-URL darstellt und bis zum Datum des generierten asynchronen Berichts gültig ist.

Name Typ Beschreibung
reportUrl

BenefitUtilizationSummaryReportSchema

Sas-URL zum Zusammenfassungsbericht für die asynchrone Vorteilsnutzung. Ist leer, wenn sich der Bericht im Status "Wird ausgeführt" oder "Fehler" befindet.

secondaryReportUrl

BenefitUtilizationSummaryReportSchema

Sas-URL für asynchrone Vorteilsnutzungszusammenfassungen im sekundären Speicher im Falle eines primären Ausfalls. Ist leer, wenn sich der Bericht im Status "Wird ausgeführt" oder "Fehler" befindet.

validUntil

string

Das Datum, an dem die in reportUrl bereitgestellte SAS-URL abläuft.

benefitKind

Reservierung oder Sparplan.

Name Typ Beschreibung
IncludedQuantity

string

Der Vorteil ist "IncludedQuantity".

Reservation

string

Der Vorteil ist "Reservierung".

SavingsPlan

string

Vorteil ist SavingsPlan.

BenefitUtilizationSummariesOperationStatus

Status eines Zusammenfassungsberichts für die Vorteilsnutzung. Stellt Async Benefit Utilization Summaries Request input, status, and report SAS URL bereit.

Name Typ Beschreibung
input

BenefitUtilizationSummariesRequest

Eingaben, die zum Erstellen des Zusammenfassungsberichts für die Vorteilsnutzung angegeben werden.

properties

AsyncOperationStatusProperties

Enthält sas-URL für den Zusammenfassungsbericht für die asynchrone Vorteilsnutzung und ein Datum, bis die URL gültig ist. Diese Werte sind leer, wenn der Bericht den Status "Wird ausgeführt" oder "Fehler" aufweist.

status

OperationStatusType

Die status der Erstellung des Leistungsnutzungsberichts.

BenefitUtilizationSummariesRequest

Eigenschaften einer asynchronen Leistungsauslastungszusammenfassungsanforderung.

Name Typ Beschreibung
benefitId

string

Vorteils-ID, für die der Bericht zur Leistungsnutzungszusammenfassung gilt. Erforderlich für den Leistungs-ID-Bereich. Wird für Leistungsbestellungen oder Abrechnungsbereiche nicht unterstützt.

benefitOrderId

string

Leistungsreihenfolge-ID, für die der Bericht zur Leistungsauslastungszusammenfassung verwendet wird. Erforderlich für Leistungsreihenfolge und Leistungs-ID-Bereiche. Wird für Abrechnungsbereiche nicht unterstützt.

billingAccountId

string

Abrechnungskonto, für das der Bericht zur Leistungsnutzungszusammenfassung gilt. Erforderlich für Abrechnungskonto- und Abrechnungsprofilbereiche. Wird für alle Leistungsbereiche nicht unterstützt.

billingProfileId

string

Abrechnungsprofil-ID, für die der Bericht zur Vorteilsnutzungszusammenfassung verwendet wird. Erforderlich für den Bereich des Abrechnungsprofils. Wird für Abrechnungskonten oder Leistungsbereiche nicht unterstützt.

endDate

string

Das Enddatum der Zusammenfassungen enthält Daten, die im Bericht bereitgestellt werden.

grain

grain

Die Körnung, für die die Zusammenfassungsdaten im Bericht bereitgestellt werden. Akzeptierte Werte sind "Daily" oder "Monthly".

kind

benefitKind

Der Typ der angeforderten Leistungsdaten. Erforderlich für Abrechnungskonto- und Abrechnungsprofilbereiche. Impliziert und nicht an Leistungsbereiche übergeben werden. Unterstützte Werte sind Reservation und SavingsPlan.

startDate

string

Das Startdatum der Zusammenfassungen enthält Daten, die im Bericht bereitgestellt werden.

BenefitUtilizationSummaryReportSchema

Die CSV-Datei aus dem Bloblink reportUrl und secondaryReportUrl besteht aus den folgenden Spalten mit Daten zur Vorteilsnutzung. "UtilizedPercentage" wird für Sparplanberichte und Reservierungen ohne Datenbausteine 0 sein. Die Auslastungsprozentsätze sind für Data Bricks-Reservierungen 0.

Name Typ Beschreibung
AvgUtilizationPercentage

string

BenefitId

string

BenefitOrderId

string

BenefitType

string

Kind

string

MaxUtilizationPercentage

string

MinUtilizationPercentage

string

UsageDate

string

UtilizedPercentage

string

ErrorDetails

Die Details des Fehlers.

Name Typ Beschreibung
code

string

Fehlercode

message

string

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Einige Fehlerantworten:

  • 429 TooManyRequests: Die Anforderung wird gedrosselt. Wiederholen Sie den Vorgang, nachdem Sie auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit gewartet haben.

  • 503 ServiceUnavailable: Der Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang, nachdem Sie die im Header „Retry-After“ angegebene Zeit abgewartet haben.

Name Typ Beschreibung
error

ErrorDetails

Die Details des Fehlers.

grain

Das Körnchen der Verwendung. Unterstützte Werte: "Stündlich"

Name Typ Beschreibung
Daily

string

Stündliche Körnung entspricht dem Wert pro Tag.

Hourly

string

Stündliche Körnung entspricht dem Wert pro Stunde.

Monthly

string

Das stündliche Körnung entspricht dem Wert pro Monat.

OperationStatusType

Die status der Erstellung des Leistungsnutzungsberichts.

Name Typ Beschreibung
Complete

string

Failed

string

Running

string