Skip to content

Commit 6d46915

Browse files
authored
Merge pull request #302679 from dominicbetts/release-aio-2507-terminology
AIO 2507: Fix terminology
2 parents dcc0d1f + cebf2c9 commit 6d46915

File tree

8 files changed

+28
-28
lines changed

8 files changed

+28
-28
lines changed

articles/iot-operations/deploy-iot-ops/howto-deploy-iot-operations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ In this article, we discuss Azure IoT Operations *deployments* and *instances*,
2020
* An Azure IoT Operations instance
2121
* Arc extensions
2222
* Custom locations
23-
* Resources that you can configure in your Azure IoT Operations solution, like assets and asset endpoints.
23+
* Resources that you can configure in your Azure IoT Operations solution, like assets and devices.
2424

2525
* An Azure IoT Operations *instance* is the parent resource that bundles the suite of services that are defined in [What is Azure IoT Operations?](../overview-iot-operations.md) like MQTT broker, data flows, and connector for OPC UA.
2626

articles/iot-operations/discover-manage-assets/concept-assets-devices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ You can create, edit, and delete devices and assets by using the Azure IoT Opera
5050

5151
Before you can create an asset, you need to define a device. A device is a profile that describes southbound edge connectivity information for one or more assets.
5252

53-
Currently, the only southbound connectors available in Azure IoT Operations are the connector for OPC UA, the media connector (preview), the connector for ONVIF (preview), and the connector for HTTP/REST (preview). You can use the Azure IoT Operations SDKs to create custom connectors. Devices are configurations for a connector that enable it to connect to an asset. For example:
53+
Currently, the only southbound connectors available in Azure IoT Operations are the connector for OPC UA, the media connector (preview), the connector for ONVIF (preview), and the connector for REST/HTTP (preview). You can use the Azure IoT Operations SDKs to create custom connectors. Devices are configurations for a connector that enable it to connect to an asset. For example:
5454

5555
- A device for OPC UA stores the information you need to connect to an OPC UA server.
5656
- A device for the media connector stores the information you need to connect to a media source.

articles/iot-operations/discover-manage-assets/howto-use-http-connector.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: How to use the HTTP connector (preview)
2+
title: How to use the connector for REST/HTTP (preview)
33
description: Use the operations experience web UI or the Azure CLI to configure assets and devices for connections to HTTP endpoints.
44
author: dominicbetts
55
ms.author: dobett
@@ -10,15 +10,15 @@ ms.date: 10/07/2024
1010
#CustomerIntent: As an industrial edge IT or operations user, I want configure my Azure IoT Operations environment so that I can access data from HTTP/REST endpoints.
1111
---
1212

13-
# Configure the HTTP connector (preview)
13+
# Configure the connector for REST/HTTP (preview)
1414

15-
In Azure IoT Operations, the HTTP connector (preview) enables access to data from HTTP/REST endpoints such as edge-attached cameras.
15+
In Azure IoT Operations, the connector for REST/HTTP (preview) enables access to data from HTTP/REST endpoints such as edge-attached cameras.
1616

1717
[!INCLUDE [iot-operations-asset-definition](../includes/iot-operations-asset-definition.md)]
1818

1919
[!INCLUDE [iot-operations-device-definition](../includes/iot-operations-device-definition.md)]
2020

21-
This article explains how to use the HTTP connector to perform tasks such as:
21+
This article explains how to use the connector for REST/HTTP to perform tasks such as:
2222

2323
- Define the devices that connect HTTP sources to your Azure IoT Operations instance.
2424
- Add assets, and define their streams, data points, and events to enable data flow from the HTTP source to the MQTT broker.
@@ -31,11 +31,11 @@ To configure devices and assets, you need a running instance of Azure IoT Operat
3131

3232
[!INCLUDE [iot-operations-entra-id-setup](../includes/iot-operations-entra-id-setup.md)]
3333

34-
Your IT administrator must have configured the HTTP connector template for your Azure IoT Operations instance in the Azure portal.
34+
Your IT administrator must have configured the connector for REST/HTTP template for your Azure IoT Operations instance in the Azure portal.
3535

3636
A camera connected to your network and accessible from your Azure IoT Operations cluster. The camera must support the Real Time Streaming Protocol for video streaming. You also need the camera's username and password to authenticate with it.
3737

38-
## Deploy the HTTP connector
38+
## Deploy the connector for REST/HTTP
3939

4040
<!--TODO: Probably not necessary now we have the connector templates? -->
4141

@@ -46,9 +46,9 @@ A camera connected to your network and accessible from your Azure IoT Operations
4646
4747
## Create a device
4848

