Generate Cost Details Report - Create Operation

  • Reference
Service:
Cost Management
API Version:
2023-11-01

Toto rozhraní API nahrazuje všechna rozhraní API podrobností o využití, která byla vydána dříve. Žádost o vygenerování sestavy podrobností o nákladech pro zadaný rozsah kalendářních dat, fakturační období (pouze podnikoví zákazníci) nebo ID faktury asynchronně v určitém rozsahu Počáteční volání žádosti o sestavu vrátí 202 s hlavičkami Location a Retry-After. Hlavička Location (Umístění) poskytne koncový bod, který se má dotazovat na výsledek generování sestavy. Hodnota Retry-After (Opakovat po) poskytuje dobu čekání před dotazováním na vygenerovanou sestavu. Volání k dotazování operace sestavy poskytne odpověď 202 s hlavičkou Umístění, pokud operace stále probíhá. Po dokončení operace generování sestavy poskytne koncový bod dotazování odpověď 200 spolu s podrobnostmi o objektech blob sestavy, které jsou k dispozici ke stažení. Podrobnosti o souborech dostupných ke stažení budou k dispozici v textu odpovědi na dotazování. Informace o vysvětlení polí podrobností o nákladech (dříve označovaných jako podrobnosti o využití) nalezených v souborech najdete v tématu 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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
scope
 path True

string

ID prostředku ARM pro předplatné, fakturační účet nebo jiné rozsahy fakturace. Skupina prostředků a skupina pro správu se v současné době nepodporují. Podrobnosti najdete v tématu https://aka.ms/costmgmt/scopes.
api-version
 query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name Typ Description
billingPeriod

string

Tento parametr můžou používat jenom smlouva Enterprise zákazníci. Použijte formát YearMonth (např. 202008). Tento parametr nelze použít společně s parametry invoiceId nebo timePeriod. Pokud v textu požadavku není uvedený parametr timePeriod, invoiceId nebo billingPeriod, vrátí rozhraní API náklady za aktuální měsíc.
invoiceId

string

Tento parametr můžou používat jenom Smlouva se zákazníkem Microsoftu zákazníci. Navíc se dá použít jenom v rozsahu fakturačního profilu nebo zákazníka. Tento parametr nelze použít společně s parametry billingPeriod ani timePeriod. Pokud v textu požadavku není uvedený parametr timePeriod, invoiceId nebo billingPeriod, vrátí rozhraní API náklady za aktuální měsíc.
metric

CostDetailsMetricType

Typ podrobné sestavy. Ve výchozím nastavení je k dispozici actualCost.
timePeriod

CostDetailsTimePeriod

Konkrétní rozsah podrobností o nákladech požadovaných pro sestavu Tento parametr nelze použít společně s parametry invoiceId ani billingPeriod. Pokud v textu požadavku není uvedený parametr timePeriod, invoiceId nebo billingPeriod, vrátí rozhraní API náklady za aktuální měsíc. Rozhraní API umožňuje natahovat data pouze po dobu 1 měsíce nebo méně a ne starší než 13 měsíců. Pokud není k dispozici žádná hodnota timePeriod, billingPeriod nebo invoiceId, rozhraní API nastaví výchozí časové období otevřeného měsíce.

Odpovědi

Name Typ Description
200 OK

CostDetailsOperationResults

Zpracování požadavku bylo dokončeno.
202 Accepted

Přijata. Žádost se zpracuje. Ke kontrole stavu použijte hlavičku Location (Umístění).

Headers

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

Žádný obsah. Požadavek byl úspěšný, ale nevrátil žádné výsledky.
Other Status Codes

GenerateCostDetailsReportErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
GenerateCostDetailsReportByBillingProfileAndInvoiceId
GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId
GenerateCostDetailsReportByCustomerAndTimePeriod
GenerateCostDetailsReportByDepartmentsAndTimePeriod
GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod
GenerateCostDetailsReportBySubscriptionAndTimePeriod

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

Status code:
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": "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"
}
Status code:
202 
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
Status code:
204

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

Status code:
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": "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"
}
Status code:
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=2023-11-01
Retry-After: 60
Status code:
204

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

