Microsoft Atomic Azure CLI Dev Tools

The aaz-dev tool is designed to generate atomic Azure CLI commands from OpenAPI specifications. For more information, please refer to document and video.

Installation

Currently, we can install it with a .whl file. Later on, we'll publish it to PyPI to support pip install way of installation.

Setting up your development environment

1 Code repos

Please Fork the following repos in your github account and Clone them in your local disk:

• Azure CLI
• Azure CLI Extension
• AAZ: Used to upload the command model generated.
• azure-rest-api-specs or azure-rest-api-specs-pr

After clone you can add upstream for every repos in your local clone by using git remote add upstream.

2 Setup python

2.1 Install python

Please install python with version >= 3.8 and <= 3.12 in your local machine.

• For windows: You can download and run full installer from Python Download.
• For linux: You can install python from Package Manager or build a stable relase from source code

Check the version of python, make use it's not less than 3.8.

• For windows: You can run:

  C:\Users\{xxxx}\AppData\Local\Programs\Python\Python3{xxxx}\python --version
  

  C:\Users\{xxxx}\AppData\Local\Programs\Python\Python3{xxxx} is the python installation path.
• For linux:

  python --version
  

  You can also specify the version number when you have multiple versions installed. For example if you want to run version 3.12

  python3.12 --version
  

2.2 Setup a python virtual environment

You can use venv to create virtual environments, optionally isolated from system site directories. Each virtual environment has its own Python binary (which matches the version of the binary that was used to create this environment) and can have its own independent set of installed Python packages in its site directories.

You can run the following command to create a new virtual environment:

• For windows:

  C:\Users\{xxxx}\AppData\Local\Programs\Python\Python3{xxxx}\python -m venv {some path}\{venv name}
  

• For linux:

  python3.12 -m venv {some path}/{venv name}
  

3 Active existing virtual environment

You should always active the virtual environment for azure-cli development.

• For Windows:
  • Powershell

  {some path}\{venv name}\Scripts\Activate.ps1
  

  • Command Prompt

  {some path}\{venv name}\Scripts\activate.bat
  

• For Linux:

source {some path}/{venv name}/bin/activate

After active the virtual environment, the python command will always be the one creates this virtual environment and you can always use python

python --version

4 Install tools for azure-cli development

4.1 Install azure-cli-dev-tools

Both for windows and linux

pip install azdev

4.2 Install aaz-dev-tools

• For Windows
  • Powershell

  pip install aaz-dev
  

  • Command Prompt

  pip install aaz-dev
  

• For linux

  pip install aaz-dev
  

4.3 Set up build env

• For linux users, set up python3 build tools would avoid other unseen installation issues

  Ubuntu: apt-get install python3-dev build-essential
  Centos: yum install python3-devel
  

4.4 Possible problems

• For windows users, dependency python-levenshtein installation might run into trouble. developers might need to download .whl file and install it manually (reference to link)

5. Code repos setup

5.1 azure-cli

Before start to the development task, you should always sync the code in the dev branch of upstream(Azure/Azure-cli). If your commands will generated to azure-cli repo, you should checkout a new branch with feature- prefix.

5.2 azure-cli-extensions

If your commands will generated to azure-cli-extension repo, you should sync the code in the main branch of upstream(Azure/Azure-cli-extensions), and checkout a new branch with feature- prefix.

5.3 aaz

Before start to the development task, you should always sync the change in the main branch of upstream, and checkout a new branch with feature- prefix.

5.4 run azdev setup

You should always run the following command everytime you sync azure-cli code of upstream.

azdev setup --cli {path to azure-cli} --repo {path to azure-cli-extensions}

6 Run aaz-dev-tools

aaz-dev run -c {path to azure-cli} -e {path to azure-cli-extensions} -s {path swagger or swagger-pr} -a {path to aaz}

Before using generated commands

1. Make sure you have logined by az login.
2. Make sure you have switched to the subscription for test by az account set -s {subscription ID for test}
3. If your commands are in extensions, make sure you have loaded this extension by azdev extension add {your extension name}

Other documentations

• extension
• command guidelines
• authoring tests
• shorthand syntax: Azure cli shorthand syntax can help cli users to pass complicated argument values. Only the arguments of AAZ(Atomic Azure CLI) commands generated by aaz-dev tool support shorthand syntax.

Submit code and command models

After finish the development, you should push the change in your forked repos first, and the create a Pull Request to upstream repos.

• azure-cli: create a Pull Request to dev branch of Azure/azure-cli
• azure-cli-extensions: create a Pull Request to main branch of Azure/azure-cli-extensions
• aaz: create a Pull Request to main branch of Azure/azz

Reporting issues and feedback

If you encounter any bugs with the tool please file an issue in the Issues section of our GitHub repository.

License

MIT License

Copyright (c) Microsoft Corporation. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ""Software""), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.