Megosztás a következőn keresztül:


Generate Cost Details Report - Create Operation

Ez az API váltja fel az összes korábban kiadott Usage Details API-t. Költségadatok jelentésének kérése a megadott dátumtartományhoz, számlázási időszakhoz (csak vállalati ügyfelekhez) vagy számlaazonosítóhoz aszinkron módon egy adott hatókörben. A jelentés igénylésére irányuló kezdeti hívás egy 202-et ad vissza egy "Location" és "Retry-After" fejléccel. A "Hely" fejléc biztosítja a lekérdezéshez szükséges végpontot a jelentés generálásának eredményének lekéréséhez. Az "Újrapróbálkozás után" megadja a létrehozott jelentés lekérdezése előtti várakozási időtartamot. Ha a művelet még folyamatban van, a jelentési művelet lekérdezésére irányuló hívás egy 202-s választ ad meg egy "Hely" fejléccel. A jelentéslétrehozási művelet befejeződése után a lekérdezési végpont 200 választ ad a letölthető jelentésblob(ok) részleteivel együtt. A letölthető fájl(ok) részletei a lekérdezési válasz törzsében lesznek elérhetők. A fájlokban található költségadatok (korábbi nevén használati adatok) megismeréséhez lásd: 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-paraméterek

Name In Kötelező Típus Description
scope
path True

string

Az előfizetéshez, a számlázási fiókhoz vagy más számlázási hatókörökhöz tartozó ARM-erőforrás-azonosító. Jelenleg az erőforráscsoport és a felügyeleti csoport nem támogatott. További részletek: https://aka.ms/costmgmt/scopes.

api-version
query True

string

A művelethez használandó API-verzió.

Kérelem törzse

Name Típus Description
billingPeriod

string

Ezt a paramétert csak Nagyvállalati Szerződés ügyfelek használhatják. Használja a YearMonth(pl. 202008) formátumot. Ez a paraméter sem az invoiceId, sem a timePeriod paraméter mellett nem használható. Ha a kérelem törzsében nincs megadva timePeriod, invoiceId vagy billingPeriod paraméter, az API az aktuális havi költséget adja vissza.

invoiceId

string

Ezt a paramétert csak Microsoft Ügyfélszerződés ügyfelek használhatják. Emellett csak a számlázási profil vagy az ügyfél hatókörében használható. Ez a paraméter nem használható a billingPeriod vagy a timePeriod paraméterekkel együtt. Ha a kérelem törzsében nincs megadva timePeriod, invoiceId vagy billingPeriod paraméter, az API az aktuális havi költséget adja vissza.

metric

CostDetailsMetricType

A részletes jelentés típusa. Alapértelmezés szerint az ActualCost van megadva

timePeriod

CostDetailsTimePeriod

A jelentéshez kért költségadatok adott dátumtartománya. Ez a paraméter sem az invoiceId, sem a billingPeriod paraméter mellett nem használható. Ha a kérelem törzsében nincs megadva timePeriod, invoiceId vagy billingPeriod paraméter, az API az aktuális havi költséget adja vissza. Az API csak 1 hónap vagy kevesebb, 13 hónapnál nem régebbi adatok lekérését teszi lehetővé. Ha nincs megadva timePeriod vagy billingPeriod vagy invoiceId, az API alapértelmezés szerint a nyitott hónap időszakára esik

Válaszok

Name Típus Description
200 OK

CostDetailsOperationResults

A kérelem feldolgozása befejeződött.

202 Accepted

Elfogadott. A kérés feldolgozása folyamatban van. Az állapot ellenőrzéséhez használja a Hely fejlécet.

Fejlécek

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

Nincs tartalom. A kérés sikeres volt, de nem adott vissza eredményt.

Other Status Codes

GenerateCostDetailsReportErrorResponse

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
GenerateCostDetailsReportByBillingProfileAndInvoiceId
GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId
GenerateCostDetailsReportByCustomerAndTimePeriod
GenerateCostDetailsReportByDepartmentsAndTimePeriod
GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod
GenerateCostDetailsReportBySubscriptionAndTimePeriod

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod

Mintakérelem

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

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

Mintaválasz

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

Mintakérelem

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

