Dela via

Generate Cost Details Report - Create Operation

  • Referens
Tjänst:
Cost Management
API-version:
2024-08-01

Det här API:et ersätter alla API:er för användningsinformation för tidigare versioner. Begäran om att generera en kostnadsinformationsrapport för det angivna datumintervallet, faktureringsperioden (endast företagskunder) eller faktura-ID asynkront i ett visst omfång. Det första anropet för att begära en rapport returnerar ett 202-meddelande med rubriken "Plats" och "Försök efter igen". "Plats"-huvudet ger slutpunkten som ska avsökas för att få resultatet av rapportgenereringen. "Återförsök efter" ger varaktigheten att vänta innan avsökningen för den genererade rapporten. Ett anrop för att avsöka rapportåtgärden ger ett 202-svar med rubriken "Plats" om åtgärden fortfarande pågår. När rapportgenereringen har slutförts ger avsökningsslutpunkten ett 200-svar tillsammans med information om de rapportblobar som är tillgängliga för nedladdning. Informationen om de filer som är tillgängliga för nedladdning kommer att vara tillgänglig i avsökningssvarstexten. Information om kostnader (kallades tidigare användningsinformation) finns i filer i 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-parametrar

Name I Obligatorisk Typ Description
scope
 path True

string

ARM-resurs-ID för prenumeration, faktureringskonto eller andra faktureringsomfång. För närvarande stöds inte resursgrupp och hanteringsgrupp. 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

Den här parametern kan endast användas av Enterprise-avtalskunder. Använd formatet YearMonth(t.ex. 202008). Den här parametern kan inte användas tillsammans med parametrarna invoiceId eller timePeriod. Om parametern timePeriod, invoiceId eller billingPeriod inte anges i begärandetexten returnerar API:et den aktuella månadens kostnad.
invoiceId

string

Den här parametern kan endast användas av Kunder med Microsoft-kundavtal. Dessutom kan den endast användas i faktureringsprofilen eller kundomfånget. Den här parametern kan inte användas tillsammans med parametrarna billingPeriod eller timePeriod. Om parametern timePeriod, invoiceId eller billingPeriod inte anges i begärandetexten returnerar API:et den aktuella månadens kostnad.
metric

CostDetailsMetricType

Typen av detaljerad rapport. Som standard tillhandahålls ActualCost
timePeriod

CostDetailsTimePeriod

Det specifika datumintervall för kostnadsinformation som begärs för rapporten. Den här parametern kan inte användas tillsammans med parametrarna invoiceId eller billingPeriod. Om parametern timePeriod, invoiceId eller billingPeriod inte anges i begärandetexten returnerar API:et den aktuella månadens kostnad. API tillåter endast att data hämtas i en månad eller mindre och inte äldre än 13 månader. Om ingen timePeriod eller billingPeriod eller invoiceId tillhandahålls anges API:et som standard till den öppna månadsperioden

Svar

Name Typ Description
200 OK

CostDetailsOperationResults

Bearbetningen av begäran har slutförts.
202 Accepted

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

Sidhuvuden

  • Location: string
  • Retry-After: integer
204 No Content

Inget innehåll. Begäran har slutförts men returnerat inga resultat.
Other Status Codes

GenerateCostDetailsReportErrorResponse

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

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
GenerateCostDetailsReportByBillingProfileAndInvoiceId
GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId
GenerateCostDetailsReportByCustomerAndTimePeriod
GenerateCostDetailsReportByDepartmentsAndTimePeriod
GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod
GenerateCostDetailsReportBySubscriptionAndTimePeriod

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod

Exempelbegäran

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

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

Exempelsvar

Statuskod:
200 
{
  "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"
}
Statuskod:
202 
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
Statuskod:
204

GenerateCostDetailsReportByBillingProfileAndInvoiceId

Exempelbegäran

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"
}

Exempelsvar

Statuskod:
200 
{
  "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"
}
Statuskod:
202 
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
Statuskod:
204

GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId

Exempelbegäran

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"
}

Exempelsvar

Statuskod:
200 
{
  "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"
}
Statuskod:
202 
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
Statuskod:
204

GenerateCostDetailsReportByCustomerAndTimePeriod

Exempelbegäran

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"
  }
}

Exempelsvar

Statuskod:
200 
{
  "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"
}
Statuskod:
202 
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
Statuskod:
204

GenerateCostDetailsReportByDepartmentsAndTimePeriod

Exempelbegäran

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"
  }
}

Exempelsvar

Statuskod:
200 
{
  "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"
}
Statuskod:
202 
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
Statuskod:
204

GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod

Exempelbegäran

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"
  }
}

Exempelsvar

Statuskod:
200 
{
  "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"
}
Statuskod:
202 
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
Statuskod:
204

GenerateCostDetailsReportBySubscriptionAndTimePeriod

Exempelbegäran

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"
  }
}

Exempelsvar

Statuskod:
200 
{
  "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"
}
Statuskod:
202 
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
Statuskod:
204

Definitioner

Name Description
BlobInfo

Blobinformationen som genereras av den här åtgärden.
CostDetailsDataFormat

Rapportens dataformat
CostDetailsMetricType

Typen av detaljerad rapport. Som standard tillhandahålls ActualCost
CostDetailsOperationResults

Resultatet av den tidskrävande åtgärden för api för kostnadsinformation.
CostDetailsStatusType

Status för kostnadsinformationsåtgärden
CostDetailsTimePeriod

Start- och slutdatumet för att hämta data för den kostnads detaljerade rapporten. API tillåter endast att data hämtas i en månad eller mindre och inte äldre än 13 månader.
ErrorDetails

