Exports - List
Operación para enumerar todas las exportaciones en el ámbito especificado.
GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports?api-version=2023-11-01
GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports?api-version=2023-11-01&$expand={$expand}
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
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 asociados. |
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
$expand
|
query |
string |
Se puede usar para expandir las propiedades dentro de una exportación. Actualmente solo se admite "runHistory" y devolverá información para la última ejecución de cada exportació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
Exports |
Exports |
Exports |
Exports |
Exports |
Exports |
ExportsGetByBillingAccount
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports?api-version=2023-11-01
Sample Response
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport1",
"name": "TestExport1",
"type": "Microsoft.CostManagement/exports",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"location": "centralus",
"properties": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ad-hoc"
}
},
"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/123456/providers/Microsoft.CostManagement/exports/TestExport2",
"name": "TestExport2",
"type": "Microsoft.CostManagement/exports",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"location": "centralus",
"properties": {
"schedule": {
"status": "Active",
"recurrence": "Weekly",
"recurrencePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
}
},
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ad-hoc"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "WeekToDate",
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
]
}
ExportsGetByDepartment
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12/departments/123/providers/Microsoft.CostManagement/exports?api-version=2023-11-01
Sample Response
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport1",
"name": "TestExport1",
"type": "Microsoft.CostManagement/exports",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"location": "centralus",
"properties": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ad-hoc"
}
},
"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/TestExport2",
"name": "TestExport2",
"type": "Microsoft.CostManagement/exports",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"location": "centralus",
"properties": {
"schedule": {
"status": "Active",
"recurrence": "Weekly",
"recurrencePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
}
},
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ad-hoc"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "WeekToDate",
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
]
}
ExportsGetByEnrollmentAccount
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports?api-version=2023-11-01
Sample Response
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport1",
"name": "TestExport1",
"type": "Microsoft.CostManagement/exports",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"location": "centralus",
"properties": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ad-hoc"
}
},
"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/TestExport2",
"name": "TestExport2",
"type": "Microsoft.CostManagement/exports",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"location": "centralus",
"properties": {
"schedule": {
"status": "Active",
"recurrence": "Weekly",
"recurrencePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
}
},
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ad-hoc"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "WeekToDate",
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
]
}
ExportsGetByManagementGroup
Sample Request
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports?api-version=2023-11-01
Sample Response
{
"value": [
{
"id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport1",
"name": "TestExport1",
"type": "Microsoft.CostManagement/exports",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"location": "centralus",
"properties": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ad-hoc"
}
},
"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/TestExport2",
"name": "TestExport2",
"type": "Microsoft.CostManagement/exports",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"location": "centralus",
"properties": {
"schedule": {
"status": "Active",
"recurrence": "Weekly",
"recurrencePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
}
},
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ad-hoc"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "WeekToDate",
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
]
}
ExportsGetByResourceGroup
Sample Request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports?api-version=2023-11-01
Sample Response
{
"value": [
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport1",
"name": "TestExport1",
"type": "Microsoft.CostManagement/exports",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"location": "centralus",
"properties": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ad-hoc"
}
},
"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/TestExport2",
"name": "TestExport2",
"type": "Microsoft.CostManagement/exports",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"location": "centralus",
"properties": {
"schedule": {
"status": "Active",
"recurrence": "Weekly",
"recurrencePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
}
},
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ad-hoc"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "WeekToDate",
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
]
}
ExportsGetBySubscription
Sample Request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports?api-version=2023-11-01
Sample Response
{
"value": [
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport1",
"name": "TestExport1",
"type": "Microsoft.CostManagement/exports",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"location": "centralus",
"properties": {
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ad-hoc"
}
},
"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/TestExport2",
"name": "TestExport2",
"type": "Microsoft.CostManagement/exports",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"location": "centralus",
"properties": {
"schedule": {
"status": "Active",
"recurrence": "Weekly",
"recurrencePeriod": {
"from": "2020-06-01T00:00:00Z",
"to": "2020-10-31T00:00:00Z"
}
},
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "exports",
"rootFolderPath": "ad-hoc"
}
},
"definition": {
"type": "ActualCost",
"timeframe": "WeekToDate",
"dataSet": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"ResourceId",
"ResourceLocation",
"Quantity"
]
}
}
}
}
}
]
}
Definiciones
Nombre | Description |
---|---|
Common |
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 |
Un recurso 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 |
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 dar acceso a los servicios de Cost Management 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 necesiten 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 partners con un plan de Contrato de partners de Microsoft 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 |
Resultado de la enumeración de exportaciones. Contiene una lista de exportaciones disponibles en el ámbito proporcionado. |
Export |
Fecha de inicio y finalización de la programación de periodicidad. |
Export |
Una ejecución de exportación. |
Export |
Programación asociada a la exportación. |
Export |
Intervalo de fechas de 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 para cargos o amortización para las reservas de servicio. |
Format |
Formato de la exportación que se entrega. Actualmente solo se admite "Csv". |
Granularity |
Granularidad de las filas de la exportación. Actualmente solo se admite "Daily". |
Recurrence |
Periodicidad de la programación. |
Status |
Estado de la programación de la exportación. Si "Inactivo", se pausa la programación de la exportación. |
System |
Identidad de servicio administrada (asignada por el sistema o ninguna) |
System |
Tipo de identidad de servicio administrada (asignada por el sistema o ninguna). |
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
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 entrega. Actualmente solo se admite "Csv". |
|
nextRunTimeEstimate |
string |
Si la exportación tiene una programación activa, proporciona una estimación de la siguiente hora de ejecución. |
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 Contrato de cliente de Microsoft ámbitos comerciales. |
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 |
Export
Un recurso 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 |
Identificador de recurso. |
identity |
La identidad administrada asociada a Export |
|
location |
string |
Ubicación de la identidad administrada de la exportación. Solo se requiere al usar la identidad administrada. |
name |
string |
Nombre del recurso. |
properties.definition |
Tiene la definición de la exportación. |
|
properties.deliveryInfo |
Tiene información de entrega para la exportación. |
|
properties.format |
Formato de la exportación que se entrega. Actualmente solo se admite "Csv". |
|
properties.nextRunTimeEstimate |
string |
Si la exportación tiene una programación activa, proporciona una estimación de la siguiente hora de ejecución. |
properties.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 Contrato de cliente de Microsoft ámbitos comerciales. |
properties.runHistory |
Si se solicita, tiene el historial de ejecución más reciente para la exportación. |
|
properties.schedule |
Tiene información de programación para la exportación. |
|
type |
string |
Tipo de recurso. |
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 del cliente (vea 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 para cargos o amortización para las reservas de servicio. |
ExportDeliveryDestination
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 dar acceso a los servicios de Cost Management 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 necesiten 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 partners con un plan de Contrato de partners de Microsoft 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 junto con storageAccount se puede especificar en lugar de resourceId. Nota: el valor devuelto por la API para esta propiedad siempre se ofuscará. Devolver este mismo valor ofuscado no dará lugar a que se actualice 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 junto con sasToken se puede especificar 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 |
Lista de ejecuciones de exportación. |
ExportListResult
Resultado de la enumeración de exportaciones. Contiene una lista de exportaciones disponibles en el ámbito proporcionado.
Nombre | Tipo | Description |
---|---|---|
value |
Export[] |
Lista de exportaciones. |
ExportRecurrencePeriod
Fecha de inicio y finalización de la programación de periodicidad.
Nombre | Tipo | Description |
---|---|---|
from |
string |
Fecha de inicio de periodicidad. |
to |
string |
Fecha de finalización de la periodicidad. |
ExportRun
Una 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 |
Identificador 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 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 en que se puso en cola la exportación para ejecutarse. |
type |
string |
Tipo de recurso. |
ExportSchedule
Programación asociada a la exportación.
Nombre | Tipo | Description |
---|---|---|
recurrence |
Periodicidad de la programación. |
|
recurrencePeriod |
Tiene la fecha de inicio y finalización de la periodicidad. La fecha de inicio debe estar en el futuro. Si está presente, la fecha de finalización debe ser mayor que la fecha de inicio. |
|
status |
Estado de la programación de la exportación. Si "Inactivo", se pausa la programación de la exportación. |
ExportTimePeriod
Intervalo de fechas de 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 de los datos de exportación. |
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 para 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 entrega. 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 |
RecurrenceType
Periodicidad de la programación.
Nombre | Tipo | Description |
---|---|---|
Annually |
string |
|
Daily |
string |
|
Monthly |
string |
|
Weekly |
string |
StatusType
Estado de la programación de la exportación. Si "Inactivo", se pausa la programación de la exportación.
Nombre | Tipo | Description |
---|---|---|
Active |
string |
|
Inactive |
string |
SystemAssignedServiceIdentity
Identidad de servicio administrada (asignada por el sistema o ninguna)
Nombre | Tipo | Description |
---|---|---|
principalId |
string |
Identificador de la entidad de servicio de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema. |
tenantId |
string |
Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema. |
type |
Tipo de identidad de servicio administrada (asignada por el sistema o ninguna). |
SystemAssignedServiceIdentityType
Tipo de identidad de servicio administrada (asignada por el sistema o ninguna).
Nombre | Tipo | Description |
---|---|---|
None |
string |
|
SystemAssigned |
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 |