Condividi tramite


Generate Benefit Utilization Summaries Report - Generate By Billing Profile

Attiva la generazione di un report riepiloghi di utilizzo dei vantaggi per l'account di fatturazione e il profilo di fatturazione specificati.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
billingAccountId
path True

string

ID account di fatturazione

billingProfileId
path True

string

ID profilo di fatturazione.

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 riepiloghi dei dati che verranno serviti nel report.

grain True

grain

La granularità dei dati di riepilogo viene servita nel report. I valori accettati sono 'Daily' o 'Monthly'.

startDate True

string

Data di inizio dei riepiloghi dei dati che verranno serviti nel report.

benefitId

string

ID vantaggio per il report riepiloghi sull'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 di vantaggio per il report riepiloghi di utilizzo dei vantaggi. Obbligatorio per gli ambiti id vantaggio e ordine dei vantaggi. Non supportato per gli ambiti di fatturazione.

billingAccountId

string

Account di fatturazione per il report riepiloghi dell'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 dei vantaggi.

kind

benefitKind

Tipo di dati del vantaggio richiesti. Obbligatorio per gli ambiti dell'account di fatturazione e del profilo di fatturazione. Implicito e non da passare in ambiti di vantaggio. I valori supportati sono Reservation e SavingsPlan

Risposte

Nome Tipo Descrizione
200 OK

BenefitUtilizationSummariesOperationStatus

Stato della generazione del report riepiloghi sull'utilizzo dei vantaggi. 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

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

ErrorResponse

Risposta di errore che descrive il motivo per cui 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

GenerateUtilizationSummariesReportByBillingProfile

Esempio di richiesta

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

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

Risposta di esempio

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2024-08-01
Retry-After: 60
{
  "input": {
    "grain": "Daily",
    "billingAccountId": "00000000-0000-0000-0000-000000000000",
    "billingProfileId": "CZSFR-SDFXC-DSDF",
    "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
AsyncOperationStatusProperties

Oggetto che rappresenta l'URL del report e valido fino alla data di generazione del report asincrono.

benefitKind

Prenotazione o risparmioPlan.

BenefitUtilizationSummariesOperationStatus

Stato di un report riepiloghi dell'utilizzo dei vantaggi. Fornisce async Benefit Utilization Summaries Request input, status e report sas url (URL della firma di accesso condiviso del vantaggio Async).

BenefitUtilizationSummariesRequest

Proprietà di una richiesta di riepilogo dell'utilizzo dei vantaggi asincroni.

BenefitUtilizationSummaryReportSchema

Il file CSV del collegamento BLOB reportUrl e secondaryReportUrl sarà costituito dalle colonne seguenti di dati sull'utilizzo dei vantaggi. UtilizzatoPercentage sarà 0 per i report sui piani di risparmio e prenotazioni non di mattoni dati. Le percentuali di utilizzo saranno 0 per le prenotazioni dei mattoni dati.

ErrorDetails

Dettagli dell'errore.

ErrorResponse

La 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 aver aspettato il tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "Retry-After".

grain

Granularità dell'utilizzo. Valori supportati: 'Hourly'

OperationStatusType

Stato della creazione del report riepiloghi sull'utilizzo dei vantaggi.

AsyncOperationStatusProperties

Oggetto che rappresenta l'URL del report e valido fino alla data di generazione del report asincrono.

Nome Tipo Descrizione
reportUrl

BenefitUtilizationSummaryReportSchema

URL di firma di accesso condiviso al report riepiloghi dell'utilizzo dei vantaggi asincroni. Sarà vuoto se il report è in stato In esecuzione o Non riuscito.

secondaryReportUrl

BenefitUtilizationSummaryReportSchema

Url di firma di accesso condiviso per riepiloghi dell'utilizzo dei vantaggi asincroni nell'archiviazione secondaria in caso di interruzione primaria. Sarà vuoto se il report è in stato In esecuzione o Non riuscito.

validUntil

string

Data di scadenza dell'URL di firma di accesso condiviso specificato in reportUrl.

benefitKind

Prenotazione o risparmioPlan.

Nome Tipo Descrizione
IncludedQuantity

string

Il vantaggio è IncludedQuantity.

Reservation

string

Il vantaggio è Prenotazione.

SavingsPlan

string

Il vantaggio è SavingsPlan.

BenefitUtilizationSummariesOperationStatus

Stato di un report riepiloghi dell'utilizzo dei vantaggi. Fornisce async Benefit Utilization Summaries Request input, status e report sas url (URL della firma di accesso condiviso del vantaggio Async).

Nome Tipo Descrizione
input

BenefitUtilizationSummariesRequest

Input specificato per creare il report riepiloghi sull'utilizzo dei vantaggi.

properties

AsyncOperationStatusProperties

Contiene l'URL della firma di accesso condiviso per il report riepiloghi dell'utilizzo dei vantaggi asincroni e una data in cui l'URL è valido fino a quando. Questi valori saranno vuoti se il report si trova in uno stato In esecuzione o Non riuscito

status

OperationStatusType

Stato della creazione del report riepiloghi sull'utilizzo dei vantaggi.

BenefitUtilizationSummariesRequest

Proprietà di una richiesta di riepilogo dell'utilizzo dei vantaggi asincroni.

Nome Tipo Descrizione
benefitId

string

ID vantaggio per il report riepiloghi sull'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 di vantaggio per il report riepiloghi di utilizzo dei vantaggi. Obbligatorio per gli ambiti id vantaggio e ordine dei vantaggi. Non supportato per gli ambiti di fatturazione.

billingAccountId

string

Account di fatturazione per il report riepiloghi dell'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 dei vantaggi.

endDate

string

Data di fine dei riepiloghi dei dati che verranno serviti nel report.

grain

grain

La granularità dei dati di riepilogo viene servita nel report. I valori accettati sono 'Daily' o 'Monthly'.

kind

benefitKind

Tipo di dati del vantaggio richiesti. Obbligatorio per gli ambiti dell'account di fatturazione e del profilo di fatturazione. Implicito e non da passare in ambiti di vantaggio. I valori supportati sono Reservation e SavingsPlan

startDate

string

Data di inizio dei riepiloghi dei dati che verranno serviti nel report.

BenefitUtilizationSummaryReportSchema

Il file CSV del collegamento BLOB reportUrl e secondaryReportUrl sarà costituito dalle colonne seguenti di dati sull'utilizzo dei vantaggi. UtilizzatoPercentage sarà 0 per i report sui piani di risparmio e prenotazioni non di 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 il motivo per cui l'operazione non è riuscita.

ErrorResponse

La 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 aver aspettato il tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "Retry-After".

Nome Tipo Descrizione
error

ErrorDetails

Dettagli dell'errore.

grain

Granularità 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