Merge branch 'dev' into feature/hub_messaging_test_fixes

HISTORY.rst

@@ -529,7 +529,7 @@ Other notable changes, which are not affected by API versions, include:
 **Device Update**
 
 * Introducing the **in preview** Azure Device Update for IoT Hub root command group `az iot device-update`.
-  To learn more about the service visit https://docs.microsoft.com/en-us/azure/iot-hub-device-update/.
+  To learn more about the service visit https://learn.microsoft.com/en-us/azure/iot-hub-device-update/.
 
   - This command group is behind a feature flag environment variable. Set `IOT_CLI_ADU_ENABLED` to any value
     to activate the command group.
@@ -841,7 +841,7 @@ Other notable changes, which are not affected by API versions, include:
     * az iot device send-d2c-message
     * az iot device simulate
 
-For more information about IoT Hub support for AAD visit: https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-dev-guide-azure-ad-rbac
+For more information about IoT Hub support for AAD visit: https://learn.microsoft.com/en-us/azure/iot-hub/iot-hub-dev-guide-azure-ad-rbac
 
 **Azure Digital Twins updates**
 

README.md

@@ -3,7 +3,7 @@
 ![Python](https://img.shields.io/pypi/pyversions/azure-cli.svg?maxAge=2592000)
 ![Build Status](https://dev.azure.com/azureiotdevxp/aziotcli/_apis/build/status/Merge%20-%20Azure.azure-iot-cli-extension?branchName=dev)
 
-The **Azure IoT extension for Azure CLI** aims to accelerate the development, management and automation of Azure IoT solutions. It does this via addition of rich features and functionality to the official [Azure CLI](https://docs.microsoft.com/en-us/cli/azure).
+The **Azure IoT extension for Azure CLI** aims to accelerate the development, management and automation of Azure IoT solutions. It does this via addition of rich features and functionality to the official [Azure CLI](https://learn.microsoft.com/en-us/cli/azure).
 
 ## News
 
@@ -34,11 +34,11 @@ The **Azure IoT extension for Azure CLI** aims to accelerate the development, ma
 
 ## Commands
 
-Please refer to the official `az iot` reference on [Microsoft Docs](https://docs.microsoft.com/en-us/cli/azure/ext/azure-iot/iot) for a complete list of supported commands.  You can also find IoT CLI usage tips on the [wiki](https://github.com/Azure/azure-iot-cli-extension/wiki/Tips).
+Please refer to the official `az iot` reference on [Microsoft Docs](https://learn.microsoft.com/en-us/cli/azure/ext/azure-iot/iot) for a complete list of supported commands.  You can also find IoT CLI usage tips on the [wiki](https://github.com/Azure/azure-iot-cli-extension/wiki/Tips).
 
 ## Installation
 
-1. Install the [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli)
+1. Install the [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)
     - You must have at least `v2.46.0` for the latest versions of `azure-iot`, which you can verify with `az --version`
 1. Add, Update or Remove the IoT extension with the following commands:
     - Add: `az extension add --name azure-iot`
@@ -116,7 +116,7 @@ Subgroups:
     export      [Preview] : Manage and configure IoT Central data exports.
     file-upload-config    : Manage and configure IoT Central file upload.
     job                   : Manage and configure jobs for an IoT Central application.
-    organization          : Manage and configure organizations for an IoT Central application.      
+    organization          : Manage and configure organizations for an IoT Central application.
     role                  : Manage and configure roles for an IoT Central application.
     scheduled-job         : Manage and configure IoT Central schedule job.
     user                  : Manage and configure IoT Central users.
@@ -246,7 +246,7 @@ Group
         to-end platform that customers can use to publish, distribute, and manage over-the-air
         updates for everything from tiny sensors to gateway-level devices.
         To learn more about the Device Update for IoT Hub service visit
-        https://docs.microsoft.com/en-us/azure/iot-hub-device-update/.
+        https://learn.microsoft.com/en-us/azure/iot-hub-device-update/.
 
 Subgroups:
     account  : Device Update account management.

SECURITY.md

@@ -4,7 +4,7 @@
 
 Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
 
-If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://learn.microsoft.com/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
 
 ## Reporting Security Issues
 
@@ -14,7 +14,7 @@ Instead, please report them to the Microsoft Security Response Center (MSRC) at
 
 If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/msrc/pgp-key-msrc).
 
-You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). 
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
 
 Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
 

azext_iot/_help.py

@@ -725,7 +725,7 @@
     type: command
     short-summary: Query an IoT Hub using a powerful SQL-like language.
     long-summary: Retrieve information regarding device and module twins, jobs and message routing.
-                  See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
+                  See https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
                   for more information.
     examples:
     - name: Query all device twin data in an Azure IoT Hub.
@@ -882,7 +882,7 @@
                    all from the cloud.
 
                    Read more about Azure IoT Edge here:
-                   https://docs.microsoft.com/en-us/azure/iot-edge/
+                   https://learn.microsoft.com/en-us/azure/iot-edge/
 """
 
 helps[

azext_iot/central/_help.py

@@ -36,7 +36,7 @@ def load_central_help():
     ] = """
         type: command
         short-summary: Query device telemetry or property data with IoT Central Query Language.
-        long-summary: For query syntax details, visit https://docs.microsoft.com/en-us/azure/iot-central/core/howto-query-with-rest-api.
+        long-summary: For query syntax details, visit https://learn.microsoft.com/en-us/azure/iot-central/core/howto-query-with-rest-api.
         examples:
           - name: Query device telemetry
             text: >

azext_iot/central/services/destination.py

@@ -3,7 +3,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
-# This is largely derived from https://docs.microsoft.com/en-us/rest/api/iotcentral/1.1-previewdataplane/destinations
 from typing import List, Union
 from knack.log import get_logger
 

azext_iot/central/services/device.py

@@ -3,7 +3,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
-# This is largely derived from https://docs.microsoft.com/en-us/rest/api/iotcentral/devices
 
 from typing import List
 import requests

azext_iot/central/services/device_group.py

@@ -3,7 +3,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
-# This is largely derived from https://docs.microsoft.com/en-us/rest/api/iotcentral/deviceGroups
 
 from typing import List
 import requests
@@ -131,7 +130,7 @@ def create_device_group(
         display_name: Display name of the device group
         filter: Query defining which devices should be in this group,
             or check here for more information
-            https://docs.microsoft.com/en-us/azure/iot-central/core/howto-query-with-rest-api
+            https://learn.microsoft.com/en-us/azure/iot-central/core/howto-query-with-rest-api
         description: Short summary of device group
         organizations: List of organization IDs of the device group
         token: (OPTIONAL) authorization token to fetch device details from IoTC.
@@ -189,7 +188,7 @@ def update_device_group(
         display_name: Display name of the device group
         filter: Query defining which devices should be in this group,
             or check here for more information
-            https://docs.microsoft.com/en-us/azure/iot-central/core/howto-query-with-rest-api
+            https://learn.microsoft.com/en-us/azure/iot-central/core/howto-query-with-rest-api
         description: Short summary of device group
         organizations: List of organization IDs of the device group
         token: (OPTIONAL) authorization token to fetch device details from IoTC.

azext_iot/central/services/device_template.py

@@ -3,7 +3,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
-# This is largely derived from https://docs.microsoft.com/en-us/rest/api/iotcentral/devicetemplates
 
 import requests
 from typing import List
@@ -138,8 +137,6 @@ def create_device_template(
         device_template_id: case sensitive device template id,
         payload: see example payload available in
             <repo-root>/azext_iot/tests/central/json/device_template_int_test.json
-            or check here for more information
-            https://docs.microsoft.com/en-us/rest/api/iotcentral/devicetemplates
         token: (OPTIONAL) authorization token to fetch device details from IoTC.
             MUST INCLUDE type (e.g. 'SharedAccessToken ...', 'Bearer ...')
         central_dns_suffix: {centralDnsSuffixInPath} as found in docs
@@ -181,8 +178,6 @@ def update_device_template(
         device_template_id: case sensitive device template id,
         payload: see example payload available in
             <repo-root>/azext_iot/tests/central/json/device_template_int_test.json
-            or check here for more information
-            https://docs.microsoft.com/en-us/rest/api/iotcentral/devicetemplates
         token: (OPTIONAL) authorization token to fetch device details from IoTC.
             MUST INCLUDE type (e.g. 'SharedAccessToken ...', 'Bearer ...')
         central_dns_suffix: {centralDnsSuffixInPath} as found in docs

azext_iot/central/services/enrollment_group.py

@@ -3,7 +3,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
-# This is largely derived from https://docs.microsoft.com/en-us/rest/api/iotcentral/deviceGroups
 
 from typing import List
 import requests

azext_iot/central/services/export.py

@@ -3,7 +3,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
-# This is largely derived from https://docs.microsoft.com/en-us/rest/api/iotcentral/1.1-previewdataplane/exports
 from typing import List, Union
 from knack.log import get_logger
 

azext_iot/central/services/file_upload.py

@@ -3,7 +3,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
-# This is largely derived from https://docs.microsoft.com/en-us/rest/api/iotcentral/fileuploads
 
 import requests
 from typing import Union

azext_iot/central/services/job.py

@@ -3,7 +3,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
-# This is largely derived from https://docs.microsoft.com/en-us/rest/api/iotcentral/jobs
 
 import requests
 from typing import List, Union
@@ -358,8 +357,6 @@ def create_job(
         group_id: The ID of the device group on which to execute the job.
         content: see example payload available in
             <repo-root>/azext_iot/tests/central/json/job_int_test.json
-            or check here for more information
-            https://docs.microsoft.com/en-us/rest/api/iotcentral/1.1-preview/jobs/create#cloudpropertyjobdata
         job_name: (OPTIONAL)(non-unique) human readable name for the job
         description: (OPTIONAL) Detailed description of the job.
         token: (OPTIONAL) authorization token to fetch job details from IoTC.

azext_iot/central/services/organization.py

@@ -3,7 +3,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
-# This is largely derived from https://docs.microsoft.com/en-us/rest/api/iotcentral/roles
 
 import requests
 from knack.log import get_logger

azext_iot/central/services/role.py

@@ -3,7 +3,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
-# This is largely derived from https://docs.microsoft.com/en-us/rest/api/iotcentral/roles
 
 from typing import List
 import requests

azext_iot/central/services/scheduled_job.py

@@ -3,7 +3,6 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
-# This is largely derived from https://docs.microsoft.com/en-us/rest/api/iotcentral/deviceGroups
 
 from typing import List
 import requests

azext_iot/deviceupdate/_help.py

@@ -20,7 +20,7 @@ def load_deviceupdate_help():
           of reliability and security and are easy to connect and manage at scale. Device Update for IoT Hub is an end-to-end platform that customers
           can use to publish, distribute, and manage over-the-air updates for everything from tiny sensors to gateway-level devices.
 
-          To learn more about the Device Update for IoT Hub service visit https://docs.microsoft.com/en-us/azure/iot-hub-device-update/
+          To learn more about the Device Update for IoT Hub service visit https://learn.microsoft.com/en-us/azure/iot-hub-device-update/
     """
 
     helps["iot du account"] = """

azext_iot/digitaltwins/_help.py

@@ -812,7 +812,7 @@ def load_digitaltwins_help():
         short-summary: Query the digital twins of an instance. Allows traversing relationships and filtering by property values.
         long-summary: In many twin queries, the `$` character is used to reference the `$dtId` property of a twin. In bash-like
           shells or powershell the `$` character has functional meaning and must be escaped as part of the query input. Please review the
-          Digital Twins CLI concepts document https://docs.microsoft.com/en-us/azure/digital-twins/concepts-cli for more information.
+          Digital Twins CLI concepts document https://learn.microsoft.com/en-us/azure/digital-twins/concepts-cli for more information.
 
         examples:
         - name: Query all digital twins in target instance and project all attributes. Also show cost in query units.

azext_iot/dps/services/global_service.py

@@ -18,8 +18,6 @@ def get_registration_state(id_scope: str, key: str, device_id: str):
     Gets device registration state from global dps endpoint
     Usefule for when dps name is unknown
 
-    https://docs.microsoft.com/en-us/rest/api/iot-dps/getdeviceregistrationstate/getdeviceregistrationstate
-
     Params:
         id_scope: dps id_scope
         key: either primary or secondary symmetric key

azext_iot/iothub/params.py

@@ -134,7 +134,7 @@ def load_iothub_arguments(self, _):
             "model_id",
             options_list=["--model-id", "--dtmi"],
             help="The Digital Twin Model Id the device will report when connecting to the hub. See "
-            "https://docs.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play for more details.",
+            "https://learn.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play for more details.",
             arg_group="Digital Twin",
             validator=validate_device_model_id,
         )

azext_iot/iothub/providers/message_endpoint.py

@@ -123,7 +123,7 @@ def create(
                     sub=endpoint_subscription_id
                 )
             else:
-                new_endpoint["entityPath"] = entity_path
+                new_endpoint["entityPath"] = entity_path.replace("~", "/")
             endpoints.event_hubs.append(new_endpoint)
         elif endpoint_type.lower() == EndpointType.ServiceBusQueue.value:
             if fetch_connection_string: