Share via

az notification-hub namespace authorization-rule

Note

This reference is part of the notification-hub extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az notification-hub namespace authorization-rule command. Learn more about extensions.

Commands to manage notification hubs namespace authorization rule.

Commands

Name Description Type Status
az notification-hub namespace authorization-rule create

Create an authorization rule for a namespace.

 Extension Experimental
az notification-hub namespace authorization-rule delete

Delete a namespace authorization rule.

 Extension Experimental
az notification-hub namespace authorization-rule list

List the authorization rules for a namespace.

 Extension Experimental
az notification-hub namespace authorization-rule list-keys

List the primary and secondary connection strings to the namespace.

 Extension Experimental
az notification-hub namespace authorization-rule regenerate-keys

Regenerate the primary/secondary keys to the namespace authorization rule.

 Extension Experimental
az notification-hub namespace authorization-rule show

Get an authorization rule for a namespace by name.

 Extension Experimental

az notification-hub namespace authorization-rule create

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create an authorization rule for a namespace.

az notification-hub namespace authorization-rule create --name
                                                        --namespace-name
                                                        --resource-group
                                                        --rights

Examples

Create a namespace authorization rule

az notification-hub namespace authorization-rule create --resource-group MyResourceGroup --namespace-name my-namespace --name "sdk-AuthRules-1788" --rights Listen Send

Required Parameters

--name -n

Authorization Rule 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>.

--rights

The rights associated with the rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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 notification-hub namespace authorization-rule delete

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a namespace authorization rule.

az notification-hub namespace authorization-rule delete [--ids]
                                                        [--name]
                                                        [--namespace-name]
                                                        [--resource-group]
                                                        [--subscription]
                                                        [--yes]

Examples

Delete a namespace authorization rule

az notification-hub namespace authorization-rule delete --resource-group MyResourceGroup --namespace-name my-namespace --name "RootManageSharedAccessKey"

Optional Parameters

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

--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

Authorization Rule Name.

Property Value
Parameter group: Resource Id Arguments
--namespace-name

The namespace name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
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.

--verbose

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

Property Value
Default value: False

az notification-hub namespace authorization-rule list

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the authorization rules for a namespace.

az notification-hub namespace authorization-rule list --namespace-name
                                                      --resource-group
                                                      [--max-items]
                                                      [--next-token]

Examples

List authorization rules of the namespace

az notification-hub namespace authorization-rule list --resource-group MyResourceGroup --namespace-name my-namespace

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

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

--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.

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination 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 notification-hub namespace authorization-rule list-keys

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the primary and secondary connection strings to the namespace.

az notification-hub namespace authorization-rule list-keys [--ids]
                                                           [--name]
                                                           [--namespace-name]
                                                           [--resource-group]
                                                           [--subscription]

Examples

List keys of the namesapce authorization rule

az notification-hub namespace authorization-rule list-keys --resource-group MyResourceGroup --namespace-name my-namespace --name "RootManageSharedAccessKey"

Optional Parameters

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

--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

The connection string of the namespace for the specified authorizationRule.

Property Value
Parameter group: Resource Id Arguments
--namespace-name

The namespace name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id 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.

--verbose

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

Property Value
Default value: False

az notification-hub namespace authorization-rule regenerate-keys

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Regenerate the primary/secondary keys to the namespace authorization rule.

az notification-hub namespace authorization-rule regenerate-keys --policy-key {Primary Key, Secondary Key}
                                                                 [--ids]
                                                                 [--name]
                                                                 [--namespace-name]
                                                                 [--resource-group]
                                                                 [--subscription]

Examples

Regenerate keys of the namesapce authorization rule

az notification-hub namespace authorization-rule regenerate-keys --resource-group MyResourceGroup --namespace-name my-namespace --name "RootManageSharedAccessKey" --policy-key "Secondary Key"

Required Parameters

--policy-key

Name of the key that has to be regenerated for the Namespace/Notification Hub Authorization Rule. The value can be Primary Key/Secondary Key.

Property Value
Parameter group: Parameters Arguments
Accepted values: Primary Key, Secondary Key

Optional Parameters

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

--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

The connection string of the namespace for the specified authorizationRule.

Property Value
Parameter group: Resource Id Arguments
--namespace-name

The namespace name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id 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.

--verbose

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

Property Value
Default value: False

az notification-hub namespace authorization-rule show

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get an authorization rule for a namespace by name.

az notification-hub namespace authorization-rule show [--ids]
                                                      [--name]
                                                      [--namespace-name]
                                                      [--resource-group]
                                                      [--subscription]

Examples

Show namespace authorization rule info

az notification-hub namespace authorization-rule show --resource-group MyResourceGroup --namespace-name my-namespace --name "RootManageSharedAccessKey"

Optional Parameters

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

--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

Authorization Rule Name.

Property Value
Parameter group: Resource Id Arguments
--namespace-name

The namespace name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id 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.

--verbose

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

Property Value
Default value: False