az servicebus georecovery-alias

Manage Azure Service Bus Geo-Disaster Recovery Configuration Alias.

Commands

Name	Description	Type	Status
az servicebus georecovery-alias authorization-rule	Manage Azure Service Bus Authorization Rule for Namespace with Geo-Disaster Recovery Configuration Alias.	Core	GA
az servicebus georecovery-alias authorization-rule keys	Manage Azure Authorization Rule keys for Service Bus Namespace.	Core	GA
az servicebus georecovery-alias authorization-rule keys list	Gets the primary and secondary connection strings for the namespace.	Core	GA
az servicebus georecovery-alias authorization-rule list	List the authorization rules for a namespace.	Core	GA
az servicebus georecovery-alias authorization-rule show	Get an authorization rule for a namespace by rule name.	Core	GA
az servicebus georecovery-alias break-pair	This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces.	Core	GA
az servicebus georecovery-alias create	Create a new Alias(Disaster Recovery configuration).	Core	GA
az servicebus georecovery-alias delete	Delete an Alias(Disaster Recovery configuration).	Core	GA
az servicebus georecovery-alias exists	Check the give namespace name availability.	Core	GA
az servicebus georecovery-alias fail-over	Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace.	Core	GA
az servicebus georecovery-alias list	List all Alias(Disaster Recovery configurations).	Core	GA
az servicebus georecovery-alias set	Sets Service Bus Geo-Disaster Recovery Configuration Alias for the give Namespace.	Core	GA
az servicebus georecovery-alias show	Get Alias(Disaster Recovery configuration) for primary or secondary namespace.	Core	GA

az servicebus georecovery-alias break-pair

This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces.

az servicebus georecovery-alias break-pair [--alias]
                                           [--ids]
                                           [--namespace-name]
                                           [--resource-group]
                                           [--subscription]

Optional Parameters

--alias -a

The Disaster Recovery configuration name.

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

--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 georecovery-alias create

Create a new Alias(Disaster Recovery configuration).

az servicebus georecovery-alias create --alias
                                       --namespace-name
                                       --partner-namespace
                                       --resource-group
                                       [--alternate-name]

Required Parameters

--alias -a

The Disaster Recovery configuration name.

--namespace-name

The namespace name.

--partner-namespace

ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing.

--resource-group -g

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

Optional Parameters

--alternate-name

Primary/Secondary eventhub namespace name, which is part of GEO DR pairing.

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 georecovery-alias delete

Delete an Alias(Disaster Recovery configuration).

az servicebus georecovery-alias delete [--alias]
                                       [--ids]
                                       [--namespace-name]
                                       [--resource-group]
                                       [--subscription]

Optional Parameters

--alias -a

The Disaster Recovery configuration name.

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

--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 georecovery-alias exists

Check the give namespace name availability.

az servicebus georecovery-alias exists --alias
                                       [--ids]
                                       [--namespace-name]
                                       [--resource-group]
                                       [--subscription]

Required Parameters

--alias -a

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.

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.

--namespace-name

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 servicebus georecovery-alias fail-over

Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace.

az servicebus georecovery-alias fail-over [--alias]
                                          [--ids]
                                          [--is-safe-failover {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--namespace-name]
                                          [--resource-group]
                                          [--subscription]

Optional Parameters

--alias -a

The Disaster Recovery configuration name.

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

--is-safe-failover

Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary.

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

--namespace-name

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 servicebus georecovery-alias list

List all Alias(Disaster Recovery configurations).

az servicebus georecovery-alias list --namespace-name
                                     --resource-group

Required Parameters

--namespace-name

The namespace name.

--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 georecovery-alias set

Sets Service Bus Geo-Disaster Recovery Configuration Alias for the give Namespace.

az servicebus georecovery-alias set --alias
                                    --partner-namespace
                                    [--alternate-name]
                                    [--ids]
                                    [--namespace-name]
                                    [--no-wait]
                                    [--resource-group]
                                    [--subscription]

Examples

Sets Geo Disaster Recovery configuration - Alias for the give Namespace

az servicebus georecovery-alias set --resource-group myresourcegroup --namespace-name primarynamespace --alias myaliasname --partner-namespace armresourceid

Sets Service Bus Geo-Disaster Recovery Configuration Alias for the give Namespace (autogenerated)

az servicebus georecovery-alias set --alias myaliasname --namespace-name primarynamespace --partner-namespace armresourceid --resource-group myresourcegroup --subscription MySubscription

Required Parameters

--alias -a

Name of the Geo-Disaster Recovery Configuration Alias.

--partner-namespace

Name (if within the same resource group) or ARM Id of Primary/Secondary Service Bus namespace name, which is part of GEO DR pairing.

Optional Parameters

--alternate-name

Alternate Name (Post failover) for Primary Namespace, when Namespace name and Alias name are same.

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

Name of Namespace.

--no-wait

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

default value: False

--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 georecovery-alias show

Get Alias(Disaster Recovery configuration) for primary or secondary namespace.

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

Optional Parameters

--alias -a

The Disaster Recovery configuration name.

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

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