Generate Cost Details Report - Create Operation
Deze API is de vervanging voor alle eerder uitgebrachte API's voor gebruiksdetails. Aanvraag voor het genereren van een rapport met kostendetails voor het opgegeven datumbereik, de factureringsperiode (alleen zakelijke klanten) of factuur-id asynchroon voor een bepaald bereik. De eerste aanroep om een rapport aan te vragen retourneert een 202 met de header 'Locatie' en 'Opnieuw proberen na'. De header 'Locatie' biedt het eindpunt voor een poll om het resultaat van het genereren van het rapport op te halen. De 'Opnieuw proberen na' geeft de duur aan van het wachten voordat het gegenereerde rapport wordt gepeild. Een aanroep om de rapportbewerking te peilen, levert een 202-antwoord met een 'Locatie'-header op als de bewerking nog steeds wordt uitgevoerd. Zodra de bewerking voor het genereren van het rapport is voltooid, geeft het polling-eindpunt een 200-antwoord, samen met details over de rapport-blob(s) die kunnen worden gedownload. De details van de bestanden die kunnen worden gedownload, zijn beschikbaar in de hoofdtekst van het polling-antwoord. Als u inzicht wilt in de velden kostendetails (voorheen bekend als gebruiksgegevens) die in bestanden zijn gevonden, raadpleegt u 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=2023-11-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
scope
|
path | True |
string |
De ARM-resource-id voor abonnement, factureringsrekening of andere factureringsbereiken. Momenteel worden resourcegroep en beheergroep niet ondersteund. Ga voor details naar https://aka.ms/costmgmt/scopes. |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagbody
Name | Type | Description |
---|---|---|
billingPeriod |
string |
Deze parameter kan alleen worden gebruikt door Enterprise Agreement klanten. Gebruik de indeling YearMonth (bijvoorbeeld 202008). Deze parameter kan niet worden gebruikt in combinatie met de parameters invoiceId of timePeriod. Als de parameter timePeriod, invoiceId of billingPeriod niet is opgegeven in de aanvraagbody, retourneert de API de kosten van de huidige maand. |
invoiceId |
string |
Deze parameter kan alleen worden gebruikt door Microsoft-klantovereenkomst klanten. Bovendien kan het alleen worden gebruikt in het bereik Factureringsprofiel of Klant. Deze parameter kan niet worden gebruikt naast de parameters billingPeriod of timePeriod. Als de parameter timePeriod, invoiceId of billingPeriod niet is opgegeven in de aanvraagbody, retourneert de API de kosten van de huidige maand. |
metric |
Het type van het gedetailleerde rapport. ActualCost is standaard opgegeven |
|
timePeriod |
Het specifieke datumbereik van kostengegevens die zijn aangevraagd voor het rapport. Deze parameter kan niet worden gebruikt in combinatie met de parameters invoiceId of billingPeriod. Als de parameter timePeriod, invoiceId of billingPeriod niet is opgegeven in de aanvraagbody, retourneert de API de kosten van de huidige maand. Api staat alleen toe dat gegevens worden opgehaald voor 1 maand of minder en niet ouder dan 13 maanden. Als er geen timePeriod of billingPeriod of invoiceId is opgegeven, wordt de API standaard ingesteld op de periode van de geopende maand |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De verwerking van de aanvraag is voltooid. |
|
202 Accepted |
Aanvaard. Aanvraag wordt verwerkt. Gebruik de header Locatie om de status te controleren. Headers
|
|
204 No Content |
Geen inhoud. De aanvraag is geslaagd, maar heeft geen resultaten geretourneerd. |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
Sample Request
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"billingPeriod": "202205"
}
Sample Response
{
"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
Sample Request
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"
}
Sample Response
{
"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
Sample Request
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"
}
Sample Response
{
"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
Sample Request
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"
}
}
Sample Response
{
"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
Sample Request
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"
}
}
Sample Response
{
"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
Sample Request
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"
}
}
Sample Response
{
"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
Sample Request
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"
}
}
Sample Response
{
"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
Definities
Name | Description |
---|---|
Blob |
De blobgegevens die door deze bewerking worden gegenereerd. |
Cost |
De gegevensindeling van het rapport |
Cost |
Het type van het gedetailleerde rapport. ActualCost is standaard opgegeven |
Cost |
Het resultaat van de langdurige bewerking voor de API voor kostendetails. |
Cost |
De status van de bewerking kostendetails |
Cost |
De begin- en einddatum voor het ophalen van gegevens voor het gedetailleerde kostenrapport. Api staat alleen toe dat gegevens worden opgehaald voor 1 maand of minder en niet ouder dan 13 maanden. |
Error |
De details van de fout. |
Generate |
Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht. Enkele foutreacties:
|
Generate |
De definitie van een gedetailleerd kostenrapport. |
BlobInfo
De blobgegevens die door deze bewerking worden gegenereerd.
Name | Type | Description |
---|---|---|
blobLink |
string |
Maak een koppeling naar de blob om het bestand te downloaden. |
byteCount |
integer |
Bytes in de blob. |
CostDetailsDataFormat
De gegevensindeling van het rapport
Name | Type | Description |
---|---|---|
Csv |
string |
CSV-gegevensindeling. |
CostDetailsMetricType
Het type van het gedetailleerde rapport. ActualCost is standaard opgegeven
Name | Type | Description |
---|---|---|
ActualCost |
string |
Gegevens over werkelijke kosten. |
AmortizedCost |
string |
Afgeschreven kostengegevens. |
CostDetailsOperationResults
Het resultaat van de langdurige bewerking voor de API voor kostendetails.
Name | Type | Description |
---|---|---|
error |
De details van de fout. |
|
id |
string |
De id van de langlopende bewerking. |
manifest.blobCount |
integer |
Het totale aantal blobs. |
manifest.blobs |
Blob |
Lijst met blobgegevens die door deze bewerking zijn gegenereerd. |
manifest.byteCount |
integer |
Het totale aantal bytes in alle blobs. |
manifest.compressData |
boolean |
Hebben de gegevens een gecomprimeerde indeling. |
manifest.dataFormat |
De gegevensindeling van het rapport |
|
manifest.manifestVersion |
string |
De manifestversie. |
manifest.requestContext.requestBody |
De hoofdtekst van de nettolading van de aanvraag die is opgegeven in de aanroep Kostendetails |
|
manifest.requestContext.requestScope |
string |
Het aanvraagbereik van de aanvraag. |
name |
string |
De naam van de langdurige bewerking. |
status |
De status van de bewerking kostendetails |
|
type |
string |
Het type van de langdurige bewerking. |
validTill |
string |
Het tijdstip waarop de rapport-URL ongeldig wordt/verloopt in UTC, bijvoorbeeld 2020-12-08T05:55:59.4394737Z. |
CostDetailsStatusType
De status van de bewerking kostendetails
Name | Type | Description |
---|---|---|
Completed |
string |
De bewerking is voltooid. |
Failed |
string |
De bewerking is mislukt. |
NoDataFound |
string |
De bewerking is voltooid en er zijn geen kostengegevens gevonden. |
CostDetailsTimePeriod
De begin- en einddatum voor het ophalen van gegevens voor het gedetailleerde kostenrapport. Api staat alleen toe dat gegevens worden opgehaald voor 1 maand of minder en niet ouder dan 13 maanden.
Name | Type | Description |
---|---|---|
end |
string |
De einddatum voor het ophalen van gegevens. voorbeeld van indeling 2020-03-15 |
start |
string |
De begindatum waaruit gegevens moeten worden opgehaald. voorbeeld van indeling 2020-03-15 |
ErrorDetails
De details van de fout.
Name | Type | Description |
---|---|---|
code |
string |
Foutcode. |
message |
string |
Foutbericht dat aangeeft waarom de bewerking is mislukt. |
GenerateCostDetailsReportErrorResponse
Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht.
Enkele foutreacties:
400 Ongeldige aanvraag : ongeldige nettolading van aanvraag. De opgegeven nettolading van de aanvraag heeft geen JSON-indeling of een ongeldig lid is niet geaccepteerd in de nettolading van de aanvraag.
400 Ongeldige aanvraag - Ongeldige nettolading van aanvraag: kan alleen timePeriod, invoiceId of billingPeriod hebben. Api staat alleen toe dat gegevens worden opgehaald voor timePeriod of invoiceId of billingPeriod. De klant moet slechts een van deze parameters opgeven.
400 Ongeldige aanvraag - Begindatum moet na zijn. Api staat alleen toe dat gegevens vanaf nu niet ouder dan 13 maanden worden opgehaald.
400 Ongeldige aanvraag: het maximaal toegestane datumbereik is 1 maanden. Api staat alleen toe dat gegevens gedurende 1 maand of minder worden opgehaald.
429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de kop 'opnieuw proberen na'.
503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u net zolang hebt gewacht zoals aangegeven in de header 'Retry-After'.
Name | Type | Description |
---|---|---|
error |
De details van de fout. |
GenerateCostDetailsReportRequestDefinition
De definitie van een gedetailleerd kostenrapport.
Name | Type | Description |
---|---|---|
billingPeriod |
string |
Deze parameter kan alleen worden gebruikt door Enterprise Agreement klanten. Gebruik de indeling YearMonth (bijvoorbeeld 202008). Deze parameter kan niet worden gebruikt in combinatie met de parameters invoiceId of timePeriod. Als de parameter timePeriod, invoiceId of billingPeriod niet is opgegeven in de aanvraagbody, retourneert de API de kosten van de huidige maand. |
invoiceId |
string |
Deze parameter kan alleen worden gebruikt door Microsoft-klantovereenkomst klanten. Bovendien kan het alleen worden gebruikt in het bereik Factureringsprofiel of Klant. Deze parameter kan niet worden gebruikt naast de parameters billingPeriod of timePeriod. Als de parameter timePeriod, invoiceId of billingPeriod niet is opgegeven in de aanvraagbody, retourneert de API de kosten van de huidige maand. |
metric |
Het type van het gedetailleerde rapport. ActualCost is standaard opgegeven |
|
timePeriod |
Het specifieke datumbereik van kostengegevens die zijn aangevraagd voor het rapport. Deze parameter kan niet worden gebruikt in combinatie met de parameters invoiceId of billingPeriod. Als de parameter timePeriod, invoiceId of billingPeriod niet is opgegeven in de aanvraagbody, retourneert de API de kosten van de huidige maand. Api staat alleen toe dat gegevens worden opgehaald voor 1 maand of minder en niet ouder dan 13 maanden. Als er geen timePeriod of billingPeriod of invoiceId is opgegeven, wordt de API standaard ingesteld op de periode van de geopende maand |