schema_registries

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

Overview

Name	schema_registries
Type	Resource
Id	azure.event_hubs.schema_registries

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the Schema Group description.

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
location	string	The geo-location where the resource lives
properties	object
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"

list_by_namespace

Successfully retrieved the list of SchemaGroups.

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
location	string	The geo-location where the resource lives
properties	object
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"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, namespaceName, schemaGroupName, subscriptionId		Gets the details of an EventHub schema group.
list_by_namespace	select	resourceGroupName, namespaceName, subscriptionId	$skip, $top	Gets all the Schema Groups in a Namespace.
create_or_update	insert	resourceGroupName, namespaceName, schemaGroupName, subscriptionId		Creates or Updates an EventHub schema group.
delete	delete	resourceGroupName, namespaceName, schemaGroupName, subscriptionId		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
namespaceName	string	The Namespace name
resourceGroupName	string	Name of the resource group within the azure subscription.
schemaGroupName	string	The Schema Group name
subscriptionId	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$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.
$top	integer	May be used to limit the number of results to the most recent N usageDetails.

SELECT examples

get

Gets the details of an EventHub schema group.

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.event_hubs.schema_registries
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND schemaGroupName = '{{ schemaGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_namespace

Gets all the Schema Groups in a Namespace.

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.event_hubs.schema_registries
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $skip = '{{ $skip }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or Updates an EventHub schema group.

INSERT INTO azure.event_hubs.schema_registries (
data__properties,
resourceGroupName,
namespaceName,
schemaGroupName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ namespaceName }}',
'{{ schemaGroupName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: schema_registries
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the schema_registries resource.
    - name: namespaceName
      value: string
      description: Required parameter for the schema_registries resource.
    - name: schemaGroupName
      value: string
      description: Required parameter for the schema_registries resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the schema_registries resource.
    - name: properties
      value: object

DELETE examples

delete

Deletes an EventHub schema group.

DELETE FROM azure.event_hubs.schema_registries
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND schemaGroupName = '{{ schemaGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;