Exports - Get Execution History
Operación para obtener el historial de ejecución de una exportación para el ámbito definido y el nombre de exportación.
GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory?api-version=2023-11-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
export
|
path | True |
string |
Nombre de exportación. |
scope
|
path | True |
string |
Ámbito asociado a las operaciones de exportación. Esto incluye "/subscriptions/{subscriptionId}/" para el ámbito de la suscripción, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para el ámbito resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para el ámbito de la cuenta de facturación y '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para el ámbito del departamento, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para el ámbito EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId} para el ámbito del grupo de administración, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para el ámbito billingProfile, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' para el ámbito invoiceSection y '/providers/Microsoft. Billing/billingAccounts/{billingAccountId}/customers/{customerId}' específico para los partners. |
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Aceptar. La solicitud se ha realizado correctamente. |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
ExportRunHistoryGetByBillingAccount
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport/runHistory?api-version=2023-11-01
Sample Response
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100",
"properties": {
"executionType": "OnDemand",
"status": "Completed",
"submittedBy": "john.doe@gmail.com",
"submittedTime": "2018-08-03T07:52:15.6016681Z",
"processingStartTime": "2018-08-03T07:52:16.9123797Z",
"processingEndTime": "2018-08-03T07:52:28.0373318Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
},
{
"id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef",
"properties": {
"executionType": "Scheduled",
"status": "Completed",
"submittedBy": "System",
"submittedTime": "2018-08-03T09:03:58.5710244Z",
"processingStartTime": "2018-08-03T09:03:58.5710244Z",
"processingEndTime": "2018-08-03T09:04:19.7223808Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
}
]
}
ExportRunHistoryGetByDepartment
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport/runHistory?api-version=2023-11-01
Sample Response
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100",
"properties": {
"executionType": "OnDemand",
"status": "Completed",
"submittedBy": "john.doe@gmail.com",
"submittedTime": "2018-08-03T07:52:15.6016681Z",
"processingStartTime": "2018-08-03T07:52:16.9123797Z",
"processingEndTime": "2018-08-03T07:52:28.0373318Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
},
{
"id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef",
"properties": {
"executionType": "Scheduled",
"status": "Completed",
"submittedBy": "System",
"submittedTime": "2018-08-03T09:03:58.5710244Z",
"processingStartTime": "2018-08-03T09:03:58.5710244Z",
"processingEndTime": "2018-08-03T09:04:19.7223808Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
}
]
}
ExportRunHistoryGetByEnrollmentAccount
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport/runHistory?api-version=2023-11-01
Sample Response
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100",
"properties": {
"executionType": "OnDemand",
"status": "Completed",
"submittedBy": "john.doe@gmail.com",
"submittedTime": "2018-08-03T07:52:15.6016681Z",
"processingStartTime": "2018-08-03T07:52:16.9123797Z",
"processingEndTime": "2018-08-03T07:52:28.0373318Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
},
{
"id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef",
"properties": {
"executionType": "Scheduled",
"status": "Completed",
"submittedBy": "System",
"submittedTime": "2018-08-03T09:03:58.5710244Z",
"processingStartTime": "2018-08-03T09:03:58.5710244Z",
"processingEndTime": "2018-08-03T09:04:19.7223808Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
}
]
}
ExportRunHistoryGetByManagementGroup
Sample Request
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/runHistory?api-version=2023-11-01
Sample Response
{
"value": [
{
"id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100",
"properties": {
"executionType": "OnDemand",
"status": "Completed",
"submittedBy": "john.doe@gmail.com",
"submittedTime": "2018-08-03T07:52:15.6016681Z",
"processingStartTime": "2018-08-03T07:52:16.9123797Z",
"processingEndTime": "2018-08-03T07:52:28.0373318Z",
"fileName": "ScheduledForTestExport/TestExportSchedule/20180729-20180804/TestExportSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
},
{
"id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef",
"properties": {
"executionType": "Scheduled",
"status": "Completed",
"submittedBy": "System",
"submittedTime": "2018-08-03T09:03:58.5710244Z",
"processingStartTime": "2018-08-03T09:03:58.5710244Z",
"processingEndTime": "2018-08-03T09:04:19.7223808Z",
"fileName": "ScheduledForTestExport/TestExportSchedule/20180729-20180804/TestExportSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
}
]
}
ExportRunHistoryGetByResourceGroup
Sample Request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport/runHistory?api-version=2023-11-01
Sample Response
{
"value": [
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100",
"properties": {
"executionType": "OnDemand",
"status": "Completed",
"submittedBy": "john.doe@gmail.com",
"submittedTime": "2018-08-03T07:52:15.6016681Z",
"processingStartTime": "2018-08-03T07:52:16.9123797Z",
"processingEndTime": "2018-08-03T07:52:28.0373318Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
},
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef",
"properties": {
"executionType": "Scheduled",
"status": "Completed",
"submittedBy": "System",
"submittedTime": "2018-08-03T09:03:58.5710244Z",
"processingStartTime": "2018-08-03T09:03:58.5710244Z",
"processingEndTime": "2018-08-03T09:04:19.7223808Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
}
]
}
ExportRunHistoryGetBySubscription
Sample Request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport/runHistory?api-version=2023-11-01
Sample Response
{
"value": [
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100",
"properties": {
"executionType": "OnDemand",
"status": "Completed",
"submittedBy": "john.doe@gmail.com",
"submittedTime": "2018-08-03T07:52:15.6016681Z",
"processingStartTime": "2018-08-03T07:52:16.9123797Z",
"processingEndTime": "2018-08-03T07:52:28.0373318Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
},
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef",
"properties": {
"executionType": "Scheduled",
"status": "Completed",
"submittedBy": "System",
"submittedTime": "2018-08-03T09:03:58.5710244Z",
"processingStartTime": "2018-08-03T09:03:58.5710244Z",
"processingEndTime": "2018-08-03T09:04:19.7223808Z",
"fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv",
"runSettings": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ScheduledTestsForJohnDoe"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "Custom",
"timePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
},
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
}
]
}
Definiciones
Nombre | Description |
---|---|
Common |
Las propiedades comunes de la exportación. |
Error |
Detalles del error. |
Error |
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:
|
Execution |
Último estado conocido de la ejecución de exportación. |
Execution |
Tipo de la ejecución de exportación. |
Export |
Definición de los datos de la exportación. |
Export |
Configuración del conjunto de datos de exportación. Permite seleccionar columnas para la exportación. Si no se proporciona, la exportación incluirá todas las columnas disponibles. |
Export |
Definición de una exportación. |
Export |
Esto representa la ubicación de la cuenta de almacenamiento de blobs donde se entregarán las exportaciones de costos. Hay dos maneras de configurar el destino. El enfoque recomendado para la mayoría de los clientes es especificar el resourceId de la cuenta de almacenamiento. Esto requiere un registro único de la suscripción de la cuenta con el proveedor de recursos Microsoft.CostManagementExports para conceder a los servicios de Cost Management acceso al almacenamiento. Al crear una exportación en el Azure Portal este registro se realiza automáticamente, pero es posible que los usuarios de la API deban registrar la suscripción explícitamente (para obtener más información, consulte https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Otra manera de configurar el destino solo está disponible para los partners con un plan de Microsoft Partner Agreement que sean administradores globales de su cuenta de facturación. Estos asociados, en lugar de especificar el resourceId de una cuenta de almacenamiento, pueden especificar el nombre de la cuenta de almacenamiento junto con un token de SAS para la cuenta. Esto permite las exportaciones de costos a una cuenta de almacenamiento en cualquier inquilino. El token de SAS debe crearse para el servicio de blobs con tipos de recursos Service/Container/Object y con permisos de lectura,escritura/eliminación/lista/agregar/crear (para obtener más información, consulte https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ). |
Export |
Información de entrega asociada a una exportación. |
Export |
Resultado de enumerar el historial de ejecución de una exportación. |
Export |
Ejecución de exportación. |
Export |
Intervalo de fechas para los datos de la exportación. Esto solo debe especificarse con timeFrame establecido en "Custom". El intervalo de fechas máximo es de 3 meses. |
Export |
Tipo de exportación. Tenga en cuenta que "Uso" es equivalente a "ActualCost" y es aplicable a las exportaciones que aún no proporcionan datos de cargos o amortización para las reservas de servicio. |
Format |
Formato de la exportación que se va a entregar. Actualmente solo se admite "Csv". |
Granularity |
Granularidad de las filas de la exportación. Actualmente solo se admite "Daily". |
Timeframe |
Período de tiempo para extraer datos para la exportación. Si es personalizado, se debe proporcionar un período de tiempo específico. |
CommonExportProperties
Las propiedades comunes de la exportación.
Nombre | Tipo | Description |
---|---|---|
definition |
Tiene la definición de la exportación. |
|
deliveryInfo |
Tiene información de entrega para la exportación. |
|
format |
Formato de la exportación que se va a entregar. Actualmente solo se admite "Csv". |
|
nextRunTimeEstimate |
string |
Si la exportación tiene una programación activa, proporciona una estimación del tiempo de ejecución siguiente. |
partitionData |
boolean |
Si se establece en true, los datos exportados se particionarán por tamaño y se colocarán en un directorio de blobs junto con un archivo de manifiesto. Nota: esta opción solo está disponible actualmente para ámbitos comerciales de Contrato de cliente de Microsoft. |
runHistory |
Si se solicita, tiene el historial de ejecución más reciente para la exportación. |
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 "Vuelva a intentarlo después de".
Nombre | Tipo | Description |
---|---|---|
error |
Detalles del error. |
ExecutionStatus
Último estado conocido de la ejecución de exportación.
Nombre | Tipo | Description |
---|---|---|
Completed |
string |
|
DataNotAvailable |
string |
|
Failed |
string |
|
InProgress |
string |
|
NewDataNotAvailable |
string |
|
Queued |
string |
|
Timeout |
string |
ExecutionType
Tipo de la ejecución de exportación.
Nombre | Tipo | Description |
---|---|---|
OnDemand |
string |
|
Scheduled |
string |
ExportDataset
Definición de los datos de la exportación.
Nombre | Tipo | Description |
---|---|---|
configuration |
Configuración del conjunto de datos de exportación. |
|
granularity |
Granularidad de las filas de la exportación. Actualmente solo se admite "Daily". |
ExportDatasetConfiguration
Configuración del conjunto de datos de exportación. Permite seleccionar columnas para la exportación. Si no se proporciona, la exportación incluirá todas las columnas disponibles.
Nombre | Tipo | Description |
---|---|---|
columns |
string[] |
Matriz de nombres de columna que se incluirán en la exportación. Si no se proporciona, la exportación incluirá todas las columnas disponibles. Las columnas disponibles pueden variar según el canal de cliente (consulte ejemplos). |
ExportDefinition
Definición de una exportación.
Nombre | Tipo | Description |
---|---|---|
dataSet |
Definición de los datos de la exportación. |
|
timePeriod |
Tiene un período de tiempo para extraer datos para la exportación. |
|
timeframe |
Período de tiempo para extraer datos para la exportación. Si es personalizado, se debe proporcionar un período de tiempo específico. |
|
type |
Tipo de exportación. Tenga en cuenta que "Uso" es equivalente a "ActualCost" y es aplicable a las exportaciones que aún no proporcionan datos de cargos o amortización para las reservas de servicio. |
ExportDeliveryDestination
Esto representa la ubicación de la cuenta de almacenamiento de blobs donde se entregarán las exportaciones de costos. Hay dos maneras de configurar el destino. El enfoque recomendado para la mayoría de los clientes es especificar el resourceId de la cuenta de almacenamiento. Esto requiere un registro único de la suscripción de la cuenta con el proveedor de recursos Microsoft.CostManagementExports para conceder a los servicios de Cost Management acceso al almacenamiento. Al crear una exportación en el Azure Portal este registro se realiza automáticamente, pero es posible que los usuarios de la API deban registrar la suscripción explícitamente (para obtener más información, consulte https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Otra manera de configurar el destino solo está disponible para los partners con un plan de Microsoft Partner Agreement que sean administradores globales de su cuenta de facturación. Estos asociados, en lugar de especificar el resourceId de una cuenta de almacenamiento, pueden especificar el nombre de la cuenta de almacenamiento junto con un token de SAS para la cuenta. Esto permite las exportaciones de costos a una cuenta de almacenamiento en cualquier inquilino. El token de SAS debe crearse para el servicio de blobs con tipos de recursos Service/Container/Object y con permisos de lectura,escritura/eliminación/lista/agregar/crear (para obtener más información, consulte https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).
Nombre | Tipo | Description |
---|---|---|
container |
string |
Nombre del contenedor donde se cargarán las exportaciones. Si el contenedor no existe, se creará. |
resourceId |
string |
Identificador de recurso de la cuenta de almacenamiento donde se entregarán las exportaciones. Esto no es necesario si se especifican sasToken y storageAccount. |
rootFolderPath |
string |
Nombre del directorio donde se cargarán las exportaciones. |
sasToken |
string |
Un token de SAS para la cuenta de almacenamiento. Para un conjunto restringido de clientes de Azure, esto se puede especificar junto con storageAccount en lugar de resourceId. Nota: el valor devuelto por la API para esta propiedad siempre se ofuscará. Si se devuelve este mismo valor ofuscado, no se actualizará el token de SAS. Para actualizar este valor, se debe especificar un nuevo token de SAS. |
storageAccount |
string |
La cuenta de almacenamiento donde se cargarán las exportaciones. Para un conjunto restringido de clientes de Azure, esto se puede especificar junto con sasToken en lugar de resourceId. |
ExportDeliveryInfo
Información de entrega asociada a una exportación.
Nombre | Tipo | Description |
---|---|---|
destination |
Tiene el destino de la exportación que se entrega. |
ExportExecutionListResult
Resultado de enumerar el historial de ejecución de una exportación.
Nombre | Tipo | Description |
---|---|---|
value |
Una lista de ejecuciones de exportación. |
ExportRun
Ejecución de exportación.
Nombre | Tipo | Description |
---|---|---|
eTag |
string |
eTag del recurso. Para controlar el escenario de actualización simultánea, este campo se usará para determinar si el usuario está actualizando la versión más reciente o no. |
id |
string |
Id. de recurso. |
name |
string |
Nombre del recurso. |
properties.error |
Detalles de cualquier error. |
|
properties.executionType |
Tipo de la ejecución de exportación. |
|
properties.fileName |
string |
Nombre del archivo exportado. |
properties.processingEndTime |
string |
Hora a la que finalizó la ejecución de exportación. |
properties.processingStartTime |
string |
Hora en la que se tomó la exportación para ejecutarse. |
properties.runSettings |
La configuración de exportación que estaba en vigor para esta ejecución. |
|
properties.status |
Último estado conocido de la ejecución de exportación. |
|
properties.submittedBy |
string |
Identificador de la entidad que desencadenó la exportación. En el caso de las ejecuciones a petición, es el correo electrónico del usuario. En el caso de las ejecuciones programadas, es "System". |
properties.submittedTime |
string |
Hora a la que se puso en cola la exportación para ejecutarse. |
type |
string |
Tipo de recurso. |
ExportTimePeriod
Intervalo de fechas para los datos de la exportación. Esto solo debe especificarse con timeFrame establecido en "Custom". El intervalo de fechas máximo es de 3 meses.
Nombre | Tipo | Description |
---|---|---|
from |
string |
Fecha de inicio para exportar datos. |
to |
string |
Fecha de finalización de los datos de exportación. |
ExportType
Tipo de exportación. Tenga en cuenta que "Uso" es equivalente a "ActualCost" y es aplicable a las exportaciones que aún no proporcionan datos de cargos o amortización para las reservas de servicio.
Nombre | Tipo | Description |
---|---|---|
ActualCost |
string |
|
AmortizedCost |
string |
|
Usage |
string |
FormatType
Formato de la exportación que se va a entregar. Actualmente solo se admite "Csv".
Nombre | Tipo | Description |
---|---|---|
Csv |
string |
GranularityType
Granularidad de las filas de la exportación. Actualmente solo se admite "Daily".
Nombre | Tipo | Description |
---|---|---|
Daily |
string |
TimeframeType
Período de tiempo para extraer datos para la exportación. Si es personalizado, se debe proporcionar un período de tiempo específico.
Nombre | Tipo | Description |
---|---|---|
BillingMonthToDate |
string |
|
Custom |
string |
|
MonthToDate |
string |
|
TheLastBillingMonth |
string |
|
TheLastMonth |
string |
|
WeekToDate |
string |