ExportExecutionProperties 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 execution.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.ExportExecutionPropertiesTypeConverter))]
public class ExportExecutionProperties : Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IExportExecutionProperties, Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IExportExecutionPropertiesInternal[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.ExportExecutionPropertiesTypeConverter))>]
type ExportExecutionProperties = class
interface IExportExecutionProperties
interface IJsonSerializable
interface IExportExecutionPropertiesInternalPublic Class ExportExecutionProperties
Implements IExportExecutionProperties, IExportExecutionPropertiesInternal- Inheritance
-
ExportExecutionProperties
- Attributes
- Implements
Constructors
| ExportExecutionProperties() |
Creates an new ExportExecutionProperties instance. |
Properties
| Code |
Error code. |
| 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). |
| DataSetGranularity |
The granularity of rows in the export. Currently only 'Daily' is supported. |
| DefinitionTimeframe |
The time frame for pulling data for the export. If custom, then a specific time period must be provided. |
| 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. |
| 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. |
| ExecutionType |
The type of the export execution. |
| FileName |
The name of the exported file. |
| Message |
Error message indicating why the operation failed. |
| ProcessingEndTime |
The time when the export execution finished. |
| ProcessingStartTime |
The time when export was picked up to be executed. |
| RunHistoryValue |
A list of export executions. |
| RunSettingFormat |
The format of the export being delivered. Currently only 'Csv' is supported. |
| RunSettingNextRunTimeEstimate |
If the export has an active schedule, provides an estimate of the next execution time. |
| RunSettingPartitionData |
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. |
| Status |
The last known status of the export execution. |
| SubmittedBy |
The identifier for the entity that executed the export. For OnDemand executions it is the user email. For scheduled executions it is 'System'. |
| SubmittedTime |
The time when export was queued to be executed. |
| TimePeriodFrom |
The start date for export data. |
| TimePeriodTo |
The end date for export data. |
Methods
| DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of ExportExecutionProperties. |
| DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of ExportExecutionProperties. |
| FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IExportExecutionProperties. |
| FromJsonString(String) |
Creates a new instance of ExportExecutionProperties, deserializing the content from a json string. |
| ToJson(JsonObject, SerializationMode) |
Serializes this instance of ExportExecutionProperties into a JsonNode. |
| ToJsonString() |
Serializes this instance to a json string. |