Generate Detailed Cost Report - Create Operation

Referencia

Servicio:: Cost Management

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

Genera el informe de costos detallado para el intervalo de fechas proporcionado, el período de facturación (solo los clientes empresariales) o el identificador de facturación de forma asincrónica en un ámbito determinado. La llamada devuelve un 202 con el encabezado AzureConsumption-AsyncOperation proporcionar un vínculo a la operación creada. Una llamada en la operación proporcionará el estado y, si la operación se completa, se almacena el archivo de blob donde se almacena el informe de costos detallado generado.

POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
scope	path	True	string	El identificador de recurso de ARM para la suscripción, el grupo de recursos, la cuenta de facturación u otros ámbitos de facturación. Para obtener más información, consulte https://aka.ms/costmgmt/scopes.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
billingPeriod	string	Período de facturación en formato YearMonth(por ejemplo, 202008). Solo para los clientes empresariales heredados pueden usarlo. Solo puede tener uno de los parámetros timePeriod o invoiceId o billingPeriod. Si no se proporciona ningún costo del mes actual.
customerId	string	Identificador de cliente para los ámbitos del Contrato de cliente de Microsoft (también se requiere el identificador de factura para esto).
invoiceId	string	Identificador de factura para ámbitos de pago por uso y Contrato de cliente de Microsoft. Solo puede tener uno de los parámetros timePeriod o invoiceId o billingPeriod. Si no se proporciona ningún costo del mes actual.
metric	GenerateDetailedCostReportMetricType	Tipo del informe detallado. De forma predeterminada, se proporciona ActualCost
timePeriod	GenerateDetailedCostReportTimePeriod	Tiene un período de tiempo para extraer datos para el informe detallado del costo. Solo puede tener uno de los parámetros timePeriod o invoiceId o billingPeriod. Si no se proporciona ningún costo del mes actual.

Respuestas

Nombre	Tipo	Description
200 OK	GenerateDetailedCostReportOperationResult	Se completó el procesamiento de solicitudes.
202 Accepted		Aceptado. Se procesará la solicitud. Use el encabezado Location (Ubicación) para comprobar el estado. Encabezados Location: string Azure-Consumption-AsyncOperation: string Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	GenerateDetailedCostReportErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Nombre

Tipo

Description

200 OK

GenerateDetailedCostReportOperationResult

Se completó el procesamiento de solicitudes.

202 Accepted

Aceptado. Se procesará la solicitud. Use el encabezado Location (Ubicación) para comprobar el estado.

Encabezados

Location: string
Azure-Consumption-AsyncOperation: string
Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

GenerateDetailedCostReportErrorResponse

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

GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod

GenerateDetailedCostReportByBillingProfileAndInvoiceId

GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId

GenerateDetailedCostReportByCustomerAndTimePeriod

GenerateDetailedCostReportBySubscriptionAndTimePeriod

GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

{
  "metric": "ActualCost",
  "billingPeriod": "202008"
}

Respuesta de muestra

status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}

status code:: 202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Retry-After: 60

GenerateDetailedCostReportByBillingProfileAndInvoiceId

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

{
  "metric": "ActualCost",
  "invoiceId": "M1234567"
}

Respuesta de muestra

status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}

status code:: 202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Retry-After: 60

GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

{
  "metric": "ActualCost",
  "invoiceId": "M1234567",
  "customerId": "456789"
}

Respuesta de muestra

status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}

status code:: 202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Retry-After: 60

GenerateDetailedCostReportByCustomerAndTimePeriod

Solicitud de ejemplo

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

{
  "metric": "ActualCost",
  "timePeriod": {
    "start": "2020-03-01",
    "end": "2020-03-15"
  }
}

Respuesta de muestra

status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}

status code:: 202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01
Retry-After: 60

GenerateDetailedCostReportBySubscriptionAndTimePeriod

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateDetailedCostReport?api-version=2024-08-01

{
  "metric": "ActualCost",
  "timePeriod": {
    "start": "2020-03-01",
    "end": "2020-03-15"
  }
}

Respuesta de muestra

status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Consumption/operationResult",
  "properties": {
    "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
    "validTill": "2020-12-08T05:55:59.4394737Z"
  }
}

status code:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000?api-version=2021-10-01
Azure-Consumption-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2021-10-01
Retry-After: 60

Definiciones

