Sdílet prostřednictvím


Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

Aktivuje generování sestavy souhrnů využití výhod pro zadaný plán úspor.

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

Parametry identifikátoru URI

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

string

ID úspory.

savingsPlanOrderId
path True

string

ID objednávky úspory plánu.

api-version
query True

string

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

Text požadavku

Name Vyžadováno Typ Description
endDate True

string

Koncové datum souhrnů dat, která budou v sestavě doručena.

grain True

grain

Jedná se o zrno, na které se v sestavě zasílají data souhrnů. Akceptované hodnoty jsou Denně nebo Měsíčně.

startDate True

string

Počáteční datum souhrnů dat, která budou v sestavě doručena.

benefitId

string

ID výhody, pro kterou je sestava souhrnů využití výhod určena. Vyžaduje se pro rozsah ID výhody. Nepodporuje se pro objednávku výhod ani rozsahy fakturace.

benefitOrderId

string

ID pořadí výhod, pro které je sestava souhrnů využití výhod určena. Vyžaduje se pro rozsahy objednávek výhod a ID výhod. Nepodporuje se pro žádné rozsahy fakturace.

billingAccountId

string

Fakturační účet, pro který je sestava souhrnů využití výhod určená. Vyžaduje se pro rozsahy fakturačního účtu a fakturačního profilu. Nepodporuje se pro žádné rozsahy výhod.

billingProfileId

string

ID fakturačního profilu, pro který je sestava souhrnů využití výhod určená. Vyžaduje se pro rozsah fakturačního profilu. Nepodporuje se pro fakturační účet ani rozsahy výhod.

kind

benefitKind

Typ požadovaných dat o výhodách Vyžaduje se pro rozsahy fakturačního účtu a fakturačního profilu. Implicitní a neprosadí se v rozsahech výhod. Podporované hodnoty jsou Rezervace a SavingsPlan.

Odpovědi

Name Typ Description
200 OK

BenefitUtilizationSummariesOperationStatus

Stav generování sestavy souhrnů využití výhod To může být probíhající, neúspěšné nebo dokončené.

202 Accepted

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

Hlavičky

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

ErrorResponse

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

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

GenerateUtilizationSummariesReportBySavingsPlan

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
AsyncOperationStatusProperties

Objekt představující adresu URL sestavy a platný až do data vygenerované asynchronní sestavy.

benefitKind

Rezervace nebo Plán úspor.

BenefitUtilizationSummariesOperationStatus

Stav sestavy souhrnů využití výhod Poskytuje souhrny využití výhod Async, vstup, stav a adresa URL sas sestavy.

BenefitUtilizationSummariesRequest

Vlastnosti požadavku souhrnů využití asynchronních výhod

BenefitUtilizationSummaryReportSchema

Soubor CSV z odkazu reportUrl a secondaryReportUrl blob se bude skládat z následujících sloupců dat o využití výhod. Využitípercentage bude 0 pro sestavy úsporných plánů a rezervace, které nejsou datové cihly. Procento využití bude pro rezervace datových cihel 0.

ErrorDetails

Podrobnosti o chybě.

ErrorResponse

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:

  • 429 TooManyRequests – Požadavek je omezený. Zkuste to znovu po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-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.

grain

Zrno využití. Podporované hodnoty: Hodinově

OperationStatusType

Stav vytvoření sestavy souhrnů využití výhod

AsyncOperationStatusProperties

Objekt představující adresu URL sestavy a platný až do data vygenerované asynchronní sestavy.

Name Typ Description
reportUrl

BenefitUtilizationSummaryReportSchema

Adresa URL sas sestavy souhrnů využití asynchronních výhod Pokud je sestava ve stavu Spuštěno nebo Selhání, bude prázdná.

secondaryReportUrl

BenefitUtilizationSummaryReportSchema

Sestava souhrnů využití výhod sas v sekundárním úložišti v případě primárního výpadku Pokud je sestava ve stavu Spuštěno nebo Selhání, bude prázdná.

