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


Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

Elindítja egy juttatáskihasználtsági összefoglaló jelentés létrehozását a megadott megtakarítási tervhez.

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2023-11-01

URI-paraméterek

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

string

Megtakarítási csomag azonosítója.

savingsPlanOrderId
path True

string

Megtakarítási csomag rendelésazonosítója.

api-version
query True

string

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

Kérelem törzse

Name Kötelező Típus Description
endDate True

string

A jelentésben kézbesítendő összesítő adatok záró dátuma.

grain True

grain

Az összefoglalók adatainak a jelentésben való kiszolgálása. Az elfogadott értékek a "Napi" vagy a "Havi".

startDate True

string

A jelentésben kézbesítendő összesítő adatok kezdő dátuma.

benefitId

string

Juttatás azonosítója, a juttatás kihasználtsági összefoglalóinak jelentése. A juttatásazonosító hatóköréhez szükséges. Nem támogatott a juttatási rendeléshez vagy a számlázási hatókörökhöz.

benefitOrderId

string

A juttatási rendelés azonosítója, a juttatás kihasználtsági összefoglalóinak jelentése. Az juttatási sorrendhez és a juttatásazonosító hatóköreihez szükséges. A számlázási hatókörök nem támogatottak.

billingAccountId

string

Számlázási fiók, a juttatás kihasználtságának összegzési jelentése. A számlázási fiók és a számlázási profil hatóköreihez szükséges. Az előnyök hatókörei nem támogatottak.

billingProfileId

string

A számlázási profil azonosítója, a juttatás kihasználtsági összefoglalóinak jelentése. A számlázási profil hatóköréhez szükséges. A számlázási fiók és az előnyök hatókörei nem támogatottak.

kind

benefitKind

A kért juttatási adatok típusa. A számlázási fiók és a számlázási profil hatóköreihez szükséges. Vélelmezett, és nem adható át juttatási hatókörökben. Támogatott értékek: Reservation and SavingsPlan

Válaszok

Name Típus Description
200 OK

BenefitUtilizationSummariesOperationStatus

A juttatáskihasználtsági összefoglaló jelentés létrehozásának állapota. Ez folyamatban lehet, sikertelen vagy 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écét.

Fejlécek

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

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

GenerateUtilizationSummariesReportBySavingsPlan

Mintakérelem

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2023-11-01

{
  "endDate": "2022-08-31T00:00:00Z",
  "startDate": "2022-06-01T00:00:00Z",
  "grain": "Daily"
}

Mintaválasz

Location: https://management.azure.com/providers/Microsoft.Capacity/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2023-11-01
Retry-After: 60
{
  "input": {
    "grain": "Daily",
    "benefitOrderId": "00000000-0000-0000-0000-000000000000",
    "benefitId": "00000000-0000-0000-0000-000000000000",
    "kind": "SavingsPlan",
    "endDate": "2022-08-31T00:00:00Z",
    "startDate": "2022-06-01T00:00:00Z"
  },
  "status": "Complete",
  "properties": {
    "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "validUntil": "2022-06-12T02:56:55.5021869Z"
  }
}

Definíciók

Name Description
AsyncOperationStatusProperties

A jelentés URL-címét képviselő objektum, amely az aszinkron jelentés létrejöttének dátumáig érvényes.

benefitKind

Foglalás vagy SavingsPlan.

BenefitUtilizationSummariesOperationStatus

A juttatáskihasználtság összefoglaló jelentésének állapota. Aszinkron előnyök kihasználtságának összegzését tartalmazza. A kérelem bemenete, állapota és a jelentés sas URL-címe.

BenefitUtilizationSummariesRequest

Az aszinkron juttatás kihasználtságának összegzésére vonatkozó kérelem tulajdonságai.

BenefitUtilizationSummaryReportSchema

A reportUrl és a secondaryReportUrl blob hivatkozásból származó CSV-fájl a következő oszlopokat tartalmazza a juttatás kihasználtsági adataiból. A UtilizedPercentage érték 0 lesz a megtakarítási tervek jelentéseihez és a nem adattéglák foglalásaihoz. A kihasználtság százalékos értéke 0 lesz az adattéglák foglalásai esetében.

ErrorDetails

A hiba részletei.

ErrorResponse

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:

  • 429 TooManyRequests – A kérés szabályozva van. Próbálkozzon újra az "x-ms-ratelimit-microsoft.consumption-retry-after" 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.

grain

A használat szemcséje. Támogatott értékek: "Óránként"

OperationStatusType

A juttatáskihasználtsági összefoglaló jelentés létrehozásának állapota.

AsyncOperationStatusProperties

A jelentés URL-címét képviselő objektum, amely az aszinkron jelentés létrejöttének dátumáig érvényes.

Name Típus Description
reportUrl

