Generate Benefit Utilization Summaries Report - Generate By Reservation Id

Referens

Tjänst:: Cost Management

API-version:: 2024-08-01

Utlöser generering av en sammanfattningsrapport för förmånsanvändning för den angivna reservationen.

POST https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
reservationId	path	True	string	Reservations-ID
reservationOrderId	path	True	string	Reservationsbeställnings-ID
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
endDate	True	string	Slutdatumet för sammanfattningsdata som ska hanteras i rapporten.
grain	True	grain	Kornet som sammanfattningsdata hanteras på i rapporten. Godkända värden är "Daily" eller "Monthly".
startDate	True	string	Startdatumet för sammanfattningsdata som ska hanteras i rapporten.
benefitId		string	Förmåns-ID som rapporten om förmånsanvändningssammanfattningar är till för. Krävs för förmåns-ID-omfång. Stöds inte för förmånsbeställning eller faktureringsomfång.
benefitOrderId		string	Förmånsbeställnings-ID som rapporten om förmånsanvändningssammanfattningar är till för. Krävs för omfång för förmånsbeställning och förmåns-ID. Stöds inte för några faktureringsomfång.
billingAccountId		string	Faktureringskonto som rapporten om förmånsanvändningssammanfattningar är till för. Krävs för faktureringskonto- och faktureringsprofilomfång. Stöds inte för några förmånsomfång.
billingProfileId		string	Faktureringsprofil-ID som rapporten om förmånsanvändningssammanfattningar är till för. Krävs för faktureringsprofilomfång. Stöds inte för faktureringskonto eller några förmånsomfång.
kind		benefitKind	Typ av förmånsdata som begärs. Krävs för faktureringskonto- och faktureringsprofilomfång. Underförstådda och ska inte skickas i förmånsomfång. Värden som stöds är Reservation och SavingsPlan

Svar

Name	Typ	Description
200 OK	BenefitUtilizationSummariesOperationStatus	Status för genereringen av rapporten över förmånsanvändningssammanfattningar. Detta kan vara pågående, misslyckat eller slutfört.
202 Accepted		Accepterad. Begäran bearbetas. Använd platsrubriken för att kontrollera statusen. Sidhuvuden Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Name

Typ

Description

200 OK

BenefitUtilizationSummariesOperationStatus

Status för genereringen av rapporten över förmånsanvändningssammanfattningar. Detta kan vara pågående, misslyckat eller slutfört.

202 Accepted

Accepterad. Begäran bearbetas. Använd platsrubriken för att kontrollera statusen.

Sidhuvuden

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

GenerateUtilizationSummariesReportByReservation

Exempelbegäran

HTTP

POST https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

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

Exempelsvar

Statuskod:: 202

Location: https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2024-08-01
Retry-After: 60

Statuskod:: 200

{
  "input": {
    "grain": "Daily",
    "benefitOrderId": "00000000-0000-0000-0000-000000000000",
    "benefitId": "00000000-0000-0000-0000-000000000000",
    "kind": "Reservation",
    "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"
  }
}

Definitioner

Name	Description
AsyncOperationStatusProperties	Objekt som representerar rapport-URL:en och giltigt fram till datumet för den asynkrona rapport som genererats.
benefitKind	Reservation eller SavingsPlan.
BenefitUtilizationSummariesOperationStatus	Status för en sammanfattningsrapport för förmånsanvändning. Tillhandahåller Async Benefit Utilization Summaries Request input, status, and report sas url.
BenefitUtilizationSummariesRequest	Egenskaper för en sammanfattningsbegäran om asynkron förmånsanvändning.
BenefitUtilizationSummaryReportSchema	CSV-filen från bloblänken reportUrl och secondaryReportUrl består av följande kolumner med nyttoanvändningsdata. UtilizedPercentage blir 0 för sparplansrapporter och andra reservationer än dataklossar. Användningsprocenten är 0 för reservationer av datastenar.
ErrorDetails	Information om felet.
ErrorResponse	Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet. Några felsvar: 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen".
grain	Användningsintervallet. Värden som stöds: "Varje timme"
OperationStatusType	Status för skapandet av rapporten med sammanfattningar av förmånsanvändning.

AsyncOperationStatusProperties

Objekt som representerar rapport-URL:en och giltigt fram till datumet för den asynkrona rapport som genererats.

