azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations
name: IotHubResourceOperations
fullName: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations
module: azure.mgmt.iothub.v2023_06_30_preview.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.iothub.v2023_06_30_preview.IotHubClient>'s\n\
  >\n> <xref:iot_hub_resource> attribute.\n>"
constructor:
  syntax: IotHubResourceOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.begin_create_or_update
  name: begin_create_or_update
  summary: '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.'
  signature: '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: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: iot_hub_description
    description: 'The IoT hub metadata and security metadata. Is either a

      IotHubDescription type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.IotHubDescription>
    - <xref:typing.IO>
  - name: if_match
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: '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.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: 'Default waiting time between two polls for LRO operations if no

      Retry-After header is present.'
    types:
    - <xref:int>
  return:
    description: 'An instance of LROPoller that returns either IotHubDescription or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.iothub.v2023_06_30_preview.models.IotHubDescription>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.begin_delete
  name: begin_delete
  summary: 'Delete an IoT hub.


    Delete an IoT hub.'
  signature: 'begin_delete(resource_group_name: str, resource_name: str, **kwargs:
    Any) -> LROPoller[IotHubDescription]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: '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.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: 'Default waiting time between two polls for LRO operations if no

      Retry-After header is present.'
    types:
    - <xref:int>
  return:
    description: 'An instance of LROPoller that returns either IotHubDescription or
      An instance of

      LROPoller that returns either ErrorDetails or the result of cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.iothub.v2023_06_30_preview.models.IotHubDescription>]
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.iothub.v2023_06_30_preview.models.ErrorDetails>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.begin_update
  name: begin_update
  summary: 'Update an existing IoT Hubs tags.


    Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate
    method.'
  signature: '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: resource_group_name
    description: Resource group identifier. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: Name of iot hub to update. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: iot_hub_tags
    description: 'Updated tag information to set into the iot hub instance. Is either
      a

      TagsResource type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.TagsResource>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: '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.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: 'Default waiting time between two polls for LRO operations if no

      Retry-After header is present.'
    types:
    - <xref:int>
  return:
    description: 'An instance of LROPoller that returns either IotHubDescription or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.iothub.v2023_06_30_preview.models.IotHubDescription>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.check_name_availability
  name: check_name_availability
  summary: 'Check if an IoT hub name is available.


    Check if an IoT hub name is available.'
  signature: 'check_name_availability(operation_inputs: _models.OperationInputs, *,
    content_type: str = ''application/json'', **kwargs: Any) -> _models.IotHubNameAvailabilityInfo'
  parameters:
  - name: operation_inputs
    description: '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 type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.OperationInputs>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: IotHubNameAvailabilityInfo or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.IotHubNameAvailabilityInfo>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.create_event_hub_consumer_group
  name: create_event_hub_consumer_group
  summary: '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.'
  signature: '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: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: event_hub_endpoint_name
    description: 'The name of the Event Hub-compatible endpoint in the IoT hub.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the consumer group to add. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: consumer_group_body
    description: 'The consumer group to add. Is either a

      EventHubConsumerGroupBodyDescription type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.EventHubConsumerGroupBodyDescription>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: EventHubConsumerGroupInfo or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.EventHubConsumerGroupInfo>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.delete_event_hub_consumer_group
  name: delete_event_hub_consumer_group
  summary: '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.'
  signature: 'delete_event_hub_consumer_group(resource_group_name: str, resource_name:
    str, event_hub_endpoint_name: str, name: str, **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: event_hub_endpoint_name
    description: 'The name of the Event Hub-compatible endpoint in the IoT hub.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the consumer group to delete. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.export_devices
  name: export_devices
  summary: '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](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](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).'
  signature: '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: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: export_devices_parameters
    description: 'The parameters that specify the export devices operation. Is

      either a ExportDevicesRequest type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.ExportDevicesRequest>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: JobResponse or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.JobResponse>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.get
  name: get
  summary: 'Get the non-security related metadata of an IoT hub.


    Get the non-security related metadata of an IoT hub.'
  signature: 'get(resource_group_name: str, resource_name: str, **kwargs: Any) ->
    IotHubDescription'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: IotHubDescription or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.IotHubDescription>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.get_endpoint_health
  name: get_endpoint_health
  summary: 'Get the health for routing endpoints.


    Get the health for routing endpoints.'
  signature: 'get_endpoint_health(resource_group_name: str, iot_hub_name: str, **kwargs:
    Any) -> Iterable[EndpointHealthData]'
  parameters:
  - name: resource_group_name
    description: Required.
    isRequired: true
    types:
    - <xref:str>
  - name: iot_hub_name
    description: Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either EndpointHealthData or the result
      of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.iothub.v2023_06_30_preview.models.EndpointHealthData>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.get_event_hub_consumer_group
  name: get_event_hub_consumer_group
  summary: '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.'
  signature: 'get_event_hub_consumer_group(resource_group_name: str, resource_name:
    str, event_hub_endpoint_name: str, name: str, **kwargs: Any) -> EventHubConsumerGroupInfo'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: event_hub_endpoint_name
    description: 'The name of the Event Hub-compatible endpoint in the IoT hub.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the consumer group to retrieve. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: EventHubConsumerGroupInfo or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.EventHubConsumerGroupInfo>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.get_job
  name: get_job
  summary: '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](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](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry).'
  signature: 'get_job(resource_group_name: str, resource_name: str, job_id: str, **kwargs:
    Any) -> JobResponse'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: job_id
    description: The job identifier. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: JobResponse or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.JobResponse>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.get_keys_for_key_name
  name: get_keys_for_key_name
  summary: '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](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](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security).'
  signature: 'get_keys_for_key_name(resource_group_name: str, resource_name: str,
    key_name: str, **kwargs: Any) -> SharedAccessSignatureAuthorizationRule'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: key_name
    description: The name of the shared access policy. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: SharedAccessSignatureAuthorizationRule or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.SharedAccessSignatureAuthorizationRule>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.get_quota_metrics
  name: get_quota_metrics
  summary: 'Get the quota metrics for an IoT hub.


    Get the quota metrics for an IoT hub.'
  signature: 'get_quota_metrics(resource_group_name: str, resource_name: str, **kwargs:
    Any) -> Iterable[IotHubQuotaMetricInfo]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either IotHubQuotaMetricInfo or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.iothub.v2023_06_30_preview.models.IotHubQuotaMetricInfo>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.get_stats
  name: get_stats
  summary: 'Get the statistics from an IoT hub.


    Get the statistics from an IoT hub.'
  signature: 'get_stats(resource_group_name: str, resource_name: str, **kwargs: Any)
    -> RegistryStatistics'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: RegistryStatistics or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.RegistryStatistics>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.get_valid_skus
  name: get_valid_skus
  summary: 'Get the list of valid SKUs for an IoT hub.


    Get the list of valid SKUs for an IoT hub.'
  signature: 'get_valid_skus(resource_group_name: str, resource_name: str, **kwargs:
    Any) -> Iterable[IotHubSkuDescription]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either IotHubSkuDescription or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.iothub.v2023_06_30_preview.models.IotHubSkuDescription>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.import_devices
  name: import_devices
  summary: '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](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](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).'
  signature: '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: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: import_devices_parameters
    description: 'The parameters that specify the import devices operation. Is

      either a ImportDevicesRequest type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.ImportDevicesRequest>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: JobResponse or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.JobResponse>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.list_by_resource_group
  name: list_by_resource_group
  summary: 'Get all the IoT hubs in a resource group.


    Get all the IoT hubs in a resource group.'
  signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[IotHubDescription]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either IotHubDescription or the result
      of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.iothub.v2023_06_30_preview.models.IotHubDescription>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.list_by_subscription
  name: list_by_subscription
  summary: 'Get all the IoT hubs in a subscription.


    Get all the IoT hubs in a subscription.'
  signature: 'list_by_subscription(**kwargs: Any) -> Iterable[IotHubDescription]'
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either IotHubDescription or the result
      of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.iothub.v2023_06_30_preview.models.IotHubDescription>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.list_event_hub_consumer_groups
  name: list_event_hub_consumer_groups
  summary: '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.'
  signature: 'list_event_hub_consumer_groups(resource_group_name: str, resource_name:
    str, event_hub_endpoint_name: str, **kwargs: Any) -> Iterable[EventHubConsumerGroupInfo]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: event_hub_endpoint_name
    description: The name of the Event Hub-compatible endpoint. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either EventHubConsumerGroupInfo or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.iothub.v2023_06_30_preview.models.EventHubConsumerGroupInfo>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.list_jobs
  name: list_jobs
  summary: '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](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](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry).'
  signature: 'list_jobs(resource_group_name: str, resource_name: str, **kwargs: Any)
    -> Iterable[JobResponse]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either JobResponse or the result of
      cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.iothub.v2023_06_30_preview.models.JobResponse>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.list_keys
  name: list_keys
  summary: 'Get the security metadata for an IoT hub. For more information, see:

    [https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security](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](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security).'
  signature: 'list_keys(resource_group_name: str, resource_name: str, **kwargs: Any)
    -> Iterable[SharedAccessSignatureAuthorizationRule]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group that contains the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_name
    description: The name of the IoT hub. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: 'An iterator like instance of either SharedAccessSignatureAuthorizationRule
      or the

      result of cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.iothub.v2023_06_30_preview.models.SharedAccessSignatureAuthorizationRule>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.test_all_routes
  name: test_all_routes
  summary: 'Test all routes.


    Test all routes configured in this Iot Hub.'
  signature: '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: iot_hub_name
    description: IotHub to be tested. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_group_name
    description: resource group which Iot Hub belongs to. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: input
    description: 'Input for testing all routes. Is either a TestAllRoutesInput type
      or a IO type.

      Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.TestAllRoutesInput>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: TestAllRoutesResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.TestAllRoutesResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.test_route
  name: test_route
  summary: 'Test the new route.


    Test the new route for this Iot Hub.'
  signature: 'test_route(iot_hub_name: str, resource_group_name: str, input: _models.TestRouteInput,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.TestRouteResult'
  parameters:
  - name: iot_hub_name
    description: IotHub to be tested. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: resource_group_name
    description: resource group which Iot Hub belongs to. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: input
    description: 'Route that needs to be tested. Is either a TestRouteInput type or
      a IO type.

      Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.TestRouteInput>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: TestRouteResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.iothub.v2023_06_30_preview.models.TestRouteResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.iothub.v2023_06_30_preview.operations.IotHubResourceOperations.models
  name: models
  signature: models = <module 'azure.mgmt.iothub.v2023_06_30_preview.models' from
    'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\iothub\\v2023_06_30_preview\\models\\__init__.py'>