IotHubResourceOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:iot_hub_resource> attribute.

Constructor

IotHubResourceOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or update the metadata of an IoT hub. Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub.
begin_delete	Delete an IoT hub. Delete an IoT hub.
begin_update	Update an existing IoT Hubs tags. Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method.
check_name_availability	Check if an IoT hub name is available. Check if an IoT hub name is available.
create_event_hub_consumer_group	Add a consumer group to an Event Hub-compatible endpoint in an IoT hub. Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.
delete_event_hub_consumer_group	Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub. Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.
export_devices	Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
get	Get the non-security related metadata of an IoT hub. Get the non-security related metadata of an IoT hub.
get_endpoint_health	Get the health for routing endpoints. Get the health for routing endpoints.
get_event_hub_consumer_group	Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub. Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.
get_job	Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
get_keys_for_key_name	Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
get_quota_metrics	Get the quota metrics for an IoT hub. Get the quota metrics for an IoT hub.
get_stats	Get the statistics from an IoT hub. Get the statistics from an IoT hub.
get_valid_skus	Get the list of valid SKUs for an IoT hub. Get the list of valid SKUs for an IoT hub.
import_devices	Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
list_by_resource_group	Get all the IoT hubs in a resource group. Get all the IoT hubs in a resource group.
list_by_subscription	Get all the IoT hubs in a subscription. Get all the IoT hubs in a subscription.
list_event_hub_consumer_groups	Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub. Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.
list_jobs	Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
list_keys	Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
test_all_routes	Test all routes. Test all routes configured in this Iot Hub.
test_route	Test the new route. Test the new route for this Iot Hub.

begin_create_or_update

Create or update the metadata of an IoT hub.

Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub.

begin_create_or_update(resource_group_name: str, resource_name: str, iot_hub_description: _models.IotHubDescription, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.IotHubDescription]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.
iot_hub_description Required	IotHubDescription or IO[bytes] The IoT hub metadata and security metadata. Is either a IotHubDescription type or a IO[bytes] type. Required.
if_match	str ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub. Default value is None. Default value: None

Returns

Type	Description
LROPoller[IotHubDescription]	An instance of LROPoller that returns either IotHubDescription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete an IoT hub.

begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> LROPoller[IotHubDescription]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.

Returns

Type	Description
LROPoller[IotHubDescription], LROPoller[ErrorDetails]	An instance of LROPoller that returns either IotHubDescription or An instance of LROPoller that returns either ErrorDetails or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Update an existing IoT Hubs tags.

Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method.

begin_update(resource_group_name: str, resource_name: str, iot_hub_tags: _models.TagsResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.IotHubDescription]

Parameters

Name	Description
resource_group_name Required	str Resource group identifier. Required.
resource_name Required	str Name of iot hub to update. Required.
iot_hub_tags Required	TagsResource or IO[bytes] Updated tag information to set into the iot hub instance. Is either a TagsResource type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[IotHubDescription]	An instance of LROPoller that returns either IotHubDescription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

check_name_availability

Check if an IoT hub name is available.

check_name_availability(operation_inputs: _models.OperationInputs, *, content_type: str = 'application/json', **kwargs: Any) -> _models.IotHubNameAvailabilityInfo

Parameters

Name	Description
operation_inputs Required	OperationInputs or IO[bytes] Set the name parameter in the OperationInputs structure to the name of the IoT hub to check. Is either a OperationInputs type or a IO[bytes] type. Required.

Returns

Type	Description
IotHubNameAvailabilityInfo	IotHubNameAvailabilityInfo or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_event_hub_consumer_group

Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.

create_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, consumer_group_body: _models.EventHubConsumerGroupBodyDescription, *, content_type: str = 'application/json', **kwargs: Any) -> _models.EventHubConsumerGroupInfo

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.
event_hub_endpoint_name Required	str The name of the Event Hub-compatible endpoint in the IoT hub. Required.
name Required	str The name of the consumer group to add. Required.
consumer_group_body Required	EventHubConsumerGroupBodyDescription or IO[bytes] The consumer group to add. Is either a EventHubConsumerGroupBodyDescription type or a IO[bytes] type. Required.

Returns

Type	Description
EventHubConsumerGroupInfo	EventHubConsumerGroupInfo or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete_event_hub_consumer_group

Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.

delete_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.
event_hub_endpoint_name Required	str The name of the Event Hub-compatible endpoint in the IoT hub. Required.
name Required	str The name of the consumer group to delete. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

export_devices

Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

export_devices(resource_group_name: str, resource_name: str, export_devices_parameters: _models.ExportDevicesRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.JobResponse

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.
export_devices_parameters Required	ExportDevicesRequest or IO[bytes] The parameters that specify the export devices operation. Is either a ExportDevicesRequest type or a IO[bytes] type. Required.

Returns

Type	Description
JobResponse	JobResponse or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get the non-security related metadata of an IoT hub.

get(resource_group_name: str, resource_name: str, **kwargs: Any) -> IotHubDescription

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.

Returns

Type	Description
IotHubDescription	IotHubDescription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_endpoint_health

Get the health for routing endpoints.

get_endpoint_health(resource_group_name: str, iot_hub_name: str, **kwargs: Any) -> Iterable[EndpointHealthData]

Parameters

Name	Description
resource_group_name Required	str Required.
iot_hub_name Required	str Required.

Returns

Type	Description
ItemPaged[EndpointHealthData]	An iterator like instance of either EndpointHealthData or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_event_hub_consumer_group

Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.

get_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, **kwargs: Any) -> EventHubConsumerGroupInfo

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.
event_hub_endpoint_name Required	str The name of the Event Hub-compatible endpoint in the IoT hub. Required.
name Required	str The name of the consumer group to retrieve. Required.

