Skip to content

Commit

Permalink
Change wording of CLI documentation to reflect rebranding.
Browse files Browse the repository at this point in the history
  • Loading branch information
Stephen Tramer committed Jun 11, 2018
1 parent 3742a36 commit 503b999
Show file tree
Hide file tree
Showing 28 changed files with 253 additions and 262 deletions.
5 changes: 5 additions & 0 deletions .openpublishing.redirection.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@
"source_path": "docs-ref-conceptual/azure-cli-extension.md",
"redirect_url": "/cli/azure/azure-cli-extensions-overview",
"redirect_document_id": true
},
{
"source_path": "docs-ref-conceptual/install-cli-version-1.0.md",
"redirect_url": "/cli/azure/install-classic-cli",
"redirect_document_id": true
}
]
}
2 changes: 1 addition & 1 deletion docs-ref-conceptual/TOC.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- name: Azure CLI 2.0
- name: Azure CLI
href: index.md
items:
- name: Install
Expand Down
26 changes: 13 additions & 13 deletions docs-ref-conceptual/authenticate-azure-cli.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
---
title: Log in with Azure CLI 2.0
description: Log in with the Azure CLI 2.0 interactively or with local credentials
title: Sign in with Azure CLI
description: Sign in with the Azure CLI interactively or with local credentials
author: sptramer
ms.author: sttramer
manager: carmonm
ms.date: 02/13/2018
ms.date: 06/11/2018
ms.topic: conceptual
ms.technology: azure-cli
ms.devlang: azurecli
ms.service: active-directory
ms.component: authentication
---

# Log in with Azure CLI 2.0
# Sign in with Azure CLI

There are several ways to log in and authenticate with the Azure CLI. The easiest way to get started is to log in interactively through your browser through either Azure Cloud Shell or the `az login` command.
There are several ways to sign in and authenticate with the Azure CLI. The easiest way to get started is to sign in interactively through your browser through either Azure Cloud Shell or the `az login` command.
The recommended approach is to use service principals, which are permissions-restricted accounts. By granting just the appropriate permissions needed to a service principal, you can ensure your automation
scripts are even more secure.

None of your private credential information is stored locally. Instead, an authentication token is generated by Azure and stored. After logging in, your login token is valid until it goes for 14 days
without being used. At that point, you need to re-authenticate.

After logging in, CLI Commands are run against your default subscription. If you have more than one subscription, you can [change your default subscription](manage-azure-subscriptions-azure-cli.md).
After signing in, CLI Commands are run against your default subscription. If you have more than one subscription, you can [change your default subscription](manage-azure-subscriptions-azure-cli.md).

## Interactive log-in
## Interactive sign in

Log in interactively from your web browser.
Sign in interactively from your web browser.

[!INCLUDE [interactive_login](includes/interactive-login.md)]

Expand Down Expand Up @@ -57,23 +57,23 @@ az login -u <username> -p <password>
> $AzPass = ""
> ```
## Log in with a specific tenant
## Sign in with a specific tenant
If you work with multiple tenants, you can select your tenant to log in under with the `--tenant` argument. The value of this argument can either be an `.onmicrosoft.com` domain
or the Azure object ID for the tenant. You can log in interactively, or provide your credentials with the `--user` and `--password` arguments.
If you work with multiple tenants, you can select your tenant to sign in under with the `--tenant` argument. The value of this argument can either be an `.onmicrosoft.com` domain
or the Azure object ID for the tenant. You can sign in interactively, or provide your credentials with the `--user` and `--password` arguments.
```azurecli
az login --tenant <tenant>
```
## Log in with a service principal
## Sign in with a service principal
Service principals are accounts not tied to any particular user, which can have permissions on them assigned through
pre-defined roles. Authenticating with a service principal is the best way to write secure scripts or programs,
allowing you to apply both permissions restrictions and locally stored static credential information. To learn more
about service principals, see [Create an Azure service principal with the Azure CLI](create-an-azure-service-principal-azure-cli.md).
To log in with a service principal, you provide the username, password or certificate PEM file, and the tenant associated with the service principal:
To sign in with a service principal, you provide the username, password or certificate PEM file, and the tenant associated with the service principal:
```azurecli
az login --service-principal -u <app-url> -p <password-or-cert> --tenant <tenant>
Expand Down
8 changes: 4 additions & 4 deletions docs-ref-conceptual/azure-cli-configuration.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: Azure CLI configuration options
description: How to configure the Azure CLI 2.0
description: How to configure the Azure CLI
keywords: Azure CLI, configuration, settings, Azure
author: sptramer
ms.author: sttramer
manager: carmonm
ms.date: 05/16/2018
ms.date: 06/11/2018
ms.topic: conceptual
ms.prod: azure
ms.technology: azure-cli
ms.devlang: azure-cli
---
# Azure CLI 2.0 configuration
# Azure CLI configuration

