Share via

az servicebus namespace

  • Reference

Servicebus namespace.

Commands

Name Description Type Status
az servicebus namespace authorization-rule

Servicebus namespace authorization-rule.

 Core GA
az servicebus namespace authorization-rule create

Create an authorization rule for a namespace.

 Core GA
az servicebus namespace authorization-rule delete

Delete a namespace authorization rule.

 Core GA
az servicebus namespace authorization-rule keys

Servicebus namespace authorization-rule keys.

 Core GA
az servicebus namespace authorization-rule keys list

Gets the primary and secondary connection strings for the namespace.

 Core GA
az servicebus namespace authorization-rule keys renew

Regenerates the primary or secondary connection strings for the namespace.

 Core GA
az servicebus namespace authorization-rule list

List the authorization rules for a namespace.

 Core GA
az servicebus namespace authorization-rule show

Get an authorization rule for a namespace by rule name.

 Core GA
az servicebus namespace authorization-rule update

Update an authorization rule for a namespace.

 Core GA
az servicebus namespace create

Create a Service Bus Namespace.

 Core GA
az servicebus namespace delete

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

 Core GA
az servicebus namespace encryption

Manage servicebus namespace encryption properties.

 Core GA
az servicebus namespace encryption add

Add Encryption properties to a namespace.

 Core GA
az servicebus namespace encryption remove

Remove one or more Encryption properties from a namespace.

 Core GA
az servicebus namespace exists

Check the give namespace name availability.

 Core GA
az servicebus namespace failover

GeoDR Failover.

 Core GA
az servicebus namespace identity

Manage servicebus namespace identity.

 Core GA
az servicebus namespace identity assign

Assign System or User or System, User assigned identities to a namespace.

 Core GA
az servicebus namespace identity remove

Removes System or User or System, User assigned identities from a namespace.

 Core GA
az servicebus namespace list

List all the available namespaces within the subscription by resource group & also irrespective of the resource groups.

 Core GA
az servicebus namespace network-rule-set

Servicebus namespace network-rule-set.

 Core GA
az servicebus namespace network-rule-set create

Create NetworkRuleSet for a Namespace.

 Core GA
az servicebus namespace network-rule-set ip-rule

Manage Azure ServiceBus ip-rules in networkruleSet for namespace.

 Core GA
az servicebus namespace network-rule-set ip-rule add

Add a IP-Rule for network rule of namespace.

 Core GA
az servicebus namespace network-rule-set ip-rule remove

Remove Ip-Rule from network rule of namespace.

 Core GA
az servicebus namespace network-rule-set list

List list of NetworkRuleSet for a Namespace.

 Core GA
az servicebus namespace network-rule-set show

Get NetworkRuleSet for a Namespace.

 Core GA
az servicebus namespace network-rule-set update

Update NetworkRuleSet for a Namespace.

 Core GA
az servicebus namespace network-rule-set virtual-network-rule

Manage Azure ServiceBus subnet-rule in networkruleSet for namespace.

 Core GA
az servicebus namespace network-rule-set virtual-network-rule add

Add a Virtual-Network-Rule for network rule of namespace.

 Core GA
az servicebus namespace network-rule-set virtual-network-rule remove

Remove network rule for a namespace.

 Core GA
az servicebus namespace private-endpoint-connection

Manage servicebus namespace private endpoint connection.

 Core GA
az servicebus namespace private-endpoint-connection approve

Approve a private endpoint connection request for servicebus namespace.

 Core GA
az servicebus namespace private-endpoint-connection create

Create PrivateEndpointConnections of service namespace.

 Core GA
az servicebus namespace private-endpoint-connection delete

Delete a private endpoint connection request for servicebus namespace.

 Core GA
az servicebus namespace private-endpoint-connection list

List the available PrivateEndpointConnections within a namespace.

 Core GA
az servicebus namespace private-endpoint-connection reject

Reject a private endpoint connection request for servicebus namespace.

 Core GA
az servicebus namespace private-endpoint-connection show

Get a description for the specified Private Endpoint Connection.

 Core GA
az servicebus namespace private-endpoint-connection update

Update PrivateEndpointConnections of service namespace.

 Core GA
az servicebus namespace private-endpoint-connection wait

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

 Core GA
az servicebus namespace private-link-resource

Manage servicebus namespace private link resources.

 Core GA
az servicebus namespace private-link-resource show

List lists of resources that supports Privatelinks.

 Core GA
az servicebus namespace replica

Manage servicebus namespace replicas.

 Core GA
az servicebus namespace replica add

Add one or more Replica properties to a namespace.

 Core GA
az servicebus namespace replica remove

Remove one or more Replica properties to a namespace.

 Core GA
az servicebus namespace show

Get a description for the specified namespace.

 Core GA
az servicebus namespace update

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

 Core GA
az servicebus namespace wait

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

 Core GA

az servicebus namespace create

Edit

Create a Service Bus Namespace.

az servicebus namespace create --name
                               --resource-group
                               [--alternate-name]
                               [--capacity {1, 16, 2, 4, 8}]
                               [--disable-local-auth {false, true}]
                               [--encryption-config]
                               [--geo-data-replication-config]
                               [--infra-encryption {false, true}]
                               [--location]
                               [--max-lag]
                               [--mi-system-assigned {false, true}]
                               [--mi-user-assigned]
                               [--min-tls {1.0, 1.1, 1.2}]
                               [--no-wait]
                               [--premium-messaging-partitions]
                               [--public-network {Disabled, Enabled}]
                               [--sku {Basic, Premium, Standard}]
                               [--tags]
                               [--zone-redundant {false, true}]

