Share via

IotHubOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

IotHubClient's

<xref:iot_hub> attribute.

Constructor

IotHubOperations(*args, **kwargs)

Methods

begin_manual_failover

Manually initiate a failover for the IoT Hub to its secondary region.

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

begin_manual_failover

Manually initiate a failover for the IoT Hub to its secondary region.

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

async begin_manual_failover(iot_hub_name: str, resource_group_name: str, failover_input: _models.FailoverInput, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
iot_hub_name
Required
str

Name of the IoT hub to failover. Required.
resource_group_name
Required
str

Name of the resource group containing the IoT hub resource. Required.
failover_input
Required
FailoverInput or IO[bytes]

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. Is either a FailoverInput type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.iothub.v2019_03_22.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv151\\Lib\\site-packages\\azure\\mgmt\\iothub\\v2019_03_22\\models\\__init__.py'>