Share via

az eventhubs namespace schema-registry

  • Reference

Manages eventhubs namespace schema registry.

Commands

Name Description Type Status
az eventhubs namespace schema-registry create

Create an EventHub schema group.

 Core GA
az eventhubs namespace schema-registry delete

Delete an EventHub schema group.

 Core GA
az eventhubs namespace schema-registry list

List all the Schema Groups in a Namespace.

 Core GA
az eventhubs namespace schema-registry show

Get the details of an EventHub schema group.

 Core GA
az eventhubs namespace schema-registry update

Update an EventHub schema group.

 Core GA

az eventhubs namespace schema-registry create

Edit

Create an EventHub schema group.

az eventhubs namespace schema-registry create --name
                                              --namespace-name
                                              --resource-group
                                              [--group-properties]
                                              [--schema-compatibility {Backward, Forward, None}]
                                              [--schema-type {Avro, Unknown}]

Required Parameters

--name --schema-group-name -n

The Schema Group name.

--namespace-name

The Namespace name.

--resource-group -g

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

Optional Parameters

--group-properties

Dictionary object for SchemaGroup group properties Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--schema-compatibility

Compatibility of Schema.

Accepted values: Backward, Forward, None
--schema-type

Type of Schema.

Accepted values: Avro, Unknown
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az eventhubs namespace schema-registry delete

Edit

Delete an EventHub schema group.

az eventhubs namespace schema-registry delete [--ids]
                                              [--name]
                                              [--namespace-name]
                                              [--resource-group]
                                              [--subscription]

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --schema-group-name -n

The Schema Group name.

--namespace-name

The Namespace name.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az eventhubs namespace schema-registry list

Edit

List all the Schema Groups in a Namespace.

az eventhubs namespace schema-registry list --namespace-name
                                            --resource-group
                                            [--max-items]
                                            [--next-token]
                                            [--skip]
                                            [--top]

Required Parameters

--namespace-name

The Namespace name.

--resource-group -g

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

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--skip

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

May be used to limit the number of results to the most recent N usageDetails.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az eventhubs namespace schema-registry show

Edit

Get the details of an EventHub schema group.

az eventhubs namespace schema-registry show [--ids]
                                            [--name]
                                            [--namespace-name]
                                            [--resource-group]
                                            [--subscription]

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --schema-group-name -n

The Schema Group name.

--namespace-name

The Namespace name.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az eventhubs namespace schema-registry update

Edit

Update an EventHub schema group.

az eventhubs namespace schema-registry update [--add]
                                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--group-properties]
                                              [--ids]
                                              [--name]
                                              [--namespace-name]
                                              [--remove]
                                              [--resource-group]
                                              [--schema-compatibility {Backward, Forward, None}]
                                              [--schema-type {Avro, Unknown}]
                                              [--set]
                                              [--subscription]

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--group-properties

Dictionary object for SchemaGroup group properties Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --schema-group-name -n

The Schema Group name.

--namespace-name

The Namespace name.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

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

--schema-compatibility

Compatibility of Schema.

Accepted values: Backward, Forward, None
--schema-type

Type of Schema.

Accepted values: Avro, Unknown
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.