Skip to content

Commit 42a785e

Browse files
Merge pull request #207434 from cartertinney/ct-broken-links
Fixed broken links for Python IoT SDKs
2 parents f0fc1e0 + 86926f6 commit 42a785e

File tree

7 files changed

+22
-15
lines changed

7 files changed

+22
-15
lines changed

articles/iot-develop/libraries-sdks.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@ The IoT Plug and Play libraries and SDKs enable developers to build IoT solution
3232
| .NET - IoT Hub service | [NuGet 1.27.1](https://www.nuget.org/packages/Microsoft.Azure.Devices ) | [GitHub](https://github.com/Azure/azure-iot-sdk-csharp) | [Samples](https://github.com/Azure-Samples/azure-iot-samples-csharp/tree/main/iot-hub/Samples/service/PnpServiceSamples) | N/A | [Reference](/dotnet/api/microsoft.azure.devices) |
3333
| Java - IoT Hub service | [Maven 1.26.0](https://mvnrepository.com/artifact/com.microsoft.azure.sdk.iot/iot-service-client/1.26.0) | [GitHub](https://github.com/Azure/azure-iot-sdk-java) | [Samples](https://github.com/Azure/azure-iot-sdk-java/tree/main/service/iot-service-samples/pnp-service-sample) | N/A | [Reference](/java/api/com.microsoft.azure.sdk.iot.service) |
3434
| Node - IoT Hub service | [npm 1.13.0](https://www.npmjs.com/package/azure-iothub) | [GitHub](https://github.com/Azure/azure-iot-sdk-node) | [Samples](https://github.com/Azure/azure-iot-sdk-node/tree/main/service/samples) | N/A | [Reference](/javascript/api/azure-iothub/) |
35-
| Python - Digital Twins service | [pip 2.2.3](https://pypi.org/project/azure-iot-hub) | [GitHub](https://github.com/Azure/azure-iot-sdk-python) | [Samples](https://github.com/Azure/azure-iot-sdk-python/tree/main/samples) | [Interact with IoT Hub Digital Twins API](tutorial-service.md) | N/A |
36-
| Node - Digital Twins service | [npm 1.13.0](https://www.npmjs.com/package/azure-iot-digitaltwins-service) | [GitHub](https://github.com/Azure/azure-iot-sdk-node) | [Samples](https://github.com/Azure/azure-iot-sdk-node/tree/main/service/samples/javascript) | [Interact with IoT Hub Digital Twins API](tutorial-service.md) | N/A |
35+
| Python - IoT Hub service | [pip 2.2.3](https://pypi.org/project/azure-iot-hub) | [GitHub](https://github.com/Azure/azure-iot-hub-python) | [Samples](https://github.com/Azure/azure-iot-hub-python/tree/main/samples) | N/A | [Reference](/python/api/azure-iot-hub/) |
3736

3837
## Next steps
3938

articles/iot-dps/quick-create-simulated-device-symm-key.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -531,7 +531,7 @@ To update and run the provisioning sample with your device information:
531531
3. Open a command prompt and go to the directory where the sample file, _provision_symmetric_key.py_, is located.
532532
533533
```cmd
534-
cd azure-iot-sdk-python\azure-iot-device\samples\async-hub-scenarios
534+
cd azure-iot-sdk-python\samples\async-hub-scenarios
535535
```
536536

537537
4. In the command prompt, run the following commands to set environment variables used by the sample:
@@ -572,7 +572,7 @@ To update and run the provisioning sample with your device information:
572572
7. You should now see something similar to the following output. Some example wind speed telemetry messages are also sent to the hub as a test.
573573
574574
```output
575-
D:\azure-iot-sdk-python\azure-iot-device\samples\async-hub-scenarios>python provision_symmetric_key.py
575+
D:\azure-iot-sdk-python\samples\async-hub-scenarios>python provision_symmetric_key.py
576576
RegistrationStage(RequestAndResponseOperation): Op will transition into polling after interval 2. Setting timer.
577577
The complete registration result is
578578
python-device-008

articles/iot-dps/quick-create-simulated-device-x509.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -375,8 +375,8 @@ You won't need the Git Bash prompt for the rest of this quickstart. However, you
375375
6. Copy the device certificate and private key to the project directory for the X.509 device provisioning sample. The path given is relative to the location where you downloaded the SDK.
376376
377377
```bash
378-
cp device-cert.pem ./azure-iot-sdk-python/azure-iot-device/samples/async-hub-scenarios
379-
cp device-key.pem ./azure-iot-sdk-python/azure-iot-device/samples/async-hub-scenarios
378+
cp device-cert.pem ./azure-iot-sdk-python/samples/async-hub-scenarios
379+
cp device-key.pem ./azure-iot-sdk-python/samples/async-hub-scenarios
380380
```
381381
382382
You won't need the Git Bash prompt for the rest of this quickstart. However, you may want to keep it open to check your certificate if you have problems in later steps.
@@ -661,7 +661,7 @@ In this section, you'll use your Windows command prompt.
661661
1. In your Windows command prompt, go to the directory of the [provision_x509.py](https://github.com/Azure/azure-iot-sdk-python/blob/main/samples/async-hub-scenarios/provision_x509.py) sample. The path shown is relative to the location where you cloned the SDK.
662662

663663
```cmd
664-
cd ./azure-iot-sdk-python/azure-iot-device/samples/async-hub-scenarios
664+
cd ./azure-iot-sdk-python/samples/async-hub-scenarios
665665
```
666666

667667
This sample uses six environment variables to authenticate and provision an IoT device using DPS. These environment variables are:
@@ -705,7 +705,7 @@ In this section, you'll use your Windows command prompt.
705705
1. Run the sample. The sample will connect to DPS, which will provision the device to an IoT hub. After the device is provisioned, the sample will send some test messages to the IoT hub.
706706
707707
```cmd
708-
$ python azure-iot-sdk-python/azure-iot-device/samples/async-hub-scenarios/provision_x509.py
708+
$ python azure-iot-sdk-python/samples/async-hub-scenarios/provision_x509.py
709709
RegistrationStage(RequestAndResponseOperation): Op will transition into polling after interval 2. Setting timer.
710710
The complete registration result is
711711
my-x509-device

articles/iot-hub/iot-hub-devguide-sdks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The Azure IoT service SDKs contain code to facilitate building applications that
6464
| .NET | [NuGet](https://www.nuget.org/packages/Microsoft.Azure.Devices ) | [GitHub](https://github.com/Azure/azure-iot-sdk-csharp) | [Samples](https://github.com/Azure-Samples/azure-iot-samples-csharp) | [Reference](/dotnet/api/microsoft.azure.devices) |
6565
| Java | [Maven](https://mvnrepository.com/artifact/com.microsoft.azure.sdk.iot/iot-service-client) | [GitHub](https://github.com/Azure/azure-iot-sdk-java) | [Samples](https://github.com/Azure/azure-iot-sdk-java/tree/main/service/iot-service-samples/pnp-service-sample) | [Reference](/java/api/com.microsoft.azure.sdk.iot.service) |
6666
| Node | [npm](https://www.npmjs.com/package/azure-iothub) | [GitHub](https://github.com/Azure/azure-iot-sdk-node) | [Samples](https://github.com/Azure/azure-iot-sdk-node/tree/main/service/samples) | [Reference](/javascript/api/azure-iothub/) |
67-
| Python | [pip](https://pypi.org/project/azure-iot-hub) | [GitHub](https://github.com/Azure/azure-iot-sdk-python) | [Samples](https://github.com/Azure/azure-iot-sdk-python/tree/main/samples) | [Reference](/python/api/azure-iot-hub) |
67+
| Python | [pip](https://pypi.org/project/azure-iot-hub) | [GitHub](https://github.com/Azure/azure-iot-hub-python) | [Samples](https://github.com/Azure/azure-iot-hub-python/tree/main/samples) | [Reference](/python/api/azure-iot-hub) |
6868

6969
## Azure IoT Hub management SDKs
7070

articles/iot-hub/iot-hub-managed-identity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ result = iothub_job_manager.create_import_export_job(JobProperties(
417417
## SDK samples
418418
- [.NET SDK sample](https://aka.ms/iothubmsicsharpsample)
419419
- [Java SDK sample](https://aka.ms/iothubmsijavasample)
420-
- [Python SDK sample](https://github.com/Azure/azure-iot-sdk-python/tree/main/samples)
420+
- [Python SDK sample](https://github.com/Azure/azure-iot-hub-python/tree/main/samples)
421421
- Node.js SDK samples: [bulk device import](https://aka.ms/iothubmsinodesampleimport), [bulk device export](https://aka.ms/iothubmsinodesampleexport)
422422

423423
## Next steps

articles/iot-hub/iot-hub-mqtt-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ In order to ensure a client/IoT Hub connection stays alive, both the service and
7373
|Java | 230 seconds | [Yes](https://github.com/Azure/azure-iot-sdk-java/blob/main/device/iot-device-client/src/main/java/com/microsoft/azure/sdk/iot/device/ClientOptions.java#L64) |
7474
|C | 240 seconds | [Yes](https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/Iothub_sdk_options.md#mqtt-transport) |
7575
|C# | 300 seconds* | [Yes](/dotnet/api/microsoft.azure.devices.client.transport.mqtt.mqtttransportsettings.keepaliveinseconds) |
76-
|Python | 60 seconds | [Yes](https://github.com/Azure/azure-iot-sdk-python/blob/main/azure-iot-device/azure/iot/device/iothub/abstract_clients.py#L339) |
76+
|Python | 60 seconds | [Yes](https://github.com/Azure/azure-iot-sdk-python/blob/main/azure-iot-device/azure/iot/device/iothub/abstract_clients.py#L343) |
7777

7878
> *The C# SDK defines the default value of the MQTT KeepAliveInSeconds property as 300 seconds but in reality the SDK sends a ping request four times per keep-alive duration set. This means the SDK sends a keep-alive ping every 75 seconds.
7979

includes/iot-pnp-service-python.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@ To learn more about the sample configuration, see the [sample readme](https://gi
4040

4141
In this quickstart, you use a sample thermostat device, written in Python, as the IoT Plug and Play device. To run the sample device:
4242

43-
1. Open a terminal window in a folder of your choice. Run the following command to clone the [Azure IoT Python SDK](https://github.com/Azure/azure-iot-sdk-python) GitHub repository into this location:
43+
1. Open a terminal window in a folder of your choice. Run the following command to clone the [Azure IoT Device Python SDK](https://github.com/Azure/azure-iot-sdk-python) GitHub repository into this location:
4444

4545
```cmd/sh
4646
git clone https://github.com/Azure/azure-iot-sdk-python
4747
```
4848
49-
1. This terminal window is used as your **device** terminal. Go to the folder of your cloned repository, and navigate to the */azure-iot-sdk-python/azure-iot-device/samples/pnp* folder.
49+
1. This terminal window is used as your **device** terminal. Go to the folder of your cloned repository, and navigate to the */azure-iot-sdk-python/samples/pnp* folder.
5050
5151
1. Run the sample thermostat device with the following command:
5252
@@ -60,9 +60,17 @@ In this quickstart, you use a sample thermostat device, written in Python, as th
6060
6161
In this quickstart, you use a sample IoT solution in Python to interact with the sample device you just set up.
6262
63-
1. Open another terminal window to use as your **service** terminal.
6463
65-
1. Navigate to the */azure-iot-sdk-python/azure-iot-hub/samples* folder of the cloned Python SDK repository.
64+
65+
66+
67+
1. Open another terminal window to use as your **service** terminal. Run the following command to clone the [Azure IoT Hub Python SDK](https://github.com/Azure/azure-iot-hub-python) GitHub repository into this location:
68+
69+
```cmd/sh
70+
git clone https://github.com/Azure/azure-iot-hub-python
71+
```
72+
73+
1. Navigate to the */azure-iot-hub-python/samples* folder of the cloned Python SDK repository.
6674
6775
1. Open the *registry_manager_pnp_sample.py* file and review the code. This sample shows how to use the **IoTHubRegistryManager** class to interact with your IoT Plug and Play device.
6876

0 commit comments

Comments
 (0)