Package com.azure.resourcemanager.iothub.fluent

Interface IotHubResourcesClient

public interface IotHubResourcesClient
An instance of this class provides access to all the operations defined in IotHubResourcesClient.

  • Method Details

    • getByResourceGroup

      IotHubDescriptionInner getByResourceGroup(String resourceGroupName, String resourceName)
      Get the non-security related metadata of an IoT hub

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

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      Returns:
      the non-security related metadata of an IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<IotHubDescriptionInner> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)
      Get the non-security related metadata of an IoT hub

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

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      context - The context to associate with this operation.
      Returns:
      the non-security related metadata of an IoT hub along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<IotHubDescriptionInner>,IotHubDescriptionInner> beginCreateOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription, String ifMatch)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      iotHubDescription - The IoT hub metadata and security metadata.
      ifMatch - ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub.
      Returns:
      the SyncPoller for polling of the description of the IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<IotHubDescriptionInner>,IotHubDescriptionInner> beginCreateOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription, String ifMatch, com.azure.core.util.Context context)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      iotHubDescription - The IoT hub metadata and security metadata.
      ifMatch - ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of the description of the IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdate

      IotHubDescriptionInner createOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription, String ifMatch)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      iotHubDescription - The IoT hub metadata and security metadata.
      ifMatch - ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub.
      Returns:
      the description of the IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdate

      IotHubDescriptionInner createOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      iotHubDescription - The IoT hub metadata and security metadata.
      Returns:
      the description of the IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdate

      IotHubDescriptionInner createOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription, String ifMatch, com.azure.core.util.Context context)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      iotHubDescription - The IoT hub metadata and security metadata.
      ifMatch - ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub.
      context - The context to associate with this operation.
      Returns:
      the description of the IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<IotHubDescriptionInner>,IotHubDescriptionInner> beginUpdate(String resourceGroupName, String resourceName, TagsResource iotHubTags)
      Update an existing IoT Hubs tags.

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

      Parameters:
      resourceGroupName - Resource group identifier.
      resourceName - Name of iot hub to update.
      iotHubTags - Updated tag information to set into the iot hub instance.
      Returns:
      the SyncPoller for polling of the description of the IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<IotHubDescriptionInner>,IotHubDescriptionInner> beginUpdate(String resourceGroupName, String resourceName, TagsResource iotHubTags, com.azure.core.util.Context context)
      Update an existing IoT Hubs tags.

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

      Parameters:
      resourceGroupName - Resource group identifier.
      resourceName - Name of iot hub to update.
      iotHubTags - Updated tag information to set into the iot hub instance.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of the description of the IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • update

      IotHubDescriptionInner update(String resourceGroupName, String resourceName, TagsResource iotHubTags)
      Update an existing IoT Hubs tags.

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

      Parameters:
      resourceGroupName - Resource group identifier.
      resourceName - Name of iot hub to update.
      iotHubTags - Updated tag information to set into the iot hub instance.
      Returns:
      the description of the IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • update

      IotHubDescriptionInner update(String resourceGroupName, String resourceName, TagsResource iotHubTags, com.azure.core.util.Context context)
      Update an existing IoT Hubs tags.

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

      Parameters:
      resourceGroupName - Resource group identifier.
      resourceName - Name of iot hub to update.
      iotHubTags - Updated tag information to set into the iot hub instance.
      context - The context to associate with this operation.
      Returns:
      the description of the IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<IotHubDescriptionInner>,IotHubDescriptionInner> beginDelete(String resourceGroupName, String resourceName)
      Delete an IoT hub

      Delete an IoT hub.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      Returns:
      the SyncPoller for polling of the description of the IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<IotHubDescriptionInner>,IotHubDescriptionInner> beginDelete(String resourceGroupName, String resourceName, com.azure.core.util.Context context)
      Delete an IoT hub

      Delete an IoT hub.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of the description of the IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      IotHubDescriptionInner delete(String resourceGroupName, String resourceName)
      Delete an IoT hub

      Delete an IoT hub.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      Returns:
      the description of the IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      IotHubDescriptionInner delete(String resourceGroupName, String resourceName, com.azure.core.util.Context context)
      Delete an IoT hub

      Delete an IoT hub.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      context - The context to associate with this operation.
      Returns:
      the description of the IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<IotHubDescriptionInner> list()
      Get all the IoT hubs in a subscription

      Get all the IoT hubs in a subscription.

      Returns:
      all the IoT hubs in a subscription as paginated response with PagedIterable.
      Throws:
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<IotHubDescriptionInner> list(com.azure.core.util.Context context)
      Get all the IoT hubs in a subscription

      Get all the IoT hubs in a subscription.

      Parameters:
      context - The context to associate with this operation.
      Returns:
      all the IoT hubs in a subscription as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<IotHubDescriptionInner> listByResourceGroup(String resourceGroupName)
      Get all the IoT hubs in a resource group

      Get all the IoT hubs in a resource group.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      Returns:
      all the IoT hubs in a resource group as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<IotHubDescriptionInner> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      Get all the IoT hubs in a resource group

      Get all the IoT hubs in a resource group.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      context - The context to associate with this operation.
      Returns:
      all the IoT hubs in a resource group as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getStats

      RegistryStatisticsInner getStats(String resourceGroupName, String resourceName)
      Get the statistics from an IoT hub

      Get the statistics from an IoT hub.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      Returns:
      the statistics from an IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getStatsWithResponse

      com.azure.core.http.rest.Response<RegistryStatisticsInner> getStatsWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)
      Get the statistics from an IoT hub

      Get the statistics from an IoT hub.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      context - The context to associate with this operation.
      Returns:
      the statistics from an IoT hub along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getValidSkus

      com.azure.core.http.rest.PagedIterable<IotHubSkuDescriptionInner> getValidSkus(String resourceGroupName, String resourceName)
      Get the list of valid SKUs for an IoT hub

      Get the list of valid SKUs for an IoT hub.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      Returns:
      the list of valid SKUs for an IoT hub as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getValidSkus

      com.azure.core.http.rest.PagedIterable<IotHubSkuDescriptionInner> getValidSkus(String resourceGroupName, String resourceName, com.azure.core.util.Context context)
      Get the list of valid SKUs for an IoT hub

      Get the list of valid SKUs for an IoT hub.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      context - The context to associate with this operation.
      Returns:
      the list of valid SKUs for an IoT hub as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listEventHubConsumerGroups

      com.azure.core.http.rest.PagedIterable<EventHubConsumerGroupInfoInner> listEventHubConsumerGroups(String resourceGroupName, String resourceName, String eventHubEndpointName)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      eventHubEndpointName - The name of the Event Hub-compatible endpoint.
      Returns:
      a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listEventHubConsumerGroups

      com.azure.core.http.rest.PagedIterable<EventHubConsumerGroupInfoInner> listEventHubConsumerGroups(String resourceGroupName, String resourceName, String eventHubEndpointName, com.azure.core.util.Context context)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      eventHubEndpointName - The name of the Event Hub-compatible endpoint.
      context - The context to associate with this operation.
      Returns:
      a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getEventHubConsumerGroup

      EventHubConsumerGroupInfoInner getEventHubConsumerGroup(String resourceGroupName, String resourceName, String eventHubEndpointName, String name)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      eventHubEndpointName - The name of the Event Hub-compatible endpoint in the IoT hub.
      name - The name of the consumer group to retrieve.
      Returns:
      a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getEventHubConsumerGroupWithResponse

      com.azure.core.http.rest.Response<EventHubConsumerGroupInfoInner> getEventHubConsumerGroupWithResponse(String resourceGroupName, String resourceName, String eventHubEndpointName, String name, com.azure.core.util.Context context)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      eventHubEndpointName - The name of the Event Hub-compatible endpoint in the IoT hub.
      name - The name of the consumer group to retrieve.
      context - The context to associate with this operation.
      Returns:
      a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createEventHubConsumerGroup

      EventHubConsumerGroupInfoInner createEventHubConsumerGroup(String resourceGroupName, String resourceName, String eventHubEndpointName, String name, EventHubConsumerGroupBodyDescription consumerGroupBody)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      eventHubEndpointName - The name of the Event Hub-compatible endpoint in the IoT hub.
      name - The name of the consumer group to add.
      consumerGroupBody - The consumer group to add.
      Returns:
      the properties of the EventHubConsumerGroupInfo object.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createEventHubConsumerGroupWithResponse

      com.azure.core.http.rest.Response<EventHubConsumerGroupInfoInner> createEventHubConsumerGroupWithResponse(String resourceGroupName, String resourceName, String eventHubEndpointName, String name, EventHubConsumerGroupBodyDescription consumerGroupBody, com.azure.core.util.Context context)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      eventHubEndpointName - The name of the Event Hub-compatible endpoint in the IoT hub.
      name - The name of the consumer group to add.
      consumerGroupBody - The consumer group to add.
      context - The context to associate with this operation.
      Returns:
      the properties of the EventHubConsumerGroupInfo object along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteEventHubConsumerGroup

      void deleteEventHubConsumerGroup(String resourceGroupName, String resourceName, String eventHubEndpointName, String name)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      eventHubEndpointName - The name of the Event Hub-compatible endpoint in the IoT hub.
      name - The name of the consumer group to delete.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteEventHubConsumerGroupWithResponse

      com.azure.core.http.rest.Response<Void> deleteEventHubConsumerGroupWithResponse(String resourceGroupName, String resourceName, String eventHubEndpointName, String name, com.azure.core.util.Context context)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      eventHubEndpointName - The name of the Event Hub-compatible endpoint in the IoT hub.
      name - The name of the consumer group to delete.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listJobs

      com.azure.core.http.rest.PagedIterable<JobResponseInner> listJobs(String resourceGroupName, String resourceName)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      Returns:
      a list of all the jobs in an IoT hub as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listJobs

      com.azure.core.http.rest.PagedIterable<JobResponseInner> listJobs(String resourceGroupName, String resourceName, com.azure.core.util.Context context)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      context - The context to associate with this operation.
      Returns:
      a list of all the jobs in an IoT hub as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getJob

      JobResponseInner getJob(String resourceGroupName, String resourceName, String jobId)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      jobId - The job identifier.
      Returns:
      the details of a job from an IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getJobWithResponse

      com.azure.core.http.rest.Response<JobResponseInner> getJobWithResponse(String resourceGroupName, String resourceName, String jobId, com.azure.core.util.Context context)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      jobId - The job identifier.
      context - The context to associate with this operation.
      Returns:
      the details of a job from an IoT hub along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getQuotaMetrics

      com.azure.core.http.rest.PagedIterable<IotHubQuotaMetricInfoInner> getQuotaMetrics(String resourceGroupName, String resourceName)
      Get the quota metrics for an IoT hub

      Get the quota metrics for an IoT hub.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      Returns:
      the quota metrics for an IoT hub as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getQuotaMetrics

      com.azure.core.http.rest.PagedIterable<IotHubQuotaMetricInfoInner> getQuotaMetrics(String resourceGroupName, String resourceName, com.azure.core.util.Context context)
      Get the quota metrics for an IoT hub

      Get the quota metrics for an IoT hub.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      context - The context to associate with this operation.
      Returns:
      the quota metrics for an IoT hub as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getEndpointHealth

      com.azure.core.http.rest.PagedIterable<EndpointHealthDataInner> getEndpointHealth(String resourceGroupName, String iotHubName)
      Get the health for routing endpoints

      Get the health for routing endpoints.

      Parameters:
      resourceGroupName - The resourceGroupName parameter.
      iotHubName - The iotHubName parameter.
      Returns:
      the health for routing endpoints as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getEndpointHealth

      com.azure.core.http.rest.PagedIterable<EndpointHealthDataInner> getEndpointHealth(String resourceGroupName, String iotHubName, com.azure.core.util.Context context)
      Get the health for routing endpoints

      Get the health for routing endpoints.

      Parameters:
      resourceGroupName - The resourceGroupName parameter.
      iotHubName - The iotHubName parameter.
      context - The context to associate with this operation.
      Returns:
      the health for routing endpoints as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • checkNameAvailability

      IotHubNameAvailabilityInfoInner checkNameAvailability(OperationInputs operationInputs)
      Check if an IoT hub name is available

      Check if an IoT hub name is available.

      Parameters:
      operationInputs - Set the name parameter in the OperationInputs structure to the name of the IoT hub to check.
      Returns:
      the properties indicating whether a given IoT hub name is available.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • checkNameAvailabilityWithResponse

      com.azure.core.http.rest.Response<IotHubNameAvailabilityInfoInner> checkNameAvailabilityWithResponse(OperationInputs operationInputs, com.azure.core.util.Context context)
      Check if an IoT hub name is available

      Check if an IoT hub name is available.

      Parameters:
      operationInputs - Set the name parameter in the OperationInputs structure to the name of the IoT hub to check.
      context - The context to associate with this operation.
      Returns:
      the properties indicating whether a given IoT hub name is available along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • testAllRoutes

      TestAllRoutesResultInner testAllRoutes(String iotHubName, String resourceGroupName, TestAllRoutesInput input)
      Test all routes

      Test all routes configured in this Iot Hub.

      Parameters:
      iotHubName - IotHub to be tested.
      resourceGroupName - resource group which Iot Hub belongs to.
      input - Input for testing all routes.
      Returns:
      result of testing all routes.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • testAllRoutesWithResponse

      com.azure.core.http.rest.Response<TestAllRoutesResultInner> testAllRoutesWithResponse(String iotHubName, String resourceGroupName, TestAllRoutesInput input, com.azure.core.util.Context context)
      Test all routes

      Test all routes configured in this Iot Hub.

      Parameters:
      iotHubName - IotHub to be tested.
      resourceGroupName - resource group which Iot Hub belongs to.
      input - Input for testing all routes.
      context - The context to associate with this operation.
      Returns:
      result of testing all routes along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • testRoute

      TestRouteResultInner testRoute(String iotHubName, String resourceGroupName, TestRouteInput input)
      Test the new route

      Test the new route for this Iot Hub.

      Parameters:
      iotHubName - IotHub to be tested.
      resourceGroupName - resource group which Iot Hub belongs to.
      input - Route that needs to be tested.
      Returns:
      result of testing one route.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • testRouteWithResponse

      com.azure.core.http.rest.Response<TestRouteResultInner> testRouteWithResponse(String iotHubName, String resourceGroupName, TestRouteInput input, com.azure.core.util.Context context)
      Test the new route

      Test the new route for this Iot Hub.

      Parameters:
      iotHubName - IotHub to be tested.
      resourceGroupName - resource group which Iot Hub belongs to.
      input - Route that needs to be tested.
      context - The context to associate with this operation.
      Returns:
      result of testing one route along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listKeys

      com.azure.core.http.rest.PagedIterable<SharedAccessSignatureAuthorizationRuleInner> listKeys(String resourceGroupName, String resourceName)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      Returns:
      the security metadata for an IoT hub as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listKeys

      com.azure.core.http.rest.PagedIterable<SharedAccessSignatureAuthorizationRuleInner> listKeys(String resourceGroupName, String resourceName, com.azure.core.util.Context context)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      context - The context to associate with this operation.
      Returns:
      the security metadata for an IoT hub as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getKeysForKeyName

      SharedAccessSignatureAuthorizationRuleInner getKeysForKeyName(String resourceGroupName, String resourceName, String keyName)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      keyName - The name of the shared access policy.
      Returns:
      a shared access policy by name from an IoT hub.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getKeysForKeyNameWithResponse

      com.azure.core.http.rest.Response<SharedAccessSignatureAuthorizationRuleInner> getKeysForKeyNameWithResponse(String resourceGroupName, String resourceName, String keyName, com.azure.core.util.Context context)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      keyName - The name of the shared access policy.
      context - The context to associate with this operation.
      Returns:
      a shared access policy by name from an IoT hub along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • exportDevices

      JobResponseInner exportDevices(String resourceGroupName, String resourceName, ExportDevicesRequest exportDevicesParameters)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      exportDevicesParameters - The parameters that specify the export devices operation.
      Returns:
      the properties of the Job Response object.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • exportDevicesWithResponse

      com.azure.core.http.rest.Response<JobResponseInner> exportDevicesWithResponse(String resourceGroupName, String resourceName, ExportDevicesRequest exportDevicesParameters, com.azure.core.util.Context context)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      exportDevicesParameters - The parameters that specify the export devices operation.
      context - The context to associate with this operation.
      Returns:
      the properties of the Job Response object along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • importDevices

      JobResponseInner importDevices(String resourceGroupName, String resourceName, ImportDevicesRequest importDevicesParameters)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      importDevicesParameters - The parameters that specify the import devices operation.
      Returns:
      the properties of the Job Response object.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • importDevicesWithResponse

      com.azure.core.http.rest.Response<JobResponseInner> importDevicesWithResponse(String resourceGroupName, String resourceName, ImportDevicesRequest importDevicesParameters, com.azure.core.util.Context context)
      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the IoT hub.
      resourceName - The name of the IoT hub.
      importDevicesParameters - The parameters that specify the import devices operation.
      context - The context to associate with this operation.
      Returns:
      the properties of the Job Response object along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDetailsException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.