IotHubOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

IotHubClient's

<xref:iot_hub> attribute.

Inheritance
builtins.object
IotHubOperations

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.

begin_manual_failover(iot_hub_name: str, resource_group_name: str, failover_input: _models.FailoverInput, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[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

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 type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.iothub.v2019_11_04.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\iothub\\v2019_11_04\\models\\__init__.py'>