Skip to content

Latest commit

 

History

History
92 lines (85 loc) · 2.52 KB

readme.azure.noprofile.md

File metadata and controls

92 lines (85 loc) · 2.52 KB

Azure PowerShell AutoRest Configuration

Values

azure: true
powershell: true
help-link-prefix: https://learn.microsoft.com/powershell/module/
license-header: MICROSOFT_MIT_NO_VERSION
pwsh-license-header: MICROSOFT_APACHE_NO_VERSION
# commit must be specified in the module's README.md file to pin the swagger.
repo: https://github.com/Azure/azure-rest-api-specs/blob/$(commit)
metadata:
  authors: Microsoft Corporation
  owners: Microsoft Corporation
  description: 'Microsoft Azure PowerShell: $(service-name) cmdlets'
  copyright: Microsoft Corporation. All rights reserved.
  tags: Azure ResourceManager ARM PSModule $(service-name)
  companyName: Microsoft Corporation
  requireLicenseAcceptance: true
  licenseUri: https://aka.ms/azps-license
  projectUri: https://github.com/Azure/azure-powershell

Names

prefix: Az
subject-prefix: $(service-name)
module-name: $(prefix).$(service-name)
namespace: Microsoft.Azure.PowerShell.Cmdlets.$(service-name)

Folders

clear-output-folder: true
output-folder: .

Exclude some properties in table view

# For a specific module, we could override this configuration by setting default-exclude-tableview-properties to false in readme.md of that module.
default-exclude-tableview-properties: true
exclude-tableview-properties:
  - Id
  - Type

Default autorest.powershell version

use-extension:
  "@autorest/powershell": "4.x"

Directives

directive:
  - from: swagger-document
    where: $.paths..responses.202.headers
    transform: delete $["Location"]
  - from: swagger-document
    where: $.paths..responses.202.headers
    transform: delete $["Retry-After"]
  - from: swagger-document
    where: $.paths..responses.202.headers
    transform: delete $["Azure-AsyncOperation"]
  - from: swagger-document
    where: $.paths..responses.201.headers
    transform: delete $["Location"]
  - from: swagger-document
    where: $.paths..responses.201.headers
    transform: delete $["Retry-After"]
  - from: swagger-document
    where: $.paths..responses.201.headers
    transform: delete $["Azure-AsyncOperation"]
  - where:
      subject: Operation
    hide: true
  - where:
      parameter-name: SubscriptionId
    set:
      default:
        script: '(Get-AzContext).Subscription.Id'

AssemblyInfo attributes

assemblyInfo-path: "Properties/AssemblyInfo.cs"
assembly-company: "Microsoft"
assembly-product: "Microsoft Azure PowerShell"
assembly-copyright: "Copyright © Microsoft"