azure-cli


Nameazure-cli JSON
Version 2.59.0 PyPI version JSON
download
home_pagehttps://github.com/Azure/azure-cli
SummaryMicrosoft Azure Command-Line Tools
upload_time2024-04-02 07:05:55
maintainerNone
docs_urlNone
authorMicrosoft Corporation
requires_python>=3.8.0
licenseMIT
keywords
VCS
bugtrack_url
requirements setuptools pip
Travis-CI No Travis.
coveralls test coverage
            Microsoft Azure CLI
===================

A great cloud needs great tools; we're excited to introduce *Azure CLI*, our next generation multi-platform command line experience for Azure.

Usage
=====
.. code-block:: console

    $ az [ group ] [ subgroup ] [ command ] {parameters}


Getting Started
=====================

After installation, use the ``az configure`` command to help setup your environment.

.. code-block:: console

   $ az configure

For usage and help content, pass in the ``-h`` parameter, for example:

.. code-block:: console

   $ az storage -h
   $ az vm create -h

Highlights
===========

Here are a few features and concepts that can help you get the most out of the Azure CLI.

The following examples are showing using the ``--output table`` format, you can change your default using the ``$ az configure`` command.

Tab Completion
++++++++++++++

We support tab-completion for groups, commands, and some parameters

.. code-block:: console

   # looking up resource group and name
   $ az vm show -g [tab][tab]
   AccountingGroup   RGOne  WebPropertiesRG
   $ az vm show -g WebPropertiesRG -n [tab][tab]
   StoreVM  Bizlogic
   $ az vm show -g WebPropertiesRG -n Bizlogic

Querying
++++++++

You can use the ``--query`` parameter and the JMESPath query syntax to customize your output.

.. code-block:: console

   $ az vm list --query '[].{name:name,os:storageProfile.osDisk.osType}'
   Name                    Os
   ----------------------  -------
   storevm                 Linux
   bizlogic                Linux
   demo32111vm             Windows
   dcos-master-39DB807E-0  Linux

Creating a new Linux VM
+++++++++++++++++++++++
The following block creates a new resource group in the 'westus' region, then creates a new Ubuntu VM.  We automatically provide a series of smart defaults, such as setting up SSH with your  ``~/.ssh/id_rsa.pub`` key.  For more details, try ``az vm create -h``.

.. code-block:: console

   $ az group create -l westus -n MyGroup
   Name     Location
   -------  ----------
   MyGroup  westus

   $ az vm create -g MyGroup -n MyVM --image ubuntults
   MacAddress         ResourceGroup    PublicIpAddress    PrivateIpAddress
   -----------------  ---------------  -----------------  ------------------
   00-0D-3A-30-B2-D7  MyGroup          52.160.111.118     10.0.0.4

   $ ssh 52.160.111.118
   Welcome to Ubuntu 14.04.4 LTS (GNU/Linux 3.19.0-65-generic x86_64)

   System information as of Thu Sep 15 20:47:31 UTC 2016

   System load: 0.39              Memory usage: 2%   Processes:       80
   Usage of /:  39.6% of 1.94GB   Swap usage:   0%   Users logged in: 0

   jasonsha@MyVM:~$

More Samples and Snippets
+++++++++++++++++++++++++
For more usage examples, take a look at our `GitHub samples repo <http://github.com/Azure/azure-cli-samples>`__.

Reporting issues and feedback
=======================================

If you encounter any bugs with the tool please file an issue in the `Issues <https://github.com/Azure/azure-cli/issues>`__ section of our GitHub repo.

To provide feedback from the command line, try the ``az feedback`` command.

License
=======

`MIT <https://github.com/Azure/azure-cli/blob/master/LICENSE.txt>`__

Release History
===============

