Generate Cost Details Report - Create Operation
Diese API ist der Ersatz für alle zuvor veröffentlichten Nutzungsdetails-APIs. Fordern Sie an, einen Kostendetailsbericht für den angegebenen Zeitraum, den Abrechnungszeitraum (nur Unternehmenskunden) oder die Rechnungs-ID asynchron in einem bestimmten Bereich zu generieren. Der anfängliche Aufruf, um einen Bericht anzufordern, gibt einen 202-Wert mit dem Header "Location" und "Retry-After" zurück. Der Header "Location" stellt den Endpunkt zum Abrufen des Ergebnisses der Berichtsgenerierung bereit. Der Vorgang "Wiederholen nach" stellt die Dauer für die Wartezeit vor dem Abrufen des generierten Berichts bereit. Ein Aufruf zum Abrufen des Berichtsvorgangs stellt eine 202-Antwort mit einem Header "Ort" bereit, wenn der Vorgang noch ausgeführt wird. Sobald der Vorgang zur Berichtgenerierung abgeschlossen ist, stellt der Abrufendpunkt eine 200-Antwort zusammen mit Details zu den Berichts-BLOBs bereit, die zum Download verfügbar sind. Die Details zu den zum Download verfügbaren Dateien sind im Antworttext des Abrufs verfügbar. Informationen zu Kostendetails (früher als Nutzungsdetails bezeichnet) in Dateien gefundenen Feldern finden Sie unter https://learn.microsoft.com/en-us/azure/cost-management-billing/automate/understand-usage-details-fields
POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2024-08-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
scope
|
path | True |
string |
Die ARM-Ressourcen-ID für Abonnement, Abrechnungskonto oder andere Abrechnungsbereiche. Derzeit werden Ressourcengruppe und Verwaltungsgruppe nicht unterstützt. Weitere Informationen finden Sie unter https://aka.ms/costmgmt/scopes. |
api-version
|
query | True |
string |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
billingPeriod |
string |
Dieser Parameter kann nur von Enterprise Agreement-Kunden verwendet werden. Verwenden Sie das YearMonth(z. B. 202008)-Format. Dieser Parameter kann nicht zusammen mit den parametern "invoiceId" oder "timePeriod" verwendet werden. Wenn ein timePeriod-, invoiceId- oder billingPeriod-Parameter nicht im Anforderungstext angegeben wird, gibt die API die Kosten des aktuellen Monats zurück. |
invoiceId |
string |
Dieser Parameter kann nur von Kunden des Microsoft-Kundenvertrags verwendet werden. Darüber hinaus kann sie nur im Bereich "Abrechnungsprofil" oder "Kunde" verwendet werden. Dieser Parameter kann nicht zusammen mit den parametern billingPeriod oder timePeriod verwendet werden. Wenn ein timePeriod-, invoiceId- oder billingPeriod-Parameter nicht im Anforderungstext angegeben wird, gibt die API die Kosten des aktuellen Monats zurück. |
metric |
Der Typ des detaillierten Berichts. ActualCost wird standardmäßig 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 ein timePeriod-, invoiceId- oder billingPeriod-Parameter nicht im Anforderungstext angegeben wird, gibt die API die Kosten des aktuellen Monats zurück. DIE API ermöglicht nur das Abrufen von Daten für 1 Monat oder weniger und nicht älter als 13 Monate. Wenn "timePeriod" oder "billingPeriod" oder "invoiceId" nicht angegeben wird, wird die API standardmäßig für den Zeitraum des geöffneten Monats verwendet. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die Anforderungsverarbeitung wurde abgeschlossen. |
|
202 Accepted |
Angenommen. Die Anforderung wird verarbeitet. Verwenden Sie den Speicherortheader, um den Status zu überprüfen. Header
|
|
204 No Content |
Kein Inhalt. Die Anforderung ist erfolgreich, hat aber keine Ergebnisse zurückgegeben. |
|
Other Status Codes |
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
GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
Beispielanforderung
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2024-08-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": "2024-08-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=2024-08-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=2024-08-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": "2024-08-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=2024-08-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=2024-08-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": "2024-08-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=2024-08-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=2024-08-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": "2024-08-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=2024-08-01
Retry-After: 60
GenerateCostDetailsReportByDepartmentsAndTimePeriod
Beispielanforderung
POST https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2024-08-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": "2024-08-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=2024-08-01
Retry-After: 60
GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod
Beispielanforderung
POST https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2024-08-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": "2024-08-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=2024-08-01
Retry-After: 60
GenerateCostDetailsReportBySubscriptionAndTimePeriod
Beispielanforderung
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2024-08-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": "2024-08-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=2024-08-01
Retry-After: 60
Definitionen
Name | Beschreibung |
---|---|
Blob |
Die von diesem Vorgang generierten BLOB-Informationen. |
Cost |
Das Datenformat des Berichts |
Cost |
Der Typ des detaillierten Berichts. ActualCost wird standardmäßig bereitgestellt. |
Cost |
Das Ergebnis des lang ausgeführten Vorgangs für die Kostendetails-API. |
Cost |
Der Status des Vorgangs "Kostendetails" |
Cost |
Das Start- und Enddatum für das Abrufen von Daten für den detaillierten Kostenbericht. DIE API ermöglicht nur das Abrufen von Daten für 1 Monat oder weniger und nicht älter als 13 Monate. |
Error |
Die Details des Fehlers. |
Generate |
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 von diesem Vorgang generierten BLOB-Informationen.
Name | Typ | Beschreibung |
---|---|---|
blobLink |
string |
Link zum Blob zum Herunterladen der Datei. |
byteCount |
integer |
Bytes im Blob. |
CostDetailsDataFormat
Das Datenformat des Berichts
Name | Typ | Beschreibung |
---|---|---|
Csv |
string |
CSV-Datenformat. |
CostDetailsMetricType
Der Typ des detaillierten Berichts. ActualCost wird standardmäßig bereitgestellt.
Name | Typ | Beschreibung |
---|---|---|
ActualCost |
string |
Ist-Kostendaten. |
AmortizedCost |
string |
Amortisierte Kostendaten. |
CostDetailsOperationResults
Das Ergebnis des lang ausgeführten Vorgangs für die Kostendetails-API.
Name | Typ | Beschreibung |
---|---|---|
error |
Die Details des Fehlers. |
|
id |
string |
Die ID des vorgangs mit langer Ausführung. |
manifest.blobCount |
integer |
Die Gesamtanzahl der Blobs. |
manifest.blobs |
Blob |
Liste der blob-Informationen, die von diesem Vorgang generiert werden. |
manifest.byteCount |
integer |
Die Gesamtanzahl der Bytes in allen Blobs. |
manifest.compressData |
boolean |
Ist die Daten im komprimierten Format. |
manifest.dataFormat |
Das Datenformat des Berichts |
|
manifest.manifestVersion |
string |
Die Manifestversion. |
manifest.requestContext.requestBody |
Der Anforderungsnutzlasttext, der im Anruf "Kostendetails" bereitgestellt wird |
|
manifest.requestContext.requestScope |
string |
Der Anforderungsbereich der Anforderung. |
name |
string |
Der Name des vorgangs mit langer Ausführung. |
status |
Der Status des Vorgangs "Kostendetails" |
|
type |
string |
Der Typ des vorgangs mit langer Ausführung. |
validTill |
string |
Die Uhrzeit, zu der die Berichts-URL in UTC ungültig/abläuft, z. B. 2020-12-08T05:55:59.4394737Z. |
CostDetailsStatusType
Der Status des Vorgangs "Kostendetails"
Name | Typ | Beschreibung |
---|---|---|
Completed |
string |
Der Vorgang ist abgeschlossen. |
Failed |
string |
Vorgang fehlgeschlagen. |
NoDataFound |
string |
Der Vorgang ist abgeschlossen, und es wurden keine Kostendaten gefunden. |
CostDetailsTimePeriod
Das Start- und Enddatum für das Abrufen von Daten für den detaillierten Kostenbericht. DIE API ermöglicht nur das Abrufen von Daten für 1 Monat oder weniger und nicht älter als 13 Monate.
Name | Typ | Beschreibung |
---|---|---|
end |
string |
Das Enddatum, in 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 |
Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist. |
GenerateCostDetailsReportErrorResponse
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 ein ungültiges Element auf, das in der Anforderungsnutzlast nicht akzeptiert wurde.
400 Ungültige Anforderung – Ungültige Anforderungsnutzlast: kann nur "timePeriod" oder "invoiceId" oder "billingPeriod" aufweisen. Die API ermöglicht nur das Abrufen von Daten für "timePeriod" oder "invoiceId" oder "billingPeriod". Der Kunde sollte nur einen dieser Parameter bereitstellen.
400 Ungültige Anforderung - Startdatum muss hinter sein. Die API ermöglicht nur, dass Daten ab jetzt nicht älter als 13 Monate abgerufen werden.
400 Ungültige Anforderung – Der maximal zulässige Datumsbereich beträgt 1 Monate. Die API ermöglicht nur das Abrufen von Daten für 1 Monat oder weniger.
429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die zeit, die im Header "Retry-after" angegeben ist.
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 |
Die Details des Fehlers. |
GenerateCostDetailsReportRequestDefinition
Die Definition eines detaillierten Kostenberichts.
Name | Typ | Beschreibung |
---|---|---|
billingPeriod |
string |
Dieser Parameter kann nur von Enterprise Agreement-Kunden verwendet werden. Verwenden Sie das YearMonth(z. B. 202008)-Format. Dieser Parameter kann nicht zusammen mit den parametern "invoiceId" oder "timePeriod" verwendet werden. Wenn ein timePeriod-, invoiceId- oder billingPeriod-Parameter nicht im Anforderungstext angegeben wird, gibt die API die Kosten des aktuellen Monats zurück. |
invoiceId |
string |
Dieser Parameter kann nur von Kunden des Microsoft-Kundenvertrags verwendet werden. Darüber hinaus kann sie nur im Bereich "Abrechnungsprofil" oder "Kunde" verwendet werden. Dieser Parameter kann nicht zusammen mit den parametern billingPeriod oder timePeriod verwendet werden. Wenn ein timePeriod-, invoiceId- oder billingPeriod-Parameter nicht im Anforderungstext angegeben wird, gibt die API die Kosten des aktuellen Monats zurück. |
metric |
Der Typ des detaillierten Berichts. ActualCost wird standardmäßig 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 ein timePeriod-, invoiceId- oder billingPeriod-Parameter nicht im Anforderungstext angegeben wird, gibt die API die Kosten des aktuellen Monats zurück. DIE API ermöglicht nur das Abrufen von Daten für 1 Monat oder weniger und nicht älter als 13 Monate. Wenn "timePeriod" oder "billingPeriod" oder "invoiceId" nicht angegeben wird, wird die API standardmäßig für den Zeitraum des geöffneten Monats verwendet. |