The Schema Registry client provides operations to interact with the Schema Registry service.
Inheritance
System.Object
SchemaRegistryClient
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Data.SchemaRegistry.dll
Syntax
public class SchemaRegistryClientConstructors
SchemaRegistryClient()
Declaration
protected SchemaRegistryClient ();SchemaRegistryClient(String, TokenCredential)
Declaration
public SchemaRegistryClient (string fullyQualifiedNamespace, Azure.Core.TokenCredential credential);Parameters
| System.String fullyQualifiedNamespace |
| Azure.Core.TokenCredential credential |
SchemaRegistryClient(String, TokenCredential, SchemaRegistryClientOptions)
Declaration
public SchemaRegistryClient (string fullyQualifiedNamespace, Azure.Core.TokenCredential credential, Azure.Data.SchemaRegistry.SchemaRegistryClientOptions options);Parameters
Properties
FullyQualifiedNamespace
Gets the fully qualified namespace that the client is connecting to.
Declaration
public string FullyQualifiedNamespace { get; }Property Value
| System.String |
Methods
GetSchema(String, CancellationToken)
Gets the schema content associated with the schema ID from the SchemaRegistry service.
Declaration
public virtual Azure.Response<Azure.Data.SchemaRegistry.SchemaRegistrySchema> GetSchema (string schemaId, System.Threading.CancellationToken cancellationToken = null);Parameters
| System.String schemaId The schema ID of the the schema from the SchemaRegistry. |
| System.Threading.CancellationToken cancellationToken The cancellation token for the operation. |
Returns
| Azure.Response<SchemaRegistrySchema> The properties of the schema, including the schema content provided by the service. |
GetSchema(String, String, Int32, CancellationToken)
Gets the schema content associated with the group name, schema name, and version from the SchemaRegistry service.
Declaration
public virtual Azure.Response<Azure.Data.SchemaRegistry.SchemaRegistrySchema> GetSchema (string groupName, string schemaName, int schemaVersion, System.Threading.CancellationToken cancellationToken = null);Parameters
| System.String groupName Schema group under which schema is registered. Group's serialization type should match the serialization type specified in the request. |
| System.String schemaName Name of schema. |
| System.Int32 schemaVersion Version number of specific schema. |
| System.Threading.CancellationToken cancellationToken The cancellation token for the operation. |
Returns
| Azure.Response<SchemaRegistrySchema> The properties of the schema, including the schema content provided by the service. |
GetSchemaAsync(String, CancellationToken)
Gets the schema content associated with the schema ID from the SchemaRegistry service.
Declaration
[System.Diagnostics.DebuggerStepThrough] public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Data.SchemaRegistry.SchemaRegistrySchema>> GetSchemaAsync (string schemaId, System.Threading.CancellationToken cancellationToken = null);Parameters
| System.String schemaId The schema ID of the the schema from the SchemaRegistry. |
| System.Threading.CancellationToken cancellationToken The cancellation token for the operation. |
Returns
| System.Threading.Tasks.Task<Azure.Response<SchemaRegistrySchema>> The properties of the schema, including the schema content provided by the service. |
GetSchemaAsync(String, String, Int32, CancellationToken)
Gets the schema content associated with the group name, schema name, and version from the SchemaRegistry service.
Declaration
[System.Diagnostics.DebuggerStepThrough] public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Data.SchemaRegistry.SchemaRegistrySchema>> GetSchemaAsync (string groupName, string schemaName, int schemaVersion, System.Threading.CancellationToken cancellationToken = null);Parameters
| System.String groupName Schema group under which schema is registered. Group's serialization type should match the serialization type specified in the request |
| System.String schemaName Name of schema. |
| System.Int32 schemaVersion Version number of specific schema. |
| System.Threading.CancellationToken cancellationToken The cancellation token for the operation. |
Returns
| System.Threading.Tasks.Task<Azure.Response<SchemaRegistrySchema>> The properties of the schema, including the schema content provided by the service. |
GetSchemaProperties(String, String, String, SchemaFormat, CancellationToken)
Gets the schema ID associated with the schema from the SchemaRegistry service.
Declaration
public virtual Azure.Response<Azure.Data.SchemaRegistry.SchemaProperties> GetSchemaProperties (string groupName, string schemaName, string schemaDefinition, Azure.Data.SchemaRegistry.SchemaFormat format, System.Threading.CancellationToken cancellationToken = null);Parameters
| System.String groupName The name of the SchemaRegistry group. |
| System.String schemaName The name of the schema. |
| System.String schemaDefinition The string representation of the schema's content. |
| SchemaFormat format The serialization format of the schema. |
| System.Threading.CancellationToken cancellationToken The cancellation token for the operation. |
Returns
| Azure.Response<SchemaProperties> The properties of the schema, including the schema ID provided by the service. |
GetSchemaPropertiesAsync(String, String, String, SchemaFormat, CancellationToken)
Gets the schema ID associated with the schema from the SchemaRegistry service.
Declaration
[System.Diagnostics.DebuggerStepThrough] public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Data.SchemaRegistry.SchemaProperties>> GetSchemaPropertiesAsync (string groupName, string schemaName, string schemaDefinition, Azure.Data.SchemaRegistry.SchemaFormat format, System.Threading.CancellationToken cancellationToken = null);Parameters
| System.String groupName The name of the SchemaRegistry group. |
| System.String schemaName The name of the schema. |
| System.String schemaDefinition The string representation of the schema's content. |
| SchemaFormat format The serialization format of the schema. |
| System.Threading.CancellationToken cancellationToken The cancellation token for the operation. |
Returns
| System.Threading.Tasks.Task<Azure.Response<SchemaProperties>> The properties of the schema, including the schema ID provided by the service. |
RegisterSchema(String, String, String, SchemaFormat, CancellationToken)
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.
Declaration
public virtual Azure.Response<Azure.Data.SchemaRegistry.SchemaProperties> RegisterSchema (string groupName, string schemaName, string schemaDefinition, Azure.Data.SchemaRegistry.SchemaFormat format, System.Threading.CancellationToken cancellationToken = null);Parameters
| System.String groupName The name of the SchemaRegistry group. |
| System.String schemaName The name of the schema. |
| System.String schemaDefinition The string representation of the schema's content. |
| SchemaFormat format The serialization format of the schema. |
| System.Threading.CancellationToken cancellationToken The cancellation token for the operation. |
Returns
RegisterSchemaAsync(String, String, String, SchemaFormat, CancellationToken)
Registers a schema with the SchemaRegistry service.
Declaration
[System.Diagnostics.DebuggerStepThrough] public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Data.SchemaRegistry.SchemaProperties>> RegisterSchemaAsync (string groupName, string schemaName, string schemaDefinition, Azure.Data.SchemaRegistry.SchemaFormat format, System.Threading.CancellationToken cancellationToken = null);Parameters
| System.String groupName The name of the SchemaRegistry group. |
| System.String schemaName The name of the schema. |
| System.String schemaDefinition The string representation of the schema's content. |
| SchemaFormat format The serialization format of the schema. |
| System.Threading.CancellationToken cancellationToken The cancellation token for the operation. |
Returns
| System.Threading.Tasks.Task<Azure.Response<SchemaProperties>> The properties of the schema. |
ncG1vNJzZmiZqqq%2Fpr%2FDpJuom6Njr627wWeaqKqVY8SqusOorqxmnprBcHDWnplonJ%2Bpu6bAjnqxrqqVY5GiwMBnipyglaKuk7HGoqqtqqlkfm9%2FjWlmmqiZZI67wdGeZX2ZpJZ7lK%2FHnqSaipWctrTA0bJmerKlp7JvkMCtmGeLk52yrq2xnp6iq6Snxm%2BfwqGcppmCmrSqv9OrsHykmZq7tXrHraSl