az notification-hub namespace

Commands to manage notification hub namespace.

Commands

az notification-hub namespace authorization-rule

Commands to manage notification hubs namespace authorization rule.

az notification-hub namespace authorization-rule create

Create an authorization rule for a namespace.

az notification-hub namespace authorization-rule delete

Delete a namespace authorization rule.

az notification-hub namespace authorization-rule list

List the authorization rules for a namespace.

az notification-hub namespace authorization-rule list-keys

List the Primary and Secondary ConnectionStrings to the namespace.

az notification-hub namespace authorization-rule regenerate-keys

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

az notification-hub namespace authorization-rule show

Show an authorization rule for a namespace by name.

az notification-hub namespace check-availability

Check the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.

az notification-hub namespace create

Create a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

az notification-hub namespace delete

Delete an existing namespace. This operation also removes all associated notification hubs under the namespace.

az notification-hub namespace list

List available namespaces.

az notification-hub namespace show

Return the description for the specified namespace.

az notification-hub namespace update

Update a service namespace. The namespace's resource manifest is immutable and cannot be modified.

az notification-hub namespace wait

Place the CLI in a waiting state until a condition of the Notification Hub Namesapce is met.

az notification-hub namespace check-availability

Check the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.

az notification-hub namespace check-availability --name

Examples

Check name availability of namespace

az notification-hub namespace check-availability --name "my-test-space"

Required Parameters

--name -n

The namespace name to check.

az notification-hub namespace create

Create a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

az notification-hub namespace create --name
                                     --resource-group
                                     --sku {Basic, Free, Standard}
                                     [--location]
                                     [--tags]

Examples

Create a namespace

az notification-hub namespace create --resource-group MyResourceGroup --name \
my-namespace --location "South Central US" --sku Standard

Required Parameters

--name -n

The namespace name.

--resource-group -g

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

--sku

Name of the notification hub sku.

accepted values: Basic, Free, Standard

Optional Parameters

--location -l

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

--tags

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

az notification-hub namespace delete

Delete an existing namespace. This operation also removes all associated notification hubs under the namespace.

az notification-hub namespace delete --name
                                     --resource-group
                                     [--no-wait]
                                     [--yes]

Examples

Delete the namespace

az notification-hub namespace delete --resource-group MyResourceGroup --name \
my-namespace

Required Parameters

--name -n

The namespace name.

--resource-group -g

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

Optional Parameters

--no-wait

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

--yes -y

Do not prompt for confirmation.

az notification-hub namespace list

List available namespaces.

az notification-hub namespace list [--resource-group]

Examples

List available namespaces within a resource group

az notification-hub namespace list --resource-group MyResourceGroup

List all the available namespaces within the subscription irrespective of the resourceGroups

az notification-hub namespace list

Optional Parameters

--resource-group -g

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

az notification-hub namespace show

Return the description for the specified namespace.

az notification-hub namespace show --name
                                   --resource-group

Examples

Show namespace info

az notification-hub namespace show --resource-group MyResourceGroup --name \
my-namespace

Required Parameters

--name -n

The namespace name.

--resource-group -g

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

az notification-hub namespace update

Update a service namespace. The namespace's resource manifest is immutable and cannot be modified.

az notification-hub namespace update --name
                                     --resource-group
                                     [--sku {Basic, Free, Standard}]
                                     [--tags]

Examples

Update the namespace

az notification-hub namespace update --resource-group MyResourceGroup --name \
my-namespace --sku Standard

Required Parameters

--name -n

The namespace name.

--resource-group -g

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

Optional Parameters

--sku

Name of the notification hub sku.

accepted values: Basic, Free, Standard
--tags

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

az notification-hub namespace wait

Place the CLI in a waiting state until a condition of the Notification Hub Namesapce is met.

az notification-hub namespace wait --name
                                   --resource-group
                                   [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--interval]
                                   [--timeout]
                                   [--updated]

Examples

Pause executing next line of CLI script until the Notification Hub Namesapce is successfully provisioned.

az notification-hub namespace wait --resource-group MyResourceGroup --name \ my-namespace --created

Required Parameters

--name -n

The namespace name.

--resource-group -g

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

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.