Mintaválasz

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

Mintakérelem

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

Mintaválasz

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

Mintakérelem

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

Mintaválasz

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

Mintakérelem

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

Mintaválasz

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

Mintakérelem

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

Mintaválasz

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

Mintakérelem

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

Mintaválasz

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

Definíciók

Name Description
BlobInfo

A művelet által létrehozott blobadatok.

CostDetailsDataFormat

A jelentés adatformátuma

CostDetailsMetricType

A részletes jelentés típusa. Alapértelmezés szerint az ActualCost van megadva

CostDetailsOperationResults

A cost details API hosszú ideig futó műveletének eredménye.

CostDetailsStatusType

A költségrészletezési művelet állapota

CostDetailsTimePeriod

A költségrészletes jelentés adatainak lekérésének kezdő és záró dátuma. Az API csak 1 hónap vagy kevesebb, 13 hónapnál nem régebbi adatok lekérését teszi lehetővé.

ErrorDetails

A hiba részletei.

GenerateCostDetailsReportErrorResponse

A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Néhány hibaválasz:

  • 400 Hibás kérelem – Érvénytelen kérelem hasznos adatai. A kérelem hasznos adatai nem JSON formátumban vannak megadva, vagy érvénytelen tagot nem fogadtak el a kérelem hasznos adatai között.

  • 400 Hibás kérelem – Érvénytelen kérelem hasznos adat: csak timePeriod, invoiceId vagy billingPeriod azonosítóval rendelkezhet. Az API csak a timePeriod, invoiceId vagy billingPeriod adatok lekérését teszi lehetővé. Az ügyfélnek csak az egyik paramétert kell megadnia.

  • 400 Hibás kérelem – A kezdési dátumnak a után kell lennie. Az API mostantól csak 13 hónapnál nem régebbi adatok lekérését teszi lehetővé.

  • 400 Hibás kérelem – A maximálisan engedélyezett dátumtartomány 1 hónap. Az API csak 1 hónapos vagy annál rövidebb ideig engedélyezi az adatok lekérését.

  • 429 TooManyRequests – A kérés szabályozva van. Próbálkozzon újra az "újrapróbálkozás után" fejlécben megadott időre való várakozás után.

  • 503 ServiceUnavailable – A szolgáltatás átmenetileg nem érhető el. Várjon a „Retry-After” fejlécben megadott ideig, majd próbálkozzon újra.

GenerateCostDetailsReportRequestDefinition

A részletes költségjelentés definíciója.

BlobInfo

A művelet által létrehozott blobadatok.

Name Típus Description
blobLink

string

A fájl letöltéséhez hivatkozzon a blobra.

byteCount

integer

Bájtok a blobban.

CostDetailsDataFormat

A jelentés adatformátuma

Name Típus Description
Csv

string

CSV-adatformátum.

CostDetailsMetricType

A részletes jelentés típusa. Alapértelmezés szerint az ActualCost van megadva

Name Típus Description
ActualCost

string

Tényleges költségadatok.

AmortizedCost

string

Amortizált költségadatok.

CostDetailsOperationResults

A cost details API hosszú ideig futó műveletének eredménye.

Name Típus Description
error

ErrorDetails

A hiba részletei.

id

string

A hosszú ideig futó művelet azonosítója.

manifest.blobCount

integer

A blobok teljes száma.

manifest.blobs

BlobInfo[]

A művelet által létrehozott blobadatok listája.

manifest.byteCount

integer

Az összes blob bájtjainak teljes száma.

manifest.compressData

boolean

Az adatok tömörített formátumban jelennek meg.

manifest.dataFormat

CostDetailsDataFormat

A jelentés adatformátuma

manifest.manifestVersion

string

A Jegyzékfájl verziója.

manifest.requestContext.requestBody

GenerateCostDetailsReportRequestDefinition

A Költség részletei hívásban megadott hasznos adattörzs

manifest.requestContext.requestScope

string

A kérelem hatóköre.

name

string

A hosszú ideig futó művelet neve.

status

CostDetailsStatusType

A költségrészletezési művelet állapota

type

string

A hosszú ideig futó művelet típusa.

validTill

string

