Generate Cost Details Report - Create Operation
Ten interfejs API zastępuje wszystkie interfejsy API szczegółów użycia poprzednich wersji. Żądanie wygenerowania raportu szczegółów kosztów dla podanego zakresu dat, okresu rozliczeniowego (tylko klienci korporacyjni) lub identyfikatora faktury asynchronicznie w określonym zakresie. Początkowe wywołanie żądania raportu zwróci 202 z nagłówkiem "Location" i "Retry-After". Nagłówek "Lokalizacja" udostępni punkt końcowy do sondowania, aby uzyskać wynik generowania raportu. Polecenie "Ponów próbę po" zapewnia czas oczekiwania przed sondowaniem wygenerowanego raportu. Wywołanie sondowania operacji raportu zapewni odpowiedź 202 z nagłówkiem "Lokalizacja", jeśli operacja jest nadal w toku. Po zakończeniu operacji generowania raportu punkt końcowy sondowania udostępni odpowiedź 200 wraz ze szczegółami dotyczącymi obiektów blob raportu, które są dostępne do pobrania. Szczegółowe informacje o plikach dostępnych do pobrania będą dostępne w treści odpowiedzi sondowania. Aby poznać szczegóły kosztów (wcześniej znane jako szczegóły użycia) pola znalezione w plikach, zobacz 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
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
scope
|
path | True |
string |
Identyfikator zasobu usługi ARM dla subskrypcji, konta rozliczeniowego lub innych zakresów rozliczeniowych. Obecnie grupa zasobów i grupa zarządzania nie są obsługiwane. Aby uzyskać szczegółowe informacje, zobacz https://aka.ms/costmgmt/scopes. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Treść żądania
Nazwa | Typ | Opis |
---|---|---|
billingPeriod |
string |
Ten parametr może być używany tylko przez klientów z umową Enterprise Agreement. Użyj formatu YearMonth (np. 202008). Tego parametru nie można używać razem z parametrami invoiceId lub timePeriod. Jeśli parametr timePeriod, invoiceId lub billingPeriod nie jest podany w treści żądania interfejs API zwróci koszt bieżącego miesiąca. |
invoiceId |
string |
Ten parametr może być używany tylko przez klientów z Umową z Klientem Microsoft. Ponadto można go używać tylko w obszarze Profil rozliczeniowy lub Zakres klienta. Tego parametru nie można używać razem z parametrami billingPeriod lub timePeriod. Jeśli parametr timePeriod, invoiceId lub billingPeriod nie jest podany w treści żądania interfejs API zwróci koszt bieżącego miesiąca. |
metric |
Typ szczegółowego raportu. Domyślnie jest udostępniany koszt rzeczywisty |
|
timePeriod |
Określony zakres dat szczegółów kosztów żądanych dla raportu. Tego parametru nie można użyć obok parametrów invoiceId lub billingPeriod. Jeśli parametr timePeriod, invoiceId lub billingPeriod nie jest podany w treści żądania interfejs API zwróci koszt bieżącego miesiąca. Interfejs API umożliwia ściąganie danych tylko przez 1 miesiąc lub mniej i nie starsze niż 13 miesięcy. Jeśli interfejs API nie ma wartości timePeriod lub billingPeriod lub invoiceId, interfejs API jest domyślnie udostępniany okresowi czasu otwartego miesiąca |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Przetwarzanie żądań zostało zakończone. |
|
202 Accepted |
Akceptowane. Żądanie zostanie przetworzone. Użyj nagłówka Lokalizacja, aby sprawdzić stan. Nagłówki
|
|
204 No Content |
Brak zawartości. Żądanie zakończyło się pomyślnie, ale nie zwróciło żadnych wyników. |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ protokołu OAuth2 usługi Azure Active Directory.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
Przykładowe żądanie
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2024-08-01
{
"metric": "ActualCost",
"billingPeriod": "202205"
}
Przykładowa odpowiedź
{
"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
Przykładowe żądanie
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"
}
Przykładowa odpowiedź
{
"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
Przykładowe żądanie
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"
}
Przykładowa odpowiedź
{
"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
Przykładowe żądanie
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"
}
}
Przykładowa odpowiedź
{
"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
Przykładowe żądanie
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"
}
}
Przykładowa odpowiedź
{
"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
Przykładowe żądanie
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"
}
}
Przykładowa odpowiedź
{
"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
Przykładowe żądanie
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"
}
}
Przykładowa odpowiedź
{
"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
Definicje
Nazwa | Opis |
---|---|
Blob |
Informacje o obiekcie blob wygenerowane przez tę operację. |
Cost |
Format danych raportu |
Cost |
Typ szczegółowego raportu. Domyślnie jest udostępniany koszt rzeczywisty |
Cost |
Wynik długotrwałej operacji dla interfejsu API szczegółów kosztów. |
Cost |
Stan operacji szczegółów kosztów |
Cost |
Data rozpoczęcia i zakończenia ściągania danych dla szczegółowego raportu o kosztach. Interfejs API umożliwia ściąganie danych tylko przez 1 miesiąc lub mniej i nie starsze niż 13 miesięcy. |
Error |
Szczegóły błędu. |
Generate |
Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie. Niektóre odpowiedzi na błędy:
|
Generate |
Definicja szczegółowego raportu dotyczącego kosztów. |
BlobInfo
Informacje o obiekcie blob wygenerowane przez tę operację.
Nazwa | Typ | Opis |
---|---|---|
blobLink |
string |
Połącz z obiektem blob, aby pobrać plik. |
byteCount |
integer |
Bajty w obiekcie blob. |
CostDetailsDataFormat
Format danych raportu
Nazwa | Typ | Opis |
---|---|---|
Csv |
string |
Format danych csv. |
CostDetailsMetricType
Typ szczegółowego raportu. Domyślnie jest udostępniany koszt rzeczywisty
Nazwa | Typ | Opis |
---|---|---|
ActualCost |
string |
Dane dotyczące kosztów rzeczywistych. |
AmortizedCost |
string |
Dane dotyczące kosztu zamortyzowanego. |
CostDetailsOperationResults
Wynik długotrwałej operacji dla interfejsu API szczegółów kosztów.
Nazwa | Typ | Opis |
---|---|---|
error |
Szczegóły błędu. |
|
id |
string |
Identyfikator długotrwałej operacji. |
manifest.blobCount |
integer |
Całkowita liczba obiektów blob. |
manifest.blobs |
Blob |
Lista informacji o obiektach blob wygenerowanych przez tę operację. |
manifest.byteCount |
integer |
Całkowita liczba bajtów we wszystkich obiektach blob. |
manifest.compressData |
boolean |
Czy dane są w formacie skompresowanym. |
manifest.dataFormat |
Format danych raportu |
|
manifest.manifestVersion |
string |
Wersja manifestu. |
manifest.requestContext.requestBody |
Treść ładunku żądania podana w wywołaniu Cost Details |
|
manifest.requestContext.requestScope |
string |
Zakres żądania. |
name |
string |
Nazwa długotrwałej operacji. |
status |
Stan operacji szczegółów kosztów |
|
type |
string |
Typ długotrwałej operacji. |
validTill |
string |
Czas, w którym adres URL raportu staje się nieprawidłowy/wygasa w utc, np. 2020-12-08T05:55:59.4394737Z. |
CostDetailsStatusType
Stan operacji szczegółów kosztów
Nazwa | Typ | Opis |
---|---|---|
Completed |
string |
Operacja jest zakończona. |
Failed |
string |
Operacja nie powiodła się. |
NoDataFound |
string |
Operacja jest ukończona i nie znaleziono danych kosztów. |
CostDetailsTimePeriod
Data rozpoczęcia i zakończenia ściągania danych dla szczegółowego raportu o kosztach. Interfejs API umożliwia ściąganie danych tylko przez 1 miesiąc lub mniej i nie starsze niż 13 miesięcy.
Nazwa | Typ | Opis |
---|---|---|
end |
string |
Data zakończenia do ściągnięcia danych. przykładowy format 2020-03-15 |
start |
string |
Data rozpoczęcia ściągania danych. przykładowy format 2020-03-15 |
ErrorDetails
Szczegóły błędu.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
message |
string |
Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się. |
GenerateCostDetailsReportErrorResponse
Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie.
Niektóre odpowiedzi na błędy:
400 Nieprawidłowe żądanie — nieprawidłowy ładunek żądania. Podany ładunek żądania nie jest w formacie JSON lub nieprawidłowy element członkowski nie został zaakceptowany w ładunku żądania.
400 Nieprawidłowe żądanie — nieprawidłowy ładunek żądania: może mieć tylko wartość timePeriod lub invoiceId lub billingPeriod. Interfejs API umożliwia ściąganie danych tylko dla właściwości timePeriod lub invoiceId lub billingPeriod. Klient powinien podać tylko jeden z tych parametrów.
400 Nieprawidłowe żądanie — data rozpoczęcia musi być późniejsza niż . Interfejs API umożliwia ściąganie danych nie starszych niż 13 miesięcy.
400 Nieprawidłowe żądanie — maksymalny dozwolony zakres dat wynosi 1 miesiące. Interfejs API umożliwia ściąganie danych tylko przez 1 miesiąc lub mniej.
429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po upływie czasu określonego w nagłówku "retry-after".
503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Ponów próbę po upływie czasu określonego w nagłówku "Ponów próbę po".
Nazwa | Typ | Opis |
---|---|---|
error |
Szczegóły błędu. |
GenerateCostDetailsReportRequestDefinition
Definicja szczegółowego raportu dotyczącego kosztów.
Nazwa | Typ | Opis |
---|---|---|
billingPeriod |
string |
Ten parametr może być używany tylko przez klientów z umową Enterprise Agreement. Użyj formatu YearMonth (np. 202008). Tego parametru nie można używać razem z parametrami invoiceId lub timePeriod. Jeśli parametr timePeriod, invoiceId lub billingPeriod nie jest podany w treści żądania interfejs API zwróci koszt bieżącego miesiąca. |
invoiceId |
string |
Ten parametr może być używany tylko przez klientów z Umową z Klientem Microsoft. Ponadto można go używać tylko w obszarze Profil rozliczeniowy lub Zakres klienta. Tego parametru nie można używać razem z parametrami billingPeriod lub timePeriod. Jeśli parametr timePeriod, invoiceId lub billingPeriod nie jest podany w treści żądania interfejs API zwróci koszt bieżącego miesiąca. |
metric |
Typ szczegółowego raportu. Domyślnie jest udostępniany koszt rzeczywisty |
|
timePeriod |
Określony zakres dat szczegółów kosztów żądanych dla raportu. Tego parametru nie można użyć obok parametrów invoiceId lub billingPeriod. Jeśli parametr timePeriod, invoiceId lub billingPeriod nie jest podany w treści żądania interfejs API zwróci koszt bieżącego miesiąca. Interfejs API umożliwia ściąganie danych tylko przez 1 miesiąc lub mniej i nie starsze niż 13 miesięcy. Jeśli interfejs API nie ma wartości timePeriod lub billingPeriod lub invoiceId, interfejs API jest domyślnie udostępniany okresowi czasu otwartego miesiąca |