Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

Referencia

Servicio:: Cost Management

Versión de la API:: 2024-08-01

Desencadena la generación de un informe de resúmenes de uso de beneficios para el plan de ahorro proporcionado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
savingsPlanId	path	True	string	Identificador del plan de ahorro.
savingsPlanOrderId	path	True	string	Id. de pedido del plan de ahorro.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
endDate	True	string	Fecha de finalización de los resúmenes de los datos que se atenderán en el informe.
grain	True	grain	En el informe se proporcionan los detalles de los resúmenes. Los valores aceptados son "Daily" o "Monthly".
startDate	True	string	La fecha de inicio de los resúmenes de los datos que se atenderán en el informe.
benefitId		string	Id. de la ventaja para el que está el informe de resúmenes de uso de las ventajas. Necesario para el ámbito del identificador de la ventaja. No se admite para el pedido de beneficios ni para ningún ámbito de facturación.
benefitOrderId		string	Id. de orden de beneficio para el que se va a consultar el informe de resúmenes de uso de las ventajas. Obligatorio para los ámbitos de identificación de beneficios y orden de beneficios. No se admite para ningún ámbito de facturación.
billingAccountId		string	Cuenta de facturación para la que es el informe de resúmenes de uso de ventajas. Necesario para los ámbitos de perfil de facturación y cuenta de facturación. No se admite para ningún ámbito de ventaja.
billingProfileId		string	Id. de perfil de facturación para el que el informe de resúmenes de uso de ventajas es . Necesario para el ámbito del perfil de facturación. No se admite para la cuenta de facturación ni para ningún ámbito de ventaja.
kind		benefitKind	Tipo de datos de ventaja solicitados. Necesario para los ámbitos de perfil de facturación y cuenta de facturación. Implícito y no que se pasen en ámbitos de beneficios. Los valores admitidos son Reservation y SavingsPlan

Respuestas

Nombre	Tipo	Description
200 OK	BenefitUtilizationSummariesOperationStatus	Estado de la generación del informe de resúmenes de uso de beneficios. Esto podría estar en curso, con errores o completados.
202 Accepted		Aceptado. Se procesará la solicitud. Use el encabezado de ubicación para comprobar el estado. Encabezados Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Nombre

Tipo

Description

200 OK

BenefitUtilizationSummariesOperationStatus

Estado de la generación del informe de resúmenes de uso de beneficios. Esto podría estar en curso, con errores o completados.

202 Accepted

Aceptado. Se procesará la solicitud. Use el encabezado de ubicación para comprobar el estado.

Encabezados

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

GenerateUtilizationSummariesReportBySavingsPlan

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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

status code:: 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"
  }
}

Definiciones

Nombre	Description
AsyncOperationStatusProperties	Objeto que representa la dirección URL del informe y la fecha válida hasta la fecha del informe asincrónico generado.
benefitKind	Reserva o Plan de ahorro.
BenefitUtilizationSummariesOperationStatus	Estado de un informe de resúmenes de uso de ventajas. Proporciona la dirección URL de sas de la solicitud de resumen de uso de ventajas asincrónicas.
BenefitUtilizationSummariesRequest	Las propiedades de una solicitud de resumen de uso de ventajas asincrónicas.
BenefitUtilizationSummaryReportSchema	El archivo CSV del vínculo de blob reportUrl y secondaryReportUrl constará de las siguientes columnas de datos de uso de ventajas. UsedPercentage será 0 para los informes de planes de ahorro y reservas de ladrillos de datos. Los porcentajes de uso serán 0 para las reservas de ladrillos de datos.
ErrorDetails	Detalles del error.
ErrorResponse	La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error. Algunas respuestas de error: 429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Retry-After".
grain	El grano del uso. Valores admitidos: "Hourly"
OperationStatusType	Estado de la creación del informe de resúmenes de uso de beneficios.

AsyncOperationStatusProperties

Objeto que representa la dirección URL del informe y la fecha válida hasta la fecha del informe asincrónico generado.

Nombre	Tipo	Description
reportUrl	BenefitUtilizationSummaryReportSchema	Dirección URL de Sas al informe de resúmenes de uso de ventajas asincrónicas. Estará vacío si el informe está en estado En ejecución o Con errores.
secondaryReportUrl	BenefitUtilizationSummaryReportSchema	La dirección URL de Sas para el uso de ventajas asincrónicas resume el informe en el almacenamiento secundario en caso de interrupción principal. Estará vacío si el informe está en estado En ejecución o Con errores.
validUntil	string	Fecha en que expira la dirección URL de sas proporcionada en reportUrl.

