Skip to content

Commit 95846bf

Browse files
abhipsaMisraabhipsaMisra
committed
Fixed broken links and unused references.
1 parent 70f4e06 commit 95846bf

File tree

8 files changed

+29
-346
lines changed

8 files changed

+29
-346
lines changed

‎doc/devguide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Instructions are available here: https://github.com/dotnet/core/blob/master/samp
3838

3939
### Xamarin, UWP, Windows IoT
4040

41-
Please follow the [devbox-setup][devbox_setup.md] "Optional Setup" for Xamarin before trying to build. To build and test, run the following Jenkins script from the root of the repository:
41+
Please follow the [devbox-setup](devbox_setup.md) "Optional Setup" for Xamarin before trying to build. To build and test, run the following Jenkins script from the root of the repository:
4242

4343
`jenkins\windows_csharp_xamarin.cmd`
4444

‎doc/faq.md

Lines changed: 0 additions & 160 deletions
This file was deleted.

‎doc/manage_iot_hub.md

Lines changed: 9 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -4,105 +4,28 @@ Before a device can communicate with IoT Hub, you must add details of that devic
44

55
To add devices to your IoT hub and manage those devices, you can use either of:
66

7-
- The cross-platform, command-line [iothub-explorer](#iothub-explorer) tool
8-
- The Windows-only, graphical [Device Explorer](#device-explorer) tool
7+
- The Device Provisioning Service DPS tool
8+
- The Windows-only, graphical Device Explorer tool
99

10-
Use either of these tools to generate a device-specific connection string that you can copy and paste in the source code of the application running on your device. Both tools are available in this [repository][lnk-this-repo].
10+
Use either of these tools to generate a device-specific connection string that you can copy and paste in the source code of the application running on your device.
1111

1212
> Note: While IoT Hub supports multiple authentication schemes for devices, both these tools generate a pre-shared key to use for authentication.
1313
1414
> Note: You must have an IoT hub running in Azure before you can provision your device. The document [Set up IoT Hub][setup-iothub] describes how to set up an IoT hub.
1515
16-
You can also use both of these tools to monitor the messages that your device sends to an IoT hub and send commands to you your devices from IoT Hub.
16+
You can also use both of these tools to monitor the messages that your device sends to an IoT hub and send commands to your devices from IoT Hub.
1717

18-
<a name="iothub-explorer"/>
19-
## Use the iothub-explorer tool to provision a device
18+
<a name="dps"/>
2019

21-
The iothub-explorer tool is a cross-platform, command-line tool (written in Node.js) for managing your devices in IoT hub. You will need to pre-install Node.js for your platform including npm package manager from [nodejs.org](https://nodejs.org)
20+
## Use the Device Provisioning Service tool to provision a device
2221

23-
To install this tool in your environment, run the following command in a terminal/shell window on your machine:
24-
25-
```
26-
npm install -g iothub-explorer
27-
```
28-
29-
See [Install iothub-explorer][lnk-install-iothub-explorer] for more information.
30-
31-
To provision a new device:
32-
33-
1. Get the connection string for your IoT hub. See [Set up IoT Hub][setup-iothub] for more details.
34-
35-
2. Run the following command to register your device with your IoT hub. When you run the command, replace `<iothub-connection-string>` with the IoT Hub connection string from the previous step and replace `<device-name>` with a name for your device such as **mydevice**.
36-
37-
```
38-
iothub-explorer <iothub-connection-string> create <device-name> --connection-string
39-
```
40-
41-
You should see a response like this:
42-
43-
```
44-
Created device mydevice
45-
46-
-
47-
...
48-
-
49-
connectionString: HostName=<hostname>;DeviceId=mydevice;SharedAccessKey=<device-key>
50-
```
51-
52-
Copy the device connection string information for later use. The samples in this repository use connection strings in the format `HostName=<iothub-name>.azure-devices.net;DeviceId=<device-name>;SharedAccessKey=<device-key>`.
53-
54-
To get help on using the iothub-explorer tool to perform other tasks such as listing devices, deleting devices, and sending commands to devices, enter the following command:
55-
56-
```
57-
iothub-explorer --help
58-
```
59-
60-
For further information about using the iothub-explorer tool to perform tasks such as disabling a device, monitoring a device, and sending commands to a device see:
61-
62-
- [Working with the device identity registry][lnk-iothub-explorer-identity]
63-
- [Working with devices][lnk-iothub-explorer-devices]
22+
Follow the steps [here](https://docs.microsoft.com/en-us/azure/iot-dps/) to learn more about how to provision devices using the Device Provisioning Service.
6423

6524
<a name="device-explorer"/>
66-
## Use the Device Explorer tool to provision a device
67-
68-
The Device Explorer tool is a Windows-only graphical tool for managing your devices in IoT Hub.
6925

70-
The easiest way to install the Device Explorer tool in your environment is to download the pre-built version by clicking [Azure IoT SDKs releases][lnk-releasepage]. Scroll down to the **Downloads** section to locate the download link for the **SetupDeviceExplorer.msi** installer. Download and run the installer.
71-
72-
To run the Device Explorer tool, double-click the **DeviceExplorer.exe** file in Windows Explorer.
73-
The default installation folder for this application is **C:\Program Files (x86)\Microsoft\DeviceExplorer**.
74-
75-
> Tip: Pin the **DeviceExplorer.exe** application to your taskbar in Windows for easier access.
76-
77-
Before you register a new device in the IoT Hub device identity registry, you must connect Device Explorer to your IoT hub:
78-
79-
1. Get the connection string for your IoT hub. See [Set up IoT Hub][setup-iothub] for more details.
80-
81-
2. On the **Configuration** tab, paste the IoT Hub connection-string for your IoT hub into **IoT Hub connection string** and click **Update**:
82-
83-
![][img-getstarted1]
84-
85-
To register a new device with IoT Hub:
86-
87-
1. Click the **Management** tab to manage the devices connected to the IoT hub.
88-
89-
![][img-getstarted2]
90-
91-
2. On the **Management** tab, click **Create** to register a new device with your IoT hub. The **Create Device** dialog appears. In the **Device ID** field, type a unique name for your device such as **mydevice**, or select **Auto Generate ID** to generate a unique ID. Then click **Create**.
92-
93-
![][img-getstarted3]
94-
95-
3. The **Device Created** window appears, indicating that your device has been successfully registered with this IoT Hub.
96-
97-
![][img-getstarted4]
98-
99-
4. Right-click on a selected device to retrieve the connection string for your device:
100-
101-
![][img-connstr]
102-
103-
5. Select **Copy connection string** to copy the device connection string to the clipboard. You can now paste this connection-string into the source code of the device application you are working with. The samples in this repository use connection strings in the format `HostName=<iothub-name>.azure-devices.net;DeviceId=<device-name>;SharedAccessKey=<device-key>`.
26+
## Use the Device Explorer tool to provision a device
10427

105-
For further information about using the Device Explorer tool to perform tasks such as disabling a device, monitoring a device, and sending commands to a device see [Using the Device Explorer tool][lnk-device-explorer-docs].
28+
For information about using the Device Explorer tool to perform tasks such as disabling a device, monitoring a device, and sending commands to a device see [Using the Device Explorer tool][lnk-device-explorer-docs].
10629

10730

10831
[img-getstarted1]: media/device_explorer/iotgetstart1.png

‎doc/setup_iothub.md

Lines changed: 5 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -6,55 +6,12 @@ Before you can communicate with IoT Hub from a device you must create an IoT hub
66

77
## Create an IoT hub
88

9-
You can use the [Azure Portal][azure-portal] to create an IoT hub to use with your devices.
9+
Follow the steps given [here](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-csharp-csharp-getstarted#create-an-iot-hub) to create an IoT Hub.
10+
Your IoT hub is now created, and you have the IoT Hub connection string, which enables applications to perform management operations on the IoT hub such as adding a new device to the IoT hub.
1011

11-
1. Log on to the [Azure Portal][azure-portal].
12-
13-
2. In the jumpbar, click **New**, then click **Internet of Things**, and then click **Azure IoT Hub**.
14-
15-
![][1]
16-
17-
3. In the **New IoT Hub** blade, specify the desired configuration for the IoT Hub.
18-
19-
![][2]
20-
21-
* In the **Name** box, enter a name to identify your IoT hub. When the **Name** is validated, a green check mark appears in the **Name** box.
22-
* Change the **Pricing and scale tier** as desired. The getting started samples do not require a specific tier.
23-
* In the **Resource group** box, create a new resource group, or select and existing one. For more information, see [Using resource groups to manage your Azure resources][resource-group-portal].
24-
* Use **Location** to specify the geographic location in which to host your IoT hub.
25-
26-
27-
4. Once the new IoT hub options are configured, click **Create**. It can take a few minutes for the IoT hub to be created. To check the status, you can monitor the progress on the Startboard. Or, you can monitor your progress from the Notifications section.
28-
29-
![][3]
30-
31-
32-
5. After the IoT hub has been created successfully, open the blade of the new IoT hub, take note of the hostname URI, and click **Shared access policies**.
33-
34-
![][4]
35-
36-
6. Select the Shared access policy called **iothubowner**, then copy and take note of the connection string on the right blade.
37-
38-
![][5]
39-
40-
Your IoT hub is now created, and you have the connection string you need to use the [iothub-explorer or the Device Explorer][lnk-manage-iothub] tool. This connection string enables applications to perform management operations on the IoT hub such as adding a new device to the IoT hub.
41-
42-
43-
## Add devices to IoT Hub
12+
## Provision your device to IoT Hub
4413

4514
You must add details your device to IoT Hub before that device can communicate with the hub. When you add a device to an IoT hub, the hub generates the connection string that the device must use when it establishes the secure connection to the IoT hub.
15+
Follow the steps given [here](./manage_iot_hub.md) to add devices to your IoT Hub.
4616

47-
To add a device to your IoT hub, you can use the [iothub-explorer or the Device Explorer][lnk-manage-iothub] utility in this repository ([azure-iot-sdks](https://github.com/Azure/azure-iot-sdks)). These tools will generate a device specific connection string that you need to copy and paste in the source code of the application running on the device.
48-
49-
50-
[iothub-landing]: http://azure.microsoft.com/documentation/services/iot-hub/
51-
[azure-portal]: https://portal.azure.com
52-
[manage-iothub-portal]: http://azure.microsoft.com/documentation/articles/iot-hub-manage-portal/
53-
[lnk-manage-iothub]: manage_iot_hub.md
54-
[resource-group-portal]: https://azure.microsoft.com/documentation/articles/resource-group-portal/
55-
56-
[1]: media/create-iot-hub1.png
57-
[2]: media/create-iot-hub2.png
58-
[3]: media/create-iot-hub3.png
59-
[4]: media/create-iot-hub4.png
60-
[5]: media/create-iot-hub5.png
17+
[iothub-landing]: http://azure.microsoft.com/documentation/services/iot-hub/

0 commit comments

Comments
 (0)