Status code:
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": "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"
}
Status code:
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=2023-11-01
Retry-After: 60
Status code:
204

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

Status code:
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": "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"
}
Status code:
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=2023-11-01
Retry-After: 60
Status code:
204

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

Status code:
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": "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"
}
Status code:
202 
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
Status code:
204

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

Status code:
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": "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"
}
Status code:
202 
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
Status code:
204

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

Status code:
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": "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"
}
Status code:
202 
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
Status code:
204

Definice

Name Description
BlobInfo

Informace o objektu blob vygenerované touto operací
CostDetailsDataFormat

Datový formát sestavy
CostDetailsMetricType

Typ podrobné sestavy. Ve výchozím nastavení je k dispozici actualCost.
CostDetailsOperationResults

Výsledek dlouhotrvající operace pro rozhraní API podrobností o nákladech.
CostDetailsStatusType

Stav operace podrobností o nákladech
CostDetailsTimePeriod

Počáteční a koncové datum pro načítání dat pro podrobnou sestavu nákladů. Rozhraní API umožňuje natahovat data pouze po dobu 1 měsíce nebo méně a ne starší než 13 měsíců.
ErrorDetails

Podrobnosti o chybě.
GenerateCostDetailsReportErrorResponse

Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uveden v chybové zprávě.

Některé chybové odpovědi:

  • 400 Chybný požadavek – neplatná datová část požadavku. Zadanou datovou část požadavku není ve formátu JSON nebo v datové části požadavku nebyl přijat neplatný člen.

  • 400 Chybný požadavek – neplatná datová část žádosti: Může obsahovat pouze timePeriod nebo invoiceId nebo billingPeriod. Rozhraní API umožňuje načíst data jenom pro timePeriod nebo invoiceId nebo billingPeriod. Zákazník by měl zadat pouze jeden z těchto parametrů.

  • 400 Chybná žádost – Počáteční datum musí být po . Rozhraní API umožňuje načíst data pouze za 13 měsíců.

  • 400 Chybný požadavek – maximální povolený rozsah dat je 1 měsíc. Rozhraní API umožňuje natahovat data jenom po dobu 1 měsíce nebo méně.

  • 429 TooManyRequests – Požadavek je omezený. Zkuste to znovu po čekání na dobu uvedenou v hlavičce "retry-after".

  • 503 ServiceUnavailable – Služba je dočasně nedostupná. Po uplynutí časového limitu uvedeného v hlavičce Retry-After zkuste operaci zopakovat.
GenerateCostDetailsReportRequestDefinition

Definice podrobné sestavy nákladů

BlobInfo

Informace o objektu blob vygenerované touto operací

Name Typ Description
blobLink

string

Odkaz na objekt blob ke stažení souboru
byteCount

integer

Bajty v objektu blob.

CostDetailsDataFormat

Datový formát sestavy

Name Typ Description
Csv

string

Formát dat CSV.

CostDetailsMetricType

Typ podrobné sestavy. Ve výchozím nastavení je k dispozici actualCost.

Name Typ Description
ActualCost

string

Data skutečných nákladů.
AmortizedCost

string

Amortizovaná data nákladů.

CostDetailsOperationResults

Výsledek dlouhotrvající operace pro rozhraní API podrobností o nákladech.

Name Typ Description
error

ErrorDetails

Podrobnosti o chybě.
id

string

ID dlouhotrvající operace.
manifest.blobCount

integer

Celkový počet objektů blob.
manifest.blobs

BlobInfo[]

Seznam informací o objektech blob vygenerovaných touto operací
manifest.byteCount

integer

Celkový počet bajtů ve všech objektech blob.
manifest.compressData

boolean

Jsou data v komprimovaném formátu.
manifest.dataFormat

CostDetailsDataFormat

Datový formát sestavy
manifest.manifestVersion

string

Verze manifestu.
manifest.requestContext.requestBody

GenerateCostDetailsReportRequestDefinition

Text datové části požadavku uvedený ve volání Podrobnosti o nákladech
manifest.requestContext.requestScope

string

Rozsah požadavku.
name

string

Název dlouhotrvající operace.
status

CostDetailsStatusType

