Share via

az notification-hub authorization-rule

  • Experimental
  • Reference

Note

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

Command group 'notification-hub' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage notification hubs authorization rule.

Commands

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

Create an authorization rule for a notification hub.

 Extension Experimental
az notification-hub authorization-rule delete

Delete a notificationHub authorization rule.

 Extension Experimental
az notification-hub authorization-rule list

List the authorization rules for a notification hub.

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

List the primary and secondary connection strings to the notification hub.

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

Regenerates the primary/secondary keys to the notification hub authorization rule.

 Extension Experimental
az notification-hub authorization-rule show

Show an authorization rule for a notification hub by name.

 Extension Experimental

az notification-hub authorization-rule create

Experimental

Command group 'notification-hub' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create an authorization rule for a notification hub.

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

Examples

Create an authorization rule

az notification-hub authorization-rule create --resource-group MyResourceGroup --namespace-name my-namespace --notification-hub-name my-hub --name DefaultListenSharedAccessSignature --rights Listen Send

Required Parameters

--name -n

Authorization Rule Name.

--namespace-name

The namespace name.

--notification-hub-name

The notification hub name.

--resource-group -g

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

Optional Parameters

--rights

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

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 notification-hub authorization-rule delete

Experimental

Command group 'notification-hub' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a notificationHub authorization rule.

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

Examples

Delete a notificationHub authorization rule

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

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

Authorization Rule Name.

--namespace-name

The namespace name.

--notification-hub-name

The notification hub 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.

--yes -y

Do not prompt for confirmation.

Default value: False
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 notification-hub authorization-rule list

Experimental

Command group 'notification-hub' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the authorization rules for a notification hub.

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

Examples

List the authorization rules for a notification hub.

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

Required Parameters

--namespace-name

The namespace name.

--notification-hub-name

The notification hub 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.

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 notification-hub authorization-rule list-keys

Experimental

Command group 'notification-hub' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the primary and secondary connection strings to the notification hub.

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

Examples

List connection strings of the authorization rule

az notification-hub authorization-rule list-keys --resource-group MyResourceGroup --namespace-name my-namespace --notification-hub-name my-hub --name "sdk-AuthRules-5800"

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

The connection string of the NotificationHub for the specified authorizationRule.

--namespace-name

The namespace name.

--notification-hub-name

The notification hub 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 notification-hub authorization-rule regenerate-keys

Experimental

Command group 'notification-hub' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Regenerates the primary/secondary keys to the notification hub authorization rule.

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

Examples

Regenerate the notification hub authorization rule

az notification-hub authorization-rule regenerate-keys --resource-group MyResourceGroup --namespace-name my-namespace --notification-hub-name my-hub --name DefaultListenSharedAccessSignature --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.

Accepted values: Primary Key, Secondary Key

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

The connection string of the NotificationHub for the specified authorizationRule.

--namespace-name

The namespace name.

--notification-hub-name

The notification hub 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 notification-hub authorization-rule show

Experimental

Command group 'notification-hub' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show an authorization rule for a notification hub by name.

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

Examples

Show the authorization rule information

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

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

Authorization Rule Name.

--namespace-name

The namespace name.

--notification-hub-name

The notification hub 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.