From e6f57012890a552aee6aea36ac67331dfc840046 Mon Sep 17 00:00:00 2001 From: Victoria Litvinova <73560279+vilit1@users.noreply.github.com> Date: Fri, 13 Dec 2024 11:09:47 -0800 Subject: [PATCH] docs: update the Microsoft Learn hyperlinks (#727) --- HISTORY.rst | 4 ++-- README.md | 10 +++++----- SECURITY.md | 4 ++-- azext_iot/_help.py | 4 ++-- azext_iot/central/_help.py | 2 +- azext_iot/central/services/destination.py | 1 - azext_iot/central/services/device.py | 1 - azext_iot/central/services/device_group.py | 5 ++--- azext_iot/central/services/device_template.py | 5 ----- azext_iot/central/services/enrollment_group.py | 1 - azext_iot/central/services/export.py | 1 - azext_iot/central/services/file_upload.py | 1 - azext_iot/central/services/job.py | 3 --- azext_iot/central/services/organization.py | 1 - azext_iot/central/services/role.py | 1 - azext_iot/central/services/scheduled_job.py | 1 - azext_iot/deviceupdate/_help.py | 2 +- azext_iot/digitaltwins/_help.py | 2 +- azext_iot/dps/services/global_service.py | 2 -- azext_iot/iothub/params.py | 2 +- azext_iot/iothub/providers/message_endpoint.py | 2 +- .../device/operations/device_operations.py | 16 ++++++++-------- .../operations/bulk_registry_operations.py | 2 +- .../cloud_to_device_messages_operations.py | 6 +++--- .../service/operations/devices_operations.py | 12 +++++------- .../service/operations/jobs_operations.py | 18 +++++++++--------- .../service/operations/modules_operations.py | 8 ++++---- .../service/operations/query_operations.py | 2 +- docs/install-help.md | 4 ++-- 29 files changed, 51 insertions(+), 72 deletions(-) diff --git a/HISTORY.rst b/HISTORY.rst index 5222b17cd..12b6fe4eb 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -512,7 +512,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. @@ -824,7 +824,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** diff --git a/README.md b/README.md index fc5409cbe..c7e416c4f 100644 --- a/README.md +++ b/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. diff --git a/SECURITY.md b/SECURITY.md index dec3d3b70..29306956d 100644 --- a/SECURITY.md +++ b/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: diff --git a/azext_iot/_help.py b/azext_iot/_help.py index ca3118acf..d365e7474 100644 --- a/azext_iot/_help.py +++ b/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[ diff --git a/azext_iot/central/_help.py b/azext_iot/central/_help.py index 042158815..68d523169 100644 --- a/azext_iot/central/_help.py +++ b/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: > diff --git a/azext_iot/central/services/destination.py b/azext_iot/central/services/destination.py index 7631d5aa7..ef0750817 100644 --- a/azext_iot/central/services/destination.py +++ b/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 diff --git a/azext_iot/central/services/device.py b/azext_iot/central/services/device.py index ee970aa40..9c98de95b 100644 --- a/azext_iot/central/services/device.py +++ b/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 diff --git a/azext_iot/central/services/device_group.py b/azext_iot/central/services/device_group.py index 7571dda23..e2a3336a5 100644 --- a/azext_iot/central/services/device_group.py +++ b/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. diff --git a/azext_iot/central/services/device_template.py b/azext_iot/central/services/device_template.py index 2d390447f..eaea066be 100644 --- a/azext_iot/central/services/device_template.py +++ b/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 /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 /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 diff --git a/azext_iot/central/services/enrollment_group.py b/azext_iot/central/services/enrollment_group.py index f2b0c8d1f..955f5b648 100644 --- a/azext_iot/central/services/enrollment_group.py +++ b/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 diff --git a/azext_iot/central/services/export.py b/azext_iot/central/services/export.py index 192e0a507..165f1983b 100644 --- a/azext_iot/central/services/export.py +++ b/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 diff --git a/azext_iot/central/services/file_upload.py b/azext_iot/central/services/file_upload.py index 10f24c5fd..be80f9396 100644 --- a/azext_iot/central/services/file_upload.py +++ b/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 diff --git a/azext_iot/central/services/job.py b/azext_iot/central/services/job.py index 97a36fcea..18b03f5cd 100644 --- a/azext_iot/central/services/job.py +++ b/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 /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. diff --git a/azext_iot/central/services/organization.py b/azext_iot/central/services/organization.py index 0c14ae32a..4b007e7c0 100644 --- a/azext_iot/central/services/organization.py +++ b/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 diff --git a/azext_iot/central/services/role.py b/azext_iot/central/services/role.py index ab5dd68ac..16b4fd982 100644 --- a/azext_iot/central/services/role.py +++ b/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 diff --git a/azext_iot/central/services/scheduled_job.py b/azext_iot/central/services/scheduled_job.py index 36d854c51..731a2e04d 100644 --- a/azext_iot/central/services/scheduled_job.py +++ b/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 diff --git a/azext_iot/deviceupdate/_help.py b/azext_iot/deviceupdate/_help.py index 44a638deb..a69e2dd3f 100644 --- a/azext_iot/deviceupdate/_help.py +++ b/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"] = """ diff --git a/azext_iot/digitaltwins/_help.py b/azext_iot/digitaltwins/_help.py index 59eb118b1..7a93c2ae2 100644 --- a/azext_iot/digitaltwins/_help.py +++ b/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. diff --git a/azext_iot/dps/services/global_service.py b/azext_iot/dps/services/global_service.py index 6f1dd0904..a501785bf 100644 --- a/azext_iot/dps/services/global_service.py +++ b/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 diff --git a/azext_iot/iothub/params.py b/azext_iot/iothub/params.py index dc79e50ce..3c000c65f 100644 --- a/azext_iot/iothub/params.py +++ b/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, ) diff --git a/azext_iot/iothub/providers/message_endpoint.py b/azext_iot/iothub/providers/message_endpoint.py index b385e8d5a..b702e6b7a 100644 --- a/azext_iot/iothub/providers/message_endpoint.py +++ b/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: diff --git a/azext_iot/sdk/iothub/device/operations/device_operations.py b/azext_iot/sdk/iothub/device/operations/device_operations.py index ed36fa2ef..d25cf9163 100644 --- a/azext_iot/sdk/iothub/device/operations/device_operations.py +++ b/azext_iot/sdk/iothub/device/operations/device_operations.py @@ -44,7 +44,7 @@ def get_devices_and_modules_in_scope( Query IotHub to retrieve information regarding devices which belong to the same deviceScope. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about device twins only. @@ -112,7 +112,7 @@ def get_device_and_module_in_scope( Get device registry information using module connect for a specific device in deviceScope. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about device twins only. @@ -179,7 +179,7 @@ def send_device_event( """Send a device-to-cloud message. Send a device-to-cloud message. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. :param id: Device ID. @@ -242,7 +242,7 @@ def receive_device_bound_notification( """This method is used to retrieve a cloud-to-device message. This method is used to retrieve a cloud-to-device message See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. This capability is only available in the standard tier IoT Hub. For more information, see [Choose the right IoT Hub tier](https://aka.ms/scaleyouriotsolution). @@ -301,7 +301,7 @@ def abandon_device_bound_notification( when completing, rejecting, or abandoning a message. A abandoned message is put back in the device message queue for re-delivery to the device. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. Currently, the use of the Etag in the header does not comply with RFC 7232. A fix for this issue is currently on our backlog. This capability is only available in the standard tier IoT Hub. For @@ -361,7 +361,7 @@ def create_file_upload_sas_uri( """This method is used to retrieve a storage SAS URI to upload a file. This method is used to retrieve a storage SAS URI to upload a file. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload for more information. :param device_id: Device ID. @@ -432,7 +432,7 @@ def update_file_upload_status( This method is used to notify an IoT hub of a completed file upload. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload for more information. :param device_id: Device ID. @@ -545,7 +545,7 @@ def complete_device_bound_notification( positive acknowledgment is sent to the application back-end if requested. A rejected message causes it to be deadlettered. To reject a message, include a query parameter called \"reject\". See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. Currently, the use of the Etag in the header does not comply with RFC 7232. A fix for this issue is currently on our backlog. This capability is only available in the standard tier IoT Hub. For diff --git a/azext_iot/sdk/iothub/service/operations/bulk_registry_operations.py b/azext_iot/sdk/iothub/service/operations/bulk_registry_operations.py index 673bb1903..3bc5e53d4 100644 --- a/azext_iot/sdk/iothub/service/operations/bulk_registry_operations.py +++ b/azext_iot/sdk/iothub/service/operations/bulk_registry_operations.py @@ -45,7 +45,7 @@ def update_registry( different devices are allowed. A maximum of 100 devices can be specified per invocation. For large scale operations, use the import feature using blob storage - (https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities). + (https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities). :param devices: The registry operations to perform. :type devices: list[~service.models.ExportImportDevice] diff --git a/azext_iot/sdk/iothub/service/operations/cloud_to_device_messages_operations.py b/azext_iot/sdk/iothub/service/operations/cloud_to_device_messages_operations.py index 5243f603e..96b2c7655 100644 --- a/azext_iot/sdk/iothub/service/operations/cloud_to_device_messages_operations.py +++ b/azext_iot/sdk/iothub/service/operations/cloud_to_device_messages_operations.py @@ -98,7 +98,7 @@ def purge_cloud_to_device_message_queue( def receive_feedback_notification( self, custom_headers=None, raw=False, **operation_config): """Gets the feedback for cloud-to-device messages. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. This capability is only available in the standard tier IoT Hub. For more information, see [Choose the right IoT Hub tier](https://aka.ms/scaleyouriotsolution). @@ -147,7 +147,7 @@ def complete_feedback_notification( self, lock_token, custom_headers=None, raw=False, **operation_config): """Completes the cloud-to-device feedback message. A completed message is deleted from the feedback queue of the service. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. :param lock_token: The lock token obtained when the cloud-to-device @@ -201,7 +201,7 @@ def complete_feedback_notification( def abandon_feedback_notification( self, lock_token, custom_headers=None, raw=False, **operation_config): """Abandons the lock on a cloud-to-device feedback message. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. :param lock_token: The lock token obtained when the cloud-to-device diff --git a/azext_iot/sdk/iothub/service/operations/devices_operations.py b/azext_iot/sdk/iothub/service/operations/devices_operations.py index 4f148c5c8..52328ed0b 100644 --- a/azext_iot/sdk/iothub/service/operations/devices_operations.py +++ b/azext_iot/sdk/iothub/service/operations/devices_operations.py @@ -42,9 +42,7 @@ def get_devices( """Gets the identities of multiple devices from the IoT Hub identity registry. Not recommended. Use the IoT Hub query API to retrieve device twin and device identity information. See - https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub - and - https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language + https://learn.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language for more information. :param top: The maximum number of device identities returned by the @@ -290,7 +288,7 @@ def delete_identity( def get_twin( self, id, custom_headers=None, raw=False, **operation_config): """Gets the device twin. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. :param id: The unique identifier of the device. @@ -349,7 +347,7 @@ def get_twin( def replace_twin( self, id, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config): """Replaces the tags and desired properties of a device twin. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. :param id: The unique identifier of the device. @@ -422,7 +420,7 @@ def replace_twin( def update_twin( self, id, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config): """Updates the tags and desired properties of a device twin. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. :param id: The unique identifier of the device. @@ -494,7 +492,7 @@ def update_twin( def invoke_method( self, device_id, direct_method_request, custom_headers=None, raw=False, **operation_config): """Invokes a direct method on a device. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information. :param device_id: The unique identifier of the device. diff --git a/azext_iot/sdk/iothub/service/operations/jobs_operations.py b/azext_iot/sdk/iothub/service/operations/jobs_operations.py index 9b1c4b7b9..5eac2bf39 100644 --- a/azext_iot/sdk/iothub/service/operations/jobs_operations.py +++ b/azext_iot/sdk/iothub/service/operations/jobs_operations.py @@ -40,7 +40,7 @@ def __init__(self, client, config, serializer, deserializer): def create_import_export_job( self, job_properties, custom_headers=None, raw=False, **operation_config): """Creates a new import or export job on the IoT Hub. See - https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities + https://learn.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. :param job_properties: The job specifications. @@ -100,7 +100,7 @@ def create_import_export_job( def get_import_export_jobs( self, custom_headers=None, raw=False, **operation_config): """Gets the status of all import and export jobs in the IoT Hub. See - https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities + https://learn.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. :param dict custom_headers: headers that will be added to the request @@ -154,7 +154,7 @@ def get_import_export_jobs( def get_import_export_job( self, id, custom_headers=None, raw=False, **operation_config): """Gets the status of an import or export job in the IoT Hub. See - https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities + https://learn.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. :param id: The unique identifier of the job. @@ -271,7 +271,7 @@ def cancel_import_export_job( def get_scheduled_job( self, id, custom_headers=None, raw=False, **operation_config): """Gets details of a scheduled job from the IoT Hub. See - https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs + https://learn.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. :param id: The unique identifier of the job. @@ -332,7 +332,7 @@ def create_scheduled_job( self, id, job_request, custom_headers=None, raw=False, **operation_config): """Creates a new job to schedule twin updates or direct methods on the IoT Hub at a scheduled time. See - https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs + https://learn.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. :param id: The unique identifier of the job. @@ -398,7 +398,7 @@ def create_scheduled_job( def cancel_scheduled_job( self, id, custom_headers=None, raw=False, **operation_config): """Cancels a scheduled job on the IoT Hub. See - https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs + https://learn.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. :param id: The unique identifier of the job. @@ -458,15 +458,15 @@ def cancel_scheduled_job( def query_scheduled_jobs( self, job_type=None, job_status=None, custom_headers=None, raw=False, **operation_config): """Gets the information about jobs using an IoT Hub query. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. :param job_type: The job type. See - https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs + https://learn.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs for a list of possible job types. :type job_type: str :param job_status: The job status. See - https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs + https://learn.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs for a list of possible statuses. :type job_status: str :param dict custom_headers: headers that will be added to the request diff --git a/azext_iot/sdk/iothub/service/operations/modules_operations.py b/azext_iot/sdk/iothub/service/operations/modules_operations.py index 92f4a1a05..5950091ed 100644 --- a/azext_iot/sdk/iothub/service/operations/modules_operations.py +++ b/azext_iot/sdk/iothub/service/operations/modules_operations.py @@ -40,7 +40,7 @@ def __init__(self, client, config, serializer, deserializer): def get_twin( self, id, mid, custom_headers=None, raw=False, **operation_config): """Gets the module twin. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. :param id: The unique identifier of the device. @@ -102,7 +102,7 @@ def get_twin( def replace_twin( self, id, mid, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config): """Replaces the tags and desired properties of a module twin. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. :param id: The unique identifier of the device. @@ -178,7 +178,7 @@ def replace_twin( def update_twin( self, id, mid, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config): """Updates the tags and desired properties of a module twin. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. :param id: The unique identifier of the device. @@ -507,7 +507,7 @@ def delete_identity( def invoke_method( self, device_id, module_id, direct_method_request, custom_headers=None, raw=False, **operation_config): """Invokes a direct method on a module of a device. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information. :param device_id: The unique identifier of the device. diff --git a/azext_iot/sdk/iothub/service/operations/query_operations.py b/azext_iot/sdk/iothub/service/operations/query_operations.py index 1142b5686..2b2ca330f 100644 --- a/azext_iot/sdk/iothub/service/operations/query_operations.py +++ b/azext_iot/sdk/iothub/service/operations/query_operations.py @@ -41,7 +41,7 @@ def get_twins( self, query=None, x_ms_continuation=None, x_ms_max_item_count=None, custom_headers=None, raw=False, **operation_config): """Query an IoT Hub to retrieve information regarding device twins using a SQL-like language. See - https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language + https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination is supported. This returns information about device twins only. diff --git a/docs/install-help.md b/docs/install-help.md index 5813f4a73..60992f8d2 100644 --- a/docs/install-help.md +++ b/docs/install-help.md @@ -23,8 +23,8 @@ After installing Azure CLI in my supported Linux environment, I try to install t Make sure you install the right distribution of Azure CLI that is compatible with your platform. -For example using the recommended installation path of [Linux via apt](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli-apt), validate that your `/etc/apt/sources.list.d/azure-cli.list` file has the proper distribution identifier. +For example using the recommended installation path of [Linux via apt](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli-apt), validate that your `/etc/apt/sources.list.d/azure-cli.list` file has the proper distribution identifier. -On an Ubuntu 16.04 environment provided with the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) the sources list file should have an entry tagged with 'xenial': +On an Ubuntu 16.04 environment provided with the [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install-win10) the sources list file should have an entry tagged with 'xenial': `deb [arch=amd64] https://packages.microsoft.com/repos/azure-cli/ xenial main`