Dela via


Generate Detailed Cost Report - Create Operation

Genererar den detaljerade kostnadsrapporten för angivet datumintervall, faktureringsperiod (endast företagskunder) eller faktura-ID asynkront i ett visst omfång. Anropet returnerar ett 202-meddelande med huvudet Azure –Consumption-AsyncOperation som tillhandahåller en länk till åtgärden som skapats. Ett anrop till åtgärden ger status och om åtgärden har slutförts lagras blobfilen där den genererade detaljerade kostnadsrapporten lagras.

POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

URI-parametrar

Name I Obligatorisk Typ Description
scope
path True

string

ARM-resurs-ID för prenumeration, resursgrupp, faktureringskonto eller andra faktureringsomfång. Mer information finns i https://aka.ms/costmgmt/scopes.

api-version
query True

string

DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name Typ Description
billingPeriod

string

Faktureringsperiod i yearmonth(t.ex. 202008) format. Endast för äldre företagskunder kan använda detta. Kan bara ha någon av parametrarna timePeriod eller invoiceId eller billingPeriod. Om ingen tillhandahålls tillhandahålls den aktuella månadskostnaden.

customerId

string

Kund-ID för Microsoft-kundavtalsomfång (faktura-ID krävs också för detta).

invoiceId

string

Faktura-ID för omfånget Betala per användning och Microsoft-kundavtal. Kan bara ha någon av parametrarna timePeriod eller invoiceId eller billingPeriod. Om ingen tillhandahålls tillhandahålls den aktuella månadskostnaden.

metric

GenerateDetailedCostReportMetricType

Typen av detaljerad rapport. Som standard tillhandahålls ActualCost

timePeriod

GenerateDetailedCostReportTimePeriod

Har en tidsperiod för att hämta data för den kostnads detaljerade rapporten. Kan bara ha någon av parametrarna timePeriod eller invoiceId eller billingPeriod. Om ingen tillhandahålls tillhandahålls den aktuella månadskostnaden.

Svar

Name Typ Description
200 OK

GenerateDetailedCostReportOperationResult

Bearbetningen av begäran har slutförts.

202 Accepted

Accepterad. Begäran bearbetas. Använd platsrubriken för att kontrollera statusen.

Sidhuvuden

  • Location: string
  • Azure-Consumption-AsyncOperation: string
  • Azure-AsyncOperation: string
  • Retry-After: integer
Other Status Codes

GenerateDetailedCostReportErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod
GenerateDetailedCostReportByBillingProfileAndInvoiceId
GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId
GenerateDetailedCostReportByCustomerAndTimePeriod
GenerateDetailedCostReportBySubscriptionAndTimePeriod

GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod

Exempelbegäran

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

{
  "metric": "ActualCost",
  "billingPeriod": "202008"
}

Exempelsvar

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Retry-After: 60

GenerateDetailedCostReportByBillingProfileAndInvoiceId

Exempelbegäran

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

{
  "metric": "ActualCost",
  "invoiceId": "M1234567"
}

Exempelsvar

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Retry-After: 60

GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId

Exempelbegäran

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

{
  "metric": "ActualCost",
  "invoiceId": "M1234567",
  "customerId": "456789"
}

Exempelsvar

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Retry-After: 60

GenerateDetailedCostReportByCustomerAndTimePeriod

Exempelbegäran

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

{
  "metric": "ActualCost",
  "timePeriod": {
    "start": "2020-03-01",
    "end": "2020-03-15"
  }
}

Exempelsvar

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Retry-After: 60

GenerateDetailedCostReportBySubscriptionAndTimePeriod

Exempelbegäran

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

{
  "metric": "ActualCost",
  "timePeriod": {
    "start": "2020-03-01",
    "end": "2020-03-15"
  }
}

Exempelsvar

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2021-10-01
Retry-After: 60

Definitioner

Name Description
ErrorDetails

Information om felet.

GenerateDetailedCostReportDefinition

Definitionen av en kostnadsbegränsade rapport.

GenerateDetailedCostReportErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

  • 413 Begärandeentiteten är för stor – begäran begränsas. Mängden data som krävs för att uppfylla begäran överskrider den maximala tillåtna storleken på 2 GB. Använd vår exportfunktion i stället.

  • 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen".

GenerateDetailedCostReportMetricType

Typen av detaljerad rapport. Som standard tillhandahålls ActualCost

GenerateDetailedCostReportOperationResult

Resultatet av den tidskrävande åtgärden för kostnads detaljerad rapport.

GenerateDetailedCostReportTimePeriod

Start- och slutdatumet för att hämta data för den kostnads detaljerade rapporten.

ErrorDetails

Information om felet.

Name Typ Description
code

string

Felkod.

message

string

Felmeddelande som anger varför åtgärden misslyckades.

GenerateDetailedCostReportDefinition

Definitionen av en kostnadsbegränsade rapport.

Name Typ Description
billingPeriod

string

Faktureringsperiod i yearmonth(t.ex. 202008) format. Endast för äldre företagskunder kan använda detta. Kan bara ha någon av parametrarna timePeriod eller invoiceId eller billingPeriod. Om ingen tillhandahålls tillhandahålls den aktuella månadskostnaden.

customerId

string

Kund-ID för Microsoft-kundavtalsomfång (faktura-ID krävs också för detta).

invoiceId

string

Faktura-ID för omfånget Betala per användning och Microsoft-kundavtal. Kan bara ha någon av parametrarna timePeriod eller invoiceId eller billingPeriod. Om ingen tillhandahålls tillhandahålls den aktuella månadskostnaden.

metric

GenerateDetailedCostReportMetricType

Typen av detaljerad rapport. Som standard tillhandahålls ActualCost

timePeriod

GenerateDetailedCostReportTimePeriod

Har en tidsperiod för att hämta data för den kostnads detaljerade rapporten. Kan bara ha någon av parametrarna timePeriod eller invoiceId eller billingPeriod. Om ingen tillhandahålls tillhandahålls den aktuella månadskostnaden.

GenerateDetailedCostReportErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

  • 413 Begärandeentiteten är för stor – begäran begränsas. Mängden data som krävs för att uppfylla begäran överskrider den maximala tillåtna storleken på 2 GB. Använd vår exportfunktion i stället.

  • 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen".

Name Typ Description
error

ErrorDetails

Information om felet.

GenerateDetailedCostReportMetricType

Typen av detaljerad rapport. Som standard tillhandahålls ActualCost

Name Typ Description
ActualCost

string

AmortizedCost

string

GenerateDetailedCostReportOperationResult

Resultatet av den tidskrävande åtgärden för kostnads detaljerad rapport.

Name Typ Description
id

string

ARM-resurs-ID för den tidskrävande åtgärden.

name

string

Namnet på den tidskrävande åtgärden.

properties.downloadUrl

string

URL:en för att ladda ned den genererade rapporten.

properties.expiryTime

string

Den tid då rapport-URL:en blir ogiltig/upphör att gälla i UTC, t.ex. 2020-12-08T05:55:59.4394737Z.

properties.validTill

string

Den tid då rapport-URL:en blir ogiltig/upphör att gälla i UTC, t.ex. 2020-12-08T05:55:59.4394737Z.

type

string

Typen av tidskrävande åtgärd.

GenerateDetailedCostReportTimePeriod

Start- och slutdatumet för att hämta data för den kostnads detaljerade rapporten.

Name Typ Description
end

string

Slutdatumet för att hämta data till. exempelformat 2020-03-15

start

string

Startdatumet för att hämta data från. exempelformat 2020-03-15