Skip to content

Commit ce1c3a9

Browse files
jsquirejsquire
authored
[Event Grid Client] Overview README (Azure#21190)
The focus of these changes is to add the overview content as a README in the root of the SDK directory, which will be used by the MS Docs site to as the landing page: [Azure Event Grid libraries for .NET - Azure for .NET Developers](https://docs.microsoft.com/dotnet/api/overview/azure/eventgrid)
1 parent 8e17e23 commit ce1c3a9

File tree

3 files changed

+41
-5
lines changed

3 files changed

+41
-5
lines changed

‎eng/.docsettings.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ known_content_issues:
150150
- ['sdk/extensions/Azure.Extensions.AspNetCore.Configuration.Secrets/README.md', 'azure-sdk-tools/issues/404']
151151
- ['sdk/extensions/Microsoft.Azure.WebJobs.Extensions.Clients/README.md','azure-sdk-tools/issues/404']
152152
- ['sdk/extensions/Microsoft.Extensions.Azure/README.md','#5499']
153+
- ['sdk/eventgrid/README.md','azure-sdk-tools/issues/42']
153154
- ['sdk/eventgrid/Microsoft.Azure.Messaging.EventGrid.CloudNativeCloudEvents/README.md', '#15423']
154155
- ['sdk/eventhub/README.md','azure-sdk-tools/issues/42']
155156
- ['sdk/search/README.md','azure-sdk-tools/issues/42']

‎sdk/eventgrid/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Azure Event Grid libraries for .NET
2+
3+
Azure Event Grid allows you to build applications with event-based architectures. The Event Grid service fully manages all routing of events from any source, to any destination, for any application. Azure service events and custom events can be published directly to the service, where the events can then be filtered and sent to various recipients, such as built-in handlers or custom webhooks. To learn more about Azure Event Grid: [What is Event Grid?](https://docs.microsoft.com/azure/event-grid/overview)
4+
5+
## Libraries for data access
6+
7+
The current generation of the Azure Event Grid client library uses the package name `Azure.Messaging.EventGrid`. Microsoft recommends using `Azure.Messaging.EventGrid` for new applications. If you are unable to upgrade existing applications, then Microsoft recommends using version 3.2 or higher of the previous package, `Microsoft.Azure.EventGrid`.
8+
9+
### `Azure.Messaging.EventGrid`
10+
11+
This package is the current generation client library and is of the Azure SDK for .NET. The source code is available on [GitHub](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/eventgrid/Azure.Messaging.EventGrid).
12+
13+
Use the following packages to publish and consume events from Event Grid:
14+
15+
| Nuget Package | Reference | Samples |
16+
|--------------------------------------|---------------------------------------------------------------|-------------------------------------------------------------------------------|
17+
| [Azure.Messaging.EventGrid](https://www.nuget.org/packages/Azure.Messaging.EventGrid) | [API Reference for Azure.Messaging.EventGrid](https://docs.microsoft.com/dotnet/api/azure.messaging.eventgrid?view=azure-dotnet) | [Samples for Azure.Messaging.EventGrid](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/eventgrid/Azure.Messaging.EventGrid/samples) |
18+
19+
### `Microsoft.Azure.EventGrid`
20+
21+
The source code for the previous generation client library, `Microsoft.Azure.EventGrid` is available on [GitHub](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/eventgrid/Microsoft.Azure.EventGrid).
22+
23+
Use the following legacy packages to publish and consume events from Event Grid:
24+
25+
| Nuget Package | Reference | Samples |
26+
|--------------------------------------|---------------------------------------------------------------|-------------------------------------------------------------------------------|
27+
| [Microsoft.Azure.EventGrid](https://www.nuget.org/packages/Microsoft.Azure.EventGrid) | [API Reference for Microsoft.Azure.EventGrid](https://docs.microsoft.com/dotnet/api/microsoft.azure.eventgrid?view=azure-dotnet) | [Samples for Azure.Messaging.EventGrid](https://github.com/Azure-Samples/event-grid-dotnet-publish-consume-events/tree/master/) |
28+
29+
## Libraries for resource management
30+
31+
Use the following library to work with the Azure Event Grid resource provider:
32+
33+
| Nuget Package | Reference |
34+
|--------------------------------------|---------------------------------------------------------------|
35+
| [Microsoft.Azure.Management.EventGrid](https://www.nuget.org/packages/Microsoft.Azure.Management.EventGrid) | [API Reference for Microsoft.Azure.Management.EventGrid](https://docs.microsoft.com/dotnet/api/overview/azure/eventgrid/management?view=azure-dotnet) |

‎sdk/eventhub/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Azure Event Hubs is a highly scalable publish-subscribe service that can ingest
44

55
## Libraries for data access
66

7-
The current generation of the Azure Event Hubs client library uses versions 5.0.1 and above. Microsoft recommends using version 5.2 or higher for new applications. If you are unable to existing applications to version 5.x, then Microsoft recommends using version 4.1 or higher.
7+
The current generation of the Azure Event Hubs client library uses package names that follow the pattern `Azure.Messaging.EventHubs.*`. Microsoft recommends using the `Azure.Messaging.EventHubs` family of packages for for new applications. If you are unable to existing applications, then Microsoft recommends using version 4.1 or higher of the legacy Event Hubs packages, `Microsoft.Azure.EventHubs.*`
88

9-
### Version 5.x
9+
### `Azure.Messaging.EventHubs`
1010

11-
The version 5.x client libraries are part of the Azure SDK for .NET. The source code for the Azure Event Hubs client libraries is available on [GitHub](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/eventhub).
11+
These packages are the current generation of client libraries for Event Hubs and are part of the Azure SDK for .NET. The source code is available on [GitHub](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/eventhub).
1212

1313
Use the following packages to publish and consume events from Event Hubs:
1414

@@ -17,9 +17,9 @@ Use the following packages to publish and consume events from Event Hubs:
1717
| [Azure.Messaging.EventHubs](https://www.nuget.org/packages/Azure.Messaging.EventHubs) | [API Reference for Azure.Messaging.EventHubs](https://docs.microsoft.com/dotnet/api/azure.messaging.eventhubs?view=azure-dotnet) | [Samples for Azure.Messaging.EventHubs](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/eventhub/Azure.Messaging.EventHubs/samples) |
1818
| [Azure.Messaging.EventHubs.Processor](https://www.nuget.org/packages/Azure.Messaging.EventHubs.Processor) | [API Reference for Azure.Messaging.EventHubs.Processor](https://docs.microsoft.com/dotnet/api/azure.messaging.eventhubs?view=azure-dotnet) | [Samples for Azure.Messaging.EventHubs.Processor](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/eventhub/Azure.Messaging.EventHubs.Processor/samples) |
1919

20-
### Version 4.x
20+
### `Microsoft.Azure.EventHubs`
2121

22-
The source code for version 4.x of the Azure Event Hubs client libraries is available on [GitHub](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/eventhub).
22+
These packages are the legacy generation of client libraries for Event Hubs. The source code is available on [GitHub](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/eventhub).
2323

2424
Use the following legacy packages to publish and consume events from Event Hubs:
2525

0 commit comments

Comments
 (0)