validUntil

string

Datum vypršení platnosti adresy URL sas zadané v reportUrl

benefitKind

Rezervace nebo Plán úspor.

Name Typ Description
IncludedQuantity

string

Výhoda je IncludedQuantity.

Reservation

string

Výhodou je rezervace.

SavingsPlan

string

Benefit je SavingsPlan.

BenefitUtilizationSummariesOperationStatus

Stav sestavy souhrnů využití výhod Poskytuje souhrny využití výhod Async, vstup, stav a adresa URL sas sestavy.

Name Typ Description
input

BenefitUtilizationSummariesRequest

Vstup zadaný k vytvoření sestavy souhrnů využití výhod

properties

AsyncOperationStatusProperties

Obsahuje adresu URL sas sestavy souhrnů využití asynchronních výhod a datum, do kterého je adresa URL platná. Pokud je sestava ve stavu Spuštěno nebo Selhání, budou tyto hodnoty prázdné.

status

OperationStatusType

Stav vytvoření sestavy souhrnů využití výhod

BenefitUtilizationSummariesRequest

Vlastnosti požadavku souhrnů využití asynchronních výhod

Name Typ Description
benefitId

string

ID výhody, pro kterou je sestava souhrnů využití výhod určena. Vyžaduje se pro rozsah ID výhody. Nepodporuje se pro objednávku výhod ani rozsahy fakturace.

benefitOrderId

string

ID pořadí výhod, pro které je sestava souhrnů využití výhod určena. Vyžaduje se pro rozsahy objednávek výhod a ID výhod. Nepodporuje se pro žádné rozsahy fakturace.

billingAccountId

string

Fakturační účet, pro který je sestava souhrnů využití výhod určená. Vyžaduje se pro rozsahy fakturačního účtu a fakturačního profilu. Nepodporuje se pro žádné rozsahy výhod.

billingProfileId

string

ID fakturačního profilu, pro který je sestava souhrnů využití výhod určená. Vyžaduje se pro rozsah fakturačního profilu. Nepodporuje se pro fakturační účet ani rozsahy výhod.

endDate

string

Koncové datum souhrnů dat, která budou v sestavě doručena.

grain

grain

Jedná se o zrno, na které se v sestavě zasílají data souhrnů. Akceptované hodnoty jsou Denně nebo Měsíčně.

kind

benefitKind

Typ požadovaných dat o výhodách Vyžaduje se pro rozsahy fakturačního účtu a fakturačního profilu. Implicitní a neprosadí se v rozsahech výhod. Podporované hodnoty jsou Rezervace a SavingsPlan.

startDate

string

Počáteční datum souhrnů dat, která budou v sestavě doručena.

BenefitUtilizationSummaryReportSchema

Soubor CSV z odkazu reportUrl a secondaryReportUrl blob se bude skládat z následujících sloupců dat o využití výhod. Využitípercentage bude 0 pro sestavy úsporných plánů a rezervace, které nejsou datové cihly. Procento využití bude pro rezervace datových cihel 0.

Name Typ Description
AvgUtilizationPercentage

string

BenefitId

string

BenefitOrderId

string

BenefitType

string

Kind

string

MaxUtilizationPercentage

string

MinUtilizationPercentage

string

UsageDate

string

UtilizedPercentage

string

ErrorDetails

Podrobnosti o chybě.

Name Typ Description
code

string

Kód chyby

message

string

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

ErrorResponse

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:

  • 429 TooManyRequests – Požadavek je omezený. Zkuste to znovu po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-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ě.

grain

Zrno využití. Podporované hodnoty: Hodinově

Name Typ Description
Daily

string

Hodinová hodnota odpovídá hodnotě za den.

Hourly

string

Hodinová hodnota odpovídá hodnotě za hodinu.

Monthly

string

Hodinová hodnota odpovídá hodnotě za měsíc.

OperationStatusType

Stav vytvoření sestavy souhrnů využití výhod

Name Typ Description
Complete

string

Failed

string

Running

string