IotHubDescriptionResource.ManualFailoverIotHub Method

Definition

Namespace:

Azure.ResourceManager.IotHub

Assembly:

Azure.ResourceManager.IotHub.dll

Package:

Azure.ResourceManager.IotHub v1.1.1

Source:

IotHubDescriptionResource.cs

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

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/failover
• Operation Id: IotHub_ManualFailover
• Default Api Version: 2023-06-30

public virtual Azure.ResourceManager.ArmOperation ManualFailoverIotHub (Azure.WaitUntil waitUntil, Azure.ResourceManager.IotHub.Models.IotHubFailoverContent content, System.Threading.CancellationToken cancellationToken = default);

abstract member ManualFailoverIotHub : Azure.WaitUntil * Azure.ResourceManager.IotHub.Models.IotHubFailoverContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
override this.ManualFailoverIotHub : Azure.WaitUntil * Azure.ResourceManager.IotHub.Models.IotHubFailoverContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation

Public Overridable Function ManualFailoverIotHub (waitUntil As WaitUntil, content As IotHubFailoverContent, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation

Parameters

waitUntil

WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

content

IotHubFailoverContent

Region to failover to. Must be the Azure paired region. Get the value from the secondary location in the locations property. To learn more, see https://aka.ms/manualfailover/region.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

ArmOperation

Exceptions

ArgumentNullException

content is null.