Az.CostManagement

This directory contains the PowerShell module for the Cost service.

---

Status

Info

• Modifiable: yes
• Generated: all
• Committed: yes
• Packaged: yes

---

Detail

This module was primarily generated via AutoRest using the PowerShell extension.

Module Requirements

• Az.Accounts module, version 2.7.5 or greater

Authentication

AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent.

Development

For information on how to develop for Az.CostManagement, see how-to.md.

---

Generation Requirements

Use of the beta version of autorest.powershell generator requires the following:

• NodeJS LTS (10.15.x LTS preferred)
  • Note: It will not work with Node < 10.x. Using 11.x builds may cause issues as they may introduce instability or breaking changes.

If you want an easy way to install and update Node, NVS - Node Version Switcher or NVM - Node Version Manager is recommended.

• AutoRest v3 beta
  npm install -g autorest@beta
   
• PowerShell 6.0 or greater
  • If you don't have it installed, you can use the cross-platform npm package
    npm install -g pwsh
     
• .NET Core SDK 2.0 or greater
  • If you don't have it installed, you can use the cross-platform npm package
    npm install -g dotnet-sdk-2.2
     

Run Generation

In this directory, run AutoRest:

autorest

---

AutoRest Configuration

see https://aka.ms/autorest

commit: 14f29e62df4563d9bf4b9d98ae0688420df12053
require:
  - $(this-folder)/../../readme.azure.noprofile.md
input-file:
  - $(repo)/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json
  - $(repo)/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.exports.json
  - $(repo)/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-05-01/costmanagement.generatecostdetailsreport.json
title: CostManagement
module-version: 0.3.0

service-name: CostManagement

identity-correction-for-post: true

# For new modules, please avoid setting 3.x using the use-extension method and instead, use 4.x as the default option
use-extension:
  "@autorest/powershell": "3.x"

directive:
  - where:
      variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$
    remove: true
  - from: source-file-csharp
    where: $
    transform: $ = $.replace(/AlertCategory System/, 'AlertCategory System1');
  - from: source-file-csharp
    where: $
    transform: $ = $.replace(/internal partial interface/, 'public partial interface');
  - where:
      verb: Set
    set:
      verb: Update
  - where:
      subject: UsageQuery
      verb: invoke
    remove: true
  - where:
      subject: ByDimensionExternalCloudProviderType|CloudForecast|DismissAlert|Forecast
      verb: Invoke
    remove: true
  # Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header.
  - where:
      subject: GenerateCostDetailReportOperationResult
      verb: Get
    remove: true
  
  - where:
      subject: GenerateCostDetailReportOperation
    set:
      subject: DetailReport

  # The schema of their response body is the same
  - where:
      subject: ByGenerateReservationDetailReportBillingAccountId|ByGenerateReservationDetailReportBillingProfileId
    set:
      subject: ReservationDetailReport
  - where:
      subject: ReservationDetailReport
      variant: ByViaIdentity|ByViaIdentity1
    remove: true

  - where:
      subject: Export|ExportExecutionHistory|ExportExecution
      parameter-name: Scope
    set:
      parameter-name: Scope
      parameter-description: This parameter defines the scope of costmanagement from different perspectives 'Subscription','ResourceGroup' and 'Provide Service'.
  - where:
      subject: Export
      verb: New
    hide: true
  - where:
      subject: Export
      verb: Update
    hide: true
  - from: source-file-csharp
    where: $
    transform: $ = $.replace(/\/runHistory\$/g, "$");
  - where:
      subject: Alert|AlertExternal|Dimension|View
    remove: true
  - from: source-file-csharp
    where: $
    transform: $ = $.replace(/\^\/\(\?<scope>\[\^\/\]\+\)/g, "(?<scope>.+)");
  - where:
      model-name: QueryResult
    set:
      format-table:
        properties:
          - NextLink
          - Column
          - Row
  - where:
      model-name: ExportExecution
    set:
      format-table:
        properties:
          - ExecutionType
          - ProcessingStartTime
          - ProcessingEndTime
          - RunSetting
          - Status
          - FileName
  - from: swagger-document
    where: $.definitions.AlertProperties.properties.details.properties.resourceGroupFilter.items
    transform: >-
        return {
          "type": "string"
        }
  - from: swagger-document
    where: $.definitions.AlertProperties.properties.details.properties.resourceFilter.items
    transform: >-
        return {
          "type": "string"
        }
  - from: swagger-document
    where: $.definitions.AlertProperties.properties.details.properties.meterFilter.items
    transform: >-
        return {
          "type": "string"
        }
  - from: swagger-document
    where: $.definitions.QueryProperties.properties.rows.items.items
    transform: >-
        return {
          "type": "string"
        }
  - from: swagger-document
    where: $.definitions.QueryFilter.properties
    transform: >-
        return {
          "and": {
            "description": "The logical \"AND\" expression. Must have at least 2 items.",
            "type": "array",
            "items": {
              "$ref": "#/definitions/QueryFilter"
            },
            "minItems": 2
          },
          "or": {
            "description": "The logical \"OR\" expression. Must have at least 2 items.",
            "type": "array",
            "items": {
              "$ref": "#/definitions/QueryFilter"
            },
            "minItems": 2
          },
          "not": {
            "description": "The logical \"NOT\" expression.",
            "$ref": "#/definitions/QueryFilter"
          },
          "dimensions": {
            "description": "Has comparison expression for a dimension",
            "$ref": "#/definitions/QueryComparisonExpression"
          },
          "tags": {
            "description": "Has comparison expression for a tag",
            "$ref": "#/definitions/QueryComparisonExpression"
          }
        }
  - where:
      model-name: QueryFilter
      property-name: Dimension
    set:
      property-name: Dimensions
  - where:
      model-name: QueryResult
    set:
      format-table:
        properties:
          - Column
          - Row
  - no-inline:
    - ReportConfigDefinitionAutoGenerated
    - ReportConfigDatasetAutoGenerated
    - ReportConfigFilterAutoGenerated
    - QueryFilter
    - ReportConfigFilter