Package com.azure.resourcemanager.iothub.fluent

Interface IotHubsClient

public interface IotHubsClient

An instance of this class provides access to all the operations defined in IotHubsClient.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginManualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput)	Manually initiate a failover for the IoT Hub to its secondary region.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginManualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput, com.azure.core.util.Context context)	Manually initiate a failover for the IoT Hub to its secondary region.
void	manualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput)	Manually initiate a failover for the IoT Hub to its secondary region.
void	manualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput, com.azure.core.util.Context context)	Manually initiate a failover for the IoT Hub to its secondary region.

Method Detail

beginManualFailover

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginManualFailover(String iotHubName,
                                                                                                                          String resourceGroupName,
                                                                                                                          FailoverInput failoverInput)

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

Parameters:

iotHubName - Name of the IoT hub to failover.

resourceGroupName - Name of the resource group containing the IoT hub resource.

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.

Returns:

the Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorDetailsException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginManualFailover

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginManualFailover(String iotHubName,
                                                                                                                          String resourceGroupName,
                                                                                                                          FailoverInput failoverInput,
                                                                                                                          com.azure.core.util.Context context)

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

Parameters:

iotHubName - Name of the IoT hub to failover.

resourceGroupName - Name of the resource group containing the IoT hub resource.

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.

context - The context to associate with this operation.

Returns:

the Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorDetailsException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

manualFailover

void manualFailover(String iotHubName,
                    String resourceGroupName,
                    FailoverInput failoverInput)

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

Parameters:

iotHubName - Name of the IoT hub to failover.

resourceGroupName - Name of the resource group containing the IoT hub resource.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorDetailsException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

manualFailover

void manualFailover(String iotHubName,
                    String resourceGroupName,
                    FailoverInput failoverInput,
                    com.azure.core.util.Context context)

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

Parameters:

iotHubName - Name of the IoT hub to failover.

resourceGroupName - Name of the resource group containing the IoT hub resource.

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.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorDetailsException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.