Skip to content

Commit

Permalink
Merge pull request #16076 from dlepow/danlep1007
Browse files Browse the repository at this point in the history
Danlep: CLI article freshness updates
  • Loading branch information
tynevi committed Oct 12, 2015
2 parents a4df899 + eea55fb commit 1ff1a78
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 38 deletions.
33 changes: 17 additions & 16 deletions articles/virtual-machines/azure-cli-arm-commands.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,57 @@
<properties
pageTitle="Use the Azure CLI with Resource Manager | Microsoft Azure"
description="Learn about using the Azure CLI for Mac, Linux, and Windows to manage Azure resources using the Resource Manager deployment mode."
services="virtual-machines"
description="Learn about using the Azure CLI for Mac, Linux, and Windows to manage Azure resources using the CLI in Azure Resource Manager mode."
services="virtual-machines,mobile-services,cloud-services"
documentationCenter=""
authors="dlepow"
manager="timlt"
editor="tysonn"
tags="azure-resource-mangaer"/>
editor=""
tags="azure-resource-manager"/>

<tags
ms.service="multiple"
ms.workload="multiple"
ms.tgt_pltfrm="command-line-interface"
ms.devlang="na"
ms.topic="article"
ms.date="06/09/2015"
ms.date="10/07/2015"
ms.author="danlep"/>

# Using the Azure CLI for Mac, Linux, and Windows with Azure Resource Manager

[AZURE.INCLUDE [learn-about-deployment-models](../../includes/learn-about-deployment-models-rm-include.md)] [classic deployment model](virtual-machines-command-line-tools.md)

[AZURE.INCLUDE [learn-about-deployment-models](../../includes/learn-about-deployment-models-rm-include.md)] [classic deployment model](virtual-machines-command-line-tools.md).
This article describes how to use the Azure Command-Line Interface (Azure CLI) in the Azure Resource Manager mode to create, manage, and delete services on the command line of Mac, Linux, and Windows computers. You can perform many of the same tasks using the various libraries of the Azure SDKs, with Azure PowerShell, and using the Azure Preview Portal.

Azure Resource Manager enables you to create a group of resources -- virtual machines, websites, databases, and so on -- as a single deployable unit. You can then deploy, update, or delete all of the resources for your application in a single, coordinated operation. You describe your group resources in a JSON template for deployment and then can use that template for different environments such as testing, staging, and production.

This topic describes how to use the Azure Command-Line Interface (Azure CLI) in the **arm** mode to create, manage, and delete services on the command line of Mac, Linux, and Windows computers. You can perform the same tasks using the various libraries of the Azure SDKs, with PowerShell, and using the Azure Portal.
## Scope of article

Azure resource management enables you to create a group of resources -- virtual machines, websites, databases, and so on -- as a single deployable unit. You can then deploy, update, or delete all of the resources for your application in a single, coordinated operation. You describe your group resources in a JSON template for deployment and then can use that template for different environments such as testing, staging and production.
This article provides syntax and options for commonly used Azure CLI commands for the Resource Manager deployment model. It is not a complete reference, and your CLI version may show some different commands or parameters. For current command syntax and options at the command line in Resource Manager mode, type `azure help` or, to display help for a specific command, `azure help [command]`. You'll also find CLI examples in the documentation for creating and managing specific Azure services.

Optional parameters are shown in square brackets (for example, [parameter]). All other parameters are required.

In addition to command-specific optional parameters documented here, there are three optional parameters that can be used to display detailed output such as request options and status codes. The -v parameter provides verbose output, and the -vv parameter provides even more detailed verbose output. The --json option will output the result in raw json format. Usage with the --json switch is very common, and is an important part of both obtaining and understanding results from Azure CLI operations that return resource information, status, and logs and also using templates. You may want to install JSON parser tools such as **jq** or **jsawk** or use your favorite language library.

## Imperative and declarative approaches