Stav operace podrobností o nákladech
type

string

Typ dlouhotrvající operace.
validTill

string

Čas, kdy se adresa URL sestavy stane neplatnou nebo vyprší v UTC, například 2020-12-08T05:55:59.4394737Z.

CostDetailsStatusType

Stav operace podrobností o nákladech

Name Typ Description
Completed

string

Operace je dokončena.
Failed

string

Operace se nezdařila.
NoDataFound

string

Operace se dokončila a nenašla se žádná data o nákladech.

CostDetailsTimePeriod

Počáteční a koncové datum pro načítání dat pro podrobnou sestavu nákladů. Rozhraní API umožňuje natahovat data pouze po dobu 1 měsíce nebo méně a ne starší než 13 měsíců.

Name Typ Description
end

string

Koncové datum pro načtení dat. příklad formátu 15.3.2020
start

string

Počáteční datum, ze které se mají načíst data. příklad formátu 15.3.2020

ErrorDetails

Podrobnosti o chybě.

Name Typ Description
code

string

Kód chyby
message

string

Chybová zpráva označující, proč operace selhala.

GenerateCostDetailsReportErrorResponse

Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uveden v chybové zprávě.

Některé chybové odpovědi:

  • 400 Chybný požadavek – neplatná datová část požadavku. Zadanou datovou část požadavku není ve formátu JSON nebo v datové části požadavku nebyl přijat neplatný člen.

  • 400 Chybný požadavek – neplatná datová část žádosti: Může obsahovat pouze timePeriod nebo invoiceId nebo billingPeriod. Rozhraní API umožňuje načíst data jenom pro timePeriod nebo invoiceId nebo billingPeriod. Zákazník by měl zadat pouze jeden z těchto parametrů.

  • 400 Chybná žádost – Počáteční datum musí být po . Rozhraní API umožňuje načíst data pouze za 13 měsíců.

  • 400 Chybný požadavek – maximální povolený rozsah dat je 1 měsíc. Rozhraní API umožňuje natahovat data jenom po dobu 1 měsíce nebo méně.

  • 429 TooManyRequests – Požadavek je omezený. Zkuste to znovu po čekání na dobu uvedenou v hlavičce "retry-after".

  • 503 ServiceUnavailable – Služba je dočasně nedostupná. Po uplynutí časového limitu uvedeného v hlavičce Retry-After zkuste operaci zopakovat.

Name Typ Description
error

ErrorDetails

Podrobnosti o chybě.

GenerateCostDetailsReportRequestDefinition

Definice podrobné sestavy nákladů

Name Typ Description
billingPeriod

string

Tento parametr můžou používat jenom smlouva Enterprise zákazníci. Použijte formát YearMonth (např. 202008). Tento parametr nelze použít společně s parametry invoiceId nebo timePeriod. Pokud v textu požadavku není uvedený parametr timePeriod, invoiceId nebo billingPeriod, vrátí rozhraní API náklady za aktuální měsíc.
invoiceId

string

Tento parametr můžou používat jenom Smlouva se zákazníkem Microsoftu zákazníci. Navíc se dá použít jenom v rozsahu fakturačního profilu nebo zákazníka. Tento parametr nelze použít společně s parametry billingPeriod ani timePeriod. Pokud v textu požadavku není uvedený parametr timePeriod, invoiceId nebo billingPeriod, vrátí rozhraní API náklady za aktuální měsíc.
metric

CostDetailsMetricType

Typ podrobné sestavy. Ve výchozím nastavení je k dispozici actualCost.
timePeriod

CostDetailsTimePeriod

Konkrétní rozsah podrobností o nákladech požadovaných pro sestavu Tento parametr nelze použít společně s parametry invoiceId ani billingPeriod. Pokud v textu požadavku není uvedený parametr timePeriod, invoiceId nebo billingPeriod, vrátí rozhraní API náklady za aktuální měsíc. Rozhraní API umožňuje natahovat data pouze po dobu 1 měsíce nebo méně a ne starší než 13 měsíců. Pokud není k dispozici žádná hodnota timePeriod, billingPeriod nebo invoiceId, rozhraní API nastaví výchozí časové období otevřeného měsíce.