schemas
Creates, updates, deletes, gets or lists a schemas resource.
Overview
| Name | schemas |
| Type | Resource |
| Id | azure.schema_registry.schemas |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_schema_by_id | exec | id, fully_qualified_namespace | Get a registered schema by its unique ID reference. Gets a registered schema by its unique ID. Azure Schema Registry guarantees that ID is unique within a namespace. Operation response type is based on serialization of schema requested. | |
get_schema_by_version | exec | group_name, schema_name, schema_version, fully_qualified_namespace | Get specific schema versions. Gets one specific version of one schema. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
fully_qualified_namespace | string | The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client fullyQualifiedNamespace parameter. (default: ) |
group_name | string | Name of schema group. Required. |
id | string | Schema ID that uniquely identifies a schema in the registry namespace. Required. |
schema_name | string | Name of schema. Required. |
schema_version | integer | Version number of specific schema. Required. |
Lifecycle Methods
- get_schema_by_id
- get_schema_by_version
Get a registered schema by its unique ID reference. Gets a registered schema by its unique ID. Azure Schema Registry guarantees that ID is unique within a namespace. Operation response type is based on serialization of schema requested.
EXEC azure.schema_registry.schemas.get_schema_by_id
@id='{{ id }}' --required,
@fully_qualified_namespace='{{ fully_qualified_namespace }}' --required
;
Get specific schema versions. Gets one specific version of one schema.
EXEC azure.schema_registry.schemas.get_schema_by_version
@group_name='{{ group_name }}' --required,
@schema_name='{{ schema_name }}' --required,
@schema_version='{{ schema_version }}' --required,
@fully_qualified_namespace='{{ fully_qualified_namespace }}' --required
;