IotHub interface

Interface representing a IotHub.

Method Details

beginManualFailover(string, string, FailoverInput, IotHubManualFailoverOptionalParams)

Perform manual fail over of given hub

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

Parameters

iotHubName

string

IotHub to fail over

resourceGroupName

string

resource group which Iot Hub belongs to

failoverInput
FailoverInput

Region to failover to. Must be a azure DR pair

options
IotHubManualFailoverOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginManualFailoverAndWait(string, string, FailoverInput, IotHubManualFailoverOptionalParams)

Perform manual fail over of given hub

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

Parameters

iotHubName

string

IotHub to fail over

resourceGroupName

string

resource group which Iot Hub belongs to

failoverInput
FailoverInput

Region to failover to. Must be a azure DR pair

options
IotHubManualFailoverOptionalParams

The options parameters.

Returns

Promise<void>