SchemaRegistryClient.GetSchema Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
GetSchema(String, CancellationToken) |
Gets the schema content associated with the schema ID from the SchemaRegistry service. |
GetSchema(String, String, Int32, CancellationToken) |
Gets the schema content associated with the group name, schema name, and version from the SchemaRegistry service. |
GetSchema(String, CancellationToken)
- Source:
- SchemaRegistryClient.cs
- Source:
- SchemaRegistryClient.cs
Gets the schema content associated with the schema ID from the SchemaRegistry service.
public virtual Azure.Response<Azure.Data.SchemaRegistry.SchemaRegistrySchema> GetSchema (string schemaId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSchema : string * System.Threading.CancellationToken -> Azure.Response<Azure.Data.SchemaRegistry.SchemaRegistrySchema>
override this.GetSchema : string * System.Threading.CancellationToken -> Azure.Response<Azure.Data.SchemaRegistry.SchemaRegistrySchema>
Public Overridable Function GetSchema (schemaId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SchemaRegistrySchema)
Parameters
- schemaId
- String
The schema ID of the the schema from the SchemaRegistry.
- cancellationToken
- CancellationToken
The cancellation token for the operation.
Returns
The properties of the schema, including the schema content provided by the service.
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 Properties.
Applies to
GetSchema(String, String, Int32, CancellationToken)
- Source:
- SchemaRegistryClient.cs
- Source:
- SchemaRegistryClient.cs
Gets the schema content associated with the group name, schema name, and version from the SchemaRegistry service.
public virtual Azure.Response<Azure.Data.SchemaRegistry.SchemaRegistrySchema> GetSchema (string groupName, string schemaName, int schemaVersion, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSchema : string * string * int * System.Threading.CancellationToken -> Azure.Response<Azure.Data.SchemaRegistry.SchemaRegistrySchema>
override this.GetSchema : string * string * int * System.Threading.CancellationToken -> Azure.Response<Azure.Data.SchemaRegistry.SchemaRegistrySchema>
Public Overridable Function GetSchema (groupName As String, schemaName As String, schemaVersion As Integer, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SchemaRegistrySchema)
Parameters
- groupName
- String
Schema group under which schema is registered. Group's serialization type should match the serialization type specified in the request.
- schemaName
- String
Name of schema.
- schemaVersion
- Int32
Version number of specific schema.
- cancellationToken
- CancellationToken
The cancellation token for the operation.
Returns
The properties of the schema, including the schema content provided by the service.
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 Properties.