Export interface

An export resource.

Extends

Properties

compressionMode

Allow customers to select compress data for exports. This setting will enable destination file compression scheme at runtime. By default set to None. Gzip is for csv and snappy for parquet.

dataOverwriteBehavior

Allow customers to select overwrite data(OverwritePreviousReport) for exports. This setting will enable overwrite data for the same month in customer storage account. By default set to CreateNewReport.

definition

Has the definition for the export.

deliveryInfo

Has delivery information for the export.

eTag

eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.

exportDescription

The export description set by customer at time of export creation/update.

format

The format of the export being delivered.

identity

The managed identity associated with Export

location

The location of the Export's managed identity. Only required when utilizing managed identity.

nextRunTimeEstimate

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

partitionData

If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file.

runHistory

If requested, has the most recent run history for the export.

schedule

Has schedule information for the export.

systemSuspensionContext

The export suspension reason if export is in SystemSuspended state. This is not populated currently.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

The name of the resource

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

compressionMode

Allow customers to select compress data for exports. This setting will enable destination file compression scheme at runtime. By default set to None. Gzip is for csv and snappy for parquet.

compressionMode?: string

Property Value

string

dataOverwriteBehavior

Allow customers to select overwrite data(OverwritePreviousReport) for exports. This setting will enable overwrite data for the same month in customer storage account. By default set to CreateNewReport.

dataOverwriteBehavior?: string

Property Value

string

definition

Has the definition for the export.

definition?: ExportDefinition

Property Value

deliveryInfo

Has delivery information for the export.

deliveryInfo?: ExportDeliveryInfo

Property Value

eTag

eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.

eTag?: string

Property Value

string

exportDescription

The export description set by customer at time of export creation/update.

exportDescription?: string

Property Value

string

format

The format of the export being delivered.

format?: string

Property Value

string

identity

The managed identity associated with Export

identity?: SystemAssignedServiceIdentity

Property Value

location

The location of the Export's managed identity. Only required when utilizing managed identity.

location?: string

Property Value

string

nextRunTimeEstimate

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

nextRunTimeEstimate?: Date

Property Value

Date

partitionData

If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file.

partitionData?: boolean

Property Value

boolean

runHistory

If requested, has the most recent run history for the export.

runHistory?: ExportExecutionListResult

Property Value

schedule

Has schedule information for the export.

schedule?: ExportSchedule

Property Value

systemSuspensionContext

The export suspension reason if export is in SystemSuspended state. This is not populated currently.

systemSuspensionContext?: ExportSuspensionContext

Property Value

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ExtensionResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ExtensionResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From ExtensionResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ExtensionResource.type