Generate Cost Details Report - Create Operation
Diese API ist der Ersatz für alle APIs, die zuvor veröffentlicht wurden: Nutzungsdetails. Anforderung zum asynchronen Generieren eines Kostendetailsberichts für den angegebenen Datumsbereich, Abrechnungszeitraum (nur Unternehmenskunden) oder Rechnungs-ID in einem bestimmten Bereich. Der anfängliche Aufruf zum Anfordern eines Berichts gibt einen 202-Wert mit dem Header "Location" und "Retry-After" zurück. Der Header "Location" stellt den Endpunkt bereit, der abgerufen werden soll, um das Ergebnis der Berichtsgenerierung zu erhalten. Das "Retry-After" gibt die Wartezeit an, bevor der generierte Bericht abgefragt wird. Ein Aufruf zum Abrufen des Berichtsvorgangs liefert eine 202-Antwort mit einem "Location"-Header, wenn der Vorgang noch ausgeführt wird. Nach Abschluss des Berichtsgenerierungsvorgangs gibt der Abrufendpunkt eine Antwort vom Typ 200 zusammen mit Details zu den Berichtsblobs an, die zum Download verfügbar sind. Die Details zu den zum Download verfügbaren Dateien sind im Antworttext der Abrufe verfügbar. Informationen zu Kostendetails (früher als Nutzungsdetails bezeichnet) Feldern in Dateien finden Sie unter https://video2.skills-academy.com/en-us/azure/cost-management-billing/automate/understand-usage-details-fields
POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
scope
|
path | True |
string |
Die ARM-Ressourcen-ID für Abonnement, Abrechnungskonto oder andere Abrechnungsbereiche. Ressourcengruppen und Verwaltungsgruppen werden derzeit nicht unterstützt. Ausführliche Informationen finden Sie unter https://aka.ms/costmgmt/scopes. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
billingPeriod |
string |
Dieser Parameter eignet sich nur für Kunden mit Enterprise Agreement. Verwenden Sie das YearMonth-Format (z. B. 202008). Dieser Parameter kann nicht zusammen mit den Parametern invoiceId oder timePeriod verwendet werden. Wenn im Anforderungstext kein parameter timePeriod, invoiceId oder billingPeriod angegeben wird, gibt die API die Kosten des aktuellen Monats zurück. |
invoiceId |
string |
Dieser Parameter eignet sich nur für Kunden mit Microsoft-Kundenvereinbarung. Darüber hinaus kann er nur im Bereich „Abrechnungsprofil“ oder „Kunde“ verwendet werden. Dieser Parameter kann nicht zusammen mit den Parametern billingPeriod oder timePeriod verwendet werden. Wenn im Anforderungstext kein parameter timePeriod, invoiceId oder billingPeriod angegeben wird, gibt die API die Kosten des aktuellen Monats zurück. |
metric |
Der Typ des detaillierten Berichts. Standardmäßig wird ActualCost bereitgestellt. |
|
timePeriod |
Der spezifische Datumsbereich der für den Bericht angeforderten Kostendetails. Dieser Parameter kann nicht zusammen mit den Parametern invoiceId oder billingPeriod verwendet werden. Wenn im Anforderungstext kein parameter timePeriod, invoiceId oder billingPeriod angegeben wird, gibt die API die Kosten des aktuellen Monats zurück. Die API lässt das Pullen von Daten nur für einen Monat oder weniger zu und darf nicht älter als 13 Monate sein. Wenn kein timePeriod oder billingPeriod oder invoiceId bereitgestellt wird, wird die API standardmäßig auf den Zeitraum des geöffneten Monats festgelegt. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die Anforderungsverarbeitung wurde abgeschlossen. |
|
202 Accepted |
Akzeptiert: Die Anforderung wird verarbeitet. Verwenden Sie den Location-Header, um die status zu überprüfen. Header
|
|
204 No Content |
Kein Inhalt. Die Anforderung war erfolgreich, hat aber keine Ergebnisse zurückgegeben. |
|
Other Status Codes |
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
GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
Beispielanforderung
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"billingPeriod": "202205"
}
Beispiel für eine Antwort
{
"id": "providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "providers/Microsoft.Billing/billingAccounts/12345",
"requestBody": {
"metric": "ActualCost",
"billingPeriod": "202205"
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
GenerateCostDetailsReportByBillingProfileAndInvoiceId
Beispielanforderung
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"invoiceId": "M1234567"
}
Beispiel für eine Antwort
{
"id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579",
"requestBody": {
"metric": "ActualCost",
"billingPeriod": "202205"
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId
Beispielanforderung
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"invoiceId": "M1234567"
}
Beispiel für eine Antwort
{
"id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579",
"requestBody": {
"metric": "ActualCost",
"billingPeriod": "202205"
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
GenerateCostDetailsReportByCustomerAndTimePeriod
Beispielanforderung
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
Beispiel für eine Antwort
{
"id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579",
"requestBody": {
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
GenerateCostDetailsReportByDepartmentsAndTimePeriod
Beispielanforderung
POST https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
Beispiel für eine Antwort
{
"id": "providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "providers/Microsoft.Billing/departments/12345",
"requestBody": {
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod
Beispielanforderung
POST https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
Beispiel für eine Antwort
{
"id": "providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "providers/Microsoft.Billing/enrollmentAccounts/1234",
"requestBody": {
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
GenerateCostDetailsReportBySubscriptionAndTimePeriod
Beispielanforderung
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
Beispiel für eine Antwort
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "subscriptions/00000000-0000-0000-0000-000000000000",
"requestBody": {
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
Definitionen
Name | Beschreibung |
---|---|
Blob |
Die durch diesen Vorgang generierten Blobinformationen. |
Cost |
Das Datenformat des Berichts |
Cost |
Der Typ des detaillierten Berichts. Standardmäßig wird ActualCost bereitgestellt. |
Cost |
Das Ergebnis des zeitintensiven Vorgangs für die Kostendetails-API. |
Cost |
Die status des Kostendetails-Vorgangs |
Cost |
Das Start- und Enddatum für das Pullen von Daten für den detaillierten Kostenbericht. Die API lässt das Pullen von Daten nur für einen Monat oder weniger zu und darf nicht älter als 13 Monate sein. |
Error |
Die Details des Fehlers. |
Generate |
Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben. Einige Fehlerantworten:
|
Generate |
Die Definition eines detaillierten Kostenberichts. |
BlobInfo
Die durch diesen Vorgang generierten Blobinformationen.
Name | Typ | Beschreibung |
---|---|---|
blobLink |
string |
Verknüpfen Sie das Blob, um die Datei herunterzuladen. |
byteCount |
integer |
Bytes im Blob. |
CostDetailsDataFormat
Das Datenformat des Berichts
Name | Typ | Beschreibung |
---|---|---|
Csv |
string |
CSV-Datenformat. |
CostDetailsMetricType
Der Typ des detaillierten Berichts. Standardmäßig wird ActualCost bereitgestellt.
Name | Typ | Beschreibung |
---|---|---|
ActualCost |
string |
Ist-Kostendaten. |
AmortizedCost |
string |
Amortisierte Kostendaten. |
CostDetailsOperationResults
Das Ergebnis des zeitintensiven Vorgangs für die Kostendetails-API.
Name | Typ | Beschreibung |
---|---|---|
error |
Die Details des Fehlers. |
|
id |
string |
Die ID des zeitintensiven Vorgangs. |
manifest.blobCount |
integer |
Die Gesamtanzahl der Blobs. |
manifest.blobs |
Blob |
Liste der durch diesen Vorgang generierten Blobinformationen. |
manifest.byteCount |
integer |
Die Gesamtanzahl der Bytes in allen Blobs. |
manifest.compressData |
boolean |
Die Daten im komprimierten Format. |
manifest.dataFormat |
Das Datenformat des Berichts |
|
manifest.manifestVersion |
string |
Die Manifestversion. |
manifest.requestContext.requestBody |
Der Anforderungsnutzlasttext, der im Aufruf "Kostendetails" bereitgestellt wird. |
|
manifest.requestContext.requestScope |
string |
Der Anforderungsbereich der Anforderung. |
name |
string |
Der Name des vorgangs mit langer Ausführungsdauer. |
status |
Die status des Kostendetails-Vorgangs |
|
type |
string |
Der Typ des Vorgangs mit langer Ausführungsdauer. |
validTill |
string |
Der Zeitpunkt, zu dem die Berichts-URL ungültig wird oder in UTC abläuft, z. B. 2020-12-08T05:55:59.4394737Z. |
CostDetailsStatusType
Die status des Kostendetails-Vorgangs
Name | Typ | Beschreibung |
---|---|---|
Completed |
string |
Vorgang ist abgeschlossen. |
Failed |
string |
Fehler beim Vorgang. |
NoDataFound |
string |
Der Vorgang ist abgeschlossen, und es wurden keine Kostendaten gefunden. |
CostDetailsTimePeriod
Das Start- und Enddatum für das Pullen von Daten für den detaillierten Kostenbericht. Die API lässt das Pullen von Daten nur für einen Monat oder weniger zu und darf nicht älter als 13 Monate sein.
Name | Typ | Beschreibung |
---|---|---|
end |
string |
Das Enddatum, an das Daten abgerufen werden sollen. Beispielformat 2020-03-15 |
start |
string |
Das Startdatum, aus dem Daten abgerufen werden sollen. Beispielformat 2020-03-15 |
ErrorDetails
Die Details des Fehlers.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode |
message |
string |
Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist. |
GenerateCostDetailsReportErrorResponse
Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.
Einige Fehlerantworten:
400 Ungültige Anforderung: Ungültige Anforderungsnutzlast. Die bereitgestellte Anforderungsnutzlast weist kein JSON-Format auf oder weist in der Anforderungsnutzlast keinen ungültigen Member auf.
400 Bad Request – Ungültige Anforderungsnutzlast: kann nur timePeriod, invoiceId oder billingPeriod haben. Die API lässt nur das Pullen von Daten für timePeriod, invoiceId oder billingPeriod zu. Der Kunde sollte nur einen dieser Parameter angeben.
400 Ungültige Anforderung: Startdatum muss hinter sein. Die API ermöglicht nur das Abrufen von Daten, die nicht älter als 13 Monate sind.
400 Ungültige Anforderung: Der maximal zulässige Datumsbereich beträgt 1 Monate. Die API lässt das Pullen von Daten nur für einen Monat oder weniger zu.
429 TooManyRequests: Die Anforderung wird gedrosselt. Wiederholen Sie den Vorgang, nachdem Sie auf die im Header "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 |
Die Details des Fehlers. |
GenerateCostDetailsReportRequestDefinition
Die Definition eines detaillierten Kostenberichts.
Name | Typ | Beschreibung |
---|---|---|
billingPeriod |
string |
Dieser Parameter eignet sich nur für Kunden mit Enterprise Agreement. Verwenden Sie das YearMonth-Format (z. B. 202008). Dieser Parameter kann nicht zusammen mit den Parametern invoiceId oder timePeriod verwendet werden. Wenn im Anforderungstext kein parameter timePeriod, invoiceId oder billingPeriod angegeben wird, gibt die API die Kosten des aktuellen Monats zurück. |
invoiceId |
string |
Dieser Parameter eignet sich nur für Kunden mit Microsoft-Kundenvereinbarung. Darüber hinaus kann er nur im Bereich „Abrechnungsprofil“ oder „Kunde“ verwendet werden. Dieser Parameter kann nicht zusammen mit den Parametern billingPeriod oder timePeriod verwendet werden. Wenn im Anforderungstext kein parameter timePeriod, invoiceId oder billingPeriod angegeben wird, gibt die API die Kosten des aktuellen Monats zurück. |
metric |
Der Typ des detaillierten Berichts. Standardmäßig wird ActualCost bereitgestellt. |
|
timePeriod |
Der spezifische Datumsbereich der für den Bericht angeforderten Kostendetails. Dieser Parameter kann nicht zusammen mit den Parametern invoiceId oder billingPeriod verwendet werden. Wenn im Anforderungstext kein parameter timePeriod, invoiceId oder billingPeriod angegeben wird, gibt die API die Kosten des aktuellen Monats zurück. Die API lässt das Pullen von Daten nur für einen Monat oder weniger zu und darf nicht älter als 13 Monate sein. Wenn kein timePeriod oder billingPeriod oder invoiceId bereitgestellt wird, wird die API standardmäßig auf den Zeitraum des geöffneten Monats festgelegt. |