See `Azure CLI release notes <https://docs.microsoft.com/cli/azure/release-notes-azure-cli>`__.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Azure/azure-cli",
    "name": "azure-cli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8.0",
    "maintainer_email": null,
    "keywords": null,
    "author": "Microsoft Corporation",
    "author_email": "azpycli@microsoft.com",
    "download_url": "https://files.pythonhosted.org/packages/dd/e0/7d75a972890f6a1ebfb17a4b963304079c33bdb564a5cd340cab6541c7c5/azure-cli-2.59.0.tar.gz",
    "platform": null,
    "description": "Microsoft Azure CLI\n===================\n\nA great cloud needs great tools; we're excited to introduce *Azure CLI*, our next generation multi-platform command line experience for Azure.\n\nUsage\n=====\n.. code-block:: console\n\n    $ az [ group ] [ subgroup ] [ command ] {parameters}\n\n\nGetting Started\n=====================\n\nAfter installation, use the ``az configure`` command to help setup your environment.\n\n.. code-block:: console\n\n   $ az configure\n\nFor usage and help content, pass in the ``-h`` parameter, for example:\n\n.. code-block:: console\n\n   $ az storage -h\n   $ az vm create -h\n\nHighlights\n===========\n\nHere are a few features and concepts that can help you get the most out of the Azure CLI.\n\nThe following examples are showing using the ``--output table`` format, you can change your default using the ``$ az configure`` command.\n\nTab Completion\n++++++++++++++\n\nWe support tab-completion for groups, commands, and some parameters\n\n.. code-block:: console\n\n   # looking up resource group and name\n   $ az vm show -g [tab][tab]\n   AccountingGroup   RGOne  WebPropertiesRG\n   $ az vm show -g WebPropertiesRG -n [tab][tab]\n   StoreVM  Bizlogic\n   $ az vm show -g WebPropertiesRG -n Bizlogic\n\nQuerying\n++++++++\n\nYou can use the ``--query`` parameter and the JMESPath query syntax to customize your output.\n\n.. code-block:: console\n\n   $ az vm list --query '[].{name:name,os:storageProfile.osDisk.osType}'\n   Name                    Os\n   ----------------------  -------\n   storevm                 Linux\n   bizlogic                Linux\n   demo32111vm             Windows\n   dcos-master-39DB807E-0  Linux\n\nCreating a new Linux VM\n+++++++++++++++++++++++\nThe following block creates a new resource group in the 'westus' region, then creates a new Ubuntu VM.  We automatically provide a series of smart defaults, such as setting up SSH with your  ``~/.ssh/id_rsa.pub`` key.  For more details, try ``az vm create -h``.\n\n.. code-block:: console\n\n   $ az group create -l westus -n MyGroup\n   Name     Location\n   -------  ----------\n   MyGroup  westus\n\n   $ az vm create -g MyGroup -n MyVM --image ubuntults\n   MacAddress         ResourceGroup    PublicIpAddress    PrivateIpAddress\n   -----------------  ---------------  -----------------  ------------------\n   00-0D-3A-30-B2-D7  MyGroup          52.160.111.118     10.0.0.4\n\n   $ ssh 52.160.111.118\n   Welcome to Ubuntu 14.04.4 LTS (GNU/Linux 3.19.0-65-generic x86_64)\n\n   System information as of Thu Sep 15 20:47:31 UTC 2016\n\n   System load: 0.39              Memory usage: 2%   Processes:       80\n   Usage of /:  39.6% of 1.94GB   Swap usage:   0%   Users logged in: 0\n\n   jasonsha@MyVM:~$\n\nMore Samples and Snippets\n+++++++++++++++++++++++++\nFor more usage examples, take a look at our `GitHub samples repo <http://github.com/Azure/azure-cli-samples>`__.\n\nReporting issues and feedback\n=======================================\n\nIf you encounter any bugs with the tool please file an issue in the `Issues <https://github.com/Azure/azure-cli/issues>`__ section of our GitHub repo.\n\nTo provide feedback from the command line, try the ``az feedback`` command.\n\nLicense\n=======\n\n`MIT <https://github.com/Azure/azure-cli/blob/master/LICENSE.txt>`__\n\nRelease History\n===============\n\nSee `Azure CLI release notes <https://docs.microsoft.com/cli/azure/release-notes-azure-cli>`__.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Microsoft Azure Command-Line Tools",
    "version": "2.59.0",
    "project_urls": {
        "Homepage": "https://github.com/Azure/azure-cli"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "dfc0389eaf7a682791fa24ad0bac4f0c45c924310c09ad5d4ae54942548d3104",
                "md5": "70eb09e87e5d4faeb3fa3200a7fbf272",
                "sha256": "5463a2adb9969aa193f35ef713eae3c7afa52862e6e520af2ae8ffa76b287a4d"
            },
            "downloads": -1,
            "filename": "azure_cli-2.59.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "70eb09e87e5d4faeb3fa3200a7fbf272",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.0",
            "size": 13910293,
            "upload_time": "2024-04-02T07:06:06",
            "upload_time_iso_8601": "2024-04-02T07:06:06.488545Z",
            "url": "https://files.pythonhosted.org/packages/df/c0/389eaf7a682791fa24ad0bac4f0c45c924310c09ad5d4ae54942548d3104/azure_cli-2.59.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "dde07d75a972890f6a1ebfb17a4b963304079c33bdb564a5cd340cab6541c7c5",
                "md5": "7fc2fad200be93da864996d197a96b1f",
                "sha256": "f9947f5682daf83461cbc7139cf075e0432ba43ef8509a97a557d93e6db4eeef"
            },
            "downloads": -1,
            "filename": "azure-cli-2.59.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7fc2fad200be93da864996d197a96b1f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.0",
            "size": 9931618,
            "upload_time": "2024-04-02T07:05:55",
            "upload_time_iso_8601": "2024-04-02T07:05:55.659904Z",
            "url": "https://files.pythonhosted.org/packages/dd/e0/7d75a972890f6a1ebfb17a4b963304079c33bdb564a5cd340cab6541c7c5/azure-cli-2.59.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-02 07:05:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Azure",
    "github_project": "azure-cli",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [
        {
            "name": "setuptools",
            "specs": [
                [
                    ">=",
                    "65.5.1"
                ]
            ]
        },
        {
            "name": "pip",
            "specs": [
                [
                    ">=",
                    "9.0.1"
                ]
            ]
        }
    ],
    "lcname": "azure-cli"
}
        
Elapsed time: 0.29707s