How to run Azure CLI commands using python?

I have been implementing this over the last couple days. The method that @cbehrenberg provides is mostly what I used, but I found that you can do it without using a temporary file. Instead catch the output directly from the azure client. Thought it might be useful.

from azure.cli.core import get_default_clidef az_cli (args_str):    args = args_str.split()    cli = get_default_cli()    cli.invoke(args)    if cli.result.result:        return cli.result.result    elif cli.result.error:        raise cli.result.error    return True

Then invoked the same way:

from azhelper import az_cliresponse = az_cli("vm list")print("vm's: %s" % (response))

How to run Azure CLI commands using python?

According to this file. we could invoke the Azure CLI with following way:

from azure.cli.core import get_default_cliget_default_cli().invoke(['vm', 'list', '-g', 'groupname'])

Note : If you get No module named 'azure.cli.command_modules' error, please install azure-cli

Using the subprocess solution is problematic as subprocess doesn't check the PATH where Azure CLI is found e.g. on Windows. To use "cmd -c" would be a Windows-specific solution and needs a fork if/else for additional Linux support.

@tom-sun's answer is almost correct, as you can reuse the Azure CLI python modules, as the CLI is also written in Python. Problem is, that the return of the .invoke() instruction is always returning the error code. To get the full body response, you must pass a file like object on the argument list of the underlying Knack Code to get the response. By default, this redirects to StdOut, that is why you can see it e.g. in your terminal but you always get a zero for success.

I wrote a little helper function that accepts the Azure CLI instructions in one string (I don't like many arguments as list, it doesn't read nicely - but that is just a personal preference, don't blame me). It uses a temporary file as output target and then it is read back in memory - this is required afaik from the underlying Knack CLI code; by default StdOut is the standard pipe.

It requires you to have azure-cli installed for Python: pip install azure-cli

File azhelper.py:

from azure.cli.core import get_default_cliimport tempfiledef az_cli (args_str):    temp = tempfile.TemporaryFile()    args = args_str.split()    code = get_default_cli().invoke(args, None, temp)    temp.seek(0)    data = temp.read().strip()    temp.close()    return [code, data]

You can then invoke like this:

from azhelper import *code, response = az_cli("vm list")print("vm's: %s" % (response))

Of course you need to be logged in, see @4c74356b41 answer.

If somebody finds a better way to deal with the response instead with a temporary file, this would be much appreciated! I tried with an in memory StringIO object but this somehow doesn't comply with the underlying Knack CLI code.