Compartir a través de

Generate Cost Details Report - Create Operation

  • Referencia
Servicio:
Cost Management
Versión de la API:
2023-11-01

Esta API es la sustitución de todas las API de detalles de uso publicadas anteriormente. Solicite generar un informe de detalles de costos para el intervalo de fechas proporcionado, el período de facturación (solo los clientes empresariales) o el identificador de factura de forma asincrónica en un ámbito determinado. La llamada inicial para solicitar un informe devolverá un 202 con un encabezado "Location" y "Retry-After". El encabezado "Location" proporcionará el punto de conexión para sondear para obtener el resultado de la generación de informes. "Retry-After" proporciona la duración que se debe esperar antes de sondear el informe generado. Una llamada para sondear la operación de informe proporcionará una respuesta 202 con un encabezado "Location" si la operación todavía está en curso. Una vez completada la operación de generación de informes, el punto de conexión de sondeo proporcionará una respuesta 200 junto con detalles sobre los blobs de informe que están disponibles para su descarga. Los detalles sobre los archivos disponibles para su descarga estarán disponibles en el cuerpo de la respuesta de sondeo. Para comprender los detalles de costos (anteriormente conocidos como detalles de uso) campos que se encuentran en los archivos , consulte https://learn.microsoft.com/en-us/azure/cost-management-billing/automate/understand-usage-details-fields

POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-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, la cuenta de facturación u otros ámbitos de facturación. Actualmente no se admiten grupos de recursos ni grupos de administración. Para obtener información detallada, vea https://aka.ms/costmgmt/scopes.
api-version
 query True

string

Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre Tipo Description
billingPeriod

string

Este parámetro solo lo pueden usar los clientes de Enterprise Agreement. Use el formato YearMonth(por ejemplo, 202008). Este parámetro no se puede usar junto con los parámetros invoiceId o timePeriod. Si no se proporciona un parámetro timePeriod, invoiceId o billingPeriod en el cuerpo de la solicitud, la API devolverá el costo del mes actual.
invoiceId

string

Este parámetro solo lo pueden usar los clientes de Contrato de cliente de Microsoft. Además, solo se puede usar en el ámbito de Perfil de facturación o Cliente. Este parámetro no se puede usar junto con los parámetros billingPeriod o timePeriod. Si no se proporciona un parámetro timePeriod, invoiceId o billingPeriod en el cuerpo de la solicitud, la API devolverá el costo del mes actual.
metric

CostDetailsMetricType

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

CostDetailsTimePeriod

Intervalo de fechas específico de los detalles de costos solicitados para el informe. Este parámetro no se puede usar junto con los parámetros invoiceId o billingPeriod. Si no se proporciona un parámetro timePeriod, invoiceId o billingPeriod en el cuerpo de la solicitud, la API devolverá el costo del mes actual. La API solo permite extraer datos durante 1 mes o menos y no más de 13 meses. Si no se proporciona timePeriod ni billingPeriod o invoiceId, se proporcionan los valores predeterminados de la API al período de tiempo del mes abierto.

Respuestas

Nombre Tipo Description
200 OK

CostDetailsOperationResults

Se completó el procesamiento de solicitudes.
202 Accepted

Accepted. Se procesará la solicitud. Use el encabezado Ubicación para comprobar el estado.

Encabezados

  • Location: string
  • Retry-After: integer
204 No Content

Sin contenido. La solicitud se ha realizado correctamente, pero no ha devuelto ningún resultado.
Other Status Codes

GenerateCostDetailsReportErrorResponse

Respuesta de error que describe el motivo del error de 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 suplantación de su cuenta de usuario

Ejemplos

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
GenerateCostDetailsReportByBillingProfileAndInvoiceId
GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId
GenerateCostDetailsReportByCustomerAndTimePeriod
GenerateCostDetailsReportByDepartmentsAndTimePeriod
GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod
GenerateCostDetailsReportBySubscriptionAndTimePeriod

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod

Solicitud de ejemplo

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

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

Respuesta de muestra