Name	Typ	Description
reportUrl	BenefitUtilizationSummaryReportSchema	Sas url till rapporten async benefit utilization summaries . Kommer att vara tom om rapporten är i tillståndet Körs eller Misslyckades.
secondaryReportUrl	BenefitUtilizationSummaryReportSchema	Sas url to async benefit utilization summaries report in secondary storage in of primary outage( Sas url to async benefit utilization summaries report in secondary storage in of primary outage. Kommer att vara tom om rapporten är i tillståndet Körs eller Misslyckades.
validUntil	string	Det datum då sas-URL:en som anges i reportUrl upphör att gälla.

benefitKind

Reservation eller SavingsPlan.

Name	Typ	Description
IncludedQuantity	string	Förmånen är IncludedQuantity.
Reservation	string	Förmånen är Reservation.
SavingsPlan	string	Förmånen är SavingsPlan.

BenefitUtilizationSummariesOperationStatus

Status för en sammanfattningsrapport för förmånsanvändning. Tillhandahåller Async Benefit Utilization Summaries Request input, status, and report sas url.

Name	Typ	Description
input	BenefitUtilizationSummariesRequest	Indata som ges för att skapa sammanfattningsrapporten för förmånsanvändning.
properties	AsyncOperationStatusProperties	Innehåller sas url till rapporten async benefit utilization summaries och ett datum då url:en är giltig tills dess. Dessa värden är tomma om rapporten är i ett tillstånd som körs eller misslyckas
status	OperationStatusType	Status för skapandet av rapporten med sammanfattningar av förmånsanvändning.

BenefitUtilizationSummariesRequest

Egenskaper för en sammanfattningsbegäran om asynkron förmånsanvändning.

Name	Typ	Description
benefitId	string	Förmåns-ID som rapporten om förmånsanvändningssammanfattningar är till för. Krävs för förmåns-ID-omfång. Stöds inte för förmånsbeställning eller faktureringsomfång.
benefitOrderId	string	Förmånsbeställnings-ID som rapporten om förmånsanvändningssammanfattningar är till för. Krävs för omfång för förmånsbeställning och förmåns-ID. Stöds inte för några faktureringsomfång.
billingAccountId	string	Faktureringskonto som rapporten om förmånsanvändningssammanfattningar är till för. Krävs för faktureringskonto- och faktureringsprofilomfång. Stöds inte för några förmånsomfång.
billingProfileId	string	Faktureringsprofil-ID som rapporten om förmånsanvändningssammanfattningar är till för. Krävs för faktureringsprofilomfång. Stöds inte för faktureringskonto eller några förmånsomfång.
endDate	string	Slutdatumet för sammanfattningsdata som ska hanteras i rapporten.
grain	grain	Kornet som sammanfattningsdata hanteras på i rapporten. Godkända värden är "Daily" eller "Monthly".
kind	benefitKind	Typ av förmånsdata som begärs. Krävs för faktureringskonto- och faktureringsprofilomfång. Underförstådda och ska inte skickas i förmånsomfång. Värden som stöds är Reservation och SavingsPlan
startDate	string	Startdatumet för sammanfattningsdata som ska hanteras i rapporten.

BenefitUtilizationSummaryReportSchema

CSV-filen från bloblänken reportUrl och secondaryReportUrl består av följande kolumner med nyttoanvändningsdata. UtilizedPercentage blir 0 för sparplansrapporter och andra reservationer än dataklossar. Användningsprocenten är 0 för reservationer av datastenar.

Name	Typ	Description
AvgUtilizationPercentage	string
BenefitId	string
BenefitOrderId	string
BenefitType	string
Kind	string
MaxUtilizationPercentage	string
MinUtilizationPercentage	string
UsageDate	string
UtilizedPercentage	string

ErrorDetails

Information om felet.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen".

Name	Typ	Description
error	ErrorDetails	Information om felet.

grain

Användningsintervallet. Värden som stöds: "Varje timme"

Name	Typ	Description
Daily	string	Timintervall motsvarar värdet per dag.
Hourly	string	Timintervall motsvarar värdet per timme.
Monthly	string	Timintervall motsvarar värdet per månad.

OperationStatusType

Status för skapandet av rapporten med sammanfattningar av förmånsanvändning.

Name	Typ	Description
Complete	string
Failed	string
Running	string

Dela via

Generate Benefit Utilization Summaries Report - Generate By Reservation Id

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

GenerateUtilizationSummariesReportByReservation

Exempelbegäran

Exempelsvar

Definitioner

AsyncOperationStatusProperties

benefitKind

BenefitUtilizationSummariesOperationStatus

BenefitUtilizationSummariesRequest

BenefitUtilizationSummaryReportSchema

ErrorDetails

ErrorResponse

grain

OperationStatusType

Ytterligare resurser