IotHubOperations Class

IotHubOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

IotHubOperations

Constructor

IotHubOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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: azure.mgmt.iothub.v2020_03_01.models._models_py3.FailoverInput, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

iot_hub_name

str

Required

Name of the IoT hub to failover.

resource_group_name

str

Required

Name of the resource group containing the IoT hub resource.

failover_input

FailoverInput

Required

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.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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

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

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.iothub.v2020_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\iothub\\v2020_03_01\\models\\__init__.py'>