Examples

Create a Service Bus Namespace.

az servicebus namespace create --resource-group myresourcegroup --name mynamespace --location westus --tags tag1=value1 tag2=value2 --sku Standard

Create a new namespace with Identity and Encryption enabled.

az servicebus namespace create --resource-group myresourcegroup --name mynamespace --location westus --sku Premium --mi-user-assigned /subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName --encryption-config key-name=key1 key-vault-uri=https://mykeyvault.vault.azure.net/ user-assigned-identity=/subscriptions/{subscriptionId}}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName

Required Parameters

--name -n

Name of Namespace.

--resource-group -g

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

Optional Parameters

--alternate-name

Alternate name specified when alias and namespace names are same.

--capacity

Number of message units. This property is only applicable to namespaces of Premium SKU.

Accepted values: 1, 16, 2, 4, 8
--disable-local-auth

A boolean value that indicates whether SAS authentication is enabled/disabled for the Service Bus.

Accepted values: false, true
--encryption-config

List of KeyVaultProperties objects.

--geo-data-replication-config --replica-config

A list of regions where replicas of the namespace are maintained Object.

--infra-encryption

A boolean value that indicates whether Infrastructure Encryption (Double Encryption).

Accepted values: false, true
--location -l

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

--max-lag --max-replication-lag-duration-in-seconds

The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas.

--mi-system-assigned

Enable System Assigned Identity.

Accepted values: false, true
--mi-user-assigned

List of User Assigned Identity ids.

--min-tls --minimum-tls-version

The minimum TLS version for the cluster to support, e.g. 1.2.

Accepted values: 1.0, 1.1, 1.2
--no-wait

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

Default value: False
--premium-messaging-partitions --premium-partitions
Preview

The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4.

--public-network --public-network-access

This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile' access rules.

Accepted values: Disabled, Enabled
--sku

Namespace SKU.

Accepted values: Basic, Premium, Standard
Default value: Standard
--tags

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

--zone-redundant

Enabling this property creates a ServiceBus Zone Redundant Namespace in regions supported availability zones.

Accepted values: false, true
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 servicebus namespace delete

Edit

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

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

Examples

Deletes the Service Bus Namespace

az servicebus namespace delete --resource-group myresourcegroup --name mynamespace

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

The resourceGroup 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 servicebus namespace exists

Edit

Check the give namespace name availability.

az servicebus namespace exists --name

Required Parameters

--name

The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number.

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 servicebus namespace failover

Edit

GeoDR Failover.

az servicebus namespace failover [--force {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--ids]
                                 [--namespace-name]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--primary-location]
                                 [--resource-group]
                                 [--subscription]

Optional Parameters

--force

If Force is false then graceful failover is attempted after ensuring no data loss. If Force flag is set to true, Forced failover is attempted with possible data loss.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--namespace-name

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

Query parameter for the new primary location after failover.

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

Edit

List all the available namespaces within the subscription by resource group & also irrespective of the resource groups.

az servicebus namespace list [--resource-group]

Examples

List the Service Bus Namespaces under resourcegroup.

az servicebus namespace list --resource-group myresourcegroup

List the Service Bus Namespaces under subscription

az servicebus namespace list

Optional Parameters

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

Edit

Get a description for the specified namespace.

az servicebus namespace show [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]

Examples

shows the Namespace details.

az servicebus namespace show --resource-group myresourcegroup --name mynamespace

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

The namespace name.

--resource-group -g

The resourceGroup 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 servicebus namespace update

Edit

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

az servicebus namespace update [--add]
                               [--alternate-name]
                               [--capacity]
                               [--connections]
                               [--disable-local-auth {0, 1, f, false, n, no, t, true, y, yes}]
                               [--encryption]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--identity]
                               [--ids]
                               [--locations]
                               [--max-lag]
                               [--minimum-tls-version {1.0, 1.1, 1.2}]
                               [--name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--premium-messaging-partitions]
                               [--public-network-access {Disabled, Enabled, SecuredByPerimeter}]
                               [--remove]
                               [--resource-group]
                               [--set]
                               [--sku {Basic, Premium, Standard}]
                               [--subscription]
                               [--tags]
                               [--tier {Basic, Premium, Standard}]

Examples

Updates a Service Bus Namespace

az servicebus namespace update --resource-group myresourcegroup --name mynamespace --tags tag=value
az az servicebus namespace update --name mynamespace --resource-group myresourcegroup --sku Basic

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

--alternate-name

Alternate name for namespace.

--capacity

Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64.

--connections --private-endpoint-connections

List of private endpoint connections. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--disable-local-auth

This property disables SAS authentication for the Service Bus namespace.

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

Properties of BYOK Encryption description Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Properties of BYOK Identity description Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--locations

A list of regions where replicas of the namespace are maintained. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--max-lag --max-replication-lag-duration-in-seconds

The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day.

--minimum-tls-version

The minimum TLS version for the cluster to support, e.g. '1.2'.

Accepted values: 1.0, 1.1, 1.2
--name --namespace-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
--premium-messaging-partitions --premium-partitions

The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4.

--public-network-access

This determines if traffic is allowed over public network. By default it is enabled.

Accepted values: Disabled, Enabled, SecuredByPerimeter
--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 this SKU.

Accepted values: Basic, Premium, 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.

--tier

The billing tier of this particular SKU.

Accepted values: Basic, Premium, Standard
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 servicebus namespace wait

Edit

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

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

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.

--interval

Polling interval in seconds.

Default value: 30
--name --namespace-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.