From c582826beb6b5bad51f0e1d1532c603bb8fca3e6 Mon Sep 17 00:00:00 2001 From: Paymaun Date: Thu, 29 Jul 2021 11:47:41 -0700 Subject: [PATCH] Update README.md (#397) * Update README.md * Update merge.yml * Delete breaking-announcements-archive.md --- .azure-devops/merge.yml | 12 +++++++++++ README.md | 8 +++++-- docs/breaking-announcements-archive.md | 30 -------------------------- 3 files changed, 18 insertions(+), 32 deletions(-) delete mode 100644 docs/breaking-announcements-archive.md diff --git a/.azure-devops/merge.yml b/.azure-devops/merge.yml index f54e0b6e8..6d1c8c716 100644 --- a/.azure-devops/merge.yml +++ b/.azure-devops/merge.yml @@ -3,12 +3,24 @@ trigger: include: - dev - master + paths: + exclude: + - README.md + - docs/alt-install-methods.md + - docs/install-help.md + - docs/scenario-automation.md pr: branches: include: - dev - master + paths: + exclude: + - README.md + - docs/alt-install-methods.md + - docs/install-help.md + - docs/scenario-automation.md variables: iot_ext_package: azure-iot diff --git a/README.md b/README.md index 15cf51a89..60cdc0ec0 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,13 @@ The **Azure IoT extension for Azure CLI** aims to accelerate the development, ma ## News -- Starting with version `0.10.13` of the IoT extension, you will need an Azure CLI core version of `2.17.1` or higher. IoT extension version `0.10.11` remains on the extension index to support environments that cannot upgrade core CLI versions. +- ❗ When upgrading your Azure CLI core version, for the best experience and to avoid breaking changes, we recommend updating your `azure-iot` extension to the [latest available](https://github.com/Azure/azure-iot-cli-extension/releases). + +- Azure CLI `2.24.0` requires an `azure-iot` extension update to `0.10.11` or later for IoT Hub commands to work properly. However **we recommend** at least `azure-iot` `0.10.14`. Updating the extension can be done with `az extension update --name azure-iot`. -- Azure CLI `2.24.0` requires an `azure-iot` extension update to `0.10.11` or later for IoT Hub commands to work properly. This can be done with `az extension update --name azure-iot`. A common error that arises when using an older `azure-iot` with Azure CLI `2.24.0` looks like `AttributeError: 'IotHubResourceOperations' object has no attribute 'config'`. +> Note: A common error that arises when using an older `azure-iot` with Azure CLI `2.24.0+` shows as follows: `AttributeError: 'IotHubResourceOperations' object has no attribute 'config'`. + +- Starting with version `0.10.13` of the IoT extension, you will need an Azure CLI core version of `2.17.1` or higher. IoT extension version `0.10.11` remains on the extension index to support environments that cannot upgrade core CLI versions. - The legacy IoT extension Id `azure-cli-iot-ext` is deprecated in favor of the new modern Id `azure-iot`. `azure-iot` is a superset of `azure-cli-iot-ext` and any new features or fixes will apply to `azure-iot` only. Also the legacy and modern IoT extension should **never** co-exist in the same CLI environment. diff --git a/docs/breaking-announcements-archive.md b/docs/breaking-announcements-archive.md deleted file mode 100644 index fa4c60d80..000000000 --- a/docs/breaking-announcements-archive.md +++ /dev/null @@ -1,30 +0,0 @@ -# :exclamation: Breaking Announcements - -**9/14/18** -In order to satisfy new CI linter rules for the Azure CLI, we have replaced multi-character short options (like '-props', or '-pri') with long option versions ('--props', '--pri'). - -The option names have not changed, but to fix any existing scripts, please use the '--' prefix for any command options that are not single characters. Single character options such as '-l', '-n', and '-d' are unaffected. - -**6/21/18** -The Windows Installer for Azure CLI since version 2.0.34 has an issue with the packaged pip. This issue prevents the IoT extension from being installed. - -To fix, upgrade using at least the 2.0.39 MSI. - -The error looks like this: - -```bash -Command '['C:\Program Files (x86)\Microsoft SDKs\Azure\CLI2\python.exe', '-m', 'pip', 'install', '--target', 'C:\Users\myuser\.azure\cliextensions\azure-cli-iot-ext', 'C:\Users\myuser\AppData\Local\Temp\tmpkds3dj8q\azure_cli_iot_ext-0.4.5-py2.py3-none-any.whl', '-vv', '--disable-pip-version-check', '--no-cache-dir']' returned non-zero exit status 2. -Pip failed -``` - -Look at this [issue thread](https://github.com/Azure/azure-iot-cli-extension/issues/33#issuecomment-399200521) for an alternative workaround. - -___ - -Versions 2.0.34 to 2.0.36 of Azure CLI are **NOT** compatible with the IoT extension. - -You will see an error that looks like this when running commands with multi-character short options: - -`command authoring error: multi-character short option '-props' is not allowed. Use a single character or convert to a long-option.` - -We recommend skipping these version. Please look at the [compatibility](./README.md#compatibility) section below for up to date guidelines.