Moving RequiredModules metadata to readme.azurestack.md

Author: bganapa

src/Azs.Backup.Admin/.gitignore

@@ -6,6 +6,7 @@ internal
 exports
 tools
 custom/*.psm1
+custom/autogen-model-cmdlets
 test/*-TestResults.xml
 /*.ps1
 /*.ps1xml

src/Azs.Backup.Admin/Azs.Backup.Admin.psd1

@@ -0,0 +1,25 @@
+@{
+  GUID = '2e202983-13f3-4bc9-a5fb-98911e8d1a12'
+  RootModule = 'Azs.Backup.Admin.psm1'
+  ModuleVersion = '1.0.2'
+  CompatiblePSEditions = 'Core', 'Desktop'
+  Author = 'Microsoft Corporation'
+  CompanyName = 'Microsoft Corporation'
+  Copyright = 'Microsoft Corporation. All rights reserved.'
+  Description = 'Microsoft AzureStack PowerShell: Backup Admin cmdlets'
+  PowerShellVersion = '5.1'
+  DotNetFrameworkVersion = '4.7.2'
+  RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '2.2.8'}, @{ModuleName = 'Az.Resources'; ModuleVersion = '0.12.0'})
+  RequiredAssemblies = './bin/Azs.Backup.Admin.private.dll'
+  FormatsToProcess = './Azs.Backup.Admin.format.ps1xml'
+  FunctionsToExport = 'Get-AzsBackup', 'Get-AzsBackupConfiguration', 'Invoke-AzsPruneBackupLocationExternalStore', 'Restore-AzsBackup', 'Set-AzsBackupConfiguration', 'Start-AzsBackup', '*'
+  AliasesToExport = '*'
+  PrivateData = @{
+    PSData = @{
+      Tags = 'AzureStack', 'ResourceManager', 'ARM', 'PSModule'
+      LicenseUri = 'https://aka.ms/azps-license'
+      ProjectUri = 'https://github.com/Azure/azurestack-powershell'
+      ReleaseNotes = 'AzureStack Hub Admin module generated with https://github.com/Azure/autorest.powershell'
+    }
+  }
+}

src/Azs.Backup.Admin/custom/README.md

@@ -0,0 +1,41 @@
+# Custom
+This directory contains custom implementation for non-generated cmdlets for the `Azs.Backup.Admin` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `..\exports` folder. The only generated file into this folder is the `Azs.Backup.Admin.custom.psm1`. This file should not be modified.
+
+## Info
+- Modifiable: yes
+- Generated: partial
+- Committed: yes
+- Packaged: yes
+
+## Details
+For `Azs.Backup.Admin` to use custom cmdlets, it does this two different ways. We **highly recommend** creating script cmdlets, as they are easier to write and allow access to the other exported cmdlets. C# cmdlets *cannot access exported cmdlets*.
+
+For C# cmdlets, they are compiled with the rest of the generated low-level cmdlets into the `./bin/Azs.Backup.Admin.private.dll`. The names of the cmdlets (methods) and files must follow the `[cmdletName]_[variantName]` syntax used for generated cmdlets. The `variantName` is used as the `ParameterSetName`, so use something appropriate that doesn't clash with already created variant or parameter set names. You cannot use the `ParameterSetName` property in the `Parameter` attribute on C# cmdlets. Each cmdlet must be separated into variants using the same pattern as seen in the `generated/cmdlets` folder.
+
+For script cmdlets, these are loaded via the `Azs.Backup.Admin.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build.
+
+## Purpose
+This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `..\exports` folder.
+
+## Usage
+The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `..\exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters:
+- Break
+- DefaultProfile
+- HttpPipelineAppend
+- HttpPipelinePrepend
+- Proxy
+- ProxyCredential
+- ProxyUseDefaultCredentials
+
+These provide functionality to our HTTP pipeline and other useful features. In script, you can forward these parameters using `$PSBoundParameters` to the other cmdlets you're calling within `Azs.Backup.Admin`. For C#, follow the usage seen in the `ProcessRecordAsync` method.
+
+### Attributes
+For processing the cmdlets, we've created some additional attributes:
+- `Microsoft.Azure.PowerShell.Cmdlets.BackupAdmin.DescriptionAttribute`
+  - Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts.
+- `Microsoft.Azure.PowerShell.Cmdlets.BackupAdmin.DoNotExportAttribute`
+  - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Azs.Backup.Admin`.
+- `Microsoft.Azure.PowerShell.Cmdlets.BackupAdmin.InternalExportAttribute`
+  - Used in C# cmdlets to route exported cmdlets to the `..\internal`, which are *not exposed* by `Azs.Backup.Admin`. For more information, see [README.md](..\internal/README.md) in the `..\internal` folder.
+- `Microsoft.Azure.PowerShell.Cmdlets.BackupAdmin.ProfileAttribute`
+  - Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules.

src/Azs.Backup.Admin/how-to.md

@@ -0,0 +1,58 @@
+# How-To
+This document describes how to develop for `Azs.Backup.Admin`.
+
+## Building `Azs.Backup.Admin`
+To build, run the `build-module.ps1` at the root of the module directory. This will generate the proxy script cmdlets that are the cmdlets being exported by this module. After the build completes, the proxy script cmdlets will be output to the `exports` folder. To read more about the proxy script cmdlets, look at the [README.md](exports/README.md) in the `exports` folder.
+
+## Creating custom cmdlets
+To add cmdlets that were not generated by the REST specification, use the `custom` folder. This folder allows you to add handwritten `.ps1` and `.cs` files. Currently, we support using `.ps1` scripts as new cmdlets or as additional low-level variants (via `ParameterSet`), and `.cs` files as low-level (variants) cmdlets that the exported script cmdlets call. We do not support exporting any `.cs` (dll) cmdlets directly. To read more about custom cmdlets, look at the [README.md](custom/README.md) in the `custom` folder.
+
+## Generating documentation
+To generate documentation, the process is now integrated into the `build-module.ps1` script. If you don't want to run this process as part of `build-module.ps1`, you can provide the `-NoDocs` switch. If you want to run documentation generation after the build process, you may still run the `generate-help.ps1` script. Overall, the process will look at the documentation comments in the generated and custom cmdlets and types, and create `.md` files into the `docs` folder. Additionally, this pulls in any examples from the `examples` folder and adds them to the generated help markdown documents. To read more about examples, look at the [README.md](examples/README.md) in the `examples` folder. To read more about documentation, look at the [README.md](docs/README.md) in the `docs` folder.
+
+## Testing `Azs.Backup.Admin`
+To test the cmdlets, we use [Pester](https://github.com/pester/Pester). Tests scripts (`.ps1`) should be added to the `test` folder. To execute the Pester tests, run the `test-module.ps1` script. This will run all tests in `playback` mode within the `test` folder. To read more about testing cmdlets, look at the [README.md](examples/README.md) in the `examples` folder.
+
+## Packing `Azs.Backup.Admin`
+To pack `Azs.Backup.Admin` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://docs.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team.
+
+## Module Script Details
+There are multiple scripts created for performing different actions for developing `Azs.Backup.Admin`.
+- `build-module.ps1`
+  - Builds the module DLL (`./bin/Azs.Backup.Admin.private.dll`), creates the exported cmdlets and documentation, generates custom cmdlet test stubs and exported cmdlet example stubs, and updates `Azs.Backup.Admin.psd1` with Azure profile information.
+  - **Parameters**: [`Switch` parameters]
+    - `-Run`: After building, creates an isolated PowerShell session and loads `Azs.Backup.Admin`.
+    - `-Test`: After building, runs the `Pester` tests defined in the `test` folder.
+    - `-Docs`: After building, generates the Markdown documents for the modules into the `docs` folder.
+    - `-Pack`: After building, packages the module into a `.nupkg`.
+    - `-Code`: After building, opens a VSCode window with the module's directory and runs (see `-Run`) the module.
+    - `-Release`: Builds the module in `Release` configuration (as opposed to `Debug` configuration).
+    - `-NoDocs`: Supresses writing the documentation markdown files as part of the cmdlet exporting process.
+    - `-Debugger`: Used when attaching the debugger in Visual Studio to the PowerShell session, and running the build process without recompiling the DLL. This suppresses running the script as an isolated process.
+- `run-module.ps1`
+  - Creates an isolated PowerShell session and loads `Azs.Backup.Admin` into the session.
+  - Same as `-Run` in `build-module.ps1`.
+  - **Parameters**: [`Switch` parameters]
+    - `-Code`: Opens a VSCode window with the module's directory.
+      - Same as `-Code` in `build-module.ps1`.
+- `generate-help.ps1`
+  - Generates the Markdown documents for the modules into the `docs` folder.
+  - Same as `-Docs` in `build-module.ps1`.
+- `test-module.ps1`
+  - Runs the `Pester` tests defined in the `test` folder.
+  - Same as `-Test` in `build-module.ps1`.
+- `pack-module.ps1`
+  - Packages the module into a `.nupkg` for distribution.
+  - Same as `-Pack` in `build-module.ps1`.
+- `generate-help.ps1`
+  - Generates the Markdown documents for the modules into the `docs` folder.
+  - Same as `-Docs` in `build-module.ps1`.
+  - This process is now integrated into `build-module.ps1` automatically. To disable, use `-NoDocs` when running `build-module.ps1`.
+- `export-surface.ps1`
+  - Generates Markdown documents for both the cmdlet surface and the model (class) surface of the module.
+  - These files are placed into the `resources` folder.
+  - Used for investigating the surface of your module. These are *not* documentation for distribution.
+- `check-dependencies.ps1`
+  - Used in `run-module.ps1` and `test-module.ps1` to verify dependent modules are available to run those tasks.
+  - It will download local (within the module's directory structure) versions of those modules as needed.
+  - This script *does not* need to be ran by-hand.