Nombre	Description
ErrorDetails	Detalles del error.
GenerateDetailedCostReportDefinition	Definición de un informe detallado de costos.
GenerateDetailedCostReportErrorResponse	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: 413 Entidad de solicitud demasiado grande: la solicitud está limitada. La cantidad de datos necesarios para cumplir la solicitud supera el tamaño máximo permitido de 2 Gb. Use en su lugar nuestra característica Exportaciones. 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".
GenerateDetailedCostReportMetricType	Tipo del informe detallado. De forma predeterminada, se proporciona ActualCost
GenerateDetailedCostReportOperationResult	Resultado de la operación de larga duración para el informe detallado de costos.
GenerateDetailedCostReportTimePeriod	Fecha de inicio y finalización para extraer datos del informe detallado del costo.

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.

GenerateDetailedCostReportDefinition

Definición de un informe detallado de costos.

Nombre	Tipo	Description
billingPeriod	string	Período de facturación en formato YearMonth(por ejemplo, 202008). Solo para los clientes empresariales heredados pueden usarlo. Solo puede tener uno de los parámetros timePeriod o invoiceId o billingPeriod. Si no se proporciona ningún costo del mes actual.
customerId	string	Identificador de cliente para los ámbitos del Contrato de cliente de Microsoft (también se requiere el identificador de factura para esto).
invoiceId	string	Identificador de factura para ámbitos de pago por uso y Contrato de cliente de Microsoft. Solo puede tener uno de los parámetros timePeriod o invoiceId o billingPeriod. Si no se proporciona ningún costo del mes actual.
metric	GenerateDetailedCostReportMetricType	Tipo del informe detallado. De forma predeterminada, se proporciona ActualCost
timePeriod	GenerateDetailedCostReportTimePeriod	Tiene un período de tiempo para extraer datos para el informe detallado del costo. Solo puede tener uno de los parámetros timePeriod o invoiceId o billingPeriod. Si no se proporciona ningún costo del mes actual.

GenerateDetailedCostReportErrorResponse

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:

413 Entidad de solicitud demasiado grande: la solicitud está limitada. La cantidad de datos necesarios para cumplir la solicitud supera el tamaño máximo permitido de 2 Gb. Use en su lugar nuestra característica Exportaciones.
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.

GenerateDetailedCostReportMetricType

Tipo del informe detallado. De forma predeterminada, se proporciona ActualCost

Nombre	Tipo	Description
ActualCost	string
AmortizedCost	string

GenerateDetailedCostReportOperationResult

Resultado de la operación de larga duración para el informe detallado de costos.

Nombre	Tipo	Description
id	string	Identificador de recurso de ARM de la operación de larga duración.
name	string	Nombre de la operación de larga duración.
properties.downloadUrl	string	Dirección URL para descargar el informe generado.
properties.expiryTime	string	La hora a la que la dirección URL del informe deja de ser válida o expira en UTC, por ejemplo, 2020-12-08T05:55:59.4394737Z.
properties.validTill	string	La hora a la que la dirección URL del informe deja de ser válida o expira en UTC, por ejemplo, 2020-12-08T05:55:59.4394737Z.
type	string	Tipo de la operación de larga duración.

GenerateDetailedCostReportTimePeriod

Fecha de inicio y finalización para extraer datos del informe detallado del costo.

Nombre	Tipo	Description
end	string	Fecha de finalización a la que se van a extraer los datos. formato de ejemplo 2020-03-15
start	string	Fecha de inicio de la que se van a extraer datos. formato de ejemplo 2020-03-15

Compartir a través de

Generate Detailed Cost Report - Create Operation

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod

Solicitud de ejemplo

Respuesta de muestra

GenerateDetailedCostReportByBillingProfileAndInvoiceId

Solicitud de ejemplo

Respuesta de muestra

GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId

Solicitud de ejemplo

Respuesta de muestra

GenerateDetailedCostReportByCustomerAndTimePeriod

Solicitud de ejemplo

Respuesta de muestra

GenerateDetailedCostReportBySubscriptionAndTimePeriod

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorDetails

GenerateDetailedCostReportDefinition

GenerateDetailedCostReportErrorResponse

GenerateDetailedCostReportMetricType

GenerateDetailedCostReportOperationResult

GenerateDetailedCostReportTimePeriod

Recursos adicionales