schema_registry

Creates, updates, deletes, gets or lists a schema_registry resource.

Overview

Name	schema_registry
Type	Resource
Id	azure.event_hub.schema_registry

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createdAtUtc	string (date-time)	Exact time the Schema Group was created.
eTag	string	The ETag value.
groupProperties	object	dictionary object for SchemaGroup group properties.
location	string	The geo-location where the resource lives.
schemaCompatibility	string	Known values are: "None", "Backward", and "Forward".
schemaType	string	Known values are: "Unknown" and "Avro".
systemData	object	The system meta data relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs".
updatedAtUtc	string (date-time)	Exact time the Schema Group was updated.

list_by_namespace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createdAtUtc	string (date-time)	Exact time the Schema Group was created.
eTag	string	The ETag value.
groupProperties	object	dictionary object for SchemaGroup group properties.
location	string	The geo-location where the resource lives.
schemaCompatibility	string	Known values are: "None", "Backward", and "Forward".
schemaType	string	Known values are: "Unknown" and "Avro".
systemData	object	The system meta data relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs".
updatedAtUtc	string (date-time)	Exact time the Schema Group was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, namespace_name, schema_group_name, subscription_id		Gets the details of an EventHub schema group.
list_by_namespace	select	resource_group_name, namespace_name, subscription_id	$skip, $top	Gets all the Schema Groups in a Namespace.
create_or_update	insert	resource_group_name, namespace_name, schema_group_name, subscription_id		Creates or Updates an EventHub schema group.
create_or_update	replace	resource_group_name, namespace_name, schema_group_name, subscription_id		Creates or Updates an EventHub schema group.
delete	delete	resource_group_name, namespace_name, schema_group_name, subscription_id		Deletes an EventHub schema group.

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
namespace_name	string	The Namespace name. Required.
resource_group_name	string	Name of the resource group within the azure subscription. Required.
schema_group_name	string	The Schema Group name. Required.
subscription_id	string
$skip	integer	Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. Default value is None.
$top	integer	May be used to limit the number of results to the most recent N usageDetails. Default value is None.

SELECT examples

get

Gets the details of an EventHub schema group.

SELECT
id,
name,
createdAtUtc,
eTag,
groupProperties,
location,
schemaCompatibility,
schemaType,
systemData,
type,
updatedAtUtc
FROM azure.event_hub.schema_registry
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND schema_group_name = '{{ schema_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_namespace

Gets all the Schema Groups in a Namespace.

SELECT
id,
name,
createdAtUtc,
eTag,
groupProperties,
location,
schemaCompatibility,
schemaType,
systemData,
type,
updatedAtUtc
FROM azure.event_hub.schema_registry
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skip = '{{ $skip }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or Updates an EventHub schema group.

INSERT INTO azure.event_hub.schema_registry (
properties,
resource_group_name,
namespace_name,
schema_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ namespace_name }}',
'{{ schema_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: schema_registry
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the schema_registry resource.
  - name: namespace_name
    value: "{{ namespace_name }}"
    description: Required parameter for the schema_registry resource.
  - name: schema_group_name
    value: "{{ schema_group_name }}"
    description: Required parameter for the schema_registry resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the schema_registry resource.
  - name: properties
    value:
      groupProperties: "{{ groupProperties }}"
      schemaCompatibility: "{{ schemaCompatibility }}"
      schemaType: "{{ schemaType }}"

REPLACE examples

create_or_update

Creates or Updates an EventHub schema group.

REPLACE azure.event_hub.schema_registry
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND schema_group_name = '{{ schema_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
type;

DELETE examples

delete

Deletes an EventHub schema group.

DELETE FROM azure.event_hub.schema_registry
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND schema_group_name = '{{ schema_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;