azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.iothub.fluent.IotHubsClient.yml

### YamlMime:JavaType
uid: "com.azure.resourcemanager.iothub.fluent.IotHubsClient"
fullName: "com.azure.resourcemanager.iothub.fluent.IotHubsClient"
name: "IotHubsClient"
nameWithType: "IotHubsClient"
summary: "An instance of this class provides access to all the operations defined in Iot<wbr>Hubs<wbr>Client."
syntax: "public interface **IotHubsClient**"
methods:
- uid: "com.azure.resourcemanager.iothub.fluent.IotHubsClient.beginManualFailover(java.lang.String,java.lang.String,com.azure.resourcemanager.iothub.models.FailoverInput)"
  fullName: "com.azure.resourcemanager.iothub.fluent.IotHubsClient.beginManualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput)"
  name: "beginManualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput)"
  nameWithType: "IotHubsClient.beginManualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput)"
  summary: "Manually initiate a failover for the IoT Hub to its secondary region"
  modifiers:
  - "abstract"
  parameters:
  - description: "Name of the IoT hub to failover."
    name: "iotHubName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of the resource group containing the IoT hub resource."
    name: "resourceGroupName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Region to failover to. Must be the Azure paired region. Get the value from the secondary\n     location in the locations property. To learn more, see https://aka.ms/manualfailover/region."
    name: "failoverInput"
    type: "<xref href=\"com.azure.resourcemanager.iothub.models.FailoverInput?alt=com.azure.resourcemanager.iothub.models.FailoverInput&text=FailoverInput\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract SyncPoller<PollResult<Void>,Void> beginManualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput)"
  desc: "Manually initiate a failover for the IoT Hub to its secondary region\n\nManually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover."
  returns:
    description: "the <xref uid=\"com.azure.core.util.polling.SyncPoller\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SyncPoller\"></xref> for polling of long-running operation."
    type: "<xref href=\"com.azure.core.util.polling.SyncPoller?alt=com.azure.core.util.polling.SyncPoller&text=SyncPoller\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.core.management.polling.PollResult?alt=com.azure.core.management.polling.PollResult&text=PollResult\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.iothub.fluent.IotHubsClient.beginManualFailover(java.lang.String,java.lang.String,com.azure.resourcemanager.iothub.models.FailoverInput,com.azure.core.util.Context)"
  fullName: "com.azure.resourcemanager.iothub.fluent.IotHubsClient.beginManualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput, Context context)"
  name: "beginManualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput, Context context)"
  nameWithType: "IotHubsClient.beginManualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput, Context context)"
  summary: "Manually initiate a failover for the IoT Hub to its secondary region"
  modifiers:
  - "abstract"
  parameters:
  - description: "Name of the IoT hub to failover."
    name: "iotHubName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of the resource group containing the IoT hub resource."
    name: "resourceGroupName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Region to failover to. Must be the Azure paired region. Get the value from the secondary\n     location in the locations property. To learn more, see https://aka.ms/manualfailover/region."
    name: "failoverInput"
    type: "<xref href=\"com.azure.resourcemanager.iothub.models.FailoverInput?alt=com.azure.resourcemanager.iothub.models.FailoverInput&text=FailoverInput\" data-throw-if-not-resolved=\"False\" />"
  - description: "The context to associate with this operation."
    name: "context"
    type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract SyncPoller<PollResult<Void>,Void> beginManualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput, Context context)"
  desc: "Manually initiate a failover for the IoT Hub to its secondary region\n\nManually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover."
  returns:
    description: "the <xref uid=\"com.azure.core.util.polling.SyncPoller\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SyncPoller\"></xref> for polling of long-running operation."
    type: "<xref href=\"com.azure.core.util.polling.SyncPoller?alt=com.azure.core.util.polling.SyncPoller&text=SyncPoller\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.core.management.polling.PollResult?alt=com.azure.core.management.polling.PollResult&text=PollResult\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.iothub.fluent.IotHubsClient.manualFailover(java.lang.String,java.lang.String,com.azure.resourcemanager.iothub.models.FailoverInput)"
  fullName: "com.azure.resourcemanager.iothub.fluent.IotHubsClient.manualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput)"
  name: "manualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput)"
  nameWithType: "IotHubsClient.manualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput)"
  summary: "Manually initiate a failover for the IoT Hub to its secondary region"
  modifiers:
  - "abstract"
  parameters:
  - description: "Name of the IoT hub to failover."
    name: "iotHubName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of the resource group containing the IoT hub resource."
    name: "resourceGroupName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Region to failover to. Must be the Azure paired region. Get the value from the secondary\n     location in the locations property. To learn more, see https://aka.ms/manualfailover/region."
    name: "failoverInput"
    type: "<xref href=\"com.azure.resourcemanager.iothub.models.FailoverInput?alt=com.azure.resourcemanager.iothub.models.FailoverInput&text=FailoverInput\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract void manualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput)"
  desc: "Manually initiate a failover for the IoT Hub to its secondary region\n\nManually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover."
- uid: "com.azure.resourcemanager.iothub.fluent.IotHubsClient.manualFailover(java.lang.String,java.lang.String,com.azure.resourcemanager.iothub.models.FailoverInput,com.azure.core.util.Context)"
  fullName: "com.azure.resourcemanager.iothub.fluent.IotHubsClient.manualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput, Context context)"
  name: "manualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput, Context context)"
  nameWithType: "IotHubsClient.manualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput, Context context)"
  summary: "Manually initiate a failover for the IoT Hub to its secondary region"
  modifiers:
  - "abstract"
  parameters:
  - description: "Name of the IoT hub to failover."
    name: "iotHubName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of the resource group containing the IoT hub resource."
    name: "resourceGroupName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Region to failover to. Must be the Azure paired region. Get the value from the secondary\n     location in the locations property. To learn more, see https://aka.ms/manualfailover/region."
    name: "failoverInput"
    type: "<xref href=\"com.azure.resourcemanager.iothub.models.FailoverInput?alt=com.azure.resourcemanager.iothub.models.FailoverInput&text=FailoverInput\" data-throw-if-not-resolved=\"False\" />"
  - description: "The context to associate with this operation."
    name: "context"
    type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract void manualFailover(String iotHubName, String resourceGroupName, FailoverInput failoverInput, Context context)"
  desc: "Manually initiate a failover for the IoT Hub to its secondary region\n\nManually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover."
type: "interface"
desc: "An instance of this class provides access to all the operations defined in IotHubsClient."
metadata: {}
package: "com.azure.resourcemanager.iothub.fluent"
artifact: com.azure.resourcemanager:azure-resourcemanager-iothub:1.2.0