Set-AzEventHubGeoDRConfigurationFailOver

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

Syntax

Set-AzEventHubGeoDRConfigurationFailOver
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzEventHubGeoDRConfigurationFailOver
   -InputObject <IEventHubIdentity>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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

Examples

Example 1: Fail Over to secondary namespace of an alias

Set-AzEventHubGeoDRConfigurationFailOver -ResourceGroupName myResourceGroup -NamespaceName mySecondaryNamespace -Name myAlias

Fails over to mySecondaryNamespace which is secondary namespace of alias myAlias.

Parameters

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity parameter. To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IEventHubIdentity
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of the Consumer Group.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-NamespaceName

The name of EventHub namespace

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Run the command asynchronously

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IEventHubIdentity

Outputs

Boolean

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IEventHubIdentity>: Identity parameter.

  • [Alias <String>]: The Disaster Recovery configuration name
  • [ApplicationGroupName <String>]: The Application Group name
  • [AuthorizationRuleName <String>]: The authorization rule name.
  • [ClusterName <String>]: The name of the Event Hubs Cluster.
  • [ConsumerGroupName <String>]: The consumer group name
  • [EventHubName <String>]: The Event Hub name
  • [Id <String>]: Resource identity path
  • [NamespaceName <String>]: The Namespace name
  • [PrivateEndpointConnectionName <String>]: The PrivateEndpointConnection name
  • [ResourceAssociationName <String>]: The ResourceAssociation Name
  • [ResourceGroupName <String>]: Name of the resource group within the azure subscription.
  • [SchemaGroupName <String>]: The Schema Group name
  • [SubscriptionId <String>]: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.