schemas

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

Overview

Name	schemas
Type	Resource
Id	azure.device_registry.schemas

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list_by_schema_registry

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, schemaRegistryName, schemaName		Get a Schema
list_by_schema_registry	select	subscriptionId, resourceGroupName, schemaRegistryName		List Schema resources by SchemaRegistry
create_or_replace	insert	subscriptionId, resourceGroupName, schemaRegistryName, schemaName		Create a Schema
delete	delete	subscriptionId, resourceGroupName, schemaRegistryName, schemaName		Delete a 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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
schemaName	string	Schema name parameter.
schemaRegistryName	string	Schema registry name parameter.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a Schema

SELECT
properties
FROM azure.device_registry.schemas
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND schemaRegistryName = '{{ schemaRegistryName }}' -- required
AND schemaName = '{{ schemaName }}' -- required
;

list_by_schema_registry

List Schema resources by SchemaRegistry

SELECT
properties
FROM azure.device_registry.schemas
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND schemaRegistryName = '{{ schemaRegistryName }}' -- required
;

INSERT examples

create_or_replace

Create a Schema

INSERT INTO azure.device_registry.schemas (
data__properties,
subscriptionId,
resourceGroupName,
schemaRegistryName,
schemaName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ schemaRegistryName }}',
'{{ schemaName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: schemas
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the schemas resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the schemas resource.
    - name: schemaRegistryName
      value: string
      description: Required parameter for the schemas resource.
    - name: schemaName
      value: string
      description: Required parameter for the schemas resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

DELETE examples

delete

Delete a Schema

DELETE FROM azure.device_registry.schemas
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND schemaRegistryName = '{{ schemaRegistryName }}' --required
AND schemaName = '{{ schemaName }}' --required
;