The Azure CLI 2.0 allows for user configuration to override internal settings such as logging and data collection, and provide default options for
The Azure CLI allows for user configuration to override internal settings such as logging and data collection, and provide default options for
some required parameters. The CLI offers a convenience command for managing some of these values, `az configure`, and other values can be set in a
configuration file or with environment variables.

Expand Down
10 changes: 5 additions & 5 deletions docs-ref-conceptual/azure-cli-extension-alias.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: Azure CLI 2.0 alias extension
description: How to use the Azure CLI 2.0 alias extension
title: Azure CLI alias extension
description: How to use the Azure CLI alias extension
author: sptramer
ms.author: sttramer
manager: carmonm
ms.date: 05/16/2018
ms.date: 06/11/2018
ms.topic: conceptual
ms.prod: azure
ms.technology: azure-cli
ms.devlang: azure-cli
---

# The Azure CLI 2.0 alias extension
# The Azure CLI alias extension

The alias extension allows users to define custom commands for the Azure CLI by using existing commands. Aliases help keep your workflow concise and simple by allowing shortcuts and giving you the ability to use positional arguments. Since aliases are powered by the Jinja2 template engine, they even offer advanced argument processing.

Expand All @@ -20,7 +20,7 @@ The alias extension allows users to define custom commands for the Azure CLI by
## Install the alias extension

The minimum required Azure CLI version to use the alias extension is **2.0.28**. To check your CLI version, run `az --version`. If you need to update your installation, follow the instructions in [Install the Azure CLI 2.0](./install-azure-cli.md).
The minimum required Azure CLI version to use the alias extension is **2.0.28**. To check your CLI version, run `az --version`. If you need to update your installation, follow the instructions in [Install the Azure CLI](./install-azure-cli.md).