BenefitUtilizationSummaryReportSchema

Sas URL-cím az aszinkron juttatás kihasználtságának összegzési jelentéséhez. Üres lesz, ha a jelentés Fut vagy Sikertelen állapotban van.

secondaryReportUrl

BenefitUtilizationSummaryReportSchema

Sas URL-cím az aszinkron előnyök kihasználtságának összegzései jelentés másodlagos tárolóban elsődleges szolgáltatáskimaradás esetén. Üres lesz, ha a jelentés Fut vagy Sikertelen állapotban van.

validUntil

string

A reportUrlban megadott sas URL-cím lejáratának dátuma.

benefitKind

Foglalás vagy SavingsPlan.

Name Típus Description
IncludedQuantity

string

Az előny a IncludedQuantity.

Reservation

string

Az előny a Foglalás.

SavingsPlan

string

Az előny a SavingsPlan.

BenefitUtilizationSummariesOperationStatus

A juttatáskihasználtság összefoglaló jelentésének állapota. Aszinkron előnyök kihasználtságának összegzését tartalmazza. A kérelem bemenete, állapota és a jelentés sas URL-címe.

Name Típus Description
input

BenefitUtilizationSummariesRequest

A juttatáskihasználtság összegző jelentésének létrehozásához megadott bemenet.

properties

AsyncOperationStatusProperties

Sas URL-címet tartalmaz az aszinkron juttatás kihasználtságának összegzési jelentéséhez, valamint egy dátumot, amelyig az URL-cím érvényes. Ezek az értékek üresek lesznek, ha a jelentés Fut vagy Sikertelen állapotban van

status

OperationStatusType

A juttatáskihasználtsági összefoglaló jelentés létrehozásának állapota.

BenefitUtilizationSummariesRequest

Az aszinkron juttatás kihasználtságának összegzésére vonatkozó kérelem tulajdonságai.

Name Típus Description
benefitId

string

Juttatás azonosítója, a juttatás kihasználtsági összefoglalóinak jelentése. A juttatásazonosító hatóköréhez szükséges. Nem támogatott a juttatási rendeléshez vagy a számlázási hatókörökhöz.

benefitOrderId

string

A juttatási rendelés azonosítója, a juttatás kihasználtsági összefoglalóinak jelentése. Az juttatási sorrendhez és a juttatásazonosító hatóköreihez szükséges. A számlázási hatókörök nem támogatottak.

billingAccountId

string

Számlázási fiók, a juttatás kihasználtságának összegzési jelentése. A számlázási fiók és a számlázási profil hatóköreihez szükséges. Az előnyök hatókörei nem támogatottak.

billingProfileId

string

A számlázási profil azonosítója, a juttatás kihasználtsági összefoglalóinak jelentése. A számlázási profil hatóköréhez szükséges. A számlázási fiók és az előnyök hatókörei nem támogatottak.

endDate

string

A jelentésben kézbesítendő összesítő adatok záró dátuma.

grain

grain

Az összefoglalók adatainak a jelentésben való kiszolgálása. Az elfogadott értékek a "Napi" vagy a "Havi".

kind

benefitKind

A kért juttatási adatok típusa. A számlázási fiók és a számlázási profil hatóköreihez szükséges. Vélelmezett, és nem adható át juttatási hatókörökben. Támogatott értékek: Reservation and SavingsPlan

startDate

string

A jelentésben kézbesítendő összesítő adatok kezdő dátuma.

BenefitUtilizationSummaryReportSchema

A reportUrl és a secondaryReportUrl blob hivatkozásból származó CSV-fájl a következő oszlopokat tartalmazza a juttatás kihasználtsági adataiból. A UtilizedPercentage érték 0 lesz a megtakarítási tervek jelentéseihez és a nem adattéglák foglalásaihoz. A kihasználtság százalékos értéke 0 lesz az adattéglák foglalásai esetében.

Name Típus Description
AvgUtilizationPercentage

string

BenefitId

string

BenefitOrderId

string

BenefitType

string

Kind

string

MaxUtilizationPercentage

string

MinUtilizationPercentage

string

UsageDate

string

UtilizedPercentage

string

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.

ErrorResponse

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:

  • 429 TooManyRequests – A kérés szabályozva van. Próbálkozzon újra az "x-ms-ratelimit-microsoft.consumption-retry-after" 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.

grain

A használat szemcséje. Támogatott értékek: "Óránként"

Name Típus Description
Daily

string

Az óránkénti szemcse napi értéknek felel meg.

Hourly

string

Az óránkénti szemcse az óránkénti értéknek felel meg.

Monthly

string

Az óránkénti szemcse a havi értéknek felel meg.

OperationStatusType

A juttatáskihasználtsági összefoglaló jelentés létrehozásának állapota.

Name Típus Description
Complete

string

Failed

string

Running

string