ExportProperties Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The properties of the export.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.ExportPropertiesTypeConverter))]
public class ExportProperties : Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IExportProperties, Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IExportPropertiesInternal, Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.ExportPropertiesTypeConverter))>]
type ExportProperties = class
interface IExportProperties
interface IJsonSerializable
interface ICommonExportProperties
interface IExportPropertiesInternal
interface ICommonExportPropertiesInternal
interface IValidates
Public Class ExportProperties
Implements IExportProperties, IExportPropertiesInternal, IValidates
- Inheritance
-
ExportProperties
- Attributes
- Implements
Constructors
ExportProperties() |
Creates an new ExportProperties instance. |
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). |
DataSetConfiguration |
The export dataset configuration. |
DataSetGranularity |
The granularity of rows in the export. Currently only 'Daily' is supported. |
Definition |
Has the definition for the export. |
DefinitionDataSet |
The definition for data in the export. |
DefinitionTimeframe |
The time frame for pulling data for the export. If custom, then a specific time period must be provided. |
DefinitionTimePeriod |
Has time period for pulling data for the export. |
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. |
DeliveryInfo |
Has delivery information for the export. |
DeliveryInfoDestination |
Has destination for the export being delivered. |
DestinationContainer |
The name of the container where exports will be uploaded. If the container does not exist it will be created. |
DestinationResourceId |
The resource id of the storage account where exports will be delivered. This is not required if a sasToken and storageAccount are specified. |
DestinationRootFolderPath |
The name of the directory where exports will be uploaded. |
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. |
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. |
Format |
The format of the export being delivered. Currently only 'Csv' is supported. |
NextRunTimeEstimate |
If the export has an active schedule, provides an estimate of the next execution time. |
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. |
RecurrencePeriodFrom |
The start date of recurrence. |
RecurrencePeriodTo |
The end date of recurrence. |
RunHistory |
If requested, has the most recent execution history for the export. |
RunHistoryValue |
A list of export executions. |
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. |
TimePeriodTo |
The end date for export data. |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of ExportProperties. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of ExportProperties. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IExportProperties. |
FromJsonString(String) |
Creates a new instance of ExportProperties, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of ExportProperties into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |
Validate(IEventListener) |
Validates that this object meets the validation criteria. |
Explicit Interface Implementations
ICommonExportPropertiesInternal.NextRunTimeEstimate |
Internal Acessors for NextRunTimeEstimate |
ICommonExportPropertiesInternal.RunHistoryValue |
Internal Acessors for RunHistoryValue |
IExportPropertiesInternal.Schedule |
Internal Acessors for Schedule |
IExportPropertiesInternal.ScheduleRecurrencePeriod |
Internal Acessors for ScheduleRecurrencePeriod |