Skip to content

Acrolinx Batch 5 Edits #3775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dbradish-microsoft merged 7 commits into from
Aug 7, 2023
Merged

Acrolinx Batch 5 Edits #3775

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9cda06a
acrolinx batch 5 edits
daphnemamsft Aug 1, 2023
fd0624a
Update docs-ref-conceptual/includes/troubleshoot-wsl.md
daphnemamsft Aug 7, 2023
45d64f0
Update docs-ref-conceptual/msal-based-azure-cli.md
daphnemamsft Aug 7, 2023
a8237e0
Update docs-ref-conceptual/msal-based-azure-cli.md
daphnemamsft Aug 7, 2023
f24eb0b
Update docs-ref-conceptual/msal-based-azure-cli.md
daphnemamsft Aug 7, 2023
472b63c
Merge branch 'main' into daphneMa_acrolinx-batch5
daphnemamsft Aug 7, 2023
47ae4c6
editing cli-install-linux-dnf
daphnemamsft Aug 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs-ref-conceptual/azure-cli-endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ ms.author: dbradish
ms.prod: non-product-specific
ms.topic: conceptual
ms.custom: devx-track-azurecli
ms.date: 07/13/2023
ms.date: 08/1/2023
ms.tool: azure-cli
---

Expand All @@ -17,7 +17,7 @@ If your organization is secured with a firewall or proxy server, you must add ce

Two URLs are used during installation to download Python packages: **pypi.org** and **files.pythonhosted.org**.

The following tables provide lists of the endpoints and suffixes used by the Azure CLI. These endpoints are specific to the Azure cloud where your organization is deployed. We do not recommend adding additional Azure CLI-related URLs aside from those needed for specific Azure CLI reference groups, although you may want to add URLs related to other Microsoft products and services.
The following tables provide lists of the endpoints and suffixes used by the Azure CLI. These endpoints are specific to the Azure cloud where your organization is deployed. We don't recommend adding other Azure CLI-related URLs aside from the URLs needed for specific Azure CLI reference groups, although you may want to add URLs related to other Microsoft products and services.

## Endpoints

Expand Down
21 changes: 10 additions & 11 deletions docs-ref-conceptual/includes/cli-install-linux-dnf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
author: chasecrum
ms.author: chasecrum
manager: mamccrea
ms.date: 08/01/2023
ms.date: 08/1/2023
ms.topic: include
ms.custom: devx-track-azurecli
---

## Before you begin

