SchemaRegistryClient.RegisterSchema Method

Definition

Namespace:

Azure.Data.SchemaRegistry

Assembly:

Azure.Data.SchemaRegistry.dll

Package:

Azure.Data.SchemaRegistry v1.4.0

Source:

SchemaRegistryClient.cs

Registers a schema with the SchemaRegistry service. If the schema did not previously exist in the Schema Registry instance, it is added to the instance and assigned a schema ID. If the schema did previous exist in the Schema Registry instance, a new version of the schema is added to the instance and assigned a new schema ID.

public virtual Azure.Response<Azure.Data.SchemaRegistry.SchemaProperties> RegisterSchema (string groupName, string schemaName, string schemaDefinition, Azure.Data.SchemaRegistry.SchemaFormat format, System.Threading.CancellationToken cancellationToken = default);

abstract member RegisterSchema : string * string * string * Azure.Data.SchemaRegistry.SchemaFormat * System.Threading.CancellationToken -> Azure.Response<Azure.Data.SchemaRegistry.SchemaProperties>
override this.RegisterSchema : string * string * string * Azure.Data.SchemaRegistry.SchemaFormat * System.Threading.CancellationToken -> Azure.Response<Azure.Data.SchemaRegistry.SchemaProperties>

Public Overridable Function RegisterSchema (groupName As String, schemaName As String, schemaDefinition As String, format As SchemaFormat, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SchemaProperties)

Parameters

groupName

String

The name of the SchemaRegistry group.

schemaName

String

The name of the schema.

schemaDefinition

String

The string representation of the schema's content.

format

SchemaFormat

The serialization format of the schema.

cancellationToken

CancellationToken

The cancellation token for the operation.

Returns

Response<SchemaProperties>

The properties of the schema.

Remarks

If using a schema format that is unsupported by this client, upgrade to a version that supports the schema format. Otherwise, the content MIME type string will be returned as the value of the Format for the returned Schema.