As with the [service management mode (**asm**)](../virtual-machines-command-line-tools.md), the **arm** mode of the Azure CLI gives you commands that create resources imperatively on the command line. For example, if you type `azure group create <groupname> <location>` you are asking Azure to create a resource group, and with `azure group deployment create <resourcegroup> <deploymentname>` you are instructing Azure to create a deployment of any number of items and place them in a group. Because each type of resource has imperative commands, you can chain them together to create fairly complex deployments.
As with the [Azure Service Management mode](../virtual-machines-command-line-tools.md), the Resource Manager mode of the Azure CLI gives you commands that create resources imperatively on the command line. For example, if you type `azure group create <groupname> <location>` you are asking Azure to create a resource group, and with `azure group deployment create <resourcegroup> <deploymentname>` you are instructing Azure to create a deployment of any number of items and place them in a group. Because each type of resource has imperative commands, you can chain them together to create fairly complex deployments.

However, using resource group _templates_ that describe a resource group is a declarative approach that is far more powerful, allowing you to automate complex deployments of (almost) any number of resources for (almost) any purpose. When using templates, the only imperative command is to deploy one. For a general overview of templates, resources, and resource groups, see [Azure Resource Group Overview](resource-groups-overview).

> [AZURE.NOTE] In addition to command-specific options documented below and on the command line, there are three options that can be used to view detailed output such as request options and status codes. The -v parameter provides verbose output, and the -vv parameter provides even more detailed verbose output. The --json option will output the result in raw json format, and is very useful for scripting scenarios.
>
> Usage with the --json switch is very common, and is an important part of both obtaining and understanding results from Azure CLI operations that return resource information, status, and logs and also using templates. You may want to install JSON parser tools such as **jq** or **jsawk** or use your favorite language library.
##Usage requirements

The set-up requirements to use the **arm** mode with the Azure CLI are:
The set-up requirements to use the Resource Manager mode with the Azure CLI are:

