az notification-hub authorization-rule

Note

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

Commands to manage notification hubs authorization rule.

Commands

az notification-hub authorization-rule create	Create an authorization rule for a NotificationHub.
az notification-hub authorization-rule delete	Delete a notificationHub authorization rule.
az notification-hub authorization-rule list	List the authorization rules for a NotificationHub.
az notification-hub authorization-rule list-keys	List the Primary and Secondary ConnectionStrings to the NotificationHub.
az notification-hub authorization-rule regenerate-keys	Regenerate the Primary/Secondary Keys to the NotificationHub Authorization Rule.
az notification-hub authorization-rule show	Show an authorization rule for a NotificationHub by name.

az notification-hub authorization-rule create

Create an authorization rule for a NotificationHub.

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

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

--rights

The rights associated with the rule.

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.

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

Delete a notificationHub authorization rule.

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

Examples

Delete the 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

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

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

List the authorization rules for a NotificationHub.

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

Examples

List authorization rules

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

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.

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

List the Primary and Secondary ConnectionStrings to the NotificationHub.

az notification-hub authorization-rule list-keys --name
                                                 --namespace-name
                                                 --notification-hub-name
                                                 --resource-group

Examples

List connectionStrings 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"

Required Parameters

--name -n

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

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.

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

Regenerate the Primary/Secondary Keys to the NotificationHub Authorization Rule.

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

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

--name -n

The authorization rule name.

--namespace-name

The namespace name.

--notification-hub-name

The notification hub name.

--policy-key

Name of the key that has to be regenerated for the Notification Hub Authorization Rule.

accepted values: Primary Key, Secondary Key

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Show an authorization rule for a NotificationHub 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

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

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