status code:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2023-11-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/billingAccounts/12345",
      "requestBody": {
        "metric": "ActualCost",
        "billingPeriod": "202205"
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
status code:
204

GenerateCostDetailsReportByBillingProfileAndInvoiceId

Solicitud de ejemplo

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

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

Respuesta de muestra

status code:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2023-11-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579",
      "requestBody": {
        "metric": "ActualCost",
        "billingPeriod": "202205"
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
status code:
204

GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId

Solicitud de ejemplo

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

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

Respuesta de muestra

status code:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2023-11-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579",
      "requestBody": {
        "metric": "ActualCost",
        "billingPeriod": "202205"
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
status code:
204

GenerateCostDetailsReportByCustomerAndTimePeriod

Solicitud de ejemplo

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

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

Respuesta de muestra

status code:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2023-11-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579",
      "requestBody": {
        "metric": "ActualCost",
        "timePeriod": {
          "start": "2020-03-01",
          "end": "2020-03-15"
        }
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
status code:
204

GenerateCostDetailsReportByDepartmentsAndTimePeriod

Solicitud de ejemplo

POST https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

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

Respuesta de muestra

status code:
200 
{
  "id": "providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2023-11-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/departments/12345",
      "requestBody": {
        "metric": "ActualCost",
        "timePeriod": {
          "start": "2020-03-01",
          "end": "2020-03-15"
        }
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
status code:
204

GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod

Solicitud de ejemplo

POST https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

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

Respuesta de muestra

status code:
200 
{
  "id": "providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2023-11-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/enrollmentAccounts/1234",
      "requestBody": {
        "metric": "ActualCost",
        "timePeriod": {
          "start": "2020-03-01",
          "end": "2020-03-15"
        }
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
status code:
204

GenerateCostDetailsReportBySubscriptionAndTimePeriod

Solicitud de ejemplo

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-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/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2023-11-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000",
      "requestBody": {
        "metric": "ActualCost",
        "timePeriod": {
          "start": "2020-03-01",
          "end": "2020-03-15"
        }
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
status code:
202 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
status code:
204

Definiciones

Nombre Description
BlobInfo

La información del blob generada por esta operación.
CostDetailsDataFormat

Formato de datos del informe
CostDetailsMetricType

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

Resultado de la operación de larga duración para la API de detalles de costos.
CostDetailsStatusType

Estado de la operación de detalles del costo
CostDetailsTimePeriod

Fecha de inicio y finalización para extraer datos para el informe detallado del costo. La API solo permite extraer datos durante 1 mes o menos y no más de 13 meses.
ErrorDetails

Detalles del error.
GenerateCostDetailsReportErrorResponse

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:

  • 400 Solicitud incorrecta: carga de solicitud no válida. La carga de solicitud proporcionada no está en un formato JSON o tenía un miembro no válido no aceptado en la carga de la solicitud.

  • 400 Solicitud incorrecta: carga de solicitud no válida: solo puede tener timePeriod o invoiceId o billingPeriod. La API solo permite extraer datos para timePeriod o invoiceId o billingPeriod. El cliente debe proporcionar solo uno de estos parámetros.

  • 400 Solicitud incorrecta: la fecha de inicio debe ser posterior a . La API solo permite extraer datos de más de 13 meses desde ahora.

  • 400 Solicitud incorrecta: el intervalo de fechas máximo permitido es de 1 meses. La API solo permite extraer datos durante 1 mes o menos.

  • 429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "retry-after".

  • 503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Vuelva a intentarlo después de".
GenerateCostDetailsReportRequestDefinition

Definición de un informe detallado de costos.

BlobInfo

La información del blob generada por esta operación.

Nombre Tipo Description
blobLink

string

Vínculo al blob para descargar el archivo.
byteCount

integer

Bytes en el blob.

CostDetailsDataFormat

Formato de datos del informe

Nombre Tipo Description
Csv

string

Formato de datos CSV.

CostDetailsMetricType

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

Nombre Tipo Description
ActualCost

string

Datos de costos reales.
AmortizedCost

string

Datos de costos amortizados.

CostDetailsOperationResults

Resultado de la operación de larga duración para la API de detalles de costos.

Nombre Tipo Description
error

ErrorDetails

Detalles del error.
id

string

Identificador de la operación de larga duración.
manifest.blobCount

integer

Número total de blobs.
manifest.blobs

BlobInfo[]

Lista de información de blobs generada por esta operación.
manifest.byteCount

integer

Número total de bytes en todos los blobs.
manifest.compressData

boolean

Son los datos en formato comprimido.
manifest.dataFormat

CostDetailsDataFormat

Formato de datos del informe
manifest.manifestVersion

string

Versión del manifiesto.
manifest.requestContext.requestBody

GenerateCostDetailsReportRequestDefinition

El cuerpo de la carga de solicitud proporcionado en la llamada a Cost Details
manifest.requestContext.requestScope

string

Ámbito de solicitud de la solicitud.
name

string

Nombre de la operación de larga duración.
status

CostDetailsStatusType

Estado de la operación de detalles del costo
type

string

Tipo de la operación de larga duración.
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.

CostDetailsStatusType

Estado de la operación de detalles del costo

Nombre Tipo Description
Completed

string

La operación se ha completado.
Failed

string

Error en la operación.
NoDataFound

string

La operación es Completada y no se encontraron datos de costo.

CostDetailsTimePeriod

Fecha de inicio y finalización para extraer datos para el informe detallado del costo. La API solo permite extraer datos durante 1 mes o menos y no más de 13 meses.

Nombre Tipo Description
end

string

Fecha de finalización a la que se van a extraer 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

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.

GenerateCostDetailsReportErrorResponse

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:

  • 400 Solicitud incorrecta: carga de solicitud no válida. La carga de solicitud proporcionada no está en un formato JSON o tenía un miembro no válido no aceptado en la carga de la solicitud.

  • 400 Solicitud incorrecta: carga de solicitud no válida: solo puede tener timePeriod o invoiceId o billingPeriod. La API solo permite extraer datos para timePeriod o invoiceId o billingPeriod. El cliente debe proporcionar solo uno de estos parámetros.

  • 400 Solicitud incorrecta: la fecha de inicio debe ser posterior a . La API solo permite extraer datos de más de 13 meses desde ahora.

  • 400 Solicitud incorrecta: el intervalo de fechas máximo permitido es de 1 meses. La API solo permite extraer datos durante 1 mes o menos.

  • 429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "retry-after".

  • 503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Vuelva a intentarlo después de".

Nombre Tipo Description
error

ErrorDetails

Detalles del error.

GenerateCostDetailsReportRequestDefinition

Definición de un informe detallado de costos.

Nombre Tipo Description
billingPeriod

string

Este parámetro solo lo pueden usar los clientes de Enterprise Agreement. Use el formato YearMonth(por ejemplo, 202008). Este parámetro no se puede usar junto con los parámetros invoiceId o timePeriod. Si no se proporciona un parámetro timePeriod, invoiceId o billingPeriod en el cuerpo de la solicitud, la API devolverá el costo del mes actual.
invoiceId

string

Este parámetro solo lo pueden usar los clientes de Contrato de cliente de Microsoft. Además, solo se puede usar en el ámbito de Perfil de facturación o Cliente. Este parámetro no se puede usar junto con los parámetros billingPeriod o timePeriod. Si no se proporciona un parámetro timePeriod, invoiceId o billingPeriod en el cuerpo de la solicitud, la API devolverá el costo del mes actual.
metric

CostDetailsMetricType

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

CostDetailsTimePeriod

Intervalo de fechas específico de los detalles de costos solicitados para el informe. Este parámetro no se puede usar junto con los parámetros invoiceId o billingPeriod. Si no se proporciona un parámetro timePeriod, invoiceId o billingPeriod en el cuerpo de la solicitud, la API devolverá el costo del mes actual. La API solo permite extraer datos durante 1 mes o menos y no más de 13 meses. Si no se proporciona timePeriod ni billingPeriod o invoiceId, se proporcionan los valores predeterminados de la API al período de tiempo del mes abierto.