IotHubResourcesClient Interface

Package:

com.azure.resourcemanager.iothub.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-iothub:1.2.0

public interface IotHubResourcesClient

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

Method Summary

Modifier and Type	Method and Description
abstract SyncPoller<PollResult<IotHubDescriptionInner>,IotHubDescriptionInner>	beginCreateOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription) Create or update the metadata of an IoT hub.
abstract SyncPoller<PollResult<IotHubDescriptionInner>,IotHubDescriptionInner>	beginCreateOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription, String ifMatch, Context context) Create or update the metadata of an IoT hub.
abstract SyncPoller<PollResult<IotHubDescriptionInner>,IotHubDescriptionInner>	beginDelete(String resourceGroupName, String resourceName) Delete an IoT hub
abstract SyncPoller<PollResult<IotHubDescriptionInner>,IotHubDescriptionInner>	beginDelete(String resourceGroupName, String resourceName, Context context) Delete an IoT hub
abstract SyncPoller<PollResult<IotHubDescriptionInner>,IotHubDescriptionInner>	beginUpdate(String resourceGroupName, String resourceName, TagsResource iotHubTags) Update an existing IoT Hubs tags.
abstract SyncPoller<PollResult<IotHubDescriptionInner>,IotHubDescriptionInner>	beginUpdate(String resourceGroupName, String resourceName, TagsResource iotHubTags, Context context) Update an existing IoT Hubs tags.
abstract IotHubNameAvailabilityInfoInner	checkNameAvailability(OperationInputs operationInputs) Check if an IoT hub name is available
abstract Response<IotHubNameAvailabilityInfoInner>	checkNameAvailabilityWithResponse(OperationInputs operationInputs, Context context) Check if an IoT hub name is available
abstract 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
abstract Response<EventHubConsumerGroupInfoInner>	createEventHubConsumerGroupWithResponse(String resourceGroupName, String resourceName, String eventHubEndpointName, String name, EventHubConsumerGroupBodyDescription consumerGroupBody, Context context) Add a consumer group to an Event Hub-compatible endpoint in an IoT hub
abstract IotHubDescriptionInner	createOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription) Create or update the metadata of an IoT hub.
abstract IotHubDescriptionInner	createOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription, String ifMatch, Context context) Create or update the metadata of an IoT hub.
abstract IotHubDescriptionInner	delete(String resourceGroupName, String resourceName) Delete an IoT hub
abstract IotHubDescriptionInner	delete(String resourceGroupName, String resourceName, Context context) Delete an IoT hub
abstract void	deleteEventHubConsumerGroup(String resourceGroupName, String resourceName, String eventHubEndpointName, String name) Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub
abstract Response<Void>	deleteEventHubConsumerGroupWithResponse(String resourceGroupName, String resourceName, String eventHubEndpointName, String name, Context context) Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub
abstract 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.
abstract Response<JobResponseInner>	exportDevicesWithResponse(String resourceGroupName, String resourceName, ExportDevicesRequest exportDevicesParameters, Context context) Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container.
abstract IotHubDescriptionInner	getByResourceGroup(String resourceGroupName, String resourceName) Get the non-security related metadata of an IoT hub
abstract Response<IotHubDescriptionInner>	getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context) Get the non-security related metadata of an IoT hub
abstract PagedIterable<EndpointHealthDataInner>	getEndpointHealth(String resourceGroupName, String iotHubName) Get the health for routing endpoints
abstract PagedIterable<EndpointHealthDataInner>	getEndpointHealth(String resourceGroupName, String iotHubName, Context context) Get the health for routing endpoints
abstract 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
abstract Response<EventHubConsumerGroupInfoInner>	getEventHubConsumerGroupWithResponse(String resourceGroupName, String resourceName, String eventHubEndpointName, String name, Context context) Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub
abstract JobResponseInner	getJob(String resourceGroupName, String resourceName, String jobId) Get the details of a job from an IoT hub.
abstract Response<JobResponseInner>	getJobWithResponse(String resourceGroupName, String resourceName, String jobId, Context context) Get the details of a job from an IoT hub.
abstract SharedAccessSignatureAuthorizationRuleInner	getKeysForKeyName(String resourceGroupName, String resourceName, String keyName) Get a shared access policy by name from an IoT hub.
abstract Response<SharedAccessSignatureAuthorizationRuleInner>	getKeysForKeyNameWithResponse(String resourceGroupName, String resourceName, String keyName, Context context) Get a shared access policy by name from an IoT hub.
abstract PagedIterable<IotHubQuotaMetricInfoInner>	getQuotaMetrics(String resourceGroupName, String resourceName) Get the quota metrics for an IoT hub
abstract PagedIterable<IotHubQuotaMetricInfoInner>	getQuotaMetrics(String resourceGroupName, String resourceName, Context context) Get the quota metrics for an IoT hub
abstract RegistryStatisticsInner	getStats(String resourceGroupName, String resourceName) Get the statistics from an IoT hub
abstract Response<RegistryStatisticsInner>	getStatsWithResponse(String resourceGroupName, String resourceName, Context context) Get the statistics from an IoT hub
abstract PagedIterable<IotHubSkuDescriptionInner>	getValidSkus(String resourceGroupName, String resourceName) Get the list of valid SKUs for an IoT hub
abstract PagedIterable<IotHubSkuDescriptionInner>	getValidSkus(String resourceGroupName, String resourceName, Context context) Get the list of valid SKUs for an IoT hub
abstract JobResponseInner	importDevices(String resourceGroupName, String resourceName, ImportDevicesRequest importDevicesParameters) Import, update, or delete device identities in the IoT hub identity registry from a blob.
abstract Response<JobResponseInner>	importDevicesWithResponse(String resourceGroupName, String resourceName, ImportDevicesRequest importDevicesParameters, Context context) Import, update, or delete device identities in the IoT hub identity registry from a blob.
abstract PagedIterable<IotHubDescriptionInner>	list() Get all the IoT hubs in a subscription
abstract PagedIterable<IotHubDescriptionInner>	list(Context context) Get all the IoT hubs in a subscription
abstract PagedIterable<IotHubDescriptionInner>	listByResourceGroup(String resourceGroupName) Get all the IoT hubs in a resource group
abstract PagedIterable<IotHubDescriptionInner>	listByResourceGroup(String resourceGroupName, Context context) Get all the IoT hubs in a resource group
abstract 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
abstract PagedIterable<EventHubConsumerGroupInfoInner>	listEventHubConsumerGroups(String resourceGroupName, String resourceName, String eventHubEndpointName, Context context) Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub
abstract PagedIterable<JobResponseInner>	listJobs(String resourceGroupName, String resourceName) Get a list of all the jobs in an IoT hub.
abstract PagedIterable<JobResponseInner>	listJobs(String resourceGroupName, String resourceName, Context context) Get a list of all the jobs in an IoT hub.
abstract PagedIterable<SharedAccessSignatureAuthorizationRuleInner>	listKeys(String resourceGroupName, String resourceName) Get the security metadata for an IoT hub.
abstract PagedIterable<SharedAccessSignatureAuthorizationRuleInner>	listKeys(String resourceGroupName, String resourceName, Context context) Get the security metadata for an IoT hub.
abstract TestAllRoutesResultInner	testAllRoutes(String iotHubName, String resourceGroupName, TestAllRoutesInput input) Test all routes
abstract Response<TestAllRoutesResultInner>	testAllRoutesWithResponse(String iotHubName, String resourceGroupName, TestAllRoutesInput input, Context context) Test all routes
abstract TestRouteResultInner	testRoute(String iotHubName, String resourceGroupName, TestRouteInput input) Test the new route
abstract Response<TestRouteResultInner>	testRouteWithResponse(String iotHubName, String resourceGroupName, TestRouteInput input, Context context) Test the new route
abstract IotHubDescriptionInner	update(String resourceGroupName, String resourceName, TagsResource iotHubTags) Update an existing IoT Hubs tags.
abstract IotHubDescriptionInner	update(String resourceGroupName, String resourceName, TagsResource iotHubTags, Context context) Update an existing IoT Hubs tags.

