* Help Overhaul project V1. (#8288)
* Dummy help.yaml file
* Parse command for testing yaml parsing
Parser can output contents as yaml
updated help.yaml test file with some comments.
* Added logic to parse help.yaml file and update help data objects.
More helpfile updates.
* _help.py now raises error if it fails to parse help.yaml or help.yaml is empty
* updated _help.py: CLI now prints extension messages. Removed parser module.
* _help.py: Addressed pep8 warnings. Made some methods static
* changed dir to dir_name as dir is a builtin function.
* script to convert _help.py to help/yaml. Parses short and long summaries. Fields within commands/groups need to have some non-alphabetic ordering
* Help conversion script uses ruamel.yaml. Output is ordered and visually appealing. '>' and '|' (part of yaml syntax) are preserved in values.
* Conversion script now converts parameters to arguments (bug fix). Outputs arguments before examples
* Added some comments. Link urls have title field instad of name field. Command and Group information formatted differently. Addressed a few other PR comments.
* Fixed bug in _params_equal()
* checked out devs _help.py file.
* Refactoring code. Todo: update print_header to print links. Fix bug where some command group names / parameter names are not updated from code.
* Removed unnecessary file.
* Addressed style feedback.
* Changes:
create temp directory to hold temporary files and scripts.
Updated value-source to value-sources.
get_all_help uses CliGroupHelpfile instead of knack's CliGroupHelpfile
* uncommented help import
* Added tests to help script.
* PEP8 style changes.
* Sphinx properly handles help groups.
* Refactored _help.py and _help_util.py to _help_loaders.py
* Removed _help_util.py
* Bug fixes
* More refactoring, script tests pass
* Changes to restore _help.py to same state before rebase.
* Updated AzCliHelp to print links associated with commands and groups.
* Moved CLIHelp class\'s print method to mixin class. Removed raw value sources field. Added logic to properly update parameter info from data. Updated temp help yaml file example.
* WIP: update loader logic/architecture, class structure.
* Finish refactoring loader code and help.py
Added todo reminder.
* updated _load_help_parameters. removed unused get_example_from_data method.
* Fixed bugs and made updates in help convert script, loader and print methods.
* Begin loader testing.
* More testing work.
* Added tests for loading from help.py
* Added tests for yaml loader. Fixed bug in example printing. Yaml loader loads files that endwith help.yaml/yml.
* Help.py and help.yaml tests are passing. Fixed bug with displaying group help.
* All help tests pass. Including test of new help loader.
* BaseHelpLoader now inherits from ABC. Loaders now check if data version matches their version.
* Updated doc generator script. Updated yaml converter test.
* Fix bug in doc gen script.
* Optimize help conversion script. Added logic to convert all core modules.
* Removed unnecessary check.
* Script updates. Yaml, no longer wraps around. Handles duplicate keys. Handles incorect module names.
* Can delete files, bug in loading multiple modules due to duplicate keys in repo. See acs create.
* Added script to convert all help.py files in core. Removed help.yaml. Handles duplicate help entries. i.e acs create properly. Conversion test strict. Relevant help obj fields must be the same. TODO: extensions logic.
* Moved scripts to /scripts, added stubs for converting extensions. Style checks.
Removed unnecessary import_module statement.
* Added license header to convert_all.py
* Fixed bug in convert_all.py. Fixed bug in container/_help.py.
* Added logic to verify number of command _help.py files matches help.yaml files.
* Convert all help.yaml files. No known errors / discrepancies.
* Fixed tox env issue. Added logger.warning if core fails to import command_modules module.
* Updated convert_all.py can now rename all command _help.py to foo.py and vice versa
* Updated loader to better handle group help and to mimic knack description loading.
* Moved acs help to correct file. Deleted yaml files.
* Updated _get_yaml_help_for_nouns to check all possible loader paths for command group help. Minor updates to scripts.
* Added extension installation helpers to convert_all script. Remove unneccessary import in redis/_params.py
* Updated / Fixed test help loader.
* Address pylint
* Added --test to convert_all script.
* Aliased old example paramaeters with new params. Removed some todos.
pep8 fix.
* Updated authoring_help doc.
* Removed 'coming soon' comments and made other minor updates to authoring_help.md.
* Moved get_default_admin_username from core to vm. Updated usages of getpass.getusername to use get_default_admin_username which catches getuser's exception.
* Patched call to getpass.getuser when creating docs.
* Pacify Pylint
* Pacify Pep8
* Add the edit mapping for managedapp to doc_source_map.json
* Add the docs mapping for aks, functionapp, deployment and lock
* Change the key botservice to bot in doc edit mapping
* initial commit
* final changes for cli
* fixed flake errors and added license headers
* more errors
* add botservice to the document source map
* missed comma
* fixes for flake
* addressing comments.
* attempt to fix build
* fix build
* checked build locally. this should succeed!
* fix cfg file
* fix more errors from build
* add manifest file. other fixes
* remove azure namespace package from setup.cfg
* update manifest to have correct parts to json files. update Bot to bot in docs
* added bdist_wheel file
* add nspkg
* add scope separator. also add package_data to setup.py
* add provider scope string
* correct sms example help. fix other create docs
* disable test check as it throws an exception on ci. enable later
* another try
* make urlparse python version independent
* fixed logic around bot download. amended error message for failed msa app provisioning
* fix indendation
* more documentation fixes as per comments
* added custom flag for generic commands
* added custom_command arg to each generic cmd registering method
* add custom flag to resolve_operations hidden method
* check for 'client' as a client_arg_name
* converted all custom show commands
* added description loader for generic_show
* bug fix for 'cmd' in command signature
* added catch for sys.exit in test base
* convert show commands registered with 'command()'
* fixed failing tests since show will now fail on missing resources
* removed exception_handler=empty_on_404 for commands using generic_show
* fix style
* bump versions
* updated history
update with minor version bump
* billing history version bump
* updated generic show/wait to custom_command/command pattern
* pep8
style
* fixes
called wrong method
* addressed comments
* removed getter_type arg from wait/show
* added documentation for new command registration methods
* addressed more comments
* added generic show method
* use generic_show_command for storage account show as example
* style and history
* exit with 3 if show gives back 404
* added exit code docs
* pass args to factory
* disable too many lines pylint
* added tests for exit codes of storage account show
* consolidated code
* updated command guidelines for show
* update arm api-version
* Introduce LocationBasedServices command_module
* Introduce test cases for LocationBasedServices command_module
* [Refactor] Renamed lbs to locationbasedservices
* [Refactor] Renamed lbs to locationbasedservices
* [Legal] Add the Preview Terms agreement requirement
- Add the Preview Terms agreement requirement
- Remove location, custom_header, and raw parameters for account operations.
* [Test] Add more strict assertion rule for key validation.
* [Test] Add test for tags parameter
* [Test] Added an additional resource group.
* [Test] Init recordings
* [Pylint] Specify string format arguments as logging function parameters
* [Refactor] Update description in _help to match the general template
* [Refactor] General template mismatch fix for 'key'
* [Feature] Introduce search by ids
[Fix] --key-type, -t are now --key
* [Temporary] Throw an exception on 'account show' command, when nonexist
* [Test] 'account show' on non-existent account should not return empty.
* [Feature] Introduce update command
[Refactor] get_account command now specifically throws error only if it's a 404 response.
* [Test] Add test for update and search by id
[Output] Added recordings
* [Refactor] Rename generic client (sync with updated Swagger)
* [Refactor] Use default SDK's function
* [Refactor] Remove Preview Terms & docs in custom.py
* [Maps] Rename LocationBasedServices to Maps
* [Maps] Use Maps SDK from LocationBasedServices SDK
* [Maps] Update dependencies
* [Maps] Resolving build error (doc_source_map)
* [Maps] Resolving PR issues.
Removed validators.py. Will be adding checks in REST API specs and our backend routes to avoid redundancy.
Updated azure_bdist_wheel.py
Introduced minor fixes.
* [Maps] Revise help text
* [Maps] Adding back help docs for maps account
Misinterpreted PR comment.
* [Load Test] replace sql with servicefabric
* Ref doc gen: Format user directory as ~ and use forward slashes
* Add CI step to verify ref doc gen
* Make script executable
* Preserve backslashes in example text
* Update authoring_commands.md
Adds guidance for suppressing --ids on list commands and supporting "name or id" type parameters.
* Add generic update for PATCH-based endpoints
* EventHubs CLI cmdlets
* removed Encoding param a it has a default value
* review comments
* updated history with version
* --ids should not displayed for list commands fix
* updated list commands
* review updates and recordings
* extension suppression code and recordings
* lint fixes
* update - support for Name or ARM Id for storageAccount in EH creation/update
* removed default for sku in update cmd
* consumergroup list no ids fix and help text
* validator fix
* review comments updated
* Consumer-Group test recording
* lint fixes
* review comments
* Servicebus on board
* Module Loading Performance fix
* review comments upodated
* updated history file with version
* review comments, extension supperssion code and recordings
* lint fixes
* updates- support name or ID for GEO DR patner_namespace
* removed default for sku in update
* review updates and help text fixes
* help fixes, capacity validator and recordings
* review comments and recordings
* [core]: correct usage of "delimiter-separated" in help strings
* [doc/]: correct usage of "delimiter-separated" in command authoring doc
* [ACR]: correct usage of "delimiter-separated" in help strings
* [tools/]: correct usage of "delimiter-separated" in help strings
* [Advisor]: correct usage of "delimiter-separated" in help strings
* [AKS]: correct usage of "delimiter-separated" in code comment
* [AppService]: correct usage of "delimiter-separated" in help strings
* [Batch]: correct usage of "delimiter-separated" in help strings
* [ARM]: correct usage of "delimiter-separated" in help string
* [CDN]: correct usage of "delimiter-separated" in help strings
* [configure]: correct usage of "delimiter-separated" in help strings
* [ACI]: correct usage of "delimiter-separated" in help strings
* [CosmosDB]: correct usage of "delimiter-separated" in help strings
* [EventGrid]: correct usage of "delimiter-separated" in help strings
* [IoT]: correct usage of "delimiter-separated" in help strings
* [KeyVault]: correct usage of "delimiter-separated" in help strings
* [DevTestLabs]: correct usage of "delimiter-separated" in help strings
* [Monitor]: correct usage of "delimiter-separated" in help strings
* [Network]: correct usage of "delimiter-separated" in help strings
* [rdbms]: correct usage of "delimiter-separated" in help string
* [VM]: correct usage of "delimiter-separated" in help strings
* [resource]: correct usage of "delimiter-separated" in help strings
* [role]: correct usage of "delimiter-separated" in help strings
* [ServiceFabric: correct usage of "delimiter-separated" in help strings
* [Storage]: correct usage of "delimiter-separated" in help strings
* Update latest versions in setup.py to match HISTORY.rst
* Bump versions of three modules that were missed
* sp reset-credentials from dev
* rebase polish rbac error message
* rebase role assignment list: show default assignments for classic administrators
* Modified AzureUSGov Endpoint to .US (#4877)
* Modified AzureUSGov Endpoint to .US
* Updated History.RST to include USGovAADEndPoint Change
* Updated Setup.py to match HISTORY.RST
* Reduced previous change in HISTORY.RST to a single line
* HISTORY.rst merge with latest commit
* HISTORY.RST Syntax Correction
* webapp/functionapp: ensure list/show display correct set of apps (#4891)
* Fix authoring doc typo (#4903)
* Changing CLI for azure-consumption reflecting the new api-version (#4900)
* Changing CLI for azure-consumption reflecting the new api-version
* Modifying Setup.py and history.rst
* Implementing review comments
* Rebase remove component module
* [acr] typo fix in help (#4904)
* [acr] typo fix in help
* [acr] bump version and add history line item
* Rebase of support raw format on resource show
* Web: add node appsetting when runtime is not specified (#4907)
* webapp: fix a bug in the cert name generation (#4909)
* Fix container module default ports (#4950)
* fix default ports
* bump up version
* update history
* Advisor command module (#4898)
* Initial change to add Advisor module.
* Add list recommendations command.
* More commands.
* More commands.
* Pylint fixes and adding a test.
* More updates.
* More updates.
* Fixing precheck errors.
* Fixing more precheck errors.
* Initial change to add Advisor module.
* Add list recommendations command.
* More commands.
* More commands.
* Pylint fixes and adding a test.
* More updates.
* More updates.
* Fixing precheck errors.
* Fixing more precheck errors.
* Adding missing manifest.
* Fixes for test failures.
* Addressing review comments and add unit tests.
* More fixes.
* Address CI failures.
* Extra space.
* One more fix.
* rebase sql usage commands.
* Add advisor to default install (#4956)
* Add consumption module to code owners (#4906)
* Added sql server conn-policy show/update commands (#4888)
* Update proj file
Squashed commits:
[9ba81a9] Handle confirmation in knack also (+2 squashed commits)
Squashed commits:
[b548356] Some fixes
[c879395] Some more stuff (+1 squashed commit)
Squashed commits:
[0a619f2] Update knack dep to 0.3.0 and pin it
- Remove `self.module_name` as no longer needed in knack 0.3.0
* Extensions: support adding by name and list-available
- Update extension publishing readme with new info
- Implement 'az extension list-available'
- Support adding an extension by name
- Define logic for extension update
- Support --index hidden param
- Explicitly only support non platform specific whls
- Add tests
* Minor change
* Added new id_part values where they are used in CLI
Implemented multiple levels for --ids in CLI
* use msrestazure resource tools
* updated docs for --ids values
* import msrestazure inside methods for azure.cli.core, removed resource_id test from cli as it is part of msrestazure
* msrestazure.tools
* BatchAI. Initial drop of azure-cli-batchai.
* BatchAI. Getting rid of legacy "learning" term.
The old service name "Batch AI Learning" has been changed to "Batch AI",
so we need to update all environment variables names.
* BatchAI. Added scenario for configless cluster and nfs creation
* BatchAI. Update cluster resize and cluster auto-scale.
After adding payload-flattening-threshold=2, cluster.update signature
changed. Updating affected commands.
* Adding recovery services module
list container working
refactoring, added methods
list and show item
enable protection (part)
Disable protection just started
Enable and disable protection
Removing recoveryservices (duplicate) module
Including backup command module
Removing unwanted files
Addressing review comments.
* Adding backup tests
Fixed json load from input param
Extend scenario in test
Pylint fixes
cli for backup
cli for backup
Updated rs backup nuget version
* Updating backup help
Took review comments
Pylint changes
Fixed formatting issue in help file
* Implementing flake8 and pylint suggestions for backup
Updated help
Limit every other workload except 'AzureVM' by giving a proper error message
Fixed some bugs
* bugfixes
* Updated test recordings
* Adding Instant File Recovery for Windows VM in backup
Fixing case sensitive bugs
Fixing case sensitive bugs
Fixing bug - found inconsistencies in case of unique name sent by service.
* Implementing File Restore for Linux VMs in backup
urllib python 2 and 3 compatibility
enforcing password in ILR
Help messages and ilr test
ilr
Flake8 passing
Add manifest
table transformers and six.moves.
six.moves changes
Disabling some pylint warnings
item list bug fix
item list bug fix
pylint and flake8 passed
Deleting unwanted files
newline bugfix
Fixing the unicode issue
fixed password bug with linux scripts for ILR
Added table transformers
vault test case recording
Added cleanup in preparers
Removing randomization in dict iteration.
fixing linux script download bug
Adding custom client request header
Adding test recordings
updated policy recording
policy test recording
item test recording
protection test recording
backup restore test recording
backup restore test recording
test restore recording
test rp recording
test job recording
* Using self.assertxx series in backup test
Removing unwanted files
pylint failure fix
Adding wheel.py and setup.cfg files
Adding draft recovery services module
list container working
list and show item
enable protection (part)
Enable and disable protection
Removing recoveryservices (duplicate) module
Including backup command module
Removing unwanted files
Adding test to backup
Fixed json load from input param
Extend scenario in test
cli for backup
Updated help
Fixed some bugs
bugfixes
ilr
Flake8 passing
Add manifest
item list bug fix
Deleting unwanted files
Removing unwanted files
Updating test recordings after sync with upstream
post rebase fixes - all backup tests passing
* post build checks passing
* Fixed parameter names and command tree
* Update version to 'unreleased'
* item --ids
* backup restore test working
* Enable IDs.
* policy and items tests passing --ids change
* protection named params change - protection test passing + pylint and flake8
* job named params change - pylint and flake8 passing
* rp named params change. pylint and flake8 passing.
* restore param names change. flake8 and pylint passed.
* Fixing bugs in restore and recoverypoint
* fixing item test bug
* container and policy tests passing.
* test bug fix + recordings
* backup restore and rp test recordings
* fix bug in restore test + pylint and flake8 passing.
* disabling --ids
* Table formatting for job and rp
* restore test recording
* Enhancements to user experience: added warning and help text in job and JSON related commands.
* Changes:
1. Ignored container_type and item_type
2. VM and Storage Account - Name or ID
3. restore-disks and restore-files
* Add extension feature
- deprecate ‘az component’ message
- add tests
- add documentation
* Fix extra comma in setup.py file
* Add version checking for extensions (with tests)
* Address code review feedback
* Address code review comments and add back in license.
* Address more code review feedback
* Remove confirm param
* Print warning messages on extension commands and help
* Remove EXT_TYPE constant and just have 'whl' twice
* Show appropriate message if unable to get extension name.
* Centralize warning message
* Only get the first part of the module path to get the module name
* Print extension directory in 'az --version'
* Add logging to show extension directory in debug
* First version of Azure EventGrid CLI
* Added azure_bdist_wheel.py, setup.cfg, and manifest.in files.
* Added license headers in 34 files, updated an example in the help file to include additional info.
* Aliased --is-subject-case-sensitive to --subject-case-sensitive.
After moving to the devtools, the original LiveTest stop working because
of the missing cmd function. The newly created LiveScenarioTest will
take over its place. The LiveTest will be eventually removed from the
devtools package since the live_only decorator is sufficent.
* Update example command module template
Now, it can be installed directly and works with latest code in master.
‘pip install -e .’
* Address code review feedback
Based on user feedback, added links to supporting documentation necessary for authoring command modules (the actual commands themselves, help and tests)
* Improvements to context/cloud commands
- Log info on the current active cloud to --debug.
- Add known clouds to config file as well.
- Show logger messages when switching cloud.
- Handle cloud switching in more user friendly way.
- Set cloud with CLI commands or AZURE_CLOUD_NAME env var.
- New commands ’az cloud set —name <NAME>’ and `az cloud update`
- Remove context.
- Remove configuration support for each context.
- Remove context options from ‘az configure’.
- Remove azure-cli-context command module.
- Blacklist the ‘context’ module to prevent it from being loaded.
* - Remove --default-subscription
- Account commands should be aware of current cloud
* Minor changes
- change method name
- catch additional exception
* Change error to warning
* Add Python 3.6 to CI
* Workaround for https://github.com/kevin1024/vcrpy/issues/293
- Do not run pylint on 3.6 as pylint doesn’t support 3.6 yet
- Add Python 3.6 to package classifiers
- When registering a command, add `confirmation=True` to enable user confirmation. Also supports a string message or callable.
- Add a —force flag for commands that support this feature.
- Integrated with configuration system so it can be enabled/disabled by setting AZURE_CORE_DISABLE_CONFIRM_PROMPT
Added for the following commands:
az group delete
az vm delete
az network dns zone delete
* Packaged release & Component release docs/setup
- Provide instructions on installing with brew
- Update docs on Homebrew packaging (how to update etc.)
- Remove the azure-cli-2 formula here as it’s in the homebrew repo now
- New packaged Docker image that builds from source and apply patches
- New Debian (apt-get) build instructions that build from source and apply patches
- Releasing components instructions
- Documentation on creating packaged releases
- Debian build automation
* Debian build script uses tmp directories so it is idempotent
Dependencies are defined in the setup.py file for each command module. That’s all that’s required.
The requirements.txt files in the command modules are never used.
- They are not required for dev_setup
- They do not get packaged when a command module is built
- Some of them hadn’t been updated for some time.
* Update and improve readability of install instructions
- Create common install issues doc
- Move developer set up
- Create Linux install prereq doc
- Additional component instructions
- Nightly instructions on README
- Remove pypi version shield
The PyPI version of azure-cli is not significant.
* lowercase install troubleshooting
* admin cmd prompt
Use the admin cmd prompt in to install the CLI (pip) on Windows
* punctuation
* Revert "admin cmd prompt"
This reverts commit ac57b1415a8d682ff223b00aa064bd92fdccff0c.
* Add plan group
* Web app group and command descriptions
* component group and command summaries
* Fix appservice plan group
* Consistent use of "Commands to ..." for groups
* Use long-summary
* Fix long-summary
* Fix caps & punctuation in login examples.
* language
* Fix account command summaries
* parens
* clarify that these are storage contexts
* group summaries
* typo
* Revert "clarify that these are storage contexts"
This reverts commit c82edd4f29c10e9d6639b6da87db6c35f6e84dbe.
* Fix iot device group
* Update _help.py
* redis commands
* Fix
* authoring help
* Doc quality
* missing command help
* availabilty set create/update
* az account
* vm wait
* vm extension list
* Fix quote
* az acs
* Fix bad quote
* Fix acs commands
* more bad quotes
* single quote
- Fix error running azhelpgen.py
-- To load the full command table with all parameter values, we iterate over the command table running -h on each command.
- Install links have changed
- AZURE_CLI_PRIVATE_PYPI_URL and AZURE_CLI_PRIVATE_PYPI_HOST no longer used
- 'az component install' -> 'az component update'
* Debian directories for Debian (apt-get) package & update README
- Packaging instructions (how to create the .deb file) will come later.
* Change link to the key
This is a breaking change to command modules and how they import cli modules!
- Don't depend on azure.cli in telemetry code
- Don't depend on azure.cli for version
- Move ACCOUNT, CONFIG and SESSION to azure.cli.core (+3 squashed commits)
Squashed commits:
- Fix dev setup after azure-cli-core as module dep.
- Install command modules after core is installed (+7 squashed commits)
- Command modules should depend on azure-cli-core
- Fix install script to work with new packages
- Nightly build script modifications
- Load module and fallback to all if doesn't work
- Fix Dockerfile
- No modules found, no problem
- Modify package_verify to work with new package structure
- modify .travis.yml file for CI builds to work again
- fix dev_setup
- import modules differently
- Move stuff
* Add tagging to VM and WebApp, refactor to eliminate nested templates
* Add copyright headers to generated files. Also add a script that can auto-add the copyright to all *.py files. Update the generate smart create script to add headers so we don't have to run the auto-add script after regenerating.
* Fix up README & add LICENSE
* move our scripts
* Add license headers
* modify setup.py with license in classifiers
* Change license from TBD to MIT
* Use contoso.com instead of test.com for url used in test and modify preview instructions
* Add license header to new file recently added
* added first draft of preview instructions
* added first draft of preview instructions
* added first draft of preview instructions
* added first draft of preview instructions
* Updated preview instructions.
* Create preview_demo_scripts.md
* Update preview_instructions.md
* Moved troubleshooting to a link back to the readme
* Update preview_demo_scripts.md
Travis Prescott
Yugang Wang
adewaleo
Yadi Reyes
oflipman
Stephen Tramer
chlahav
John Eismeier
Ankit Goyal
wawon-msft
Johan Stenberg (MSFT)
Chenyang Liu
swagat mishra
Justin Emgarten
Clemens Vasters
Yang Yuan
Willie Xu
Noel
bulentelmaci
James Park
Derek Bekoe
Troy Dai
vchske
Ernest Wong
Lucas Marambio
Brendan Burns
Laurent Mazuel
Ian Griffiths
Ajit Navasare
Matt Boersma
hyo
AlexanderYukhanov
samedder
georgechenchao
mhaslett
QingChenmsft
J. Kalyana Sundaram
Chen
Ian McCowan
Suhail Dawood
Panda Wang
Mohammad Derakhshani
Sarthak Narang
Qinen.Zhu
Payam Hekmat
Allen Clark
erich-wang
Vishrut Shah
Jun Han
Jason R. Shaver
Burt Bielicki
Derek Bekoe
Travis Prescott