Information om felet.
GenerateCostDetailsReportErrorResponse

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

Några felsvar:

  • 400 Felaktig begäran – Ogiltig nyttolast för begäran. Den angivna nyttolasten för begäran är inte i json-format eller om en ogiltig medlem inte accepterades i nyttolasten för begäran.

  • 400 Felaktig begäran – Ogiltig nyttolast för begäran: kan bara ha timePeriod eller invoiceId eller billingPeriod. API tillåter endast att data hämtas för antingen timePeriod eller invoiceId eller billingPeriod. Kunden bör endast ange en av dessa parametrar.

  • 400 Felaktig begäran – Startdatumet måste vara efter . API tillåter endast att data hämtas senast 13 månader från och med nu.

  • 400 Felaktig begäran – Det högsta tillåtna datumintervallet är 1 månad. API tillåter endast att data hämtas i minst en månad.

  • 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "försök igen".

  • 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".
GenerateCostDetailsReportRequestDefinition

Definitionen av en kostnadsbegränsade rapport.

BlobInfo

Blobinformationen som genereras av den här åtgärden.

Name Typ Description
blobLink

string

Länka till bloben för att ladda ned filen.
byteCount

integer

Byte i bloben.

CostDetailsDataFormat

Rapportens dataformat

Name Typ Description
Csv

string

Csv-dataformat.

CostDetailsMetricType

Typen av detaljerad rapport. Som standard tillhandahålls ActualCost

Name Typ Description
ActualCost

string

Faktiska kostnadsdata.
AmortizedCost

string

Amorterade kostnadsdata.

CostDetailsOperationResults

Resultatet av den tidskrävande åtgärden för api för kostnadsinformation.

Name Typ Description
error

ErrorDetails

Information om felet.
id

string

ID:t för den tidskrävande åtgärden.
manifest.blobCount

integer

Det totala antalet blobar.
manifest.blobs

BlobInfo[]

Lista över blobinformation som genereras av den här åtgärden.
manifest.byteCount

integer

Det totala antalet byte i alla blobar.
manifest.compressData

boolean

Är data i komprimerat format.
manifest.dataFormat

CostDetailsDataFormat

Rapportens dataformat
manifest.manifestVersion

string

Manifestversionen.
manifest.requestContext.requestBody

GenerateCostDetailsReportRequestDefinition

Begärandenyttolasttexten som anges i kostnadsinformationsanropet
manifest.requestContext.requestScope

string

Begärans omfattning.
name

string

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

CostDetailsStatusType

Status för kostnadsinformationsåtgärden
type

string

Typen av tidskrävande åtgärd.
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.

CostDetailsStatusType

Status för kostnadsinformationsåtgärden

Name Typ Description
Completed

string

Åtgärden har slutförts.
Failed

string

Åtgärden misslyckades.
NoDataFound

string

Åtgärden har slutförts och inga kostnadsdata hittades.

CostDetailsTimePeriod

Start- och slutdatumet för att hämta data för den kostnads detaljerade rapporten. API tillåter endast att data hämtas i en månad eller mindre och inte äldre än 13 månader.

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

ErrorDetails

Information om felet.

Name Typ Description
code

string

Felkod.
message

string

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

GenerateCostDetailsReportErrorResponse

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

Några felsvar:

  • 400 Felaktig begäran – Ogiltig nyttolast för begäran. Den angivna nyttolasten för begäran är inte i json-format eller om en ogiltig medlem inte accepterades i nyttolasten för begäran.

  • 400 Felaktig begäran – Ogiltig nyttolast för begäran: kan bara ha timePeriod eller invoiceId eller billingPeriod. API tillåter endast att data hämtas för antingen timePeriod eller invoiceId eller billingPeriod. Kunden bör endast ange en av dessa parametrar.

  • 400 Felaktig begäran – Startdatumet måste vara efter . API tillåter endast att data hämtas senast 13 månader från och med nu.

  • 400 Felaktig begäran – Det högsta tillåtna datumintervallet är 1 månad. API tillåter endast att data hämtas i minst en månad.

  • 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "försök igen".

  • 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.

GenerateCostDetailsReportRequestDefinition

Definitionen av en kostnadsbegränsade rapport.

Name Typ Description
billingPeriod

string

Den här parametern kan endast användas av Enterprise-avtalskunder. Använd formatet YearMonth(t.ex. 202008). Den här parametern kan inte användas tillsammans med parametrarna invoiceId eller timePeriod. Om parametern timePeriod, invoiceId eller billingPeriod inte anges i begärandetexten returnerar API:et den aktuella månadens kostnad.
invoiceId

string

Den här parametern kan endast användas av Kunder med Microsoft-kundavtal. Dessutom kan den endast användas i faktureringsprofilen eller kundomfånget. Den här parametern kan inte användas tillsammans med parametrarna billingPeriod eller timePeriod. Om parametern timePeriod, invoiceId eller billingPeriod inte anges i begärandetexten returnerar API:et den aktuella månadens kostnad.
metric

CostDetailsMetricType

Typen av detaljerad rapport. Som standard tillhandahålls ActualCost
timePeriod

CostDetailsTimePeriod

Det specifika datumintervall för kostnadsinformation som begärs för rapporten. Den här parametern kan inte användas tillsammans med parametrarna invoiceId eller billingPeriod. Om parametern timePeriod, invoiceId eller billingPeriod inte anges i begärandetexten returnerar API:et den aktuella månadens kostnad. API tillåter endast att data hämtas i en månad eller mindre och inte äldre än 13 månader. Om ingen timePeriod eller billingPeriod eller invoiceId tillhandahålls anges API:et som standard till den öppna månadsperioden