schema_registries

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

Overview

Name	schema_registries
Type	Resource
Id	azure.device_registry.schema_registries

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.
description	string	Human-readable description of the schema registry.
displayName	string	Human-readable display name.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
namespace	string	Schema registry namespace. Uniquely identifies a schema registry within a tenant. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
storageAccountContainerUrl	string	The Storage Account's Container URL where schemas will be stored. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uuid	string	Globally unique, immutable, non-reusable id.

list_by_resource_group

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.
description	string	Human-readable description of the schema registry.
displayName	string	Human-readable display name.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
namespace	string	Schema registry namespace. Uniquely identifies a schema registry within a tenant. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
storageAccountContainerUrl	string	The Storage Account's Container URL where schemas will be stored. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uuid	string	Globally unique, immutable, non-reusable id.

list_by_subscription

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.
description	string	Human-readable description of the schema registry.
displayName	string	Human-readable display name.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
namespace	string	Schema registry namespace. Uniquely identifies a schema registry within a tenant. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
storageAccountContainerUrl	string	The Storage Account's Container URL where schemas will be stored. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uuid	string	Globally unique, immutable, non-reusable id.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, schema_registry_name, subscription_id		Get a SchemaRegistry.
list_by_resource_group	select	resource_group_name, subscription_id		List SchemaRegistry resources by resource group.
list_by_subscription	select	subscription_id		List SchemaRegistry resources by subscription ID.
create_or_replace	insert	resource_group_name, schema_registry_name, subscription_id, location		Create a SchemaRegistry.
update	update	resource_group_name, schema_registry_name, subscription_id		Update a SchemaRegistry.
create_or_replace	replace	resource_group_name, schema_registry_name, subscription_id, location		Create a SchemaRegistry.
delete	delete	resource_group_name, schema_registry_name, subscription_id		Delete a SchemaRegistry.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
schema_registry_name	string	Schema registry name parameter. Required.
subscription_id	string

SELECT examples

get

Get a SchemaRegistry.

SELECT
id,
name,
description,
displayName,
identity,
location,
namespace,
provisioningState,
storageAccountContainerUrl,
systemData,
tags,
type,
uuid
FROM azure.device_registry.schema_registries
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND schema_registry_name = '{{ schema_registry_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List SchemaRegistry resources by resource group.

SELECT
id,
name,
description,
displayName,
identity,
location,
namespace,
provisioningState,
storageAccountContainerUrl,
systemData,
tags,
type,
uuid
FROM azure.device_registry.schema_registries
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List SchemaRegistry resources by subscription ID.

SELECT
id,
name,
description,
displayName,
identity,
location,
namespace,
provisioningState,
storageAccountContainerUrl,
systemData,
tags,
type,
uuid
FROM azure.device_registry.schema_registries
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_replace

Create a SchemaRegistry.

INSERT INTO azure.device_registry.schema_registries (
tags,
location,
properties,
identity,
resource_group_name,
schema_registry_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ schema_registry_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: schema_registries
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the schema_registries resource.
  - name: schema_registry_name
    value: "{{ schema_registry_name }}"
    description: Required parameter for the schema_registries resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the schema_registries resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      uuid: "{{ uuid }}"
      namespace: "{{ namespace }}"
      displayName: "{{ displayName }}"
      description: "{{ description }}"
      storageAccountContainerUrl: "{{ storageAccountContainerUrl }}"
      provisioningState: "{{ provisioningState }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"

UPDATE examples

update

Update a SchemaRegistry.

UPDATE azure.device_registry.schema_registries
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND schema_registry_name = '{{ schema_registry_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_replace

Create a SchemaRegistry.

REPLACE azure.device_registry.schema_registries
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND schema_registry_name = '{{ schema_registry_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a SchemaRegistry.

DELETE FROM azure.device_registry.schema_registries
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND schema_registry_name = '{{ schema_registry_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;