49-
To configure the HTTP connector, first create a device that defines the connection to the HTTP source. The device includes the URL of the HTTP source, the type of HTTP source, and any credentials you need to access the HTTP source.
49+
To configure the connector for REST/HTTP, first create a device that defines the connection to the HTTP source. The device includes the URL of the HTTP source, the type of HTTP source, and any credentials you need to access the HTTP source.
5050

51-
If your HTTP endpoint requires authentication, create a secret in your Kubernetes cluster that stores the endpoint's username and password. The HTTP connector uses this secret to authenticate with the endpoint:
51+
If your HTTP endpoint requires authentication, create a secret in your Kubernetes cluster that stores the endpoint's username and password. The connector for REST/HTTP uses this secret to authenticate with the endpoint:
5252

5353
1. Create a YAML file called _contoso-http-secrets.yaml_ with the following content. Replace the placeholders with your camera's username and password encoded in base64:
5454

@@ -206,7 +206,7 @@ authentication: {
206206

207207
## Asset configuration
208208

209-
When you configure an asset, the `datasets.DataPoints` parameter specifies the action the HTTP connector takes on the asset. An HTTP asset supports the following task types:
209+
When you configure an asset, the `datasets.DataPoints` parameter specifies the action the connector for REST/HTTP takes on the asset. An HTTP asset supports the following task types:
210210

211211
| Task type | Description |
212212
|-----------|-------------|
@@ -216,7 +216,7 @@ When you configure an asset, the `datasets.DataPoints` parameter specifies the a
216216
The following examples show how to deploy assets for each task type.
217217

218218
> [!TIP]
219-
> The HTTP pods aren't created in Kubernetes until you deploy an asset that uses the HTTP connector. If you try to run the `kubectl get pods` command before deploying an asset, you see no HTTP pods.
219+
> The HTTP pods aren't created in Kubernetes until you deploy an asset that uses the connector for REST/HTTP. If you try to run the `kubectl get pods` command before deploying an asset, you see no HTTP pods.
220220

221221
## Snapshot to MQTT
222222

articles/iot-operations/discover-manage-assets/overview-akri.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The following table shows the connectors currently available in Azure IoT Operat
6262
| Connector for OPC UA | Yes | Yes |
6363
| Connector for ONVIF | No | Yes |
6464
| Media connector | Yes | No |
65-
| HTTP connector | No | No |
65+
| Connector for REST/HTTP | No | No |
6666

6767
The media connector supports discovery of cameras and other media devices that use the ONVIF protocol.
6868

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
---
2-
title: Connect HTTP sources using the HTTP connector (preview)
3-
description: The HTTP connector (preview) in Azure IoT Operations makes HTTP from HTTP sources such as IP cameras available to other Azure IoT Operations components.
2+
title: Connect HTTP sources using the connector for REST/HTTP (preview)
3+
description: The connector for REST/HTTP (preview) in Azure IoT Operations makes HTTP from HTTP sources such as IP cameras available to other Azure IoT Operations components.
44
author: dominicbetts
55
ms.author: dobett
66
ms.service: azure-iot-operations
77
ms.topic: overview
88
ms.date: 11/12/2024
99

10-
#CustomerIntent: As an industrial edge IT or operations user, I want to understand what the HTTP connector is so that I can determine whether I can use it in my industrial IoT solution.
10+
#CustomerIntent: As an industrial edge IT or operations user, I want to understand what the connector for REST/HTTP is so that I can determine whether I can use it in my industrial IoT solution.
1111
---
1212

13-
# What is the Azure IoT Operations HTTP connector (preview)?
13+
# What is the Azure IoT Operations connector for REST/HTTP (preview)?
1414

15-
This article introduces the HTTP connector (preview) in Azure IoT Operations. The HTTP connector calls REST endpoints to retrieve data to share with other Azure IoT Operations components. The HTTP connector is secure and performant.
15+
This article introduces the connector for REST/HTTP (preview) in Azure IoT Operations. The connector for REST/HTTP calls REST endpoints to retrieve data to share with other Azure IoT Operations components. The connector for REST/HTTP is secure and performant.
1616

1717
## HTTP source types
1818

19-
The HTTP connector can connect to various sources.
19+
The connector for REST/HTTP can connect to various sources.
2020

2121
<!-- TODO: Add details here when we have more information -->
2222

2323
## Example uses
2424

25-
Example uses of the HTTP connector include calling REST APIs to retrieve data from industrial devices such as cameras, sensors, and other devices that expose data over HTTP.
25+
Example uses of the connector for REST/HTTP include calling REST APIs to retrieve data from industrial devices such as cameras, sensors, and other devices that expose data over HTTP.
2626

2727
<!-- TODO: Add details here when we have more information -->
2828

2929
## How does it relate to Azure IoT Operations?
3030

31-
The HTTP connector is part of Azure IoT Operations. The connector deploys to an Arc-enabled Kubernetes cluster on the edge as part of an Azure IoT Operations deployment. The connector interacts with other Azure IoT Operations components, such as:
31+
The connector for REST/HTTP is part of Azure IoT Operations. The connector deploys to an Arc-enabled Kubernetes cluster on the edge as part of an Azure IoT Operations deployment. The connector interacts with other Azure IoT Operations components, such as:
3232

3333
- [Assets and devices](./concept-assets-devices.md)
3434
- [The MQTT broker](../connect-to-cloud/overview-dataflow.md)
@@ -37,4 +37,4 @@ The HTTP connector is part of Azure IoT Operations. The connector deploys to an
3737
## Next step
3838

3939
> [!div class="nextstepaction"]
40-
> [How to use the HTTP connector](howto-use-http-connector.md)
40+
> [How to use the connector for REST/HTTP](howto-use-http-connector.md)

articles/iot-operations/discover-manage-assets/overview-manage-assets.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Azure IoT Operations includes several services that help you manage devices and
7878
- The **connector for OPC UA** is a data ingress and protocol translation service that enables Azure IoT Operations to ingress data from OPC UA servers. A key requirement in industrial environments is for a common standard or protocol for machine-to-machine and machine-to-cloud data exchange. [OPC UA](https://opcfoundation.org/about/opc-technologies/opc-ua/) is a specification for a platform independent service-oriented architecture that enables data exchange in industrial environments. The connector receives messages and events from your assets and publishes the data to topics in the MQTT broker.
7979
- The **media connector (preview)** is a service that makes media from media sources such as edge-attached cameras available to other Azure IoT Operations components.
8080
- The **connector for ONVIF (preview)** is a service that discovers and registers ONVIF assets such as cameras. The connector enables you to manage and control ONVIF assets such as cameras connected to your cluster.
81-
- The **REST/HTTP connector** is a service that lets you connect to REST/HTTP endpoints and publish data to the MQTT broker.
81+
- The **connector for REST/HTTP** is a service that lets you connect to REST/HTTP endpoints and publish data to the MQTT broker.
8282
- **Custom connectors** are services that you can create to connect to other data sources and publish data to the MQTT broker. Use the Azure IoT Operations SDKS to create custom connectors that meet your specific requirements.
8383
- **Akri services** are a set of services that enable the automatic discovery of physical assets and devices in your environment. Akri services can help you create and configure assets and devices in operations experience. To learn more, see [What is asset discovery (preview)?](overview-akri.md).
8484

@@ -120,9 +120,9 @@ And the final screenshot shows the same thermostat asset as a Kubernetes custom
120120

121121
### Automatic asset discovery
122122

123-
Akri services let you deploy and configure connectivity protocols, such as OPC UA and ONVIF, at the edge. Akri services use the asset and asset endpoint resources in Azure Device Registry to model the different device and protocol connections in your environment.
123+
Akri services let you deploy and configure connectivity protocols, such as OPC UA and ONVIF, at the edge. Akri services use the asset and device resources in Azure Device Registry to model the different device and protocol connections in your environment.
124124

125-
Akri services simplify the process of creating assets by automatically onboarding assets with pre-configured datasets and asset endpoints generated by the connectors to represent capabilities and devices on the network.
125+
Akri services simplify the process of creating assets by automatically onboarding assets with pre-configured datasets and device endpoints generated by the connectors to represent capabilities and devices on the network.
126126

127127
Currently:
128128

articles/iot-operations/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,10 @@ items:
115115
displayName: camera, PTZ, pan, tilt, zoom, DiscoveredAsset, DiscoveredAssetEndpointProfile, media, events, stream, southbound
116116
- name: Connect to HTTP endpoints
117117
items:
118-
- name: Understand the HTTP connector
118+
- name: Understand the connector for REST/HTTP
119119
href: discover-manage-assets/overview-http-connector.md
120120
displayName: HTTP, REST, API, southbound
121-
- name: Use the HTTP connector
121+
- name: Use the connector for REST/HTTP
122122
href: discover-manage-assets/howto-use-http-connector.md
123123
displayName: HTTP, REST, API, southbound
124124
- name: Manage MQTT broker

articles/iot-operations/troubleshoot/tips-tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ To view custom resource types other that pods in the cluster:
208208
> [!TIP]
209209
> To search for a custom resource type by name, type **/** and then start typing the name of the type you're looking for.
210210
211-
1. Select a custom resource and choose one of the available operations. For example, you can view the YAML definition os an asset endpoint profile by selecting it and pressing **y**. For some resources, you can edit the configuration.
211+
1. Select a custom resource and choose one of the available operations. For example, you can view the YAML definition of a device endpoint profile by selecting it and pressing **y**. For some resources, you can edit the configuration.
212212

213213
The following table describes some of the custom resource types you might work with in Azure IoT Operations:
214214

0 commit comments

Comments
 (0)