Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

Referentie

Service:: Cost Management

API-versie:: 2024-08-01

Hiermee wordt het genereren van een overzichtsrapport over het voordeelgebruik voor het opgegeven besparingsplan geactiveerd.

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

URI-parameters

Name	In	Vereist	Type	Description
savingsPlanId	path	True	string	Spaarplan-id.
savingsPlanOrderId	path	True	string	Order-id van spaarplan.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
endDate	True	string	De einddatum van de samenvattingsgegevens die in het rapport worden geleverd.
grain	True	grain	Het graan van de samenvattingsgegevens wordt in het rapport verwerkt. Geaccepteerde waarden zijn 'Dagelijks' of 'Maandelijks'.
startDate	True	string	De begindatum van de samenvattingsgegevens die in het rapport worden geleverd.
benefitId		string	Voordeel-id waarvoor het overzichtsrapport voor het voordeelgebruik is bedoeld. Vereist voor het bereik van de voordeel-id. Niet ondersteund voor voordeelorders of factureringsbereiken.
benefitOrderId		string	De order-id van het voordeel waarvoor het rapport samenvattingen van het voordeelgebruik is bedoeld. Vereist voor bereiken van voordeelvolgorde en voordeel-id. Niet ondersteund voor factureringsbereiken.
billingAccountId		string	Factureringsrekening waarvoor het overzichtsrapport van het voordeelgebruik geldt. Vereist voor bereiken voor factureringsaccounts en factureringsprofielen. Niet ondersteund voor voordelenbereiken.
billingProfileId		string	De factureringsprofiel-id waarvoor het overzichtsrapport voor voordeelgebruik geldt. Vereist voor het bereik van het factureringsprofiel. Niet ondersteund voor factureringsaccounts of voordelenbereiken.
kind		benefitKind	Het type aangevraagde voordeelgegevens. Vereist voor bereiken voor factureringsaccounts en factureringsprofielen. Impliciet en niet worden doorgegeven aan voordelenbereiken. Ondersteunde waarden zijn Reservation and SavingsPlan

Antwoorden

Name	Type	Description
200 OK	BenefitUtilizationSummariesOperationStatus	De status van het genereren van het overzicht van het voordeelgebruik. Dit kan worden uitgevoerd, mislukt of voltooid.
202 Accepted		Geaccepteerd. De aanvraag wordt verwerkt. Gebruik de locatieheader om de status te controleren. Kopteksten Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

BenefitUtilizationSummariesOperationStatus

De status van het genereren van het overzicht van het voordeelgebruik. Dit kan worden uitgevoerd, mislukt of voltooid.

202 Accepted

Geaccepteerd. De aanvraag wordt verwerkt. Gebruik de locatieheader om de status te controleren.

Kopteksten

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

GenerateUtilizationSummariesReportBySavingsPlan

Voorbeeldaanvraag

HTTP

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=2024-08-01

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

Voorbeeldrespons

Statuscode:: 202

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=2024-08-01
Retry-After: 60

Statuscode:: 200

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

Definities

Name	Description
AsyncOperationStatusProperties	Object dat de rapport-URL vertegenwoordigt en geldig is tot de datum van het gegenereerde asynchrone rapport.
benefitKind	Reservering of Spaarplan.
BenefitUtilizationSummariesOperationStatus	Status van een overzichtsrapport over het voordeelgebruik. Biedt Async Benefit Utilization Summaries Request input, status, and report SAS URL.
BenefitUtilizationSummariesRequest	Eigenschappen van een aanvraag voor asynchroon voordeelgebruik.
BenefitUtilizationSummaryReportSchema	Het CSV-bestand van de blobkoppeling reportUrl en secondaryReportUrl bestaat uit de volgende kolommen met gegevens over het voordeelgebruik. Het gebruikspercentage is 0 voor besparingsplannen en niet-data bricks reserveringen. Gebruikspercentages zijn 0 voor reserveringen van gegevensstenen.
ErrorDetails	De details van de fout.
ErrorResponse	Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht. Enkele foutberichten: 429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'.
grain	Het korreltje van het gebruik. Ondersteunde waarden: 'Elk uur'
OperationStatusType	De status van het maken van het overzichtsrapport voordeelgebruik.

AsyncOperationStatusProperties

Object dat de rapport-URL vertegenwoordigt en geldig is tot de datum van het gegenereerde asynchrone rapport.

