Package com.azure.resourcemanager.iothub.models

Interface IotHubResources

  • public interface IotHubResources
    Resource collection API of IotHubResources.

    • Method Detail

      • getByResourceGroup

        IotHubDescription getByResourceGroup​(String resourceGroupName,
                                     String resourceName)
        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<IotHubDescription> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                                    String resourceName,
                                                                                    com.azure.core.util.Context context)
        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.

      • deleteByResourceGroup

        IotHubDescription deleteByResourceGroup​(String resourceGroupName,
                                        String resourceName)
        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

        IotHubDescription delete​(String resourceGroupName,
                         String resourceName,
                         com.azure.core.util.Context context)
        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<IotHubDescription> list()
        Get all the IoT hubs in a subscription.
        Returns:
        all the IoT hubs in a subscription.
        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<IotHubDescription> list​(com.azure.core.util.Context context)
        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.
        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<IotHubDescription> listByResourceGroup​(String resourceGroupName)
        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.
        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<IotHubDescription> listByResourceGroup​(String resourceGroupName,
                                                                              com.azure.core.util.Context context)
        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.
        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

        RegistryStatistics getStats​(String resourceGroupName,
                            String resourceName)
        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<RegistryStatistics> getStatsWithResponse​(String resourceGroupName,
                                                                           String resourceName,
                                                                           com.azure.core.util.Context context)
        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<IotHubSkuDescription> getValidSkus​(String resourceGroupName,
                                                                          String resourceName)
        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.
        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<IotHubSkuDescription> getValidSkus​(String resourceGroupName,
                                                                          String resourceName,
                                                                          com.azure.core.util.Context context)
        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.
        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<EventHubConsumerGroupInfo> 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.
        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.
        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<EventHubConsumerGroupInfo> 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.
        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.
        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

        EventHubConsumerGroupInfo 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.
        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<EventHubConsumerGroupInfo> 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.
        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.

      • 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.
        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.
        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<JobResponse> 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.
        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.
        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<JobResponse> 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.
        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.
        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

        JobResponse 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.
        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<JobResponse> 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.
        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<IotHubQuotaMetricInfo> getQuotaMetrics​(String resourceGroupName,
                                                                              String resourceName)
        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.
        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<IotHubQuotaMetricInfo> getQuotaMetrics​(String resourceGroupName,
                                                                              String resourceName,
                                                                              com.azure.core.util.Context context)
        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.
        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<EndpointHealthData> getEndpointHealth​(String resourceGroupName,
                                                                             String iotHubName)
        Get the health for routing endpoints.
        Parameters:
        resourceGroupName - The resourceGroupName parameter.
        iotHubName - The iotHubName parameter.
        Returns:
        the health for routing endpoints.
        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<EndpointHealthData> getEndpointHealth​(String resourceGroupName,
                                                                             String iotHubName,
                                                                             com.azure.core.util.Context context)
        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.
        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

        IotHubNameAvailabilityInfo checkNameAvailability​(OperationInputs operationInputs)
        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<IotHubNameAvailabilityInfo> checkNameAvailabilityWithResponse​(OperationInputs operationInputs,
                                                                                                com.azure.core.util.Context context)
        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

        TestAllRoutesResult testAllRoutes​(String iotHubName,
                                  String resourceGroupName,
                                  TestAllRoutesInput input)
        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<TestAllRoutesResult> testAllRoutesWithResponse​(String iotHubName,
                                                                                 String resourceGroupName,
                                                                                 TestAllRoutesInput input,
                                                                                 com.azure.core.util.Context context)
        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

        TestRouteResult testRoute​(String iotHubName,
                          String resourceGroupName,
                          TestRouteInput input)
        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<TestRouteResult> testRouteWithResponse​(String iotHubName,
                                                                         String resourceGroupName,
                                                                         TestRouteInput input,
                                                                         com.azure.core.util.Context context)
        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<SharedAccessSignatureAuthorizationRule> 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.
        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.
        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<SharedAccessSignatureAuthorizationRule> 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.
        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.
        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

        SharedAccessSignatureAuthorizationRule 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.
        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<SharedAccessSignatureAuthorizationRule> 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.
        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

        JobResponse 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.
        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<JobResponse> 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.
        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

        JobResponse 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.
        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<JobResponse> 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.
        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.

      • getById

        IotHubDescription getById​(String id)
        Get the non-security related metadata of an IoT hub.
        Parameters:
        id - the resource ID.
        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.

      • getByIdWithResponse

        com.azure.core.http.rest.Response<IotHubDescription> getByIdWithResponse​(String id,
                                                                         com.azure.core.util.Context context)
        Get the non-security related metadata of an IoT hub.
        Parameters:
        id - the resource ID.
        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.

      • getEventHubConsumerGroupById

        EventHubConsumerGroupInfo getEventHubConsumerGroupById​(String id)
        Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.
        Parameters:
        id - the resource ID.
        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.

      • getEventHubConsumerGroupByIdWithResponse

        com.azure.core.http.rest.Response<EventHubConsumerGroupInfo> getEventHubConsumerGroupByIdWithResponse​(String id,
                                                                                                      com.azure.core.util.Context context)
        Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.
        Parameters:
        id - the resource ID.
        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.

      • deleteByIdWithResponse

        IotHubDescription deleteByIdWithResponse​(String id,
                                         com.azure.core.util.Context context)
        Delete an IoT hub.
        Parameters:
        id - the resource ID.
        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.

      • deleteEventHubConsumerGroupById

        void deleteEventHubConsumerGroupById​(String id)
        Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.
        Parameters:
        id - the resource ID.
        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.

      • deleteEventHubConsumerGroupByIdWithResponse

        com.azure.core.http.rest.Response<Void> deleteEventHubConsumerGroupByIdWithResponse​(String id,
                                                                                    com.azure.core.util.Context context)
        Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.
        Parameters:
        id - the resource ID.
        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.

      • define

        IotHubDescription.DefinitionStages.Blank define​(String name)
        Begins definition for a new IotHubDescription resource.
        Parameters:
        name - resource name.
        Returns:
        the first stage of the new IotHubDescription definition.

      • defineEventHubConsumerGroup

        EventHubConsumerGroupInfo.DefinitionStages.Blank defineEventHubConsumerGroup​(String name)
        Begins definition for a new EventHubConsumerGroupInfo resource.
        Parameters:
        name - resource name.
        Returns:
        the first stage of the new EventHubConsumerGroupInfo definition.