- Azure CLI [2.38.0](/cli/azure/release-notes-azure-cli#july-05-2022) (released on 07/05/2022) is the last version supported on RHEL 7 and Centos 7 and will continue to receive security fixes until the end of life of the operating systems. Microsoft will not provide additional updates or bug fixes for these distributions.
- Azure CLI [2.38.0](/cli/azure/release-notes-azure-cli#july-05-2022) (released on July 5, 2022) is the last version supported on RHEL 7 and Centos 7 and will continue to receive security fixes until the end of life of the operating systems. Microsoft isn't providing other updates or bug fixes for these distributions.

- Azure CLI and the Linux [Install script](/cli/azure/install-azure-cli-linux?pivots=script) will continue to be developed and supported by Microsoft. Packages provided by Red Hat and CentOS repositories are maintained and supported by their respective distributions.
- Microsoft continues to develop and support Azure CLI and the Linux [Install script](/cli/azure/install-azure-cli-linux?pivots=script). Red Hat and CentOS distributions provide packages, while maintaining and supporting their respective repositories.
Copy link
Member

@jiasli jiasli Aug 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Red Hat and CentOS distributions provide packages, while maintaining and supporting their respective repositories.

This sentence is hard to understand to me. Our packages are delivered from PMC. They have nothing to do with Red Hat and CentOS repositories.

Copy link
Collaborator

@dbradish-microsoft dbradish-microsoft Aug 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jiasli, This sentence had to be reworded to meet Acrolinx standards.

Copy link
Member

@jiasli jiasli Aug 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph was initially added by #3505.

To me, the rephrasing changes the meaning of the second sentence.

Packages provided by Red Hat and CentOS repositories are maintained and supported by their respective distributions.

In the original version of this sentence, it tries to express that Red Hat and CentOS also provide Azure CLI packages (this is not true as Azure CLI RPM packages are only released from PMC), but these Azure CLI packages are maintained by Red Hat and CentOS.

However, after rephrasing it to active voice, it becomes irrelevant to the first sentence.

We can remove it, as we don't need to state how Red Hat and CentOS maintain their repositories or packages which is not related to Azure CLI packages.


- Use the `yum` package manager if you are using a Linux system that doesn't support the `dnf` package manager.
- Use the `yum` package manager if you're using a Linux system that doesn't support the `dnf` package manager.

## Install Azure CLI

Expand Down Expand Up @@ -56,7 +56,7 @@ To install the Azure CLI, follow these steps:

## Install specific version

To install a specific version, first configure the `azure-cli` repository information as shown above. Available versions can be found at [Azure CLI release notes](../release-notes-azure-cli.md).
You must first configure `azure-cli` repository information as shown previously. Available versions can be found at [Azure CLI release notes](../release-notes-azure-cli.md).

1. To view available versions with command:

Expand Down Expand Up @@ -113,8 +113,7 @@ Here are some common problems seen when installing with `dnf`. If you experience

### Install on RHEL 7.6 or other systems without Python 3

The RPM package of the Azure CLI depends on the `python3` package. If you are able, upgrade your system to a version with official support for the `python 3.6+` package.
Otherwise, you need to first install a `python3` package then install Azure CLI without dependency.
If you're able, upgrade your system to a version with official support for `python 3.6+` package. Otherwise, you need to first install a `python3` package, then install Azure CLI without dependency.

You can use the following command to download and install the Azure CLI install script with `python 3.6` built from source:

Expand All @@ -124,7 +123,7 @@ curl -sL https://azurecliprod.blob.core.windows.net/rhel7_6_install.sh | sudo ba

You can also do it step by step:

First, Azure CLI requires `SSL 1.1+` and you will need to build `openssl 1.1` from source before building `python3`:
First, Azure CLI requires `SSL 1.1+` and you need to build `openssl 1.1` from source before building `python3`:

```bash
sudo dnf install gcc gcc-c++ make ncurses patch wget tar zlib zlib-devel -y
Expand Down Expand Up @@ -158,14 +157,14 @@ Finally, follow steps 1 and 2 of the [install instruction](#install-azure-cli) t

> [!NOTE]
>
> If the dnf download plugin isn't already installed, you will encounter a `command not found` error when executing the code below. Use `dnf install 'dnf-command(download)'` to install the dnf download plugin.
> If the dnf download plugin isn't already installed, you will encounter a `command not found` error when executing the following code. Use `dnf install 'dnf-command(download)'` to install the dnf download plugin.

```bash
sudo dnf download azure-cli
sudo rpm -ivh --nodeps azure-cli-*.rpm
```

As an alternative, you can also install Python 3 using an [additional repo](https://developers.redhat.com/blog/2018/08/13/install-python3-rhel/). Use this method, if you have set up `python3` but are still getting the error `python3: command not found`. Make sure it has been include it in your path.
As an alternative, you can also install Python 3 using [another repo](https://developers.redhat.com/blog/2018/08/13/install-python3-rhel/). Use this method, if you have set up `python3` but are still getting the error `python3: command not found`. Make sure it has been included it in your path.

```bash
scl enable rh-python36 bash
Expand All @@ -175,7 +174,7 @@ scl enable rh-python36 bash

[!INCLUDE[configure-proxy](configure-proxy.md)]

You may also want to explicitly configure `dnf` to use this proxy at all times. Make sure that the following
You may also want to explicitly configure `dnf` to always use this proxy. Make sure that the following
lines appear under the `[main]` section of `/etc/dnf/dnf.conf`:

```dnf.conf
Expand Down
12 changes: 6 additions & 6 deletions docs-ref-conceptual/includes/troubleshoot-wsl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
author: dbradish-microsoft
ms.author: dbradish
ms.date: 07/05/2023
ms.date: 08/1/2023
ms.topic: include
ms.custom: devx-track-azurecli
---
Expand All @@ -15,13 +15,13 @@ there's a good chance it's an issue with WSL and not with the CLI install proces
To troubleshoot your WSL installation and possibly resolve issues:

* If you can, run an identical install process on a Linux machine or VM to see if it succeeds. If it does,
your issue is almost certainly related to WSL. To start a Linux VM in Azure, see the
[create a Linux VM in the Azure Portal](/azure/virtual-machines/linux/quick-create-portal) documentation.
your issue is likely related to WSL. To start a Linux VM in Azure, see the
[create a Linux VM in the Azure portal](/azure/virtual-machines/linux/quick-create-portal) documentation.
* Make sure that you're running the latest version of WSL. To get the latest version,
[update your Windows 10 installation](https://support.microsoft.com/help/4027667/windows-10-update).
* Check for any [open issues](https://github.com/Microsoft/WSL/issues) with WSL which might address your problem.
Often there will be suggestions on how to work around the problem, or information about a release where
the issue will be fixed.
* Check for any [open issues](https://github.com/Microsoft/WSL/issues) with WSL that might address your problem.
Often there are suggestions on how to work around the problem, or information about a release where
the issue is fixed.
* If there are no existing issues for your problem, [file a new issue with WSL](https://github.com/Microsoft/WSL/issues/new)
and make sure that you include as much information as possible.

Expand Down
12 changes: 6 additions & 6 deletions docs-ref-conceptual/msal-based-azure-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Learn about the MSAL-based Azure CLI.
author: jiasli
ms.author: jiasli
manager: yonzhan
ms.date: 06/19/2023
ms.date: 08/1/2023
ms.topic: conceptual
ms.service: azure-cli
ms.tool: azure-cli
Expand All @@ -14,23 +14,23 @@ keywords: msal, msal-based azure cli

# MSAL-based Azure CLI

Starting in version 2.30.0, Azure CLI uses [MSAL](https://github.com/AzureAD/microsoft-authentication-library-for-python) as the underlying authentication library. MSAL uses AAD v2.0 authentication flow to provide more functionality and increases security for token cache.
Starting in version 2.30.0, Azure CLI uses Microsoft Authentication Library [(MSAL)](https://github.com/AzureAD/microsoft-authentication-library-for-python) as the underlying authentication library. MSAL uses Azure Active Directory v2.0 authentication flow to provide more functionality and increases security for token cache.

> [!WARNING]
> BREAKING CHANGES are introduced in Azure CLI 2.30.0. Carefully read document prior to installation.

## `accessTokens.json` deprecation

Previous versions of Azure CLI save ADAL tokens and service principal entries to `~/.azure/accessToken.json`. Latest versions of Azure CLI use MSAL and no longer generate `accessTokens.json`. Any existing workflow depending on `accessTokens.json` no longer works.
Previous versions of Azure CLI saved Azure AD Authentication Library (ADAL) tokens and service principal entries to `~/.azure/accessToken.json`. The latest versions of the Azure CLI use MSAL and no longer generate `accessTokens.json`. Any existing workflow depending on `accessTokens.json` no longer works.

The MSAL token cache and service principal entries are saved as encrypted files on Windows, and plaintext files on Linux and MacOS.
The MSAL token cache and service principal entries are saved as encrypted files on Windows, and plaintext files on Linux and macOS.

> [!IMPORTANT]
> When using Azure CLI in a pipeline like Azure DevOps, ensure all tasks and stages are using versions of Azure CLI above v2.30.0 for MSAL-based Azure CLI. Azure CLI 2.30.0 is not backwards compatible with prior versions and throws an error when working with versions below 2.30.0.
> When using Azure CLI in a pipeline like Azure DevOps, ensure all tasks and stages are using versions of Azure CLI above v2.30.0 for MSAL-based Azure CLI. Azure CLI 2.30.0 is not backwards compatible with prior versions and throws an error when working with versions prior to 2.30.0.

## Alternatives to consider

Below are a couple alternatives you may consider for stability:
Alternatives you may consider for stability:

### Calling `az account get-access-token`

Expand Down