az notification-hub namespace

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

Commands

Name	Description	Type	Status
az notification-hub namespace authorization-rule	Commands to manage notification hubs namespace authorization rule.	Extension	Experimental
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 check-availability	Checks 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.	Extension	Experimental
az notification-hub namespace create	Create a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.	Extension	Experimental
az notification-hub namespace delete	Delete an existing namespace. This operation also removes all associated notificationHubs under the namespace.	Extension	Experimental
az notification-hub namespace list	List available namespaces.	Extension	Experimental
az notification-hub namespace show	Return the description for the specified namespace.	Extension	Experimental
az notification-hub namespace update	Update a service namespace. The namespace's resource manifest is immutable and cannot be modified.	Extension	Experimental
az notification-hub namespace wait	Place the CLI in a waiting state until a condition is met.	Extension	Experimental

az notification-hub namespace check-availability

Experimental

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

Checks 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

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

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

Experimental

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

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

Resource ___location When not specified, the ___location of the resource group will be used.

--tags

Resource tags 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 namespace delete

Experimental

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

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

az notification-hub namespace delete [--ids]
                                     [--name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

Examples

Delete the namespace

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

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

--no-wait

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

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

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

Experimental

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

List available namespaces.

az notification-hub namespace list [--max-items]
                                   [--next-token]
                                   [--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 resource groups

az notification-hub namespace list

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.

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

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

Experimental

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

Return the description for the specified namespace.

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

Examples

Show namespace info

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

Optional Parameters

--ids

--name -n

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 notification-hub namespace update

Experimental

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

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

az notification-hub namespace update [--add]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--ids]
                                     [--___location]
                                     [--name]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--sku {Basic, Free, Standard}]
                                     [--subscription]
                                     [--tags]

Examples

Update the namespace

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

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

--ids

--___location -l

Resource ___location.

--name -n

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

--set

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

--sku

Name of the notification hub sku.

Accepted values: Basic, Free, Standard

--subscription

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

--tags

Resource tags 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 namespace wait

Experimental

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

Place the CLI in a waiting state until a condition is met.

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

Optional Parameters

--created

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

Default value: False

--custom

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

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

Default value: False

--ids

--interval

Polling interval in seconds.

Default value: 30

--name -n

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.

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

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.

Share via

az notification-hub namespace

Commands

az notification-hub namespace check-availability

Examples

Required Parameters

az notification-hub namespace create

Examples

Required Parameters

Optional Parameters

az notification-hub namespace delete

Examples

Optional Parameters

az notification-hub namespace list

Examples

Optional Parameters

az notification-hub namespace show

Examples

Optional Parameters

az notification-hub namespace update

Examples

Optional Parameters

az notification-hub namespace wait

Optional Parameters