Microsoft.Azure.Data.SchemaRegistry.ApacheAvro 1.0.0-beta.8

Azure Schema Registry Apache Avro client library for .NET

Azure Schema Registry is a schema repository service hosted by Azure Event Hubs, providing schema storage, versioning, and management. This package provides an Avro serializer capable of serializing and deserializing payloads containing Schema Registry schema identifiers and Avro-serialized data.

Getting started

Install the package

Install the Azure Schema Registry Apache Avro library for .NET with NuGet:

dotnet add package Microsoft.Azure.Data.SchemaRegistry.ApacheAvro --version 1.0.0-beta.1

Prerequisites

• An Azure subscription
• An Event Hubs namespace

If you need to create an Event Hubs namespace, you can use the Azure Portal or Azure PowerShell.

You can use Azure PowerShell to create the Event Hubs namespace with the following command:

New-AzEventHubNamespace -ResourceGroupName myResourceGroup -NamespaceName namespace_name -Location eastus

Authenticate the client

In order to interact with the Azure Schema Registry service, you'll need to create an instance of the Schema Registry Client class. To create this client, you'll need Azure resource credentials and the Event Hubs namespace hostname.

Get credentials

To acquire authenicated credentials and start interacting with Azure resources, please see the quickstart guide here.

Get Event Hubs namespace hostname

The simpliest way is to use the Azure portal and navigate to your Event Hubs namespace. From the Overview tab, you'll see Host name. Copy the value from this field.

Create SchemaRegistryClient

Once you have the Azure resource credentials and the Event Hubs namespace hostname, you can create the SchemaRegistryClient. You'll also need the Azure.Identity package to create the credential.

// Create a new SchemaRegistry client using the default credential from Azure.Identity using environment variables previously set,
// including AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, and AZURE_TENANT_ID.
// For more information on Azure.Identity usage, see: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/README.md
var schemaRegistryClient = new SchemaRegistryClient(fullyQualifiedNamespace: fullyQualifiedNamespace, credential: new DefaultAzureCredential());

Key concepts

Serializer

This library provides a serializer, SchemaRegistryAvroSerializer, that interacts with EventData events. The SchemaRegistryAvroSerializer utilizes a SchemaRegistryClient to enrich the EventData events with the schema ID for the schema used to serialize the data.

This serializer requires the Apache Avro library. The payload types accepted by this serializer include GenericRecord and ISpecificRecord.

Examples

The following shows examples of what is available through the SchemaRegistryAvroSerializer. There are both sync and async methods available for these operations. These examples use a generated Apache Avro class Employee.cs created using this schema:

{
   "type" : "record",
    "namespace" : "TestSchema",
    "name" : "Employee",
    "fields" : [
        { "name" : "Name" , "type" : "string" },
        { "name" : "Age", "type" : "int" }
    ]
}

Details on generating a class using the Apache Avro library can be found in the Avro C# Documentation.

Serialize and deserialize data using the Event Hub EventData model

In order to serialize an EventData instance with Avro information, you can do the following:

var serializer = new SchemaRegistryAvroSerializer(client, groupName, new SchemaRegistryAvroSerializerOptions { AutoRegisterSchemas = true });

var employee = new Employee { Age = 42, Name = "Caketown" };
EventData eventData = (EventData) await serializer.SerializeAsync(employee, messageType: typeof(EventData));

// the schema Id will be included as a parameter of the content type
Console.WriteLine(eventData.ContentType);

// the serialized Avro data will be stored in the EventBody
Console.WriteLine(eventData.EventBody);

To deserialize an EventData event that you are consuming:

Employee deserialized = (Employee) await serializer.DeserializeAsync(eventData, typeof(Employee));
Console.WriteLine(deserialized.Age);
Console.WriteLine(deserialized.Name);

You can also use generic methods to serialize and deserialize the data. This may be more convenient if you are not building a library on top of the Avro serializer, as you won't have to worry about the virality of generics:

var serializer = new SchemaRegistryAvroSerializer(client, groupName, new SchemaRegistryAvroSerializerOptions { AutoRegisterSchemas = true });

var employee = new Employee { Age = 42, Name = "Caketown" };
EventData eventData = await serializer.SerializeAsync<EventData, Employee>(employee);

// the schema Id will be included as a parameter of the content type
Console.WriteLine(eventData.ContentType);

// the serialized Avro data will be stored in the EventBody
Console.WriteLine(eventData.EventBody);

Similarly, to deserialize:

Employee deserialized = await serializer.DeserializeAsync<Employee>(eventData);
Console.WriteLine(deserialized.Age);
Console.WriteLine(deserialized.Name);

Serialize and deserialize data using MessageContent directly

It is also possible to serialize and deserialize using MessageContent. Use this option if you are not integrating with any of the messaging libraries that work with MessageContent.

var serializer = new SchemaRegistryAvroSerializer(client, groupName, new SchemaRegistryAvroSerializerOptions { AutoRegisterSchemas = true });
MessageContent content = await serializer.SerializeAsync<MessageContent, Employee>(employee);

Employee deserializedEmployee = await serializer.DeserializeAsync<Employee>(content);

Troubleshooting

If you encounter errors when communicating with the Schema Registry service, these errors will be thrown as a RequestFailedException. The serializer will only communicate with the service the first time it encounters a schema (when serializing) or a schema ID (when deserializing). Any errors related to serialization to Avro, or deserialization from Avro, will be thrown as a AvroSerializationException. The InnerException property will contain the underlying exception that was thrown from the Apache Avro library. When deserializing, the SerializedSchemaId property will contain the schema ID corresponding to the serialized data. Using our Employee schema example, if we add an Employee_V2 model that adds a new required field, this would not be compatible with Employee. If the data we are attempting to deserialize may contain a schema that would not be compatible with our Employee_V2 model, then we might write code like the following:

try
{
    Employee_V2 employeeV2 = await serializer.DeserializeAsync<Employee_V2>(content);
}
catch (SchemaRegistryAvroException exception)
{
    // When this exception occurs when deserializing, the exception message will contain the schema ID that was used to
    // serialize the data.
    Console.WriteLine(exception);

    // We might also want to look up the specific schema from Schema Registry so that we can log the schema definition
    if (exception.SchemaId != null)
    {
        SchemaRegistrySchema schema = await client.GetSchemaAsync(exception.SchemaId);
        Console.WriteLine(schema.Definition);
    }
}

In general, any invalid Avro schemas would probably be caught during testing, but such schemas will also result in a AvroSerializationException being thrown when attempting to serialize using an invalid writer schema, or deserialize when using an invalid reader schema.

Next steps

See Azure Schema Registry for additional information.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.