Returns

Type	Description
EventHubConsumerGroupInfo	EventHubConsumerGroupInfo or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_job

Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

get_job(resource_group_name: str, resource_name: str, job_id: str, **kwargs: Any) -> JobResponse

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.
job_id Required	str The job identifier. Required.

Returns

Type	Description
JobResponse	JobResponse or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_keys_for_key_name

Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

get_keys_for_key_name(resource_group_name: str, resource_name: str, key_name: str, **kwargs: Any) -> SharedAccessSignatureAuthorizationRule

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.
key_name Required	str The name of the shared access policy. Required.

Returns

Type	Description
SharedAccessSignatureAuthorizationRule	SharedAccessSignatureAuthorizationRule or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_quota_metrics

Get the quota metrics for an IoT hub.

get_quota_metrics(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[IotHubQuotaMetricInfo]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.

Returns

Type	Description
ItemPaged[IotHubQuotaMetricInfo]	An iterator like instance of either IotHubQuotaMetricInfo or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_stats

Get the statistics from an IoT hub.

get_stats(resource_group_name: str, resource_name: str, **kwargs: Any) -> RegistryStatistics

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.

Returns

Type	Description
RegistryStatistics	RegistryStatistics or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_valid_skus

Get the list of valid SKUs for an IoT hub.

get_valid_skus(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[IotHubSkuDescription]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.

Returns

Type	Description
ItemPaged[IotHubSkuDescription]	An iterator like instance of either IotHubSkuDescription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

import_devices

Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

import_devices(resource_group_name: str, resource_name: str, import_devices_parameters: _models.ImportDevicesRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.JobResponse

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.
import_devices_parameters Required	ImportDevicesRequest or IO[bytes] The parameters that specify the import devices operation. Is either a ImportDevicesRequest type or a IO[bytes] type. Required.

Returns

Type	Description
JobResponse	JobResponse or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Get all the IoT hubs in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[IotHubDescription]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.

Returns

Type	Description
ItemPaged[IotHubDescription]	An iterator like instance of either IotHubDescription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Get all the IoT hubs in a subscription.

list_by_subscription(**kwargs: Any) -> Iterable[IotHubDescription]

Returns

Type	Description
ItemPaged[IotHubDescription]	An iterator like instance of either IotHubDescription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_event_hub_consumer_groups

Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.

list_event_hub_consumer_groups(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, **kwargs: Any) -> Iterable[EventHubConsumerGroupInfo]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.
event_hub_endpoint_name Required	str The name of the Event Hub-compatible endpoint. Required.

Returns

Type	Description
ItemPaged[EventHubConsumerGroupInfo]	An iterator like instance of either EventHubConsumerGroupInfo or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_jobs

Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

list_jobs(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[JobResponse]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.

Returns

Type	Description
ItemPaged[JobResponse]	An iterator like instance of either JobResponse or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_keys

Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

list_keys(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[SharedAccessSignatureAuthorizationRule]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the IoT hub. Required.
resource_name Required	str The name of the IoT hub. Required.

Returns

Type	Description
ItemPaged[SharedAccessSignatureAuthorizationRule]	An iterator like instance of either SharedAccessSignatureAuthorizationRule or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

test_all_routes

Test all routes.

Test all routes configured in this Iot Hub.

test_all_routes(iot_hub_name: str, resource_group_name: str, input: _models.TestAllRoutesInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TestAllRoutesResult

Parameters

Name	Description
iot_hub_name Required	str IotHub to be tested. Required.
resource_group_name Required	str resource group which Iot Hub belongs to. Required.
input Required	TestAllRoutesInput or IO[bytes] Input for testing all routes. Is either a TestAllRoutesInput type or a IO[bytes] type. Required.

Returns

Type	Description
TestAllRoutesResult	TestAllRoutesResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

test_route

Test the new route.

Test the new route for this Iot Hub.

test_route(iot_hub_name: str, resource_group_name: str, input: _models.TestRouteInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TestRouteResult

Parameters

Name	Description
iot_hub_name Required	str IotHub to be tested. Required.
resource_group_name Required	str resource group which Iot Hub belongs to. Required.
input Required	TestRouteInput or IO[bytes] Route that needs to be tested. Is either a TestRouteInput type or a IO[bytes] type. Required.

Returns

Type	Description
TestRouteResult	TestRouteResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

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

Feedback

Was this page helpful?

Share via

IotHubResourceOperations Class

Constructor

Methods

begin_create_or_update

Parameters

Returns

Exceptions

begin_delete

Parameters

Returns

Exceptions

begin_update

Parameters

Returns

Exceptions

check_name_availability

Parameters

Returns

Exceptions

create_event_hub_consumer_group

Parameters

Returns

Exceptions

delete_event_hub_consumer_group

Parameters

Returns

Exceptions

export_devices

Parameters

Returns

Exceptions

get

Parameters

Returns

Exceptions

get_endpoint_health

Parameters

Returns

Exceptions

get_event_hub_consumer_group

Parameters

Returns

Exceptions

get_job

Parameters

Returns

Exceptions

get_keys_for_key_name

Parameters

Returns

Exceptions

get_quota_metrics

Parameters

Returns

Exceptions

get_stats

Parameters

Returns

Exceptions

get_valid_skus

Parameters

Returns

Exceptions

import_devices

Parameters

Returns

Exceptions

list_by_resource_group

Parameters

Returns

Exceptions

list_by_subscription

Returns

Exceptions

list_event_hub_consumer_groups

Parameters

Returns

Exceptions

list_jobs