az servicebus namespace

Reference

Manage Azure Service Bus Namespace.

Commands

az servicebus namespace authorization-rule	Manage Azure Service Bus Namespace Authorization Rule.
az servicebus namespace authorization-rule create	Create Authorization Rule for the given Service Bus Namespace.
az servicebus namespace authorization-rule delete	Deletes the Authorization Rule of the Service Bus Namespace.
az servicebus namespace authorization-rule keys	Manage Azure Authorization Rule connection strings for Namespace.
az servicebus namespace authorization-rule keys list	List the keys and connection strings of Authorization Rule for Service Bus Namespace.
az servicebus namespace authorization-rule keys renew	Regenerate keys of Authorization Rule for the Service Bus Namespace.
az servicebus namespace authorization-rule list	Shows the list of Authorization Rule by Service Bus Namespace.
az servicebus namespace authorization-rule show	Shows the details of Service Bus Namespace Authorization Rule.
az servicebus namespace authorization-rule update	Updates Authorization Rule for the given Service Bus Namespace.
az servicebus namespace create	Create a Service Bus Namespace.
az servicebus namespace delete	Deletes the Service Bus Namespace.
az servicebus namespace encryption	Manage servicebus namespace encryption properties.
az servicebus namespace encryption add	Add Encryption properties to a namespace.
az servicebus namespace encryption remove	Remove one or more Encryption properties from a namespace.
az servicebus namespace exists	Check for the availability of the given name for the Namespace.
az servicebus namespace identity	Manage servicebus namespace identity.
az servicebus namespace identity assign	Assign System or User or System, User assigned identities to a namespace.
az servicebus namespace identity remove	Removes System or User or System, User assigned identities from a namespace.
az servicebus namespace list	List the Service Bus Namespaces.
az servicebus namespace network-rule	Manage Azure ServiceBus networkruleSet for namespace.
az servicebus namespace network-rule add	Add a network rule for a namespace.
az servicebus namespace network-rule list	Show properties of Network rule of the given Namespace.
az servicebus namespace network-rule remove	Remove network rule for a namespace.
az servicebus namespace network-rule update	Update network rule properties of the given Namespace.
az servicebus namespace private-endpoint-connection	Manage servicebus namespace private endpoint connection.
az servicebus namespace private-endpoint-connection approve	Approve a private endpoint connection request for servicebus namespace.
az servicebus namespace private-endpoint-connection delete	Delete a private endpoint connection request for servicebus namespace.
az servicebus namespace private-endpoint-connection list	Gets the available PrivateEndpointConnections within a namespace.
az servicebus namespace private-endpoint-connection reject	Reject a private endpoint connection request for servicebus namespace.
az servicebus namespace private-endpoint-connection show	Show details of a private endpoint connection request for servicebus namespace.
az servicebus namespace private-link-resource	Manage servicebus namespace private link resources.
az servicebus namespace private-link-resource show	Get the private link resources that need to be created for a servicebus namespace.
az servicebus namespace show	Shows the Service Bus Namespace details.
az servicebus namespace update	Updates a Service Bus Namespace.

az servicebus namespace create

Edit

Create a Service Bus Namespace.

az servicebus namespace create --name
                               --resource-group
                               [--capacity {1, 16, 2, 4, 8}]
                               [--encryption-config]
                               [--location]
                               [--mi-system-assigned {false, true}]
                               [--mi-user-assigned]
                               [--min-tls {1.0, 1.1, 1.2}]
                               [--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

--capacity

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

accepted values: 1, 16, 2, 4, 8

--encryption-config

List of KeyVaultProperties objects.

--location -l

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

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

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

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

Deletes the Service Bus Namespace.

az servicebus namespace delete [--ids]
                               [--name]
                               [--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 -n

Name of Namespace.

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

Edit

Check for the availability of the given name for the Namespace.

az servicebus namespace exists --name

Examples

check for the availability of mynamespace for the Namespace

az servicebus namespace exists --name mynamespace

Required Parameters

--name -n

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

--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 the Service Bus Namespaces.

az servicebus namespace list [--resource-group]

Examples

Get the Service Bus Namespaces by resource group

az servicebus namespace list --resource-group myresourcegroup

Get the Service Bus Namespaces by 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.

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

Shows the Service Bus Namespace details.

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

--name -n

Name of Namespace.

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

Edit

Updates a Service Bus Namespace.

az servicebus namespace update [--add]
                               [--capacity {1, 16, 2, 4, 8}]
                               [--force-string]
                               [--ids]
                               [--min-tls {1.0, 1.1, 1.2}]
                               [--name]
                               [--remove]
                               [--resource-group]
                               [--set]
                               [--sku {Basic, Premium, Standard}]
                               [--subscription]
                               [--tags]

Examples

Updates a Service Bus Namespace.

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

Updates a Service Bus Namespace (autogenerated)

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

default value: []

--capacity

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

accepted values: 1, 16, 2, 4, 8

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

default value: False

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

--name -n

Name of Namespace.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

default value: []

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

default value: []

--sku

Namespace 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

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

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

Commands

az servicebus namespace create

Examples

Required Parameters

Optional Parameters

az servicebus namespace delete

Examples

Optional Parameters

az servicebus namespace exists

Examples

Required Parameters

az servicebus namespace list

Examples

Optional Parameters

az servicebus namespace show

Examples

Optional Parameters

az servicebus namespace update

Examples

Optional Parameters

Feedback

Additional resources