1
0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-11 23:53:43 +08:00
ohmyzsh/plugins/azure/README.md
Julien Rottenberg 379fe0fe13
feat(azure): add azure plugin (#8848)
Co-authored-by: hagridaaron <hagridaaron@gmail.com>
Co-authored-by: Terry <tmoschou@gmail.com>

Closes #8847
2023-02-07 12:33:59 +01:00

1.5 KiB

azure

This plugin provides completion support for azure cli
and a few utilities to manage azure subscriptions and display them in the prompt.

To use it, add azure to the plugins array in your zshrc file.

plugins=(... azure)

Plugin commands

  • az_subscriptions: lists the available subscriptions in the AZURE_CONFIG_DIR (default: ~/.azure/).
    Used to provide completion for the azss function.

  • azgs: gets the current value of $azure_subscription.

  • azss [<subscription>]: sets the $azure_subscription.

NOTE : because azure keeps the state of active subscription in ${AZURE_CONFIG_DIR:-$HOME/.azure/azureProfile.json}, the prompt command requires jq to be enabled to parse the file. If jq is not in the path the prompt will show nothing

Theme

The plugin creates an azure_prompt_info function that you can use in your theme, which displays
the current $azure_subscription. It uses two variables to control how that is shown:

  • ZSH_THEME_AZURE_PREFIX: sets the prefix of the azure_subscription. Defaults to <az:.

  • ZSH_THEME_azure_SUFFIX: sets the suffix of the azure_subscription. Defaults to >.

RPROMPT='$(azure_prompt_info)'

Develop

On ubuntu get a working environment with :

docker run -it -v $(pwd):/mnt -w /mnt ubuntu bash

apt install -y curl jq zsh git vim
sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
curl -sL https://aka.ms/InstallAzureCLIDeb | bash