You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-signalr/signalr-howto-use-management-sdk.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ ms.author: lianwei
10
10
11
11
# Use Azure SignalR Management SDK
12
12
13
-
Azure SignalR Management SDK helps you to manage SignalR clients through Azure SignalR Service directly such as broadcast messages. Therefore, this SDK could be but not limited to be used in [serverless](https://azure.microsoft.com/solutions/serverless/) environments. You could use this SDK to manage SignalR clients connected to your Azure SignalR Service in any environment, such as in a console app, in an Azure function or in a web server.
13
+
Azure SignalR Management SDK helps you to manage SignalR clients through Azure SignalR Service directly such as broadcast messages. Therefore, this SDK can be used in [serverless](https://azure.microsoft.com/solutions/serverless/) environments, but it is not limited to them. You could use this SDK to manage SignalR clients connected to your Azure SignalR Service in any environment, such as in a console app, in an Azure function or in a web server.
description: This article shows you how to create a schema registry in an Azure Event Hubs namespace.
2
+
title: 'Quickstart: Create an Azure Event Hubs Schema Registry'
3
+
description: Azure Schema Registry provides a central repository for schemas for event-driven and messaging-centric apps. Learn how to create a schema registry.
4
4
ms.topic: quickstart
5
-
ms.date: 09/09/2022
5
+
ms.date: 06/16/2025
6
6
ms.custom: references_regions, mode-other
7
+
#customer intent: As a developer, I want to learn how to implement Azure Schema Registry as a central repository to support event-driven and messaging-centric applications.
8
+
7
9
---
8
10
9
11
# Quickstart: Create an Azure Event Hubs schema registry using Azure portal
10
12
11
-
**Azure Schema Registry** is a feature of Event Hubs, which provides a central repository for schemas for event-driven and messaging-centric applications. It provides the flexibility for your producer and consumer applications to **exchange data without having to manage and share the schema**. It also provides a simple governance framework for reusable schemas and defines relationship between schemas through a grouping construct (schema groups). For more information, see [Azure Schema Registry in Event Hubs](schema-registry-overview.md).
13
+
In this quickstart, you create a schema group with schemas in a schema registry hosted by Azure Event Hubs.
12
14
13
-
This article shows you how to create a schema group with schemas in a schema registry hosted by Azure Event Hubs.
15
+
*Azure Schema Registry* is a feature of Event Hubs. It provides a central repository for schemas for event-driven and messaging-centric applications. It provides the flexibility for your producer and consumer applications to *exchange data without having to manage and share the schema*. It also provides a simple governance framework for reusable schemas and defines relationship between schemas through a grouping construct (schema groups). For more information, see [Azure Schema Registry in Event Hubs](schema-registry-overview.md).
14
16
15
-
> [!NOTE]
16
-
> - The feature isn't available in the **basic** tier.
17
-
> - Make sure that you are a member of one of these roles: **Owner**, **Contributor**, or **Schema Registry Contributor**. For details about role-based access control, see [Schema Registry overview](schema-registry-concepts.md#azure-role-based-access-control).
18
-
> - If the event hub is in a **virtual network**, you won't be able to create schemas in the Azure portal unless you access the portal from a VM in the same virtual network.
19
17
18
+
> [!NOTE]
19
+
> - The feature isn't available in the **Basic** tier.
20
+
> - Make sure that you're a member of one of these roles: **Owner**, **Contributor**, or **Schema Registry Contributor**. For more information, see [Azure role-based access control](schema-registry-concepts.md#azure-role-based-access-control).
21
+
> - If the event hub is in a *virtual network*, you can't create schemas in the Azure portal unless you access the portal from a virtual machine in the same virtual network.
20
22
21
23
## Prerequisites
22
-
[Create an Event Hubs namespace](event-hubs-create.md#create-an-event-hubs-namespace). You can also use an existing namespace.
24
+
25
+
[Create an Event Hubs namespace](event-hubs-create.md#create-an-event-hubs-namespace). You can instead use an existing namespace.
23
26
24
27
## Create a schema group
25
-
1. Navigate to the **Event Hubs Namespace** page.
26
-
1. Select **Schema Registry** on the left menu. To create a schema group, select **+ Schema Group** on the toolbar.
27
28
28
-
:::image type="content" source="./media/create-schema-registry/namespace-page.png" alt-text="Image showing the Schema Registry page in the Azure portal":::
29
+
1. Navigate to the **Event Hubs Namespace** page.
30
+
1. In the left menu, expand **Entities** and select **Schema Registry**.
31
+
1. To create a schema group, select **+ Schema Group**.
32
+
33
+
:::image type="content" source="./media/create-schema-registry/namespace-page.png" alt-text="Screenshot showing the Schema Registry page in the Azure portal" lightbox="./media/create-schema-registry/namespace-page.png":::
34
+
29
35
1. On the **Create Schema Group** page, do these steps:
30
-
1. Enter a **name** for the schema group.
31
-
1. For **Serialization type**, select **Avro** serialization format that applies to all schemas in the schema group. **JSON** serialization format is also supported (preview).
32
-
3. Select a **compatibility mode** for all schemas in the group. For **Avro**, forward and backward compatibility modes are supported.
33
-
4. Then, select **Create** to create the schema group.
34
-
35
-
:::image type="content" source="./media/create-schema-registry/create-schema-group-page.png" alt-text="Image showing the page for creating a schema group":::
36
-
1. Select the name of the **schema group** in the list of schema groups.
37
36
38
-
:::image type="content" source="./media/create-schema-registry/select-schema-group.png" alt-text="Image showing schema group in the list selected.":::
37
+
1. Enter a **name** for the schema group.
38
+
1. For **Serialization type**, select **Avro** serialization format. This format applies to all schemas in the schema group. **JSON** serialization format is also supported (preview).
39
+
1. Select a **compatibility mode** for all schemas in the group. For **Avro**, forward and backward compatibility modes are supported.
40
+
1. Select **Create** to create the schema group.
41
+
42
+
:::image type="content" source="./media/create-schema-registry/create-schema-group-page.png" alt-text="Screenshot showing the page for creating a schema group.":::
43
+
44
+
1. Select the name of the schema group in the list of schema groups.
45
+
46
+
:::image type="content" source="./media/create-schema-registry/select-schema-group.png" alt-text="Screenshot showing schema group in the list selected." lightbox="./media/create-schema-registry/select-schema-group.png":::
47
+
39
48
1. You see the **Schema Group** page for the group.
40
49
41
-
:::image type="content" source="./media/create-schema-registry/schema-group-page.png" alt-text="Image showing the Schema Group page":::
42
-
50
+
:::image type="content" source="./media/create-schema-registry/schema-group-page.png" alt-text="Screenshot showing the Schema Group page." lightbox="./media/create-schema-registry/schema-group-page.png":::
51
+
43
52
44
53
## Add a schema to the schema group
54
+
45
55
In this section, you add a schema to the schema group using the Azure portal.
46
56
47
57
1. On the **Schema Group** page, select **+ Schema** on the toolbar.
48
58
1. On the **Create Schema** page, do these steps:
59
+
49
60
1. For **Name**, enter `orderschema`.
50
-
1. Enter the following **schema** into the text box. You can also select file with the schema.
61
+
1. Enter the following **schema** into the text box. You can instead select a file with the schema.
51
62
52
63
```json
53
64
{
@@ -66,41 +77,46 @@ In this section, you add a schema to the schema group using the Azure portal.
66
77
]
67
78
}
68
79
```
69
-
1. Select **Create**.
80
+
1. Select **Create**.
81
+
70
82
1. Select the **schema** from the list of schemas.
71
83
72
-
:::image type="content" source="./media/create-schema-registry/select-schema.png" alt-text="Image showing the schema selected.":::
84
+
:::image type="content" source="./media/create-schema-registry/select-schema.png" alt-text="Screenshot showing the schema selected.":::
85
+
73
86
1. You see the **Schema Overview** page for the schema.
74
87
75
-
:::image type="content" source="./media/create-schema-registry/schema-overview-page.png" alt-text="Image showing the Schema Overview page.":::
76
-
1. If there are multiple versions of a schema, you see them in the **Versions** drop-down list. Select a version to switch to that version schema.
88
+
:::image type="content" source="./media/create-schema-registry/schema-overview-page.png" alt-text="Image showing the Schema Overview page." lightbox="./media/create-schema-registry/schema-overview-page.png":::
89
+
90
+
1. If there are multiple versions of a schema, you see them in the **Versions**. Select a version to switch to that version schema.
77
91
78
92
## Create a new version of schema
79
93
80
-
1. Update the schema in the text box, and select **Validate**. In the following example, a new field `description` has been added to the schema.
94
+
1. Update the schema in the text box, and select **Validate**. In the following example, you add a new field called `description` to the schema.
95
+
96
+
:::image type="content" source="./media/create-schema-registry/update-schema.png" alt-text="Screenshot showing the Update schema page" lightbox="./media/create-schema-registry/update-schema.png":::
81
97
82
-
:::image type="content" source="./media/create-schema-registry/update-schema.png" alt-text="Image showing the Update schema page":::
83
-
84
98
1. Review validation status and changes, and select **Save**.
85
99
86
-
:::image type="content" source="./media/create-schema-registry/compare-save-schema.png" alt-text="Image showing the Review page that shows validation status, changes, and save":::
87
-
1. You see that `2` is selected for the **version** on the **Schema Overview** page.
100
+
:::image type="content" source="./media/create-schema-registry/compare-save-schema.png" alt-text="Screenshot showing the Review page that shows validation status, changes, and save." lightbox="./media/create-schema-registry/compare-save-schema.png":::
101
+
102
+
You see that `2` is selected for the **version** on the **Schema Overview** page.
103
+
104
+
:::image type="content" source="./media/create-schema-registry/new-version.png" alt-text="Screenshot showing the new version of schema." lightbox="./media/create-schema-registry/new-version.png":::
88
105
89
-
:::image type="content" source="./media/create-schema-registry/new-version.png" alt-text="Image showing the new version of schema":::
90
106
1. Select `1` to see the version 1 of the schema.
91
107
92
108
## Clean up resources
93
109
94
110
> [!NOTE]
95
-
> Don't clean up resources if you want to continue to the next quick start linked from **Next steps**.
111
+
> Don't clean up resources if you want to continue to the next quickstart linked from **Next step**.
96
112
97
-
1. Navigate to the **Event Hubs Namespace** page.
113
+
1. Navigate to the **Event Hubs Namespace** page.
98
114
1. Select **Schema Registry** on the left menu.
99
-
1. Select the **schema group** you created in this quickstart.
115
+
1. Select the **schema group** you created in this quickstart.
100
116
1. On the **Schema Group** page, select **Delete** on the toolbar.
101
117
1. On the **Delete Schema Group** page, type the name of the schema group, and select **Delete**.
102
118
103
-
## Next steps
119
+
## Next step
104
120
105
121
> [!div class="nextstepaction"]
106
122
> [Validate schema when sending and receiving events - AMQP and .NET](schema-registry-dotnet-send-receive-quickstart.md).
![learn-build-service-prod[bot]](https://avatars.githubusercontent.com/in/237442?v=4&size=40){kind=avatar}
0 commit comments