Generate Benefit Utilization Summaries Report - Generate By Billing Account

Referenz

Dienst:: Cost Management

API-Version:: 2024-08-01

Löst die Generierung eines Nutzennutzungszusammenfassungsberichts für das bereitgestellte Abrechnungskonto aus. Diese API unterstützt nur Registrierungskonten.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
billingAccountId	path	True	string	Abrechnungskonto-ID
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
endDate	True	string	Das Enddatum der Zusammenfassungsdaten, die im Bericht bereitgestellt werden.
grain	True	grain	Das Korn der Zusammenfassungsdaten wird im Bericht bereitgestellt. Akzeptierte Werte sind "Täglich" oder "Monatlich".
startDate	True	string	Das Startdatum der Zusammenfassungsdaten, die im Bericht bereitgestellt werden.
benefitId		string	Vorteils-ID, für die der Zusammenfassende Bericht über die Nutzung von Vorteilen gilt. Erforderlich für den Leistungs-ID-Bereich. Wird für den Leistungsauftrag oder abrechnungsbezogene Bereiche nicht unterstützt.
benefitOrderId		string	Die Leistungsauftrags-ID ist der Bericht über die Leistungsauslastung. Erforderlich für Leistungsauftrags- und Leistungs-ID-Bereiche. Wird für Abrechnungsbereiche nicht unterstützt.
billingAccountId		string	Abrechnungskonto, für das der Bericht "Nutzennutzungszusammenfassungen" gilt. Erforderlich für Abrechnungskonto- und Abrechnungsprofilbereiche. Wird für alle Leistungsbereiche nicht unterstützt.
billingProfileId		string	Abrechnungsprofil-ID, für die der Bericht über die Leistungsnutzungszusammenfassung gilt. Erforderlich für den Abrechnungsprofilbereich. Wird für Abrechnungskonten oder Leistungsbereiche nicht unterstützt.
kind		benefitKind	Der Typ der angeforderten Leistungsdaten. Erforderlich für Abrechnungskonto- und Abrechnungsprofilbereiche. Implizit und nicht zu leistungsbezogenen Bereichen übergeben werden. Unterstützte Werte sind Reservation und SavingsPlan

Antworten

Name	Typ	Beschreibung
200 OK	BenefitUtilizationSummariesOperationStatus	Der Status der Generierung des Berichts zur Leistungsauslastung. Dies kann in Bearbeitung, fehlgeschlagen oder abgeschlossen sein.
202 Accepted		Angenommen. Die Anforderung wird verarbeitet. Verwenden Sie den Speicherortheader, um den Status zu überprüfen. Header Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

BenefitUtilizationSummariesOperationStatus

Der Status der Generierung des Berichts zur Leistungsauslastung. Dies kann in Bearbeitung, fehlgeschlagen oder abgeschlossen sein.

202 Accepted

Angenommen. Die Anforderung wird verarbeitet. Verwenden Sie den Speicherortheader, um den Status zu überprüfen.

Header

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

GenerateUtilizationSummariesReportByBillingAccount

Beispielanforderung

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/8099099/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

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

Beispiel für eine Antwort

Statuscode:: 202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/8099099/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2024-08-01
Retry-After: 60

Statuscode:: 200

