readme.md

Azs.Fabric.Admin

This directory contains the PowerShell module for the FabricAdmin service.

---

Status

Info

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

---

Detail

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

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

input-file:
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/EdgeGateway.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/EdgeGatewayPool.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/Fabric.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/FabricLocation.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/InfraRole.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/InfraRoleInstance.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/IpPool.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/LogicalNetwork.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/LogicalSubnet.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/MacAddressPool.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/NetworkOperationResults.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2020-10-01/ScaleUnit.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2020-10-01/ScaleUnitNode.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/SlbMuxInstance.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/StorageOperationResults.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/FileShare.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/StorageSubSystem.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2019-05-01/Drive.json
  - $(repo)/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2019-05-01/Volume.json

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

### PSD1 metadata changes
subject-prefix: ''
module-version: 1.0.1
service-name: FabricAdmin

### File Renames
### IMPORTANT - Note that the following settings are case sensitive ###
module-name: Azs.Fabric.Admin
csproj: Azs.Fabric.Admin.csproj
psd1: Azs.Fabric.Admin.psd1
psm1: Azs.Fabric.Admin.psm1

Parameter default values

directive:
  - where:
      parameter-name: ResourceGroupName
    set:
      default:
        script: -join("System.",(Get-AzLocation)[0].Location)

  # ------------------- [EdgeGateway] -------------------
  # [EdgeGateway] Propertity Rename: change NumberOfConnection to NumberOfConnections
  - where:
      model-name: EdgeGateway
      property-name: NumberOfConnection
    set:
      property-name: NumberOfConnections

  # [EdgeGateway] Rename cmdlet parameter name in EdgeGateway
  - where:
      subject: EdgeGateway
      parameter-name: EdgeGateway
    set:
      parameter-name: Name

  # [EdgeGateway] hide autorest generated cmdlet to use the custom one
  - where:
      verb: Get
      subject: EdgeGateway
    hide: true

  # ------------------- [LogicalNetwork] -------------------
  # [LogicalNetwork] Rename property name in LogicalNetwork
  - where:
      model-name: LogicalNetwork
      property-name: Subnet
    set:
      property-name: Subnets

  # [LogicalNetwork] Rename cmdlet parameter name in LogicalNetwork
  - where:
      subject: LogicalNetwork
      parameter-name: LogicalNetwork
    set:
      parameter-name: Name

  # [LogicalNetwork] hide autorest generated cmdlet to use the custom one
  - where:
      verb: Get
      subject: LogicalNetwork
    hide: true

  # ------------------- [LogicalSubnet] -------------------
  # [LogicalSubnet] Parameter rename
  - where:
      subject: LogicalSubnet
      parameter-name: LogicalSubnet
    set:
      parameter-name: Name

  # [LogicalSubnet] hide autorest generated cmdlet
  - where:
      verb: Get
      subject: LogicalSubnet
    hide: true

  # ------------------- [MacAddressPool] -------------------
  # [MacAddressPool] Parameter rename
  - where:
      subject: MacAddressPool
      parameter-name: MacAddressPool
    set:
      parameter-name: Name

  # [MacAddressPool] Rename property name in LogicalNetwork
  - where:
      model-name: MacAddressPool
      property-name: NumberOfAllocatedMacAddress
    set:
      property-name: NumberOfAllocatedMacAddresses

  # [MacAddressPool] Rename property name in LogicalNetwork
  - where:
      model-name: MacAddressPool
      property-name: NumberOfAvailableMacAddress
    set:
      property-name: NumberOfAvailableMacAddresses

  # [MacAddressPool] hide autorest generated cmdlet
  - where:
      verb: Get
      subject: MacAddressPool
    hide: true

  # ------------------- [SlbMuxInstance] -------------------
  # [SlbMuxInstance] Parameter rename
  - where:
      subject: SlbMuxInstance
      parameter-name: SlbMuxInstance
    set:
      parameter-name: Name
  
  # [SlbMuxInstance] Property Rename
  - where:
      model-name: SlbMuxInstance
      property-name: BgpPeer
    set:
      property-name: BgpPeers

  # [SlbMuxInstance] hide autorest generated cmdlet
  - where:
      verb: Get
      subject: SlbMuxInstance
    hide: true

  # ------------------- [EdgeGatewayPool] -------------------
  # [EdgeGateway] Rename cmdlet parameter name in EdgeGatewayPool
  - where:
      subject: EdgeGatewayPool
      parameter-name: EdgeGatewayPool
    set:
      parameter-name: Name

  # [EdgeGatewayPool]: Rename property name NumberOfGateway to NumberOfGateways
  - where:
      model-name: EdgeGatewayPool
      property-name: NumberOfGateway
    set:
      property-name: NumberOfGateways

  # [EdgeGatewayPool] hide autorest generated cmdlet to use the custom one
  - where:
      verb: Get
      subject: EdgeGatewayPool
    hide: true

  # ------------------- [InfrastructureRole] -------------------
  # Rename subject AzsInfraRole to AzsInfrastructureRole
  - where:
      subject: InfraRole
    set:
      subject: InfrastructureRole

  # [InfrastructureRole]: Rename property name Instance to Instances
  - where:
      model-name: InfraRole
      property-name: Instance
    set:
      property-name: Instances

  # [InfrastructureRole] Rename cmdlet parameter name in EdgeGatewayPool
  - where:
      subject: InfrastructureRole
      parameter-name: InfraRole
    set:
      parameter-name: Name

  # [InfrastructureRole] hide autorest generated cmdlet to use the custom one
  - where:
      verb: Get
      subject: InfrastructureRole
    hide: true

  - where:
      verb: Restart
      subject: InfrastructureRole
    hide: true

  # ------------------- [IPPool] -------------------
  # [IPPool]: Rename property name
  - where:
      model-name: IPPool
      property-name: NumberOfAllocatedIPAddress
    set:
      property-name: NumberOfAllocatedIPAddresses

  - where:
      model-name: IPPool
      property-name: NumberOfIPAddress
    set:
      property-name: NumberOfIPAddresses

  # [IPPool] Rename cmdlet parameter name in IPPool
  - where:
      subject: IPPool
      parameter-name: IPPool
    set:
      parameter-name: Name

  # [IPPool] Hide the auto-generated Set-AzsIPPool and expose it through customized one
  - where:
      verb: Set
      subject: IPPool
    hide: true

  # [IPPool] Hide the auto-generated Get-AzsIPPool and expose it through customized one
  - where:
      verb: Get
      subject: IPPool
    hide: true

  # ------------------- [ScaleUnit] -------------------
  # [ScaleUnit]: Rename property name
  - where:
      model-name: ScaleUnit
      property-name: TotalCapacityCore
    set:
      property-name: TotalCapacityOfCores

  - where:
      model-name: ScaleUnit
      property-name: TotalCapacityMemoryGb
    set:
      property-name: TotalCapacityOfMemoryInGB

  # [ScaleUnit] Cmdlet parameter rename
  - where:
      subject: ScaleUnit
      parameter-name: ScaleUnit
    set:
      parameter-name: Name

  # [ScaleUnit] Hide auto-generated
  - where:
      verb: Get
      subject: ScaleUnit
    hide: true

  # [ScaleUnit] Rename Set-ScaleUnitGpuPartitionSize to Set-ScaleUnitGpuPartitionSize
  - where:
      subject: ScaleUnitGpuPartitionSize
    set:
      subject: ScaleUnit

  # [ScaleUnit] Cmdlet parameter rename
  - where:
      subject: ScaleUnit
      parameter-name: GpuPartitionSize
    set:
      parameter-name: NumberOfGPUPartition

  - where:
      subject: ScaleUnit
      parameter-name: ScaleUnit
    set:
      parameter-name: Name

  # [ScaleUnit] Hide auto-generated
  - where:
      verb: Set
      subject: ScaleUnit
    hide: true

  # ------------------- [ScaleUnitNode] -------------------
  # [ScaleUnitNode] Cmdlet parameter rename
  - where:
      subject: ScaleUnitNode
      parameter-name: ScaleUnitNode
    set:
      parameter-name: Name

  - where:
      subject: ScaleUnitNodeMaintenanceMode
      parameter-name: ScaleUnitNode
    set:
      parameter-name: Name

  # [ScaleUnitNode] Hide auto-generated
  - where:
      verb: Get
      subject: ScaleUnitNode
    hide: true

  - where:
      verb: Repair
      subject: ScaleUnitNode
    hide: true

  - where:
      verb: Start
      subject: ScaleUnitNode
    hide: true

  - where:
      verb: Stop
      subject: ScaleUnitNode
    hide: true

  - where:
      verb: Start
      subject: ScaleUnitNodeMaintenanceMode
    hide: true

  - where:
      verb: Stop
      subject: ScaleUnitNodeMaintenanceMode
    hide: true

  # [ScaleUnitNode]: Rename property name
  - where:
      model-name: ScaleUnitNode
      property-name: Status
    set:
      property-name: ScaleUnitNodeStatus

  - where:
      model-name: ScaleUnitNode
      property-name: CapacityCore
    set:
      property-name: CapacityOfCores

  - where:
      model-name: ScaleUnitNode
      property-name: CapacityMemoryGb
    set:
      property-name: CapacityOfMemoryInGB

  # [ScaleUnitNode] Rename Invoke-ScaleUnitOut to Add-AzsScaleUnitNode
  - where:
      verb: Invoke
      subject: ScaleUnitOut
    set:
      verb: Add
      subject: ScaleUnitNode

  - where:
      verb: Add
      subject: ScaleUnitNode
    hide: true

  # [ScaleUnitNode]Rename Start-AzsScaleUnitNodeMaintenanceMode to Disable-AzsScaleUnitNode
  - where:
      verb: Start
      subject: ScaleUnitNodeMaintenanceMode
    set:
      verb: Disable
      subject: ScaleUnitNode

  # [ScaleUnitNode]Rename Stop-AzsScaleUnitNodeMaintenanceMode to Enable-AzsScaleUnitNode
  - where:
      verb: Stop
      subject: ScaleUnitNodeMaintenanceMode
    set:
      verb: Enable
      subject: ScaleUnitNode

  # ------------------- [FabricLocation] -------------------
  # Rename Get-AzsFabricLocation to Get-AzsInfrastructureLocation
  - where:
      subject: FabricLocation
    set:
      subject: InfrastructureLocation

  # ------------------- [InfrastructureRoleInstance] -------------------
  # [InfrastructureRoleInstance] Rename Subject
  - where:
      subject: InfraRoleInstance
    set:
      subject: InfrastructureRoleInstance

  # [InfrastructureRoleInstance] Propertity rename
  - where:
      model-name: InfraRoleInstance
      property-name: SizeCore
    set:
      property-name: NumberOfCores

  - where:
      model-name: InfraRoleInstance
      property-name: SizeMemoryGb
    set:
      property-name: SizeMemoryInGB

  # [InfrastructureRoleInstance] Parameter Raname
  - where:
      subject: InfrastructureRoleInstance
      parameter-name: InfraRoleInstance
    set:
      parameter-name: Name

  # [InfrastructureRoleInstance] Supress default module
  - where:
      verb: Get
      subject: InfrastructureRoleInstance
    hide: true

  - where:
      verb: Start
      subject: InfrastructureRoleInstance
    hide: true

  - where:
      verb: Restart
      subject: InfrastructureRoleInstance
    hide: true

  - where:
      verb: Stop
      subject: InfrastructureRoleInstance
    hide: true

  - where:
      verb: Disable
      subject: InfrastructureRoleInstance
    hide: true

  # [InfrastructureRoleInstance] Separate InfraRoleInstance stop operations
  - where:
      verb: Stop
      subject: InfrastructureRoleInstance
      variant: Shutdown.*
    set:
      verb: Disable

  # ------------------- [AzsInfrastructureShare] -------------------
  # Rename Get-AzsFileShare to Get-AzsInfrastructureShare
  - where:
      subject: FileShare
    set:
      subject: InfrastructureShare

  # Hide the auto-generated Get-AzsInfrastructureShare and expose it through customized one
  - where:
      verb: Get
      subject: InfrastructureShare
    hide: true

  # Rename cmdlet parameter name in InfrastructureShare
  - where:
      subject: InfrastructureShare
      parameter-name: FileShare
    set:
      parameter-name: Name

  # ------------------- [StorageSubSystem] -------------------
  # [StorageSubSystem] Rename model property names for StorageSubSystem to match spec
  - where:
      model-name: StorageSubSystem
      property-name: TotalCapacityGb
    set:
      property-name: TotalCapacityGB

  - where:
      model-name: StorageSubSystem
      property-name: RemainingCapacityGb
    set:
      property-name: RemainingCapacityGB
  
 # [StorageSubSystem] Hide the auto-generated Get-AzsStorageSubSystem and expose it through customized one
  - where:
      verb: Get
      subject: StorageSubSystem
    hide: true

  # Rename cmdlet parameter name in StorageSubSystem
  - where:
      subject: StorageSubSystem
      parameter-name: StorageSubSystem
    set:
      parameter-name: Name

  # ------------------- [Drive] -------------------
  # [Drive] Rename model property names for Drive to match spec
  - where:
      model-name: Drive
      property-name: CapacityGb
    set:
      property-name: CapacityGB

  # [Drive] Rename cmdlet parameter name in Drive
  - where:
      subject: Drive
      parameter-name: Drive
    set:
      parameter-name: Name

  # [Drive] Hide the auto-generated Get-AzsDrive and expose it through customized one
  - where:
      verb: Get
      subject: Drive
    hide: true

  # ------------------- [Volume] -------------------
  # [Volume] Rename model property names for Volume to match spec
  - where:
      model-name: Volume
      property-name: TotalCapacityGb
    set:
      property-name: TotalCapacityGB

  - where:
      model-name: Volume
      property-name: RemainingCapacityGb
    set:
      property-name: RemainingCapacityGB

  - where:
      model-name: Volume
      property-name: Label
    set:
      property-name: VolumeLabel

  # [Volume] Rename cmdlet parameter name in Volume
  - where:
      subject: Volume
      parameter-name: Volume
    set:
      parameter-name: Name

  # Default to Format-List for the StorageSubSystem, FileShare and Volume model as there are many important fields
  - where:
      model-name: StorageSubSystem
    set:
      suppress-format: true
  - where:
      model-name: FileShare
    set:
      suppress-format: true
  - where:
      model-name: Volume
    set:
      suppress-format: true

  # Hide the auto-generated Get-AzsInfrastructureShare and expose it through customized one
  - where:
      verb: Get
      subject: InfrastructureShare
    hide: true

  # Hide the auto-generated Get-AzsStorageSubSystem and expose it through customized one
  - where:
      verb: Get
      subject: StorageSubSystem
    hide: true

  # Hide the auto-generated Get-AzsDrive and expose it through customized one
  - where:
      verb: Get
      subject: Drive
    hide: true

  # Hide the auto-generated Get-AzsVolume and expose it through customized one
  - where:
      verb: Get
      subject: Volume
    hide: true

  # ------------------- [Misc] -------------------
  # Hide the auto-generated Get-AzsFabricOperation and expose it through customized one
  - where:
      verb: Get
      subject: FabricOperation
    hide: true

  # Hide the auto-generated Get-AzsNetworkOperationResult and expose it through customized one
  - where:
      verb: Get
      subject: NetworkOperationResult
    hide: true

  # Hide the auto-generated Get-AzsStorageOperationResult and expose it through customized one
  - where:
      subject: StorageOperationResult
    hide: true

  # Hide the auto-generated New-AzsScaleUnitFromJson and expose it through customized one
  - where:
      subject: ScaleUnitFromJson
    hide: true

