Generate Benefit Utilization Summaries Report - Generate By Reservation Id
Attiva la generazione di un report di riepilogo dell'utilizzo dei vantaggi per la prenotazione specificata.
POST https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2023-11-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
reservation
|
path | True |
string |
ID prenotazione |
reservation
|
path | True |
string |
ID ordine prenotazione |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
endDate | True |
string |
Data di fine dei dati di riepilogo che verranno serviti nel report. |
grain | True |
Il granulare dei dati di riepilogo viene servito nel report. I valori accettati sono "Giornaliero" o "Mensile". |
|
startDate | True |
string |
Data di inizio dei riepiloghi che verranno serviti nel report. |
benefitId |
string |
Id vantaggio per il report riepiloghi dell'utilizzo dei vantaggi. Obbligatorio per l'ambito id vantaggio. Non supportato per l'ordine dei vantaggi o per gli ambiti di fatturazione. |
|
benefitOrderId |
string |
Id ordine dei vantaggi per il report riepiloghi di utilizzo dei vantaggi. Obbligatorio per l'ordine dei vantaggi e gli ambiti id vantaggio. Non supportato per gli ambiti di fatturazione. |
|
billingAccountId |
string |
Account di fatturazione per il report riepiloghi di utilizzo dei vantaggi. Obbligatorio per gli ambiti dell'account di fatturazione e del profilo di fatturazione. Non supportato per gli ambiti dei vantaggi. |
|
billingProfileId |
string |
Id profilo di fatturazione per il report riepiloghi di utilizzo dei vantaggi. Obbligatorio per l'ambito del profilo di fatturazione. Non supportato per l'account di fatturazione o per gli ambiti di vantaggio. |
|
kind |
Tipo di dati di vantaggio richiesti. Obbligatorio per gli ambiti dell'account di fatturazione e del profilo di fatturazione. Implicito e non da passare a ambiti di vantaggio. I valori supportati sono Prenotazioni e RisparmioPlan |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Stato della generazione del report riepiloghi dell'utilizzo dei vantaggi. Questo potrebbe essere in corso, non riuscito o completato. |
|
202 Accepted |
Accettato. La richiesta verrà elaborata. Usare l'intestazione della posizione per controllare lo stato. Intestazioni
|
|
Other Status Codes |
Risposta di errore che descrive perché l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
GenerateUtilizationSummariesReportByReservation
Esempio di richiesta
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=2023-11-01
{
"endDate": "2022-08-31T00:00:00Z",
"startDate": "2022-06-01T00:00:00Z",
"grain": "Daily"
}
Risposta di esempio
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=2023-11-01
Retry-After: 60
{
"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"
}
}
Definizioni
Nome | Descrizione |
---|---|
Async |
Oggetto che rappresenta l'URL del report e valido fino alla data del report asincrono generato. |
benefit |
Prenotazione o RisparmioPlan. |
Benefit |
Stato di un report di riepilogo dell'utilizzo dei vantaggi. Fornisce riepiloghi di utilizzo dei vantaggi asincroni Richiesta di input, stato e url firma di accesso condiviso del report. |
Benefit |
Proprietà di una richiesta di riepilogo dell'utilizzo dei vantaggi asincrona. |
Benefit |
Il file CSV dal collegamento BLOB reportUrl e secondaryReportUrl consisterà nelle colonne seguenti dei dati di utilizzo dei vantaggi. UsatoPercentage sarà 0 per i report sui piani di risparmio e le prenotazioni non dei mattoni dati. Le percentuali di utilizzo saranno 0 per le prenotazioni dei mattoni dati. |
Error |
Dettagli dell'errore. |
Error |
Risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore. Alcune risposte di errore:
|
grain |
Grana dell'utilizzo. Valori supportati: 'Hourly' |
Operation |
Stato della creazione del report riepiloghi sull'utilizzo dei vantaggi. |
AsyncOperationStatusProperties
Oggetto che rappresenta l'URL del report e valido fino alla data del report asincrono generato.
Nome | Tipo | Descrizione |
---|---|---|
reportUrl |
URL di firma di accesso condiviso al report riepiloghi dell'utilizzo dei vantaggi asincroni. Sarà vuoto se il report è in esecuzione o stato non riuscito. |
|
secondaryReportUrl |
Url di firma di accesso condiviso per i riepiloghi dell'utilizzo dei vantaggi asincroni nell'archiviazione secondaria in caso di interruzione primaria. Sarà vuoto se il report è in esecuzione o stato non riuscito. |
|
validUntil |
string |
Data di scadenza dell'URL sas fornito in reportUrl. |
benefitKind
Prenotazione o RisparmioPlan.
Nome | Tipo | Descrizione |
---|---|---|
IncludedQuantity |
string |
Il vantaggio è InclusoQuantity. |
Reservation |
string |
Il vantaggio è Prenotazione. |
SavingsPlan |
string |
Il vantaggio è SavingsPlan. |
BenefitUtilizationSummariesOperationStatus
Stato di un report di riepilogo dell'utilizzo dei vantaggi. Fornisce riepiloghi di utilizzo dei vantaggi asincroni Richiesta di input, stato e url firma di accesso condiviso del report.
Nome | Tipo | Descrizione |
---|---|---|
input |
Input specificato per creare il report riepiloghi di utilizzo dei vantaggi. |
|
properties |
Contiene l'URL di firma di accesso condiviso per il report di riepilogo dell'utilizzo dei vantaggi asincroni e una data di validità dell'URL fino a quando l'URL non è valido. Questi valori saranno vuoti se il report si trova in uno stato In esecuzione o Non riuscito |
|
status |
Stato della creazione del report riepiloghi sull'utilizzo dei vantaggi. |
BenefitUtilizationSummariesRequest
Proprietà di una richiesta di riepilogo dell'utilizzo dei vantaggi asincrona.
Nome | Tipo | Descrizione |
---|---|---|
benefitId |
string |
Id vantaggio per il report riepiloghi dell'utilizzo dei vantaggi. Obbligatorio per l'ambito id vantaggio. Non supportato per l'ordine dei vantaggi o per gli ambiti di fatturazione. |
benefitOrderId |
string |
Id ordine dei vantaggi per il report riepiloghi di utilizzo dei vantaggi. Obbligatorio per l'ordine dei vantaggi e gli ambiti id vantaggio. Non supportato per gli ambiti di fatturazione. |
billingAccountId |
string |
Account di fatturazione per il report riepiloghi di utilizzo dei vantaggi. Obbligatorio per gli ambiti dell'account di fatturazione e del profilo di fatturazione. Non supportato per gli ambiti dei vantaggi. |
billingProfileId |
string |
Id profilo di fatturazione per il report riepiloghi di utilizzo dei vantaggi. Obbligatorio per l'ambito del profilo di fatturazione. Non supportato per l'account di fatturazione o per gli ambiti di vantaggio. |
endDate |
string |
Data di fine dei dati di riepilogo che verranno serviti nel report. |
grain |
Il granulare dei dati di riepilogo viene servito nel report. I valori accettati sono "Giornaliero" o "Mensile". |
|
kind |
Tipo di dati di vantaggio richiesti. Obbligatorio per gli ambiti dell'account di fatturazione e del profilo di fatturazione. Implicito e non da passare a ambiti di vantaggio. I valori supportati sono Prenotazioni e RisparmioPlan |
|
startDate |
string |
Data di inizio dei riepiloghi che verranno serviti nel report. |
BenefitUtilizationSummaryReportSchema
Il file CSV dal collegamento BLOB reportUrl e secondaryReportUrl consisterà nelle colonne seguenti dei dati di utilizzo dei vantaggi. UsatoPercentage sarà 0 per i report sui piani di risparmio e le prenotazioni non dei mattoni dati. Le percentuali di utilizzo saranno 0 per le prenotazioni dei mattoni dati.
Nome | Tipo | Descrizione |
---|---|---|
AvgUtilizationPercentage |
string |
|
BenefitId |
string |
|
BenefitOrderId |
string |
|
BenefitType |
string |
|
Kind |
string |
|
MaxUtilizationPercentage |
string |
|
MinUtilizationPercentage |
string |
|
UsageDate |
string |
|
UtilizedPercentage |
string |
ErrorDetails
Dettagli dell'errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore. |
message |
string |
Messaggio di errore che indica perché l'operazione non è riuscita. |
ErrorResponse
Risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.
Alcune risposte di errore:
429 TooManyRequests - La richiesta è limitata. Riprovare dopo l'attesa dell'ora specificata nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable : il servizio non è temporaneamente disponibile. Riprovare dopo aver atteso il tempo specificato nell'intestazione "Retry-After".
Nome | Tipo | Descrizione |
---|---|---|
error |
Dettagli dell'errore. |
grain
Grana dell'utilizzo. Valori supportati: 'Hourly'
Nome | Tipo | Descrizione |
---|---|---|
Daily |
string |
La granularità oraria corrisponde al valore al giorno. |
Hourly |
string |
La granularità oraria corrisponde al valore all'ora. |
Monthly |
string |
La granularità oraria corrisponde al valore al mese. |
OperationStatusType
Stato della creazione del report riepiloghi sull'utilizzo dei vantaggi.
Nome | Tipo | Descrizione |
---|---|---|
Complete |
string |
|
Failed |
string |
|
Running |
string |