This is the AutoRest configuration and documentation file for AppConfiguration powershell module
Use of the beta version of autorest.powershell generator requires the following:
- NodeJS LTS (10.15.x LTS preferred. Will not function with Node < 10.x Be Wary of 11.x builds as they may introduce instability or breaking changes. )
if you want an easy way to install and update Node, I recommend NVS - Node Version Switcher or NVM - Node Version Manager
- AutoRest v3 beta
npm install -g autorest@beta
- PowerShell 6.0 - If you dont have it installed, you can use the cross-platform npm package
npm install -g pwsh
- Dotnet SDK 2 or greater - If you dont have it installed, you can use the cross-platform npm package
npm install -g dotnet-sdk-2.1
- Modified Azure AzAccounts module (included in
Az.Accountsfolder)
- run
use-azaccount.ps1so the right az.accounts module is loaded for tests.
In this directory, run AutoRest
autorest
Then you can compile and run the module:
./generated/build-module.ps1 -test
Spawning in isolated process.
Cleaning folders...
Compiling private module code
Private Module loaded (C:\...\sample\generated\bin\TimesNewswire.private.dll).
Processing cmdlet variants
Generating unified cmdlet proxies
Done.
PS C:\...\sample\generated [ testing AppConfigurationManagement ] >
and you can examine the cmdlets:
get-command -module AppConfigurationManagement
get-command -module AppConfiguration
CommandType Name Version Source
----------- ---- ------- ------
Function Get-AzConfigurationStore 1.0 AppConfiguration
Function Get-AzConfigurationStoreKey 1.0 AppConfiguration
Function New-AzConfigurationStore 1.0 AppConfiguration
Function New-AzConfigurationStoreKey 1.0 AppConfiguration
Function Remove-AzConfigurationStore 1.0 AppConfiguration
Function Test-AzConfigurationStoreNameAvailability 1.0 AppConfiguration
Function Update-AzConfigurationStore 1.0 AppConfiguration
Run a command:
Get-AppConfigurationurationStore
Name Type Id Location Tag Propertie
s
---- ---- -- -------- --- ---------
ElkTestConfig Microsoft.AppConfiguration/configurationStores /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/AppConfigurationsrg/providers/Microsoft.AppConfiguration/configurationStores/elktestconfig centralus {} Micros...
ElkTestConfig2 Microsoft.AppConfiguration/configurationStores /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/AppConfigurationsrg/providers/Microsoft.AppConfiguration/configurationStores/elktestconfig2 centralus {} Micros...
testcf6 Microsoft.AppConfiguration/configurationStores /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/AppConfigurationsrg/providers/Microsoft.AppConfiguration/configurationStores/testcf6 westus {foo} Micros...
AutoRest doesn't add authentication code into the generated client, given that there is so much variance on how that works.
This sample includes an extension to the module that alters the HTTP payload before it's sent.
These are the settings for generating the cmdlets for the API with AutoRest (instead of putting them on the command line)
input-file: AppConfiguration.json
namespace: Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration
title: AppConfiguration
powershell: true
clear-output-folder: true
output-folder: generated
azure: true
skip-model-cmdlets: true
directive:
- remove-operation: Operations_List
#- from: openapi-document:
#where: $..paths.*[?(@.operationId == 'Operations_List')]
#transform: $ = undefined;
This configuration block pulls in the powershell generator automatically.
use:
- "@microsoft.azure/autorest.powershell@beta"