IoTHubHttpRuntimeManager Class

A class to provide convenience APIs for IoTHub Http Runtime Manager operations, based on top of the auto generated IotHub REST APIs

Initializer for a Http Runtime Manager Service client.

After a successful creation the class has been authenticated with IoTHub and it is ready to call the member APIs to communicate with IoTHub.

Inheritance

builtins.object

IoTHubHttpRuntimeManager

Constructor

IoTHubHttpRuntimeManager(connection_string=None, host=None, auth=None)

Parameters

Name	Description
connection_string	str The IoTHub connection string used to authenticate connection with IoTHub if we are using connection_str authentication. Default value: None Default value: None
host	str The Azure service url if we are using token credential authentication. Default value: None Default value: None
auth	str The Azure authentication object if we are using token credential authentication. Default value: None Default value: None

Methods

abandon_feedback_notification	This method abandons a feedback message.
complete_feedback_notification	This method completes a feedback message.
from_connection_string	Classmethod initializer for a IoTHubHttpRuntimeManager Service client. Creates IoTHubHttpRuntimeManager class from connection string. After a successful creation the class has been authenticated with IoTHub and it is ready to call the member APIs to communicate with IoTHub.
from_token_credential	Classmethod initializer for a IoTHubHttpRuntimeManager Service client. Creates IoTHubHttpRuntimeManager class from host name url and Azure token credential. After a successful creation the class has been authenticated with IoTHub and it is ready to call the member APIs to communicate with IoTHub.
receive_feedback_notification	This method is used to retrieve feedback of a cloud-to-device message.

abandon_feedback_notification

This method abandons a feedback message.

abandon_feedback_notification(lock_token)

Parameters

Name	Description
lock_token Required	str Lock token.

Returns

Type	Description
	None.

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

complete_feedback_notification

This method completes a feedback message.

complete_feedback_notification(lock_token)

Parameters

Name	Description
lock_token Required	str Lock token.

Returns

Type	Description
	None.

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_connection_string

Classmethod initializer for a IoTHubHttpRuntimeManager Service client. Creates IoTHubHttpRuntimeManager class from connection string.

After a successful creation the class has been authenticated with IoTHub and it is ready to call the member APIs to communicate with IoTHub.

from_connection_string(connection_string)

Parameters

Name	Description
connection_string Required	str The IoTHub connection string used to authenticate connection with IoTHub.

Returns

Type	Description
IoTHubHttpRuntimeManager

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_token_credential

Classmethod initializer for a IoTHubHttpRuntimeManager Service client. Creates IoTHubHttpRuntimeManager class from host name url and Azure token credential.

After a successful creation the class has been authenticated with IoTHub and it is ready to call the member APIs to communicate with IoTHub.

from_token_credential(url, token_credential)

Parameters

Name	Description
url Required	str The Azure service url (host name).
token_credential Required	<xref:azure.core.TokenCredential> The Azure token credential object

Returns

Type	Description
IoTHubHttpRuntimeManager

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

receive_feedback_notification

This method is used to retrieve feedback of a cloud-to-device message.

receive_feedback_notification()

Returns

Type	Description
	None.

Exceptions

Type	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>