{
  "input": {
    "grain": "Daily",
    "billingAccountId": "8099099",
    "kind": "Reservation",
    "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 und gültig bis zum Datum des generierten asynchronen Berichts darstellt.
benefitKind	Reservierung oder Sparplan.
BenefitUtilizationSummariesOperationStatus	Der Status eines Berichts über die Leistungsnutzungszusammenfassung. Stellt Async Benefit Utilization Zusammenfassungen Anforderungseingabe, Status und Sas-URL des Berichts bereit.
BenefitUtilizationSummariesRequest	Eigenschaften einer asynchronen Vorteilsnutzungszusammenfassungsanforderung.
BenefitUtilizationSummaryReportSchema	Die CSV-Datei aus dem reportUrl- und sekundärenReportUrl-BLOB-Link besteht aus den folgenden Spalten mit Nutzennutzungsdaten. Die Nutzung VonPercentage wird 0 für Sparpläne Berichte und nicht Datensteinreservierungen sein. Die Nutzungsprozentsätze sind 0 für Datensteinreservierungen.
ErrorDetails	Die Details des Fehlers.
ErrorResponse	Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben. Einige Fehlerantworten: 429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit. 503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.
grain	Das Korn der Nutzung. Unterstützte Werte: "Stündlich"
OperationStatusType	Der Status der Erstellung des Berichts über die Leistungsnutzung.

AsyncOperationStatusProperties

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

Name	Typ	Beschreibung
reportUrl	BenefitUtilizationSummaryReportSchema	Sas url to the async benefit utilization summaryes report. Ist leer, wenn sich der Bericht im Zustand "Ausführen" oder "Fehlgeschlagen" befindet.
secondaryReportUrl	BenefitUtilizationSummaryReportSchema	Sas-URL zu asynchronem Nutzennutzungszusammenfassungsbericht im sekundären Speicher im Falle eines primären Ausfalls. Ist leer, wenn sich der Bericht im Zustand "Ausführen" oder "Fehlgeschlagen" befindet.
validUntil	string	Das Datum, an dem die sas-URL in reportUrl abläuft.

benefitKind

Reservierung oder Sparplan.

Name	Typ	Beschreibung
IncludedQuantity	string	Der Vorteil ist inbegriffen.
Reservation	string	Vorteil ist Reservierung.
SavingsPlan	string	Vorteil ist SavingsPlan.

BenefitUtilizationSummariesOperationStatus

Der Status eines Berichts über die Leistungsnutzungszusammenfassung. Stellt Async Benefit Utilization Zusammenfassungen Anforderungseingabe, Status und Sas-URL des Berichts bereit.

Name	Typ	Beschreibung
input	BenefitUtilizationSummariesRequest	Eingaben, die zum Erstellen des Berichts zur Leistungsauslastung gegeben wurden.
properties	AsyncOperationStatusProperties	Enthält sas url to the async benefit utilization summaryes report and a date that the url is valid until. Diese Werte sind leer, wenn sich der Bericht in einem Zustand "Ausführen" oder "Fehlgeschlagen" befindet.
status	OperationStatusType	Der Status der Erstellung des Berichts über die Leistungsnutzung.

BenefitUtilizationSummariesRequest

Eigenschaften einer asynchronen Vorteilsnutzungszusammenfassungsanforderung.

Name	Typ	Beschreibung
benefitId	string	Vorteils-ID, für die der Zusammenfassende Bericht über die Nutzung von Vorteilen gilt. Erforderlich für den Leistungs-ID-Bereich. Wird für den Leistungsauftrag oder abrechnungsbezogene Bereiche nicht unterstützt.
benefitOrderId	string	Die Leistungsauftrags-ID ist der Bericht über die Leistungsauslastung. Erforderlich für Leistungsauftrags- und Leistungs-ID-Bereiche. Wird für Abrechnungsbereiche nicht unterstützt.
billingAccountId	string	Abrechnungskonto, für das der Bericht "Nutzennutzungszusammenfassungen" gilt. Erforderlich für Abrechnungskonto- und Abrechnungsprofilbereiche. Wird für alle Leistungsbereiche nicht unterstützt.
billingProfileId	string	Abrechnungsprofil-ID, für die der Bericht über die Leistungsnutzungszusammenfassung gilt. Erforderlich für den Abrechnungsprofilbereich. Wird für Abrechnungskonten oder Leistungsbereiche nicht unterstützt.
endDate	string	Das Enddatum der Zusammenfassungsdaten, die im Bericht bereitgestellt werden.
grain	grain	Das Korn der Zusammenfassungsdaten wird im Bericht bereitgestellt. Akzeptierte Werte sind "Täglich" oder "Monatlich".
kind	benefitKind	Der Typ der angeforderten Leistungsdaten. Erforderlich für Abrechnungskonto- und Abrechnungsprofilbereiche. Implizit und nicht zu leistungsbezogenen Bereichen übergeben werden. Unterstützte Werte sind Reservation und SavingsPlan
startDate	string	Das Startdatum der Zusammenfassungsdaten, die im Bericht bereitgestellt werden.

BenefitUtilizationSummaryReportSchema

Die CSV-Datei aus dem reportUrl- und sekundärenReportUrl-BLOB-Link besteht aus den folgenden Spalten mit Nutzennutzungsdaten. Die Nutzung VonPercentage wird 0 für Sparpläne Berichte und nicht Datensteinreservierungen sein. Die Nutzungsprozentsätze sind 0 für Datensteinreservierungen.

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	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

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

Einige Fehlerantworten:

429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit.
503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.

Name	Typ	Beschreibung
error	ErrorDetails	Die Details des Fehlers.

grain

Das Korn der Nutzung. Unterstützte Werte: "Stündlich"

Name	Typ	Beschreibung
Daily	string	Stundenkorn entspricht dem Wert pro Tag.
Hourly	string	Stundenkorn entspricht dem Wert pro Stunde.
Monthly	string	Stundenkorn entspricht dem Wert pro Monat.

OperationStatusType

Der Status der Erstellung des Berichts über die Leistungsnutzung.

Name	Typ	Beschreibung
Complete	string
Failed	string
Running	string

Freigeben über

Generate Benefit Utilization Summaries Report - Generate By Billing Account

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

GenerateUtilizationSummariesReportByBillingAccount

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AsyncOperationStatusProperties

benefitKind

BenefitUtilizationSummariesOperationStatus

BenefitUtilizationSummariesRequest

BenefitUtilizationSummaryReportSchema

ErrorDetails

ErrorResponse

grain

OperationStatusType

Zusätzliche Ressourcen