Skip to content

Commit 55468e1

Browse files
Merge pull request #222278 from KennedyDMSFT/US44747-05
December freshness (5/11) - in progress
2 parents 4148bde + c52be21 commit 55468e1

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

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

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.author: kgremban
77
ms.service: iot-hub
88
services: iot-hub
99
ms.topic: conceptual
10-
ms.date: 06/10/2019
10+
ms.date: 12/21/2022
1111
ms.custom: [amqp, mqtt, 'Role: Cloud Development', 'Role: System Architecture']
1212
---
1313

@@ -17,17 +17,19 @@ ms.custom: [amqp, mqtt, 'Role: Cloud Development', 'Role: System Architecture']
1717

1818
## IoT Hub names
1919

20-
You can find the hostname of the IoT hub that hosts your endpoints in the portal on your hub's **Overview** page. By default, the DNS name of an IoT hub looks like: `{your iot hub name}.azure-devices.net`.
20+
You can find the hostname of the IoT hub that hosts your endpoints in the Azure portal, on your IoT hub's **Overview** working pane. By default, the DNS name of an IoT hub looks like the following example:
21+
22+
`{your iot hub name}.azure-devices.net`
2123

2224
## List of built-in IoT Hub endpoints
2325

2426
Azure IoT Hub is a multi-tenant service that exposes its functionality to various actors. The following diagram shows the various endpoints that IoT Hub exposes.
2527

26-
![IoT Hub endpoints](./media/iot-hub-devguide-endpoints/endpoints.png)
28+
:::image type="content" source="./media/iot-hub-devguide-endpoints/endpoints.png" alt-text="Diagram showing the list of build-in IoT Hub endpoints." border="false":::
2729

2830
The following list describes the endpoints:
2931

