IotHubOperationsExtensions.BeginManualFailoverAsync Method

Definition

Manually initiate a failover for the IoT Hub to its secondary region

public static System.Threading.Tasks.Task BeginManualFailoverAsync (this Microsoft.Azure.Management.IotHub.IIotHubOperations operations, string iotHubName, string resourceGroupName, string failoverRegion, System.Threading.CancellationToken cancellationToken = default);
static member BeginManualFailoverAsync : Microsoft.Azure.Management.IotHub.IIotHubOperations * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
<Extension()>
Public Function BeginManualFailoverAsync (operations As IIotHubOperations, iotHubName As String, resourceGroupName As String, failoverRegion As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

operations
IIotHubOperations

The operations group for this extension method.

iotHubName
String

Name of the IoT hub to failover

resourceGroupName
String

Name of the resource group containing the IoT hub resource

failoverRegion
String

Region the hub will be failed over to

cancellationToken
CancellationToken

The cancellation token.

Returns

Remarks

Manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover

Applies to