def main(args, file=sys.stdout): # pylint: disable=redefined-builtin
azlogging.configure_logging(args)
logger.debug('Command arguments %s', args)
if len(args) > 0 and args[0] == '--version':
show_version_info_exit(file)
azure_folder = get_config_dir()
if not os.path.exists(azure_folder):
os.makedirs(azure_folder)
ACCOUNT.load(os.path.join(azure_folder, 'azureProfile.json'))
CONFIG.load(os.path.join(azure_folder, 'az.json'))
SESSION.load(os.path.join(azure_folder, 'az.sess'), max_age=3600)
APPLICATION.initialize(Configuration())
try:
cmd_result = APPLICATION.execute(args)
# Commands can return a dictionary/list of results
# If they do, we print the results.
if cmd_result and cmd_result.result is not None:
from azure.cli.core._output import OutputProducer
formatter = OutputProducer.get_formatter(APPLICATION.configuration.output_format)
OutputProducer(formatter=formatter, file=file).out(cmd_result)
except Exception as ex: # pylint: disable=broad-except
# TODO: include additional details of the exception in telemetry
telemetry.set_exception(ex, 'outer-exception',
'Unexpected exception caught during application execution.')
telemetry.set_failure()
error_code = handle_exception(ex)
return error_code
def send_telemetry(self):
import azure.cli.core.telemetry as telemetry
telemetry.set_error_type(self.error_type.value)
# For userfaults
if self.error_type in [
AzCLIErrorType.CommandNotFoundError,
AzCLIErrorType.ArgumentParseError,
AzCLIErrorType.ValidationError, AzCLIErrorType.ManualInterrupt
]:
telemetry.set_user_fault(self.error_msg)
# For failures: service side error, client side error, unexpected error
else:
telemetry.set_failure(self.error_msg)
# For unexpected error
if self.raw_exception:
telemetry.set_exception(self.raw_exception, '')
def main(args, output=sys.stdout, logging_stream=None):
configure_logging(args, logging_stream)
logger = get_az_logger(__name__)
logger.debug('Command arguments %s', args)
if args and (args[0] == '--version' or args[0] == '-v'):
show_version_info_exit(output)
azure_folder = get_config_dir()
if not os.path.exists(azure_folder):
os.makedirs(azure_folder)
ACCOUNT.load(os.path.join(azure_folder, 'azureProfile.json'))
CONFIG.load(os.path.join(azure_folder, 'az.json'))
SESSION.load(os.path.join(azure_folder, 'az.sess'), max_age=3600)
APPLICATION.initialize(Configuration())
try:
cmd_result = APPLICATION.execute(args)
# Commands can return a dictionary/list of results
# If they do, we print the results.
if cmd_result and cmd_result.result is not None:
from azure.cli.core._output import OutputProducer
formatter = OutputProducer.get_formatter(
APPLICATION.configuration.output_format)
OutputProducer(formatter=formatter, file=output).out(cmd_result)
except Exception as ex: # pylint: disable=broad-except
# TODO: include additional details of the exception in telemetry
telemetry.set_exception(
ex, 'outer-exception',
'Unexpected exception caught during application execution.')
telemetry.set_failure()
error_code = handle_exception(ex)
return error_code
uuid.uuid1 = uuid.uuid4
logger = get_logger(__name__)
def cli_main(cli, args):
return cli.invoke(args)
az_cli = get_default_cli()
telemetry.set_application(az_cli, ARGCOMPLETE_ENV_NAME)
try:
telemetry.start()
exit_code = cli_main(az_cli, sys.argv[1:])
if exit_code and exit_code != 0:
telemetry.set_failure()
else:
telemetry.set_success()
sys.exit(exit_code)
except KeyboardInterrupt:
telemetry.set_user_fault('keyboard interrupt')
sys.exit(1)
finally:
telemetry.conclude()
def upgrade_version(cmd, update_all=None, yes=None): # pylint: disable=too-many-locals, too-many-statements, too-many-branches, no-member, unused-argument
import os
import platform
import sys
import subprocess
import azure.cli.core.telemetry as telemetry
from azure.cli.core import __version__ as local_version
from azure.cli.core._environment import _ENV_AZ_INSTALLER
from azure.cli.core.extension import get_extensions, WheelExtension
from distutils.version import LooseVersion
from knack.util import CLIError
update_cli = True
from azure.cli.core.util import get_latest_from_github
try:
latest_version = get_latest_from_github()
if latest_version and LooseVersion(latest_version) <= LooseVersion(
local_version):
logger.warning("You already have the latest azure-cli version: %s",
local_version)
update_cli = False
if not update_all:
return
except Exception as ex: # pylint: disable=broad-except
logger.debug("Failed to get the latest version. %s", str(ex))
exts = [ext.name for ext in get_extensions(
ext_type=WheelExtension)] if update_all else []
exit_code = 0
installer = os.getenv(_ENV_AZ_INSTALLER) or ''
installer = installer.upper()
if update_cli:
latest_version_msg = 'It will be updated to {}.'.format(latest_version) if yes \
else 'Latest version available is {}.'.format(latest_version)
logger.warning("Your current Azure CLI version is %s. %s",
local_version, latest_version_msg)
from knack.prompting import prompt_y_n
if not yes:
confirmation = prompt_y_n(
"Please check the release notes first: https://docs.microsoft.com/"
"cli/azure/release-notes-azure-cli\nDo you want to continue?",
default='y')
if not confirmation:
telemetry.set_success("Upgrade stopped by user")
return
if installer == 'DEB':
from azure.cli.core.util import in_cloud_console
if in_cloud_console():
raise CLIError("az upgrade is not supported in Cloud Shell.")
apt_update_cmd = 'apt-get update'.split()
az_update_cmd = 'apt-get install --only-upgrade -y azure-cli'.split(
)
if os.geteuid() != 0: # pylint: disable=no-member
apt_update_cmd.insert(0, 'sudo')
az_update_cmd.insert(0, 'sudo')
exit_code = subprocess.call(apt_update_cmd)
if exit_code == 0:
logger.debug("Update azure cli with '%s'",
" ".join(apt_update_cmd))
exit_code = subprocess.call(az_update_cmd)
elif installer == 'RPM':
from azure.cli.core.util import get_linux_distro
distname, _ = get_linux_distro()
if not distname:
logger.warning(UPGRADE_MSG)
else:
distname = distname.lower().strip()
if any(x in distname
for x in ['centos', 'rhel', 'red hat', 'fedora']):
update_cmd = 'yum update -y azure-cli'.split()
if os.geteuid() != 0: # pylint: disable=no-member
update_cmd.insert(0, 'sudo')
logger.debug("Update azure cli with '%s'",
" ".join(update_cmd))
exit_code = subprocess.call(update_cmd)
elif any(x in distname for x in ['opensuse', 'suse', 'sles']):
zypper_refresh_cmd = ['zypper', 'refresh']
az_update_cmd = 'zypper update -y azure-cli'.split()
if os.geteuid() != 0: # pylint: disable=no-member
zypper_refresh_cmd.insert(0, 'sudo')
az_update_cmd.insert(0, 'sudo')
exit_code = subprocess.call(zypper_refresh_cmd)
if exit_code == 0:
logger.debug("Update azure cli with '%s'",
" ".join(az_update_cmd))
exit_code = subprocess.call(az_update_cmd)
else:
logger.warning(UPGRADE_MSG)
elif installer == 'HOMEBREW':
logger.warning("Update homebrew formulae")
exit_code = subprocess.call(['brew', 'update'])
if exit_code == 0:
update_cmd = ['brew', 'upgrade', 'azure-cli']
logger.debug("Update azure cli with '%s'",
" ".join(update_cmd))
exit_code = subprocess.call(update_cmd)
elif installer == 'PIP':
pip_args = [
sys.executable, '-m', 'pip', 'install', '--upgrade',
'azure-cli', '-vv', '--disable-pip-version-check',
'--no-cache-dir'
]
logger.debug("Update azure cli with '%s'", " ".join(pip_args))
exit_code = subprocess.call(pip_args,
shell=platform.system() == 'Windows')
elif installer == 'DOCKER':
logger.warning(
"Exit the container to pull latest image with 'docker pull mcr.microsoft.com/azure-cli' "
"or run 'pip install --upgrade azure-cli' in this container")
elif installer == 'MSI':
logger.debug(
"Update azure cli with MSI from https://aka.ms/installazurecliwindows"
)
exit_code = subprocess.call(['powershell.exe', '-NoProfile', "Start-Process msiexec.exe -Wait -ArgumentList '/i https://aka.ms/installazurecliwindows'"]) # pylint: disable=line-too-long
else:
logger.warning(UPGRADE_MSG)
if exit_code:
telemetry.set_failure("CLI upgrade failed.")
sys.exit(exit_code)
# Updating Azure CLI and extension together is not supported in homebrewe package.
if installer == 'HOMEBREW' and exts:
logger.warning("Please rerun 'az upgrade' to update all extensions.")
else:
for ext_name in exts:
try:
logger.warning("Checking update for %s", ext_name)
subprocess.call(['az', 'extension', 'update', '-n', ext_name],
shell=platform.system() == 'Windows')
except Exception as ex: # pylint: disable=broad-except
msg = "Extension {} update failed during az upgrade. {}".format(
ext_name, str(ex))
raise CLIError(msg)
logger.warning("Upgrade finished.")
def send_telemetry(self):
super().send_telemetry()
telemetry.set_failure(self.error_msg)
if self.exception_trace:
telemetry.set_exception(self.exception_trace, '')
def send_telemetry(self):
super().send_telemetry()
telemetry.set_failure(self.error_msg)
def upgrade_version(cmd, update_all=None, yes=None): # pylint: disable=too-many-locals, too-many-statements, too-many-branches, no-member, unused-argument
import os
import platform
import sys
import subprocess
import azure.cli.core.telemetry as telemetry
from azure.cli.core import __version__ as local_version
from azure.cli.core._environment import _ENV_AZ_INSTALLER
from azure.cli.core.extension import get_extensions, WheelExtension
from packaging.version import parse
from knack.util import CLIError
update_cli = True
from azure.cli.core.util import get_latest_from_github
try:
latest_version = get_latest_from_github()
if latest_version and parse(latest_version) <= parse(local_version):
logger.warning("You already have the latest azure-cli version: %s",
local_version)
update_cli = False
if not update_all:
return
except Exception as ex: # pylint: disable=broad-except
logger.debug("Failed to get the latest version. %s", str(ex))
exts = [ext.name for ext in get_extensions(
ext_type=WheelExtension)] if update_all else []
exit_code = 0
installer = os.getenv(_ENV_AZ_INSTALLER) or ''
installer = installer.upper()
if update_cli:
latest_version_msg = 'It will be updated to {}.'.format(latest_version) if yes \
else 'Latest version available is {}.'.format(latest_version)
logger.warning("Your current Azure CLI version is %s. %s",
local_version, latest_version_msg)
from knack.prompting import prompt_y_n, NoTTYException
if not yes:
logger.warning(
"Please check the release notes first: https://docs.microsoft.com/"
"cli/azure/release-notes-azure-cli")
try:
confirmation = prompt_y_n("Do you want to continue?",
default='y')
except NoTTYException:
from azure.cli.core.azclierror import UnclassifiedUserFault
raise UnclassifiedUserFault("No tty available.",
"Please run command with --yes.")
if not confirmation:
telemetry.set_success("Upgrade stopped by user")
return
if installer == 'DEB':
from azure.cli.core.util import in_cloud_console
if in_cloud_console():
raise CLIError("az upgrade is not supported in Cloud Shell.")
apt_update_cmd = 'apt-get update'.split()
az_update_cmd = 'apt-get install --only-upgrade -y azure-cli'.split(
)
if os.geteuid() != 0: # pylint: disable=no-member
apt_update_cmd.insert(0, 'sudo')
az_update_cmd.insert(0, 'sudo')
exit_code = subprocess.call(apt_update_cmd)
if exit_code == 0:
logger.debug("Update azure cli with '%s'",
" ".join(az_update_cmd))
exit_code = subprocess.call(az_update_cmd)
elif installer == 'RPM':
from azure.cli.core.util import get_linux_distro
distname, _ = get_linux_distro()
if not distname:
logger.warning(UPGRADE_MSG)
else:
distname = distname.lower().strip()
if any(x in distname
for x in ['centos', 'rhel', 'red hat', 'fedora']):
update_cmd = 'yum update -y azure-cli'.split()
if os.geteuid() != 0: # pylint: disable=no-member
update_cmd.insert(0, 'sudo')
logger.debug("Update azure cli with '%s'",
" ".join(update_cmd))
exit_code = subprocess.call(update_cmd)
elif any(x in distname for x in ['opensuse', 'suse', 'sles']):
zypper_refresh_cmd = ['zypper', 'refresh']
az_update_cmd = 'zypper update -y azure-cli'.split()
if os.geteuid() != 0: # pylint: disable=no-member
zypper_refresh_cmd.insert(0, 'sudo')
az_update_cmd.insert(0, 'sudo')
exit_code = subprocess.call(zypper_refresh_cmd)
if exit_code == 0:
logger.debug("Update azure cli with '%s'",
" ".join(az_update_cmd))
exit_code = subprocess.call(az_update_cmd)
else:
logger.warning(UPGRADE_MSG)
elif installer == 'HOMEBREW':
logger.debug("Update homebrew formulae")
exit_code = subprocess.call(['brew', 'update'])
if exit_code == 0:
update_cmd = ['brew', 'upgrade', 'azure-cli']
logger.debug("Update azure cli with '%s'",
" ".join(update_cmd))
exit_code = subprocess.call(update_cmd)
elif installer == 'PIP':
pip_args = [
sys.executable, '-m', 'pip', 'install', '--upgrade',
'azure-cli', '-vv', '--disable-pip-version-check',
'--no-cache-dir'
]
logger.debug("Update azure cli with '%s'", " ".join(pip_args))
exit_code = subprocess.call(pip_args,
shell=platform.system() == 'Windows')
elif installer == 'DOCKER':
logger.warning(
"Exit the container to pull latest image with 'docker pull mcr.microsoft.com/azure-cli' "
"or run 'pip install --upgrade azure-cli' in this container")
elif installer == 'MSI':
logger.debug(
"Update azure cli with MSI from https://aka.ms/installazurecliwindows"
)
exit_code = subprocess.call(['powershell.exe', '-NoProfile', "Start-Process msiexec.exe -Wait -ArgumentList '/i https://aka.ms/installazurecliwindows'"]) # pylint: disable=line-too-long
else:
logger.warning(UPGRADE_MSG)
if exit_code:
err_msg = "CLI upgrade failed."
logger.warning(err_msg)
telemetry.set_failure(err_msg)
sys.exit(exit_code)
# Avoid using python modules directly as they may have been changed due to upgrade.
# If you do need to use them, you may need to reload them and their dependent modules.
# Otherwise you may have such issue https://github.com/Azure/azure-cli/issues/16952
import importlib
import json
importlib.reload(subprocess)
importlib.reload(json)
version_result = subprocess.check_output(
['az', 'version', '-o', 'json'], shell=platform.system() == 'Windows')
version_json = json.loads(version_result)
new_version = version_json['azure-cli-core']
if update_cli and new_version == local_version:
err_msg = "CLI upgrade failed or aborted."
logger.warning(err_msg)
telemetry.set_failure(err_msg)
sys.exit(1)
if exts:
logger.warning("Upgrading extensions")
for ext_name in exts:
try:
logger.warning("Checking update for %s", ext_name)
subprocess.call(['az', 'extension', 'update', '-n', ext_name],
shell=platform.system() == 'Windows')
except Exception as ex: # pylint: disable=broad-except
msg = "Extension {} update failed during az upgrade. {}".format(
ext_name, str(ex))
raise CLIError(msg)
auto_upgrade_msg = "You can enable auto-upgrade with 'az config set auto-upgrade.enable=yes'. " \
"More details in https://docs.microsoft.com/cli/azure/update-azure-cli#automatic-update"
logger.warning(
"Upgrade finished.%s", "" if cmd.cli_ctx.config.getboolean(
'auto-upgrade', 'enable', False) else auto_upgrade_msg)
def set_failure(summary=None):
telemetry_core.set_failure(summary=summary)
def run(self):
""" runs the CLI """
telemetry.start()
self.cli.buffers['symbols'].reset(
initial_document=Document(u'%s' %shell_help)
)
while True:
try:
document = self.cli.run(reset_current_buffer=True)
text = document.text
cmd = text
outside = False
if text.split() and text.split()[0] == 'az':
cmd = ' '.join(text.split()[1:])
if self.default_command:
cmd = self.default_command + " " + cmd
# if self.default_params:
# for param in self.default_params:
# cmd += ' ' + param
except AttributeError: # when the user pressed Control Q
break
else:
if text.strip() == "quit" or text.strip() == "exit":
break
elif text.strip() == "clear": # clears the history, but only when you restart
outside = True
cmd = 'echo -n "" >' +\
os.path.join(
SHELL_CONFIGURATION.get_config_dir(),
SHELL_CONFIGURATION.get_history())
elif text.strip() == "help":
print(help_doc.dump(shell_help))
if text:
if text[0] == SELECT_SYMBOL['outside']:
cmd = text[1:]
outside = True
# elif text.split()[0] == "az": # dumps the extra az
# cmd = " ".join(text.split()[1:])
elif text[0] == SELECT_SYMBOL['exit_code']:
print(self.last_exit)
self.set_prompt()
continue
elif SELECT_SYMBOL['query'] in text: # query previous output
if self.last and self.last.result:
if hasattr(self.last.result, '__dict__'):
input_dict = dict(self.last.result)
else:
input_dict = self.last.result
try:
result = jmespath.search(
text.partition(SELECT_SYMBOL['query'])[2], input_dict)
if isinstance(result, str):
print(result)
else:
print(json.dumps(result, sort_keys=True, indent=2))
except jmespath.exceptions.ParseError:
print("Invalid Query")
self.set_prompt()
continue
elif "|" in text or ">" in text: # anything I don't parse, send off
outside = True
cmd = "az " + cmd
elif SELECT_SYMBOL['example'] in text:
global NOTIFICATIONS
cmd = self.handle_example(text)
if SELECT_SYMBOL['default'] in text:
default = text.partition(SELECT_SYMBOL['default'])[2].split()
if default[0].startswith('-'):
value = self.handle_default_param(default)
else:
value = self.handle_default_command(default)
print("defaulting: " + value)
self.set_prompt()
continue
if SELECT_SYMBOL['undefault'] in text:
value = text.partition(SELECT_SYMBOL['undefault'])[2].split()
if len(value) == 0:
self.default_command = ""
set_default_command("", add=False)
# self.default_params = []
print('undefaulting all')
elif len(value) == 1 and value[0] == self.default_command:
self.default_command = ""
set_default_command("", add=False)
print('undefaulting: ' + value[0])
# elif len(value) == 2 and ' '.join(value[:2]) in self.default_params:
# self.default_params.remove(' '.join(value[:2]))
# print('undefaulting: ' + ' '.join(value[:2]))
self.set_prompt()
continue
if not text: # not input
self.set_prompt()
continue
self.history.append(cmd)
self.set_prompt()
if outside:
subprocess.Popen(cmd, shell=True).communicate()
else:
try:
args = [str(command) for command in cmd.split()]
azlogging.configure_logging(args)
azure_folder = get_config_dir()
if not os.path.exists(azure_folder):
os.makedirs(azure_folder)
ACCOUNT.load(os.path.join(azure_folder, 'azureProfile.json'))
CONFIG.load(os.path.join(azure_folder, 'az.json'))
SESSION.load(os.path.join(azure_folder, 'az.sess'), max_age=3600)
config = Configuration(args)
self.app.initialize(config)
result = self.app.execute(args)
if result and result.result is not None:
from azure.cli.core._output import OutputProducer, format_json
if self.output:
self.output.out(result)
else:
formatter = OutputProducer.get_formatter(
self.app.configuration.output_format)
OutputProducer(formatter=formatter, file=self.input).out(result)
self.last = result
self.last_exit = 0
except Exception as ex: # pylint: disable=broad-except
self.last_exit = handle_exception(ex)
except SystemExit as ex:
self.last_exit = ex.code
if self.last_exit != 0:
telemetry.set_failure()
else:
telemetry.set_success()
print('Have a lovely day!!')
telemetry.conclude()