Skip to content

Latest commit

 

History

History
194 lines (167 loc) · 6.1 KB

readme.md

File metadata and controls

194 lines (167 loc) · 6.1 KB
Raw

Azs.Network.Admin

This directory contains the PowerShell module for the NetworkAdmin service.

Status

Azs.Network.Admin

Info

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

Detail

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

Module Requirements

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 Azs.Network.Admin, 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

require:
  - $(this-folder)/../readme.azurestack.md
  - $(repo)/specification/azsadmin/resource-manager/network/readme.md

metadata:
  description: 'Microsoft AzureStack PowerShell: Network Admin cmdlets'

### PSD1 metadata changes
subject-prefix: ''
module-version: 1.1.0
service-name: NetworkAdmin

### File Renames
### IMPORTANT - Note that the following settings are case sensitive ###
module-name: Azs.Network.Admin
csproj: Azs.Network.Admin.csproj # C# project file
psd1: Azs.Network.Admin.psd1 # module manifest file
psm1: Azs.Network.Admin.psm1 # script module file

Parameter default values

directive:
    # Prepend Network for the Quota cmdlets
  - where:
      subject: Quota
    set:
      subject-prefix: Network

    # Remove LocationsOperation, OnPremLocation cmdlets
  - where:
      subject: (Location)
    remove: true.

    # Rename ResourceName parameter to Name
  - where:
      parameter-name: ResourceName
    set:
      parameter-name: Name

    # Default to Format-List for the LoadBalancer commandlets as there are many important fields
  - where:
      model-name: LoadBalancer
    set:
      suppress-format: true

    # Default to Format-List for the Quota commandlets as there are many important fields
  - where:
      model-name: Quota
    set:
      suppress-format: true

    # Default to Format-List for the PublicIpAddress commandlets as there are many important fields
  - where:
      model-name: PublicIpAddress
    set:
      suppress-format: true

    # Default to Format-List for the VirtualNetwork commandlets as there are many important fields
  - where:
      model-name: VirtualNetwork
    set:
      suppress-format: true

    # Rename Get-AzsResourceProviderState to Get-AzsNetworkAdminOverView
  - where:
      verb: Get
      subject: ResourceProviderState
    set:
      subject: NetworkAdminOverview
    # Default to Format-List for AdminOverview as there are many important fields
  - where:
      model-name: AdminOverview
    set:
      suppress-format: true

    # New-AzsNetworkQuota.ps1 - Assign default values matching to the portal UI
  - where:
      verb: New
      parameter-name: MaxLoadBalancersPerSubscription
    set:
      default:
        script: '50'
  - where:
      verb: New
      parameter-name: MaxNicsPerSubscription
    set:
      default:
        script: '100'
  - where:
      verb: New
      parameter-name: MaxPublicIpsPerSubscription
    set:
      default:
        script: '50'
  - where:
      verb: New
      parameter-name: MaxSecurityGroupsPerSubscription
    set:
      default:
        script: '50'
  - where:
      verb: New
      parameter-name: MaxVirtualNetworkGatewayConnectionsPerSubscription
    set:
      default:
        script: '2'
  - where:
      verb: New
      parameter-name: MaxVirtualNetworkGatewaysPerSubscription
    set:
      default:
        script: '1'
  - where:
      verb: New
      parameter-name: MaxVnetsPerSubscription
    set:
      default:
        script: '50'

  ## variant removal from all Set cmdlets -- parameter set UpdateExpanded
  - where:
      verb: Set
      variant: UpdateExpanded
    remove: true
  
  ## hide autorest generated cmdlet to use the custom one
  - where:
      verb: Get|New|Set
      subject: Quota
    hide: true

# Add release notes
  - from: Azs.Network.Admin.nuspec
    where: $
    transform: $ = $.replace('<releaseNotes></releaseNotes>', '<releaseNotes>AzureStack Hub Admin module generated with https://github.com/Azure/autorest.powershell.</releaseNotes>');

# Add Az.Accounts/Az.Resources as dependencies
  - from: Azs.Network.Admin.nuspec
    where: $
    transform: $ = $.replace('<dependency id="Az.Accounts" version="2.2.3" />', '<dependency id="Az.Accounts" version="[2.2.8]" />\n      <dependency id="Az.Resources" version="[0.12.0]" />');

# PSD1 changes for ReleaseNotes
  - from: source-file-csharp
    where: $
    transform: $ = $.replace('sb.AppendLine\(\$@\"\{Indent\}\{Indent\}\{Indent\}ReleaseNotes = \'\'\"\);', 'sb.AppendLine\(\$@\"\{Indent\}\{Indent\}\{Indent\}ReleaseNotes = \'AzureStack Hub Admin module generated with https://github.com/Azure/autorest.powershell\'\"\);' );