az iot adr schema registry

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.73.0 or higher). The extension will automatically install the first time you run an az iot adr schema registry command. Learn more about extensions.

Command group 'iot adr schema' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Schema Registries.

A Schema Registry stores Schema Version content in an Azure Data Lake Storage Gen2 container. It is a separate Azure resource and does not belong to a Device Registry namespace.

Commands

Name	Description	Type	Status
az iot adr schema registry create	Create a Schema Registry backed by Azure Data Lake Storage Gen2.	Extension	Preview
az iot adr schema registry delete	Delete a Schema Registry.	Extension	Preview
az iot adr schema registry list	List Schema Registries.	Extension	Preview
az iot adr schema registry show	Show a Schema Registry.	Extension	Preview
az iot adr schema registry update	Update writable Schema Registry properties.	Extension	Preview
az iot adr schema registry wait	Wait for a Schema Registry operation to finish.	Extension	Preview

az iot adr schema registry create

Preview

Command group 'iot adr schema registry' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a Schema Registry backed by Azure Data Lake Storage Gen2.

Provide the URL of an existing container in a storage account with hierarchical namespace. When only an outbound identity is selected, the command also attaches that identity to the Schema Registry. The command does not create the container or grant storage access.

az iot adr schema registry create --container-url --storage-account-container-url
                                  --name
                                  --registry-namespace
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--desc --description]
                                  [--display-name]
                                  [--location]
                                  [--no-wait]
                                  [--omi-sa --outbound-system-assigned-mi {false, true}]
                                  [--omi-ua --outbound-user-assigned-mi]
                                  [--system-assigned-mi {false, true}]
                                  [--tags]
                                  [--user-assigned-mi]

Examples

Create a Schema Registry with a system-assigned identity

az iot adr schema registry create -n site-a -g MyRG \
  --registry-namespace site-a \
  --storage-account-container-url https://mystorage.blob.core.windows.net/schemas \
  --system-assigned-mi

Required Parameters

--container-url --storage-account-container-url

URL of the existing Azure Data Lake Storage Gen2 container used to store Schema Version content.

--name -n

Schema Registry name.

--registry-namespace

Tenant-unique namespace for the Schema Registry.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--desc --description

Description for the Schema Registry.

--display-name

Display name for the Schema Registry.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--omi-sa --outbound-system-assigned-mi

Use the Schema Registry system-assigned identity for outbound calls. Pass false on update to clear the explicit outbound identity.

Property	Value
Parameter group:	Outbound Identity Arguments
Accepted values:	false, true

--omi-ua --outbound-user-assigned-mi

User-assigned managed identity resource ID used for outbound calls.

Property	Value
Parameter group:	Outbound Identity Arguments

--system-assigned-mi

Include or remove the system-assigned managed identity.

Property	Value
Parameter group:	Managed Identity Arguments
Accepted values:	false, true

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--user-assigned-mi

Complete desired set of user-assigned managed identity resource IDs.

Property	Value
Parameter group:	Managed Identity Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az iot adr schema registry delete

Preview

Command group 'iot adr schema registry' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a Schema Registry.

az iot adr schema registry delete --name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--no-wait]
                                  [--yes {false, true}]

Examples

Delete a Schema Registry

az iot adr schema registry delete -n site-a -g MyRG --yes

Required Parameters

--name -n

Schema Registry name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--yes -y

Skip user prompts. Indicates acceptance of action. Used primarily for automation scenarios. Default: false.

Property	Value
Accepted values:	false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az iot adr schema registry list

Preview

Command group 'iot adr schema registry' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List Schema Registries.

az iot adr schema registry list [--resource-group]

Examples

List Schema Registries in a resource group

az iot adr schema registry list -g MyRG

List Schema Registries in the subscription

az iot adr schema registry list

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az iot adr schema registry show

Preview

Command group 'iot adr schema registry' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show a Schema Registry.

az iot adr schema registry show --name
                                --resource-group

Examples

Show a Schema Registry

az iot adr schema registry show -n site-a -g MyRG

Required Parameters

--name -n

Schema Registry name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az iot adr schema registry update

Preview

Command group 'iot adr schema registry' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update writable Schema Registry properties.

az iot adr schema registry update --name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--desc --description]
                                  [--display-name]
                                  [--no-wait]
                                  [--omi-sa --outbound-system-assigned-mi {false, true}]
                                  [--omi-ua --outbound-user-assigned-mi]
                                  [--system-assigned-mi {false, true}]
                                  [--tags]
                                  [--user-assigned-mi]

Examples

Update the display name and tags

az iot adr schema registry update -n site-a -g MyRG \
  --display-name "Site A" --tags environment=test

Required Parameters

--name -n

Schema Registry name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--desc --description

Description for the Schema Registry.

--display-name

Display name for the Schema Registry.

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--omi-sa --outbound-system-assigned-mi

Use the Schema Registry system-assigned identity for outbound calls. Pass false on update to clear the explicit outbound identity.

Property	Value
Parameter group:	Outbound Identity Arguments
Accepted values:	false, true

--omi-ua --outbound-user-assigned-mi

User-assigned managed identity resource ID used for outbound calls.

Property	Value
Parameter group:	Outbound Identity Arguments

--system-assigned-mi

Include or remove the system-assigned managed identity.

Property	Value
Parameter group:	Managed Identity Arguments
Accepted values:	false, true

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--user-assigned-mi

Complete desired set of user-assigned managed identity resource IDs.

Property	Value
Parameter group:	Managed Identity Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az iot adr schema registry wait

Preview

Command group 'iot adr schema registry' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Wait for a Schema Registry operation to finish.

Use after starting an operation with --no-wait. Specify a condition such as --created, --updated, --deleted, or --exists.

az iot adr schema registry wait --name
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]
                                [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--interval]
                                [--timeout]
                                [--updated]

Examples

Wait for a Schema Registry to be created

az iot adr schema registry wait -n site-a -g MyRG --created

Required Parameters

--name -n

Schema Registry name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False