Update-AzCostManagementExport

The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.

Syntax

Update-AzCostManagementExport
      -Name <String>
      -Scope <String>
      [-ConfigurationColumn <String[]>]
      [-DataSetGranularity <GranularityType>]
      [-DefinitionTimeframe <TimeframeType>]
      [-DefinitionType <ExportType>]
      [-DestinationContainer <String>]
      [-DestinationResourceId <String>]
      [-DestinationRootFolderPath <String>]
      [-ETag <String>]
      [-Format <FormatType>]
      [-RecurrencePeriodFrom <DateTime>]
      [-RecurrencePeriodTo <DateTime>]
      [-ScheduleRecurrence <RecurrenceType>]
      [-ScheduleStatus <StatusType>]
      [-TimePeriodFrom <DateTime>]
      [-TimePeriodTo <DateTime>]
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Update-AzCostManagementExport
      -InputObject <ICostManagementIdentity>
      [-ConfigurationColumn <String[]>]
      [-DataSetGranularity <GranularityType>]
      [-DefinitionTimeframe <TimeframeType>]
      [-DefinitionType <ExportType>]
      [-DestinationContainer <String>]
      [-DestinationResourceId <String>]
      [-DestinationRootFolderPath <String>]
      [-ETag <String>]
      [-Format <FormatType>]
      [-RecurrencePeriodFrom <DateTime>]
      [-RecurrencePeriodTo <DateTime>]
      [-ScheduleRecurrence <RecurrenceType>]
      [-ScheduleStatus <StatusType>]
      [-TimePeriodFrom <DateTime>]
      [-TimePeriodTo <DateTime>]
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.

Examples

Example 1: Update AzCostManagementExport by scope and name

PS C:\> Update-AzCostManagementExport -Scope "subscriptions//*********" -Name "TestExport" -ScheduleRecurrence 'Weekly'

ETag              Name                                 Type
----              ----                                 ----
"********" TestExportDatasetAggregationInfo Microsoft.CostManagement/exports

Update AzCostManagementExport by Scope and name

Example 2: Update AzCostManagementExport by InputObject

PS C:\> $oldExport = Get-AzCostManagementExport -Scope "subscriptions/*********" -Name "TestExport"
Update-AzCostManagementExport -InputObject $oldExport -ScheduleRecurrence 'Weekly'

ETag              Name                                 Type
----              ----                                 ----
"********" TestExportDatasetAggregationInfo Microsoft.CostManagement/exports

Update AzCostManagementExport by InputObject

Parameters

-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).

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DataSetGranularity

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

Type:Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.GranularityType
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefinitionTimeframe

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

Type:Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.TimeframeType
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-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.

Type:Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.ExportType
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DestinationContainer

The name of the container where exports will be uploaded.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DestinationResourceId

The resource id of the storage account where exports will be delivered.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DestinationRootFolderPath

The name of the directory where exports will be uploaded.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-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.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Format

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

Type:Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.FormatType
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.ICostManagementIdentity
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Name

Export Name.

Type:String
Aliases:ExportName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RecurrencePeriodFrom

The start date of recurrence.

Type:DateTime
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RecurrencePeriodTo

The end date of recurrence.

Type:DateTime
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ScheduleRecurrence

The schedule recurrence.

Type:Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.RecurrenceType
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ScheduleStatus

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

Type:Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Support.StatusType
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Scope

This parameter defines the scope of costmanagement from different perspectives 'Subscription','ResourceGroup' and 'Provide Service'.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TimePeriodFrom

The start date for export data.

Type:DateTime
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TimePeriodTo

The end date for export data.

Type:DateTime
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.ICostManagementIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20200601.IExport

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT : Identity Parameter

  • [AlertId <String>]: Alert ID
  • [ExportName <String>]: Export Name.
  • [ExternalCloudProviderId <String>]: This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.
  • [ExternalCloudProviderType <ExternalCloudProviderType?>]: The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.
  • [Id <String>]: Resource identity path
  • [Scope <String>]: The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope.
  • [ViewName <String>]: View name