Sdílet prostřednictvím


Generate Cost Details Report - Create Operation

Toto rozhraní API je náhradou za všechna dříve vydaná rozhraní API s podrobnostmi o využití. Žá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í požadavku na sestavu vrátí hodnotu 202 s hlavičkou Location (Umístění) a Retry-After (Opakovat po). Hlavička Location (Umístění) poskytne koncový bod, který se má dotazovat, aby získal výsledek generování sestavy. Retry-After 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 koncový bod dotazování poskytne odpověď 200 spolu s podrobnostmi o objektech blob sestavy, které jsou k dispozici ke stažení. Podrobnosti o souborech, které jsou k dispozici ke stažení, budou k dispozici v textu odpovědi na dotazování. Vysvětlení podrobností o nákladech (dříve označovaných jako podrobnosti o využití) nalezených v souborech najdete v 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 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 zákazníci se smlouvou Enterprise. Použijte formát YearMonth(např. 202008). Tento parametr nelze použít společně s parametry invoiceId nebo timePeriod. Pokud parametr timePeriod, invoiceId nebo billingPeriod není v textu požadavku zadaný, rozhraní API vrátí náklady na aktuální měsíc.

invoiceId

string

Tento parametr můžou používat jenom zákazníci se smlouvou se zákazníkem Microsoftu. Kromě toho ho můžete použít pouze v rozsahu fakturačního profilu nebo zákazníka. Tento parametr nelze použít společně s parametry billingPeriod nebo timePeriod. Pokud parametr timePeriod, invoiceId nebo billingPeriod není v textu požadavku zadaný, rozhraní API vrátí náklady na aktuální měsíc.

metric

CostDetailsMetricType

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

timePeriod

CostDetailsTimePeriod

Konkrétní rozsah dat podrobností o nákladech požadovaných pro sestavu. Tento parametr nelze použít společně s parametry invoiceId nebo billingPeriod. Pokud parametr timePeriod, invoiceId nebo billingPeriod není v textu požadavku zadaný, rozhraní API vrátí náklady na aktuální měsíc. Rozhraní API umožňuje načíst data pouze po dobu 1 měsíce nebo méně a ne starší než 13 měsíců. Pokud není k dispozici žádný časPeriod nebo billingPeriod nebo invoiceId, rozhraní API se standardně nastaví na č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řijal. Žádost bude zpracována. Pomocí záhlaví Umístění zkontrolujte stav.

Hlavičky

  • 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 OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
GenerateCostDetailsReportByBillingProfileAndInvoiceId
GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId
GenerateCostDetailsReportByCustomerAndTimePeriod
GenerateCostDetailsReportByDepartmentsAndTimePeriod
GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod
GenerateCostDetailsReportBySubscriptionAndTimePeriod

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod

Ukázkový požadavek

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

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

Ukázková odpověď

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

Ukázkový požadavek

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

Ukázková odpověď

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

Ukázkový požadavek

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

Ukázková odpověď

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

Ukázkový požadavek

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

Ukázková odpověď

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

Ukázkový požadavek

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

Ukázková odpověď

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

Ukázkový požadavek

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

Ukázková odpověď

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

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
BlobInfo

Informace o objektu blob vygenerované touto operací.

CostDetailsDataFormat

Formát dat sestavy

CostDetailsMetricType

Typ podrobné sestavy. Ve výchozím nastavení je k dispozici hodnota 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 vyžádání dat pro podrobnou sestavu nákladů. Rozhraní API umožňuje načíst 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 žádosti Za předpokladu, že datová část požadavku není ve formátu JSON nebo nemá v datové části požadavku přijatý neplatný člen.

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

  • 400 Chybný požadavek - Počáteční datum musí být za . 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íce. Rozhraní API umožňuje načíst data pouze po dobu 1 měsíce nebo méně.

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

  • 503 ServiceUnavailable – Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.

GenerateCostDetailsReportRequestDefinition

Definice podrobné sestavy nákladů

BlobInfo

Informace o objektu blob vygenerované touto operací.

Name Typ Description
blobLink

string

Odkaz na objekt blob pro stažení souboru.

byteCount

integer

Bajty v objektu blob.

CostDetailsDataFormat

Formát dat sestavy

Name Typ Description
Csv

string

Formát dat CSV.

CostDetailsMetricType

Typ podrobné sestavy. Ve výchozím nastavení je k dispozici hodnota 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šechobjektch

manifest.compressData

boolean

Jsou data v komprimovaném formátu.

manifest.dataFormat

CostDetailsDataFormat

Formát dat sestavy

manifest.manifestVersion

string

Verze manifestu.

manifest.requestContext.requestBody

GenerateCostDetailsReportRequestDefinition

Text datové části požadavku zadaný ve volání Podrobnosti nákladů

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 bude adresa URL sestavy neplatná 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 je dokončena a nebyla nalezena žádná data nákladů.

CostDetailsTimePeriod

Počáteční a koncové datum pro vyžádání dat pro podrobnou sestavu nákladů. Rozhraní API umožňuje načíst 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 2020-03-15

start

string

Počáteční datum pro načtení dat. Příklad formátu 2020-03-15

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 žádosti Za předpokladu, že datová část požadavku není ve formátu JSON nebo nemá v datové části požadavku přijatý neplatný člen.

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

  • 400 Chybný požadavek - Počáteční datum musí být za . 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íce. Rozhraní API umožňuje načíst data pouze po dobu 1 měsíce nebo méně.

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

  • 503 ServiceUnavailable – Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.

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 zákazníci se smlouvou Enterprise. Použijte formát YearMonth(např. 202008). Tento parametr nelze použít společně s parametry invoiceId nebo timePeriod. Pokud parametr timePeriod, invoiceId nebo billingPeriod není v textu požadavku zadaný, rozhraní API vrátí náklady na aktuální měsíc.

invoiceId

string

Tento parametr můžou používat jenom zákazníci se smlouvou se zákazníkem Microsoftu. Kromě toho ho můžete použít pouze v rozsahu fakturačního profilu nebo zákazníka. Tento parametr nelze použít společně s parametry billingPeriod nebo timePeriod. Pokud parametr timePeriod, invoiceId nebo billingPeriod není v textu požadavku zadaný, rozhraní API vrátí náklady na aktuální měsíc.

metric

CostDetailsMetricType

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

timePeriod

CostDetailsTimePeriod

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