Install the extension with the [az extension add](/cli/azure/extension#az-extension-add) command.

Expand Down
8 changes: 4 additions & 4 deletions docs-ref-conceptual/azure-cli-extensions-list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Available extensions for the Azure CLI 2.0
description: A complete list of the officially supported extensions for the Azure CLI 2.0.
title: Available extensions for the Azure CLI
description: A complete list of the officially supported extensions for the Azure CLI
author: derekbekoe
ms.author: debekoe
manager: routlaw
Expand All @@ -11,9 +11,9 @@ ms.technology: azure-cli
ms.devlang: azure-cli
---

# Available extensions for the Azure CLI 2.0
# Available extensions for the Azure CLI

This article is a complete list of the available extensions for the Azure CLI 2.0 which are offered and supported by Microsoft.
This article is a complete list of the available extensions for the Azure CLI which are offered and supported by Microsoft.

The list of extensions is also available directly from the CLI. To get it, run [az extension list-available](/cli/azure/extension?view=azure-cli-latest#az-extension-list-available):

Expand Down
8 changes: 4 additions & 4 deletions docs-ref-conceptual/azure-cli-extensions-overview.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: Azure CLI 2.0 Extensions
description: Using extensions with the Azure CLI 2.0
title: Azure CLI Extensions
description: Using extensions with the Azure CLI
keywords: Azure CLI, Extensions
author: sptramer
ms.author: sttramer
manager: carmonm
ms.date: 05/16/2018
ms.date: 06/11/2018
ms.topic: conceptual
ms.prod: azure
ms.technology: azure-cli
ms.devlang: azure-cli
---

# Using extensions with the Azure CLI 2.0
# Using extensions with the Azure CLI

Extensions are individual modules not shipped with the Azure CLI itself that add functionality through new commands. These might be experimental or pre-release offerings, specialized tools from Microsoft, or custom features you
write yourself. Extensions allow for a degree of flexibility with the CLI that let you modify it to your own needs, without having to ship a lot of additional packages that aren't considered part of the core feature set.
Expand Down
8 changes: 4 additions & 4 deletions docs-ref-conceptual/azure-cli-vm-tutorial.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
### YamlMime:Tutorial
title: Create virtual machines with the Azure CLI 2.0
title: Create virtual machines with the Azure CLI
metadata:
title: Create virtual machines with the Azure CLI 2.0
title: Create virtual machines with the Azure CLI
description: Get started with the Azure CLI by creating virtual machines.
audience: Developer
level: Beginner
displayType: two-column
interactive: azurecli
ms.date: 02/08/2018
ms.date: 06/11/2018
ms.author: sttramer
author: sptramer
manager: carmonm
Expand All @@ -19,7 +19,7 @@ metadata:
items:
- durationInMinutes: 1
content: |-
In this tutorial, you learn all of the steps involved in setting up a virtual machine with the Azure CLI 2.0. The tutorial
In this tutorial, you learn all of the steps involved in setting up a virtual machine with the Azure CLI. The tutorial
also covers output queries, Azure resource reuse, and resource cleanup.
This tutorial can be completed with the interactive experienced offered through Azure Cloud Shell, or you may [install the CLI](install-azure-cli.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: Use Azure service principals with Azure CLI 2.0
description: Learn how to create and use a service principal with Azure CLI 2.0.
title: Use Azure service principals with Azure CLI
description: Learn how to create and use a service principal with Azure CLI.
author: sptramer
ms.author: sttramer
manager: carmonm
ms.date: 05/16/2018
ms.date: 06/11/2018
ms.topic: conceptual
ms.technology: azure-cli
ms.devlang: azure-cli
ms.service: role-based-access-control
---
# Create an Azure service principal with Azure CLI 2.0
# Create an Azure service principal with Azure CLI

If you want to create a separate login with access restrictions, you can do so through a service principal. Service principals are separate identities that can be
associated with an account. Service principals are useful for working with applications and tasks that must be automated. This article runs you through the steps for creating a service principal.
Expand Down Expand Up @@ -68,9 +68,9 @@ The `appId`, `tenant`, and `password` values are used for authentication. The `d
> [!NOTE]
> If your account does not have sufficient permissions to create a service principal, you see an error message containing "Insufficient privileges to complete the operation." Contact your Azure Active Directory admin to create a service principal.
## Manage service principal roles
## Manage service principal roles

The Azure CLI 2.0 provides the following commands to manage role assignments.
The Azure CLI provides the following commands to manage role assignments.

* [az role assignment list](/cli/azure/role/assignment#az-role-assignment-list)
* [az role assignment create](/cli/azure/role/assignment#az-role-assignment-create)
Expand All @@ -93,12 +93,12 @@ The changes can be verified by listing the assigned roles.
az role assignment list --assignee APP_ID
```

> [!NOTE]
> [!NOTE]
> If your account doesn't have the permissions to assign a role, you see an error message that your account "does not have authorization to perform action 'Microsoft.Authorization/roleAssignments/write' over scope '/subscriptions/{guid}'." Contact your Azure Active Directory admin to manage roles.
## Log in using the service principal
## Sign in using the service principal

You can test the new service principal's login and permissions by logging in under it within the Azure CLI. Log in as the new service principal using the `appId`, `tenant`, and credentials values. The authentication information you provide changes based on whether you chose to create the service principal with a password, or a certificate.
You can test the new service principal's login and permissions by signing in under it within the Azure CLI. Sign in as the new service principal using the `appId`, `tenant`, and credentials values. The authentication information you provide changes based on whether you chose to create the service principal with a password, or a certificate.

To log in with a password, provide it as an argument parameter.

Expand Down
14 changes: 7 additions & 7 deletions docs-ref-conceptual/format-output-azure-cli.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: Output formats for Azure CLI 2.0
description: Learn how to format the output of Azure CLI 2.0 commands to tables, lists or json.
title: Output formats for Azure CLI
description: Learn how to format the output of Azure CLI commands to tables, lists or json.
author: sptramer
ms.author: sttramer
manager: carmonm
ms.date: 05/16/2018
ms.date: 06/11/2018
ms.topic: conceptual
ms.prod: azure
ms.technology: azure-cli
ms.devlang: azure-cli
---
# Output formats for Azure CLI 2.0 commands
# Output formats for Azure CLI commands

Azure CLI 2.0 uses json as its default output option, but offers various ways for you to format the output of any command. Use the `--output` (or `--out` or `-o`) parameter
The Azure CLI uses json as its default output option, but offers various ways for you to format the output of any command. Use the `--output` (or `--out` or `-o`) parameter
to format the output of the command into one of the output types noted in the following table:

--output | Description
Expand Down Expand Up @@ -102,7 +102,7 @@ RGDEMO001 KBDemo020
> az vm list --query "[].{objectID:id}" -o table
> ```

For more about using queries to filter data, see [Use JMESPath queries with Azure CLI 2.0](/cli/azure/query-azure-cli).
For more about using queries to filter data, see [Use JMESPath queries with Azure CLI](/cli/azure/query-azure-cli).

## TSV output format

Expand Down Expand Up @@ -161,4 +161,4 @@ What default output format would you like?
Please enter a choice [1]:
```

To learn more about configuring your environment, see [Azure CLI 2.0 configuration](/cli/azure/azure-cli-configuration).
To learn more about configuring your environment, see [Azure CLI configuration](/cli/azure/azure-cli-configuration).
20 changes: 10 additions & 10 deletions docs-ref-conceptual/get-started-with-azure-cli.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: Get started with Azure CLI 2.0
description: Get started using the Azure CLI 2.0 by learning command basics.
title: Get started with Azure CLI
description: Get started using the Azure CLI by learning command basics.
keywords: Azure CLI, CLI help, Azure help, query, automation,
author: sptramer
ms.author: sttramer
manager: carmonm
ms.date: 05/16/2018
ms.date: 06/11/2018
ms.topic: conceptual
ms.prod: azure
ms.technology: azure-cli
ms.devlang: azure-cli
---
# Get started with Azure CLI 2.0
# Get started with Azure CLI

Welcome to the Azure CLI 2.0! The CLI is a tool designed to get you working quickly and efficiently with Azure services,
Welcome to the Azure CLI! The CLI is a tool designed to get you working quickly and efficiently with Azure services,
with an emphasis on automation. This article introduces features of the CLI and links out to resources that help you be productive.

## Install and log in
Expand All @@ -27,7 +27,7 @@ az login
```

This command prompts you to log in with an authentication code via a website. There are ways to log in non-interactively,
which are covered in detail in [Log in with Azure CLI 2.0](authenticate-azure-cli.md).
which are covered in detail in [Log in with Azure CLI](authenticate-azure-cli.md).

## Common commands

Expand Down Expand Up @@ -75,7 +75,7 @@ There are some arguments that are available for every command.
commands.
* `--output` changes the output format. The available output formats are `json`, `jsonc` (colorized JSON), `tsv` (Tab-Separated
Values), and `table` (human-readable ASCII tables). By default the CLI outputs `json`. To learn more about the available
output formats, see [Output formats for Azure CLI 2.0](format-output-azure-cli.md).
output formats, see [Output formats for Azure CLI](format-output-azure-cli.md).
* `--query` uses the [JMESPath query language](http://jmespath.org/) to filter the output returned from Azure services. To learn
To learn more about queries, see [Query command results with Azure CLI 2.0](query-azure-cli.md) and the [JMESPath tutorial](http://jmespath.org/tutorial.html).
* `--verbose` prints information about resources created in Azure during an operation, and other useful information.
Expand All @@ -91,18 +91,18 @@ select subcommands. You enter interactive mode with the [az interactive](/cli/az
az interactive
```

For more information on interactive mode, see [Azure CLI 2.0 Interactive Mode](interactive-azure-cli.md).
For more information on interactive mode, see [Azure CLI Interactive Mode](interactive-azure-cli.md).

There is also a [Visual Studio Code plugin](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azurecli) that
offers an interactive experience, including autocomplete and mouse-over documentation.

## Learn CLI basics with quickstarts and tutorials

To get you started with the Azure CLI 2.0, try an in-depth tutorial for setting up virtual machines and using the power
To get you started with the Azure CLI, try an in-depth tutorial for setting up virtual machines and using the power
of the CLI to query Azure resources.

> [!div class="nextstepaction"]
> [Create virtual machines with the Azure CLI 2.0 tutorial](azure-cli-vm-tutorial.yml)
> [Create virtual machines with the Azure CLI tutorial](azure-cli-vm-tutorial.yml)
If you would rather focus on other services, there are a variety of quickstarts for Azure services that use the CLI.

Expand Down
4 changes: 2 additions & 2 deletions docs-ref-conceptual/includes/interactive-login.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
author: sptramer
ms.author: sttramer
manager: carmonm
ms.date: 05/16/2018
ms.date: 06/11/2018
ms.topic: include
---

Expand All @@ -17,4 +17,4 @@ ms.topic: include
2. Use a web browser to open the page [https://aka.ms/devicelogin](https://aka.ms/devicelogin)
and enter the code to authenticate.
3. Log in with your account credentials in the browser.
3. Sign in with your account credentials in the browser.
Loading

0 comments on commit 503b999

Please sign in to comment.