- an Azure account ([get a free trial here](http://azure.microsoft.com/pricing/free-trial/))
- [installing the Azure CLI](../xplat-cli-install.md)
- [configuring the Azure CLI](../xplat-cli-connect.md) to use an Azure Active Directory identity or a Service Principal

Once you have an account and have installed the Azure CLI, you must

- switch to the **arm** mode by typing `azure config mode arm`.
- switch to the Resource Manager mode by typing `azure config mode arm`.
- Log in to your Azure account by typing `azure login` and using your work or school identity at the prompts

Now type `azure` to see a list of the top level commands described in the sections below.

## azure account: Manage your account information and publish settings
Your Azure subscription information is used by the tool to connect to your account. This information can be obtained from the Azure portal in a publish settings file as described here. You can import the publish settings file as a persistent local configuration setting that the tool will use for subsequent operations. You only need to import your publish settings once.
Expand Down
17 changes: 10 additions & 7 deletions articles/virtual-machines/virtual-machines-command-line-tools.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<properties
pageTitle="Use the Azure CLI with Service Management | Microsoft Azure"
description="Learn about using the command-line tools for Mac, Linux, and Windows to manage Azure using the Azure CLI in classic (Servivce Management) deployment mode."
description="Learn about using the command-line tools for Mac, Linux, and Windows to manage Azure using the Azure CLI in classic (Azure Service Management) mode."
services="virtual-machines, mobile-services, cloud-services"
documentationCenter=""
authors="dlepow"
Expand All @@ -14,24 +14,27 @@
ms.tgt_pltfrm="command-line-interface"
ms.devlang="na"
ms.topic="article"
ms.date="06/30/2015"
ms.date="10/07/2015"
ms.author="danlep"/>

# Using the Azure CLI for Mac, Linux, and Windows with Azure Service Management

[AZURE.INCLUDE [learn-about-deployment-models](../../includes/learn-about-deployment-models-classic-include.md)] [Resource Manager model](virtual-machines-deploy-rmtemplates-azure-cli.md).
[AZURE.INCLUDE [learn-about-deployment-models](../../includes/learn-about-deployment-models-include.md)] This article covers creating and managing a resource with CLI commands in the classic deployment model. You can also create and manage a resource with CLI commands in the [Resource Manager deployment model](azure-cli-arm-commands.md).

This article describes how to use the Azure CLI in the Service Management mode (asm mode) to create, manage, and delete services on the command line of Mac, Linux, and Windows computers. You can perform many of the same tasks using the various libraries of the Azure SDKs, with Azure PowerShell, and using the Azure Portal. Using Azure services with the Service Management mode is conceptually similar to creating and managing individual Azure concepts and services like Websites, Virtual Machines, Virtual Networks, Storage, and so on.

This topic describes how to use the Azure CLI in the **asm** mode to create, manage, and delete services on the command line of Mac, Linux, and Windows computers. This functionality is similar to that provided by the Windows PowerShell Service Management cmdlets that are installed with the Azure SDKs for .NET, Node.JS, and PHP.
> [AZURE.NOTE]
To get started, first [install the Azure CLI](../xplat-cli-install.md) and [log on to use Azure resources associated with your account](../xplat-cli-connect.md).

> [AZURE.NOTE] Using Azure services with the **asm** mode is conceptually similar to thinking of individual Azure concepts and services like Websites, Virtual Machines, Virtual Networks, Storage, and so on. Richer functionality with a logically grouped and hierarchical model of resources is available on the command line using the **arm** mode. To switch to that mode, see [Using the Azure Command-Line Interface with the Resource Manager](xplat-cli-azure-resource-manager.md).
## Scope of article

For installation instructions, see [Install and Configure the Azure Command-Line Interface](../xplat-cli-install.md).
This article provides syntax and options for commonly used Azure CLI commands for the classic (Service Management) deployment model. It is not a complete reference, and your CLI version may show some different commands or parameters. For current command syntax and options at the command line in Service Management mode, type `azure help` or, to display help for a specific command, `azure help [command]`. You'll also find CLI examples in the documentation for creating and managing specific Azure services.

Optional parameters are shown in square brackets (for example, [parameter]). All other parameters are required.

In addition to command-specific optional parameters documented here, there are three optional parameters that can be used to display detailed output such as request options and status codes. The -v parameter provides verbose output, and the -vv parameter provides even more detailed verbose output. The --json option will output the result in raw json format.

## Setting the **asm** mode
## Setting the Service Management mode

Currently the Service Management mode is enabled by default when you first install the CLI. If you need to, use the following command to enable Azure CLI Service Management commands.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ms.service="virtual-machines"
ms.topic="article"
ms.tgt_pltfrm="vm-multiple"
ms.workload="big-compute"
ms.date="09/28/2015"
ms.date="10/08/2015"
ms.author="danlep"/>

# Options to create and manage a high peformance computing (HPC) cluster in Azure with Microsoft HPC Pack
Expand Down Expand Up @@ -46,7 +46,7 @@ Take advantage of Microsoft HPC Pack and Azure compute and infrastructure servic

### PowerShell deployment script

* [Create an HPC cluster with the HPC Pack IaaS deployment script](virtual-machines-hpcpackcluster-powershell-script.md)
* [Create an HPC cluster with the HPC Pack IaaS deployment script](virtual-machines-hpcpack-cluster-powershell-script.md)

### Tutorials

Expand Down
22 changes: 12 additions & 10 deletions articles/virtual-machines/virtual-machines-manage-vms-azure-cli.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
<properties
pageTitle="Manage your Azure VMs using the Azure CLI | Microsoft Azure"
description="Describes how to manage your Azure VMs using the Azure CLI for Mac, Linux, and Windows."
pageTitle="Manage virtual machines with the CLI | Microsoft Azure"
description="Automate the management of your Azure Resource Manager VMs by using the Azure Command-Line Interface (CLI)."
services="virtual-machines"
documentationCenter="virtual-machines"
documentationCenter=""
authors="dlepow"
manager="timlt"
editor=""
tags="azure-service-management"/>
tags="azure-resource-manager"/>

<tags
ms.service="virtual-machines"
ms.devlang="na"
ms.topic="article"
ms.tgt_pltfrm="vm-linux"
ms.workload="infrastructure-services"
ms.date="06/09/2015"
ms.date="10/07/2015"
ms.author="danlep"/>

# Manage your Virtual Machines using the Azure CLI for Mac, Linux, and Windows
# Manage your Resource Manager virtual machines by using the Azure CLI for Mac, Linux, and Windows

[AZURE.INCLUDE [learn-about-deployment-models](../../includes/learn-about-deployment-models-include.md)] This article covers managing a resource created with the classic deployment model. You can also manage a resource created with the [Resource Manager deployment model](virtual-machines-how-to-automate-azure-resource-manager.md).
[AZURE.INCLUDE [learn-about-deployment-models](../../includes/learn-about-deployment-models-include.md)] This article covers managing a resource created with the Resource Manager deployment model. You can also manage a resource created with the classic deployment model.

Many tasks you do each day to manage your VMs can by automated by using the Azure CLI. This article gives you example commands for simpler tasks, and links to articles that show the commands for more complex tasks.
Many tasks you do each day to manage your VMs can by automated by using the Azure Command-Line Interface (CLI) for Mac, Linux, and Windows. This article gives you example commands for simpler tasks, and links to articles that show the commands for more complex tasks.

>[AZURE.NOTE] If you haven't installed and configured the Azure CLI yet, you can get instructions [here](../xplat-cli-install.md). If you want a quickstart for the same tasks in PowerShell, see [Manage your VMs using Azure PowerShell](virtual-machines-manage-vms-powershell.md).
>[AZURE.NOTE] If you haven't installed the Azure CLI yet, you can get instructions [here](../xplat-cli-install.md) and learn how to connect to your subscription [here](../xplat-cli-connect.md). You also need to configure the CLI in Azure Resource Manager (arm) mode.
## How to Use the Example Commands
You'll need to replace some of the text in the commands with text that's appropriate for your environment. The < and > symbols indicate text you need to replace. When you replace the text, remove the symbols but leave the quote marks in place.
Expand Down Expand Up @@ -84,4 +84,6 @@ Of course, if you already have those values you can find the proper switches to

## Next steps

For far more examples of Azure CLI usage with the **arm** mode, see [Using the Microsoft Azure CLI for Mac, Linux, and Windows with Azure Resource Management](../xplat-cli-resource-manager.md). To learn more about Azure resources and their concepts, see [Azure Resource Manager Overview](../resource-group-overview.md).
* For more examples of Azure CLI usage with the Azure Resource Manager mode, see [Using the Microsoft Azure CLI for Mac, Linux, and Windows with Azure Resource Management](xplat-cli-azure-resource-manager.md).

* To learn more about Azure resources and their concepts, see [Azure Resource Manager Overview](../resource-group-overview.md).
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
ms.topic="get-started-article"
ms.tgt_pltfrm="vm-multiple"
ms.workload="infrastructure-services"
ms.date="10/01/2015"
ms.date="10/07/2015"
ms.author="danlep"/>

# Articles for virtual machines in Service Management
Expand Down Expand Up @@ -87,8 +87,6 @@

[How to set up endpoints to a virtual machine](virtual-machines-set-up-endpoints.md)

[Manage your virtual machines using the Azure CLI for Mac, Linux, and Windows](virtual-machines-manage-vms-azure-cli.md)

## Create workloads

[Active Directory](../active-directory/active-directory-new-forest-virtual-machine.md)
Expand Down

0 comments on commit 1ff1a78

Please sign in to comment.