IIotHubOperations.BeginManualFailoverWithHttpMessagesAsync 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 System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> BeginManualFailoverWithHttpMessagesAsync (string iotHubName, string resourceGroupName, string failoverRegion, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member BeginManualFailoverWithHttpMessagesAsync : string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>

Public Function BeginManualFailoverWithHttpMessagesAsync (iotHubName As String, resourceGroupName As String, failoverRegion As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

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

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

ErrorDetailsException

Thrown when the operation returned an invalid status code

ValidationException

Thrown when a required parameter is null

Remarks

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

Applies to

Share via