az eventhubs georecovery-alias

Manage Azure EventHubs Geo Recovery configuration Alias.

Commands

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

az eventhubs georecovery-alias break-pair

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--alias -a

The Disaster Recovery configuration name.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

The Namespace name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az eventhubs georecovery-alias create

Create a new Alias(Disaster Recovery configuration).

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

Required Parameters

--alias --name -a

The Disaster Recovery configuration name.

--namespace-name

The Namespace name.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--alternate-name

Alternate name specified when alias and namespace names are same.

Property	Value
Parameter group:	Properties Arguments

--partner-namespace

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

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az eventhubs georecovery-alias delete

Delete an Alias(Disaster Recovery configuration).

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--alias -a

The Disaster Recovery configuration name.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

The Namespace name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az eventhubs georecovery-alias exists

Check the give Namespace name availability.

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

Required Parameters

--alias -a

Name to check the namespace name availability.

Property	Value
Parameter group:	Parameters Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

The Namespace name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az eventhubs georecovery-alias fail-over

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

az eventhubs georecovery-alias fail-over [--alias]
                                         [--ids]
                                         [--namespace-name]
                                         [--resource-group]
                                         [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--alias -a

The Disaster Recovery configuration name.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

The Namespace name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az eventhubs georecovery-alias list

List all Alias(Disaster Recovery configurations).

az eventhubs georecovery-alias list --namespace-name
                                    --resource-group
                                    [--max-items]
                                    [--next-token]

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az eventhubs georecovery-alias set

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

az eventhubs 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 eventhubs georecovery-alias set --resource-group myresourcegroup --namespace-name primarynamespace --alias myaliasname --partner-namespace resourcearmid

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

az eventhubs georecovery-alias set --alias myaliasname --namespace-name primarynamespace --partner-namespace resourcearmid --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 the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--alternate-name

Alternate Name for the Alias, when the 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.

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

Name of Namespace.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Default value:	False

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az eventhubs georecovery-alias show

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--alias -a

The Disaster Recovery configuration name.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

The Namespace name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False