Share via

IExportProperties Interface

  • Reference

Definition

Namespace:
Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001
Assembly:
Az.CostManagement.private.dll
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.ExportPropertiesTypeConverter))]
public interface IExportProperties : Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.ICommonExportProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.ExportPropertiesTypeConverter))>]
type IExportProperties = interface
    interface IJsonSerializable
    interface ICommonExportProperties
Public Interface IExportProperties
Implements ICommonExportProperties
Derived
Attributes
TypeConverterAttribute
Implements
ICommonExportProperties IJsonSerializable

Properties

ConfigurationColumn

Array of column names to be included in the export. If not provided then the export will include all available columns. The available columns can vary by customer channel (see examples).

(Inherited from ICommonExportProperties)
DataSetGranularity

The granularity of rows in the export. Currently only 'Daily' is supported.

(Inherited from ICommonExportProperties)
DefinitionTimeframe

The time frame for pulling data for the export. If custom, then a specific time period must be provided.

(Inherited from ICommonExportProperties)
DefinitionType

The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations.

(Inherited from ICommonExportProperties)
DestinationContainer

The name of the container where exports will be uploaded. If the container does not exist it will be created.

(Inherited from ICommonExportProperties)
DestinationResourceId

The resource id of the storage account where exports will be delivered. This is not required if a sasToken and storageAccount are specified.

(Inherited from ICommonExportProperties)
DestinationRootFolderPath

The name of the directory where exports will be uploaded.

(Inherited from ICommonExportProperties)
DestinationSasToken

A SAS token for the storage account. For a restricted set of Azure customers this together with storageAccount can be specified instead of resourceId. Note: the value returned by the API for this property will always be obfuscated. Returning this same obfuscated value will not result in the SAS token being updated. To update this value a new SAS token must be specified.

(Inherited from ICommonExportProperties)
DestinationStorageAccount

The storage account where exports will be uploaded. For a restricted set of Azure customers this together with sasToken can be specified instead of resourceId.

(Inherited from ICommonExportProperties)
Format

The format of the export being delivered. Currently only 'Csv' is supported.

(Inherited from ICommonExportProperties)
NextRunTimeEstimate

If the export has an active schedule, provides an estimate of the next execution time.

(Inherited from ICommonExportProperties)
PartitionData

If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file. Note: this option is currently available only for modern commerce scopes.

(Inherited from ICommonExportProperties)
RecurrencePeriodFrom

The start date of recurrence.
RecurrencePeriodTo

The end date of recurrence.
RunHistoryValue

A list of export executions.

(Inherited from ICommonExportProperties)
ScheduleRecurrence

The schedule recurrence.
ScheduleStatus

The status of the export's schedule. If 'Inactive', the export's schedule is paused.
TimePeriodFrom

The start date for export data.

(Inherited from ICommonExportProperties)
TimePeriodTo

The end date for export data.

(Inherited from ICommonExportProperties)

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to