benefitKind

Reserva o Plan de ahorro.

Nombre	Tipo	Description
IncludedQuantity	string	La ventaja es IncludedQuantity.
Reservation	string	La ventaja es Reserva.
SavingsPlan	string	La ventaja es SavingsPlan.

BenefitUtilizationSummariesOperationStatus

Estado de un informe de resúmenes de uso de ventajas. Proporciona la dirección URL de sas de la solicitud de resumen de uso de ventajas asincrónicas.

Nombre	Tipo	Description
input	BenefitUtilizationSummariesRequest	Entrada dada para crear el informe de resúmenes de uso de ventajas.
properties	AsyncOperationStatusProperties	Contiene la dirección URL de sas al informe de resúmenes de uso de ventajas asincrónicas y una fecha hasta que la dirección URL es válida. Estos valores estarán vacíos si el informe está en estado En ejecución o Con errores
status	OperationStatusType	Estado de la creación del informe de resúmenes de uso de beneficios.

BenefitUtilizationSummariesRequest

Las propiedades de una solicitud de resumen de uso de ventajas asincrónicas.

Nombre	Tipo	Description
benefitId	string	Id. de la ventaja para el que está el informe de resúmenes de uso de las ventajas. Necesario para el ámbito del identificador de la ventaja. No se admite para el pedido de beneficios ni para ningún ámbito de facturación.
benefitOrderId	string	Id. de orden de beneficio para el que se va a consultar el informe de resúmenes de uso de las ventajas. Obligatorio para los ámbitos de identificación de beneficios y orden de beneficios. No se admite para ningún ámbito de facturación.
billingAccountId	string	Cuenta de facturación para la que es el informe de resúmenes de uso de ventajas. Necesario para los ámbitos de perfil de facturación y cuenta de facturación. No se admite para ningún ámbito de ventaja.
billingProfileId	string	Id. de perfil de facturación para el que el informe de resúmenes de uso de ventajas es . Necesario para el ámbito del perfil de facturación. No se admite para la cuenta de facturación ni para ningún ámbito de ventaja.
endDate	string	Fecha de finalización de los resúmenes de los datos que se atenderán en el informe.
grain	grain	En el informe se proporcionan los detalles de los resúmenes. Los valores aceptados son "Daily" o "Monthly".
kind	benefitKind	Tipo de datos de ventaja solicitados. Necesario para los ámbitos de perfil de facturación y cuenta de facturación. Implícito y no que se pasen en ámbitos de beneficios. Los valores admitidos son Reservation y SavingsPlan
startDate	string	La fecha de inicio de los resúmenes de los datos que se atenderán en el informe.

BenefitUtilizationSummaryReportSchema

El archivo CSV del vínculo de blob reportUrl y secondaryReportUrl constará de las siguientes columnas de datos de uso de ventajas. UsedPercentage será 0 para los informes de planes de ahorro y reservas de ladrillos de datos. Los porcentajes de uso serán 0 para las reservas de ladrillos de datos.

Nombre	Tipo	Description
AvgUtilizationPercentage	string
BenefitId	string
BenefitOrderId	string
BenefitType	string
Kind	string
MaxUtilizationPercentage	string
MinUtilizationPercentage	string
UsageDate	string
UtilizedPercentage	string

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

ErrorResponse

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Algunas respuestas de error:

429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Retry-After".

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error.

grain

El grano del uso. Valores admitidos: "Hourly"

Nombre	Tipo	Description
Daily	string	El grano por hora corresponde al valor por día.
Hourly	string	El grano por hora corresponde al valor por hora.
Monthly	string	El grano por hora corresponde al valor al mes.

OperationStatusType

Estado de la creación del informe de resúmenes de uso de beneficios.

Nombre	Tipo	Description
Complete	string
Failed	string
Running	string

Compartir a través de

Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

GenerateUtilizationSummariesReportBySavingsPlan

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AsyncOperationStatusProperties

benefitKind

BenefitUtilizationSummariesOperationStatus

BenefitUtilizationSummariesRequest

BenefitUtilizationSummaryReportSchema

ErrorDetails

ErrorResponse

grain

OperationStatusType

Recursos adicionales