30-
* **Resource provider**. The IoT Hub resource provider exposes an [Azure Resource Manager](../azure-resource-manager/management/overview.md) interface. This interface enables Azure subscription owners to create and delete IoT hubs, and to update IoT hub properties. IoT Hub properties govern [hub-level security policies](iot-hub-dev-guide-sas.md#access-control-and-permissions), as opposed to device-level access control, and functional options for cloud-to-device and device-to-cloud messaging. The IoT Hub resource provider also enables you to [export device identities](iot-hub-devguide-identity-registry.md#import-and-export-device-identities).
32+
* **Resource provider**. The IoT Hub resource provider exposes an [Azure Resource Manager](../azure-resource-manager/management/overview.md) interface. This interface enables Azure subscription owners to create and delete IoT hubs, and to update IoT hub properties. IoT Hub properties govern [hub-level shared access policies](iot-hub-dev-guide-sas.md#access-control-and-permissions), as opposed to device-level access control, and functional options for cloud-to-device and device-to-cloud messaging. The IoT Hub resource provider also enables you to [export device identities](iot-hub-devguide-identity-registry.md#import-and-export-device-identities).
3133

3234
* **Device identity management**. Each IoT hub exposes a set of HTTPS REST endpoints to manage device identities (create, retrieve, update, and delete). [Device identities](iot-hub-devguide-identity-registry.md) are used for device authentication and access control.
3335

@@ -43,9 +45,9 @@ The following list describes the endpoints:
4345

4446
* *Initiate file uploads*. A device uses this endpoint to receive an Azure Storage SAS URI from IoT Hub to [upload a file](iot-hub-devguide-file-upload.md).
4547

46-
* *Retrieve and update device twin properties*. A device uses this endpoint to access its [device twin](iot-hub-devguide-device-twins.md)'s properties. HTTPS is not supported.
48+
* *Retrieve and update device twin properties*. A device uses this endpoint to access its [device twin](iot-hub-devguide-device-twins.md)'s properties. HTTPS isn't supported.
4749

48-
* *Receive direct method requests*. A device uses this endpoint to listen for [direct method](iot-hub-devguide-direct-methods.md)'s requests. HTTPS is not supported.
50+
* *Receive direct method requests*. A device uses this endpoint to listen for [direct method](iot-hub-devguide-direct-methods.md) requests. HTTPS isn't supported.
4951

5052
[!INCLUDE [iot-hub-include-x509-ca-signed-support-note](../../includes/iot-hub-include-x509-ca-signed-support-note.md)]
5153

@@ -59,15 +61,15 @@ The following list describes the endpoints:
5961

6062
* *Direct method invocation*. This endpoint allows a back-end service to invoke a [direct method](iot-hub-devguide-direct-methods.md) on a device.
6163

62-
The [Azure IoT SDKs](iot-hub-devguide-sdks.md) article describes the various ways to access these endpoints.
64+
The [Azure IoT Hub SDKs](iot-hub-devguide-sdks.md) article describes the various ways to access these endpoints.
6365

6466
All IoT Hub endpoints use the [TLS](https://tools.ietf.org/html/rfc5246) protocol, and no endpoint is ever exposed on unencrypted/unsecured channels.
6567

6668
## Custom endpoints
6769

68-
You can link existing Azure services in your Azure subscriptions to your IoT hub to act as endpoints for message routing. These endpoints act as service endpoints and are used as sinks for message routes. Devices cannot write directly to the additional endpoints. Learn more about [message routing](../iot-hub/iot-hub-devguide-messages-d2c.md).
70+
You can link existing Azure services in your Azure subscriptions to your IoT hub to act as endpoints for message routing. These endpoints act as service endpoints and are used as sinks for message routes. Devices can't write directly to these endpoints. For more information about message routing, see [Use IoT Hub message routing to send device-to-cloud messages to different endpoints](../iot-hub/iot-hub-devguide-messages-d2c.md).
6971

70-
IoT Hub currently supports the following Azure services as additional endpoints:
72+
IoT Hub currently supports the following Azure services as custom endpoints:
7173

7274
* Storage containers
7375
* Event Hubs
@@ -83,15 +85,15 @@ For the limits on the number of endpoints you can add, see [Quotas and throttlin
8385

8486
## Field gateways
8587

86-
In an IoT solution, a *field gateway* sits between your devices and your IoT Hub endpoints. It is typically located close to your devices. Your devices communicate directly with the field gateway by using a protocol supported by the devices. The field gateway connects to an IoT Hub endpoint using a protocol that is supported by IoT Hub. A field gateway might be a dedicated hardware device or a low-power computer running custom gateway software.
88+
In an IoT solution, a *field gateway* sits between your devices and your IoT Hub endpoints. It's typically located close to your devices. Your devices communicate directly with the field gateway by using a protocol supported by the devices. The field gateway connects to an IoT Hub endpoint using a protocol that is supported by IoT Hub. A field gateway might be a dedicated hardware device or a low-power computer running custom gateway software.
8789

8890
You can use [Azure IoT Edge](../iot-edge/index.yml) to implement a field gateway. IoT Edge offers functionality such as multiplexing communications from multiple devices onto the same IoT Hub connection.
8991

9092
## Next steps
9193

9294
Other reference topics in this IoT Hub developer guide include:
9395

94-
* [IoT Hub query language for device twins, jobs, and message routing](iot-hub-devguide-query-language.md)
95-
* [Quotas and throttling](iot-hub-devguide-quotas-throttling.md)
96-
* [IoT Hub MQTT support](iot-hub-mqtt-support.md)
97-
* [Understand your IoT hub IP address](iot-hub-understand-ip-address.md)
96+
* [IoT Hub query language for device and module twins, jobs, and message routing](iot-hub-devguide-query-language.md)
97+
* [IoT Hub quotas and throttling](iot-hub-devguide-quotas-throttling.md)
98+
* [Communicate with your IoT hub using the MQTT protocol](iot-hub-mqtt-support.md)
99+
* [IoT Hub IP addresses](iot-hub-understand-ip-address.md)

0 commit comments

Comments
 (0)