Az az időpont, amikor a jelentés URL-címe érvénytelenné válik/lejár (UTC), például 2020-12-08T05:55:59.4394737Z.

CostDetailsStatusType

A költségrészletezési művelet állapota

Name Típus Description
Completed

string

A művelet befejeződött.

Failed

string

A művelet nem sikerült.

NoDataFound

string

A művelet befejeződött, és nem találhatók költségadatok.

CostDetailsTimePeriod

A költségrészletes jelentés adatainak lekérésének kezdő és záró dátuma. Az API csak 1 hónap vagy kevesebb, 13 hónapnál nem régebbi adatok lekérését teszi lehetővé.

Name Típus Description
end

string

Az adatok lekérésének záró dátuma. example format 2020-03-15

start

string

Az adatok lekérésének kezdő dátuma. example format 2020-03-15

ErrorDetails

A hiba részletei.

Name Típus Description
code

string

Hibakód.

message

string

Hibaüzenet, amely jelzi, hogy a művelet miért hiúsult meg.

GenerateCostDetailsReportErrorResponse

A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Néhány hibaválasz:

  • 400 Hibás kérelem – Érvénytelen kérelem hasznos adatai. A kérelem hasznos adatai nem JSON formátumban vannak megadva, vagy érvénytelen tagot nem fogadtak el a kérelem hasznos adatai között.

  • 400 Hibás kérelem – Érvénytelen kérelem hasznos adat: csak timePeriod, invoiceId vagy billingPeriod azonosítóval rendelkezhet. Az API csak a timePeriod, invoiceId vagy billingPeriod adatok lekérését teszi lehetővé. Az ügyfélnek csak az egyik paramétert kell megadnia.

  • 400 Hibás kérelem – A kezdési dátumnak a után kell lennie. Az API mostantól csak 13 hónapnál nem régebbi adatok lekérését teszi lehetővé.

  • 400 Hibás kérelem – A maximálisan engedélyezett dátumtartomány 1 hónap. Az API csak 1 hónapos vagy annál rövidebb ideig engedélyezi az adatok lekérését.

  • 429 TooManyRequests – A kérés szabályozva van. Próbálkozzon újra az "újrapróbálkozás után" fejlécben megadott időre való várakozás után.

  • 503 ServiceUnavailable – A szolgáltatás átmenetileg nem érhető el. Várjon a „Retry-After” fejlécben megadott ideig, majd próbálkozzon újra.

Name Típus Description
error

ErrorDetails

A hiba részletei.

GenerateCostDetailsReportRequestDefinition

A részletes költségjelentés definíciója.

Name Típus Description
billingPeriod

string

Ezt a paramétert csak Nagyvállalati Szerződés ügyfelek használhatják. Használja a YearMonth(pl. 202008) formátumot. Ez a paraméter sem az invoiceId, sem a timePeriod paraméter mellett nem használható. Ha a kérelem törzsében nincs megadva timePeriod, invoiceId vagy billingPeriod paraméter, az API az aktuális havi költséget adja vissza.

invoiceId

string

Ezt a paramétert csak Microsoft Ügyfélszerződés ügyfelek használhatják. Emellett csak a számlázási profil vagy az ügyfél hatókörében használható. Ez a paraméter nem használható a billingPeriod vagy a timePeriod paraméterekkel együtt. Ha a kérelem törzsében nincs megadva timePeriod, invoiceId vagy billingPeriod paraméter, az API az aktuális havi költséget adja vissza.

metric

CostDetailsMetricType

A részletes jelentés típusa. Alapértelmezés szerint az ActualCost van megadva

timePeriod

CostDetailsTimePeriod

A jelentéshez kért költségadatok adott dátumtartománya. Ez a paraméter sem az invoiceId, sem a billingPeriod paraméter mellett nem használható. Ha a kérelem törzsében nincs megadva timePeriod, invoiceId vagy billingPeriod paraméter, az API az aktuális havi költséget adja vissza. Az API csak 1 hónap vagy kevesebb, 13 hónapnál nem régebbi adatok lekérését teszi lehetővé. Ha nincs megadva timePeriod vagy billingPeriod vagy invoiceId, az API alapértelmezés szerint a nyitott hónap időszakára esik