# Add release notes
  - from: Azs.Fabric.Admin.nuspec
    where: $
    transform: $ = $.replace('<releaseNotes></releaseNotes>', '<releaseNotes> 1.Bug fix for switched cmdlets \"Enable-AzsScaleUnitNode\" and \"Disable-AzsScaleUnitNode\"; 2. Replace parameter \"NodeList\" with \"BmciPAddress\" and \"ComputerName\" in cmd \"Add-AzsScaleUnitNode\" </releaseNotes>');

# Add Az.Accounts/Az.Resources as dependencies
  - from: Azs.Fabric.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.11.0]" />');

# PSD1 Changes for RequiredModules
  - from: source-file-csharp
    where: $
    transform: $ = $.replace('sb.AppendLine\(\$@\"\{Indent\}RequiredAssemblies = \'\{\"./bin/Azs.Fabric.Admin.private.dll\"\}\'\"\);', 'sb.AppendLine\(\$@\"\{Indent\}RequiredAssemblies = \'\{\"./bin/Azs.Fabric.Admin.private.dll\"\}\'\"\);\n      sb.AppendLine\(\$@\"\{Indent\}RequiredModules = @\(@\{\{ModuleName = \'Az.Accounts\'; RequiredVersion = \'2.2.8\'; \}\}, @\{\{ModuleName = \'Az.Resources\'; RequiredVersion = \'0.11.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\'\"\);' );