Skip to content

Commit 824c89a

Browse files
committed
rewrite as conceptual
1 parent 8df6ce9 commit 824c89a

File tree

5 files changed

+48
-43
lines changed

5 files changed

+48
-43
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Understand message schemas
3+
description: Learn how schema registry handles message schemas to work with Azure IoT Operations components including dataflows.
4+
author: kgremban
5+
ms.author: kgremban
6+
ms.topic: conceptual
7+
ms.date: 09/23/2024
8+
9+
#CustomerIntent: As an operator, I want to understand how I can use message schemas to filter and transform messages.
10+
---
11+
12+
# Understand message schemas
13+
14+
Schema registry, a feature provided by Azure Device Registry Preview, is a synchronized repository in the cloud and at the edge. The schema registry stores the definitions of messages coming from edge assets, and then exposes an API to access those schemas at the edge.
15+
16+
The connector for OPC UA can create message schemas and add them to the schema registry or customers can upload schemas to the operations experience web UI.
17+
18+
Edge services use message schemas to filter and transform messages as they're routed across your industrial edge scenario.
19+
20+
*Schemas* are documents that describe data to enable processing and contextualization. *Message schemas* describe the format of a message and its contents.
21+
22+
## How dataflows use message schemas
23+
24+
Message schemas are used in all three phases of a dataflow: defining the source input, applying data tranformations, and creating the destination output.
25+
26+
### Input schema
27+
28+
Each dataflow source requires a message schema.
29+
30+
Asset sources have a predefined message schema that was created by the connector for OPC UA.
31+
32+
MQTT sources require an uploaded message schema. Azure IoT Operations supports JSON schemas, and the filename is used as the schema name. In the operations experience, you can select an existing schema or upload one while defining an MQTT source:
33+
34+
:::image type="content" source="./media/concept-schema-registry/upload-schema.png" alt-text="Screenshot that shows uploading a message schema in the operations experience portal.":::
35+
36+
### Transformation
37+
38+
The operations experience uses the input schema as a starting point for your data, making it easier to select transformations based on the known input message format.
39+
40+
### Output schema
41+
42+
Schemas are only used for dataflows that select Fabric or ADX as the destination endpoint.
43+
44+
For these dataflows, the operations experience applies any transformations to the input schema then creates a new schema in Delta format. When the dataflow custom resource (CR) is created, it includes a `schemaRef` value that points to the generated schema stored in the schema registry.
45+
46+
Other endpoints don't need reference schemas because they accept messages in JSON format

articles/iot-operations/connect-to-cloud/howto-schema-registry.md

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

articles/iot-operations/connect-to-cloud/overview-dataflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Schema registry, a feature provided by Azure Device Registry Preview, is a synch
6565

6666
Dataflows uses messages schemas at both the source and destination points. For sources, message schemas can work as filters to identify the specific messages that you want to capture for a dataflow. For destinations, message schemas help to transform the message into the format expected by the destination endpoint.
6767

68-
For more information, see [Create message schemas](./howto-schema-registry.md).
68+
For more information, see [Understand message schemas](./howto-schema-registry.md).
6969

7070
## Related content
7171

articles/iot-operations/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ items:
9999
href: connect-to-cloud/concept-dataflow-conversions.md
100100
- name: Enrich data
101101
href: connect-to-cloud/concept-dataflow-enrich.md
102-
- name: Create message schemas
102+
- name: Use message schemas
103103
href: connect-to-cloud/howto-schema-registry.md
104104
- name: Manage dataflow profile
105105
href: connect-to-cloud/howto-configure-dataflow-profile.md

0 commit comments

Comments
 (0)