Share via

az servicebus namespace encryption

  • Reference

Manage servicebus namespace encryption properties.

Commands

Name Description Type Status
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 encryption add

Edit

Add Encryption properties to a namespace.

az servicebus namespace encryption add --encryption-config
                                       --namespace-name
                                       --resource-group
                                       [--infra-encryption {false, true}]

Examples

Set 2 different encryption properties for a namespace that has User Assigned Identity already enabled

az servicebus namespace encryption add --namespace-name mynamespace -g MyResourceGroup --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/MSIName2

Required Parameters

--encryption-config

List of KeyVaultProperties objects.

--namespace-name

Name of the Namespace.

--resource-group -g

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

Optional Parameters

--infra-encryption

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

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

Edit

Remove one or more Encryption properties from a namespace.

az servicebus namespace encryption remove --encryption-config
                                          --namespace-name
                                          --resource-group

Examples

Remove encryption properties for a namespace that has User Assigned Identity already enabled

az servicebus namespace encryption remove --namespace-name mynamespace -g MyResourceGroup --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

--encryption-config

List of KeyVaultProperties objects.

--namespace-name

Name of the Namespace.

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