Share via

IotHub interface

  • Reference
Package:
@azure/arm-iothub

Interface representing a IotHub.

Methods

beginManualFailover(string, string, FailoverInput, IotHubManualFailoverOptionalParams)

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

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

Method Details

beginManualFailover(string, string, FailoverInput, IotHubManualFailoverOptionalParams)

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

function beginManualFailover(iotHubName: string, resourceGroupName: string, failoverInput: FailoverInput, options?: IotHubManualFailoverOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

iotHubName

string

Name of the IoT hub to failover

resourceGroupName

string

Name of the resource group containing the IoT hub resource

failoverInput
FailoverInput

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

options
IotHubManualFailoverOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginManualFailoverAndWait(string, string, FailoverInput, IotHubManualFailoverOptionalParams)

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

function beginManualFailoverAndWait(iotHubName: string, resourceGroupName: string, failoverInput: FailoverInput, options?: IotHubManualFailoverOptionalParams): Promise<void>

Parameters

iotHubName

string

Name of the IoT hub to failover

resourceGroupName

string

Name of the resource group containing the IoT hub resource

failoverInput
FailoverInput

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

options
IotHubManualFailoverOptionalParams

The options parameters.

Returns

Promise<void>