IotHubOperationsExtensions.ManualFailoverAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Management.IotHub

Assembly:: Microsoft.Azure.Management.IotHub.dll

Package:: Microsoft.Azure.Management.IotHub v4.2.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public static System.Threading.Tasks.Task ManualFailoverAsync (this Microsoft.Azure.Management.IotHub.IIotHubOperations operations, string iotHubName, string resourceGroupName, string failoverRegion, System.Threading.CancellationToken cancellationToken = default);

static member ManualFailoverAsync : Microsoft.Azure.Management.IotHub.IIotHubOperations * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function ManualFailoverAsync (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

Task

Remarks

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

Applies to