Method Details

beginCreateOrUpdate

public abstract SyncPoller<>,IotHubDescriptionInner> beginCreateOrUpdate(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. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior.

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 SyncPoller<T,U> for polling of the description of the IoT hub.

beginCreateOrUpdate

public abstract SyncPoller<>,IotHubDescriptionInner> beginCreateOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription, String ifMatch, 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. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior.

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<T,U> for polling of the description of the IoT hub.

beginDelete

public abstract SyncPoller<>,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<T,U> for polling of the description of the IoT hub.

beginDelete

public abstract SyncPoller<>,IotHubDescriptionInner> beginDelete(String resourceGroupName, String resourceName, 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<T,U> for polling of the description of the IoT hub.

beginUpdate

public abstract SyncPoller<>,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<T,U> for polling of the description of the IoT hub.

beginUpdate

public abstract SyncPoller<>,IotHubDescriptionInner> beginUpdate(String resourceGroupName, String resourceName, TagsResource iotHubTags, 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<T,U> for polling of the description of the IoT hub.

checkNameAvailability

public abstract 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.

checkNameAvailabilityWithResponse

public abstract Response checkNameAvailabilityWithResponse(OperationInputs operationInputs, 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<T>.

createEventHubConsumerGroup

public abstract 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.

createEventHubConsumerGroupWithResponse

public abstract Response createEventHubConsumerGroupWithResponse(String resourceGroupName, String resourceName, String eventHubEndpointName, String name, EventHubConsumerGroupBodyDescription consumerGroupBody, 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<T>.

createOrUpdate

public abstract 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. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior.

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.

createOrUpdate

public abstract IotHubDescriptionInner createOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription, String ifMatch, 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. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior.

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.

delete

public abstract 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.

delete

public abstract IotHubDescriptionInner delete(String resourceGroupName, String resourceName, 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.

deleteEventHubConsumerGroup

public abstract 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.

deleteEventHubConsumerGroupWithResponse

public abstract Response deleteEventHubConsumerGroupWithResponse(String resourceGroupName, String resourceName, String eventHubEndpointName, String name, 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<T>.

exportDevices

public abstract 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.

exportDevicesWithResponse

public abstract Response exportDevicesWithResponse(String resourceGroupName, String resourceName, ExportDevicesRequest exportDevicesParameters, 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<T>.

getByResourceGroup

public abstract 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.

getByResourceGroupWithResponse

public abstract Response getByResourceGroupWithResponse(String resourceGroupName, String resourceName, 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<T>.

getEndpointHealth

public abstract PagedIterable 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<T>.

getEndpointHealth

public abstract PagedIterable getEndpointHealth(String resourceGroupName, String iotHubName, 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<T>.

getEventHubConsumerGroup

public abstract 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.

getEventHubConsumerGroupWithResponse

public abstract Response getEventHubConsumerGroupWithResponse(String resourceGroupName, String resourceName, String eventHubEndpointName, String name, 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<T>.

getJob

public abstract 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.

getJobWithResponse

public abstract Response getJobWithResponse(String resourceGroupName, String resourceName, String jobId, 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<T>.

getKeysForKeyName

public abstract 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.

getKeysForKeyNameWithResponse

public abstract Response getKeysForKeyNameWithResponse(String resourceGroupName, String resourceName, String keyName, 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<T>.

getQuotaMetrics

public abstract PagedIterable 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<T>.

getQuotaMetrics

public abstract PagedIterable getQuotaMetrics(String resourceGroupName, String resourceName, 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<T>.

getStats

public abstract 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.

getStatsWithResponse

public abstract Response getStatsWithResponse(String resourceGroupName, String resourceName, 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<T>.

getValidSkus

public abstract PagedIterable 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<T>.

getValidSkus

public abstract PagedIterable getValidSkus(String resourceGroupName, String resourceName, 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<T>.

importDevices

public abstract 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.

importDevicesWithResponse

public abstract Response importDevicesWithResponse(String resourceGroupName, String resourceName, ImportDevicesRequest importDevicesParameters, 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<T>.

list

public abstract PagedIterable 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<T>.

list

public abstract PagedIterable list(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<T>.

listByResourceGroup

public abstract PagedIterable 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<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName, 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<T>.

listEventHubConsumerGroups

public abstract PagedIterable 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<T>.

listEventHubConsumerGroups

public abstract PagedIterable listEventHubConsumerGroups(String resourceGroupName, String resourceName, String eventHubEndpointName, 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<T>.

listJobs

public abstract PagedIterable 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<T>.

listJobs

public abstract PagedIterable listJobs(String resourceGroupName, String resourceName, 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<T>.

listKeys

public abstract PagedIterable 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<T>.

listKeys

public abstract PagedIterable listKeys(String resourceGroupName, String resourceName, 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<T>.

testAllRoutes

public abstract 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.

testAllRoutesWithResponse

public abstract Response testAllRoutesWithResponse(String iotHubName, String resourceGroupName, TestAllRoutesInput input, 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<T>.

testRoute

public abstract 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.

testRouteWithResponse

public abstract Response testRouteWithResponse(String iotHubName, String resourceGroupName, TestRouteInput input, 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<T>.

update

public abstract 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.

update

public abstract IotHubDescriptionInner update(String resourceGroupName, String resourceName, TagsResource iotHubTags, 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.