Name	Type	Description
reportUrl	BenefitUtilizationSummaryReportSchema	Sas-URL naar het overzichtsrapport asynchroon voordeelgebruik. Is leeg als het rapport de status Wordt uitgevoerd of Mislukt heeft.
secondaryReportUrl	BenefitUtilizationSummaryReportSchema	Sas-URL naar asynchroon voordeeloverzichtenrapport in secundaire opslag in geval van primaire storing. Is leeg als het rapport de status Wordt uitgevoerd of Mislukt heeft.
validUntil	string	De datum waarop de SAS-URL in reportUrl verloopt.

benefitKind

Reservering of Spaarplan.

Name	Type	Description
IncludedQuantity	string	Benefit is IncludedQuantity.
Reservation	string	Voordeel is Reservering.
SavingsPlan	string	Voordeel is SavingsPlan.

BenefitUtilizationSummariesOperationStatus

Status van een overzichtsrapport over het voordeelgebruik. Biedt Async Benefit Utilization Summaries Request input, status, and report SAS URL.

Name	Type	Description
input	BenefitUtilizationSummariesRequest	Invoer die is opgegeven om het overzichtsrapport voor het voordeelgebruik te maken.
properties	AsyncOperationStatusProperties	Bevat een SAS-URL naar het overzichtsrapport asynchroon voordeelgebruik en een datum waarop de URL geldig is totdat. Deze waarden zijn leeg als het rapport de status Actief of Mislukt heeft
status	OperationStatusType	De status van het maken van het overzichtsrapport voordeelgebruik.

BenefitUtilizationSummariesRequest

Eigenschappen van een aanvraag voor asynchroon voordeelgebruik.

Name	Type	Description
benefitId	string	Voordeel-id waarvoor het overzichtsrapport voor het voordeelgebruik is bedoeld. Vereist voor het bereik van de voordeel-id. Niet ondersteund voor voordeelorders of factureringsbereiken.
benefitOrderId	string	De order-id van het voordeel waarvoor het rapport samenvattingen van het voordeelgebruik is bedoeld. Vereist voor bereiken van voordeelvolgorde en voordeel-id. Niet ondersteund voor factureringsbereiken.
billingAccountId	string	Factureringsrekening waarvoor het overzichtsrapport van het voordeelgebruik geldt. Vereist voor bereiken voor factureringsaccounts en factureringsprofielen. Niet ondersteund voor voordelenbereiken.
billingProfileId	string	De factureringsprofiel-id waarvoor het overzichtsrapport voor voordeelgebruik geldt. Vereist voor het bereik van het factureringsprofiel. Niet ondersteund voor factureringsaccounts of voordelenbereiken.
endDate	string	De einddatum van de samenvattingsgegevens die in het rapport worden geleverd.
grain	grain	Het graan van de samenvattingsgegevens wordt in het rapport verwerkt. Geaccepteerde waarden zijn 'Dagelijks' of 'Maandelijks'.
kind	benefitKind	Het type aangevraagde voordeelgegevens. Vereist voor bereiken voor factureringsaccounts en factureringsprofielen. Impliciet en niet worden doorgegeven aan voordelenbereiken. Ondersteunde waarden zijn Reservation and SavingsPlan
startDate	string	De begindatum van de samenvattingsgegevens die in het rapport worden geleverd.

BenefitUtilizationSummaryReportSchema

Het CSV-bestand van de blobkoppeling reportUrl en secondaryReportUrl bestaat uit de volgende kolommen met gegevens over het voordeelgebruik. Het gebruikspercentage is 0 voor besparingsplannen en niet-data bricks reserveringen. Gebruikspercentages zijn 0 voor reserveringen van gegevensstenen.

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

ErrorDetails

De details van de fout.

Name	Type	Description
code	string	Foutcode.
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

ErrorResponse

Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht.

Enkele foutberichten:

429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'.

Name	Type	Description
error	ErrorDetails	De details van de fout.

grain

Het korreltje van het gebruik. Ondersteunde waarden: 'Elk uur'

Name	Type	Description
Daily	string	Elk uur komt overeen met de waarde per dag.
Hourly	string	Elk uur komt overeen met de waarde per uur.
Monthly	string	Elk uur komt overeen met de waarde per maand.

OperationStatusType

De status van het maken van het overzichtsrapport voordeelgebruik.

Name	Type	Description
Complete	string
Failed	string
Running	string

Delen via

Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

GenerateUtilizationSummariesReportBySavingsPlan

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AsyncOperationStatusProperties

benefitKind

BenefitUtilizationSummariesOperationStatus

BenefitUtilizationSummariesRequest

BenefitUtilizationSummaryReportSchema

ErrorDetails

ErrorResponse

grain

OperationStatusType

Aanvullende resources