IotHubResourcesClient Interface
public interface IotHubResourcesClient
An instance of this class provides access to all the operations defined in IotHubResourcesClient.
Method Summary
Method Details
beginCreateOrUpdate
public abstract SyncPoller<>
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:
Returns:
beginCreateOrUpdate
public abstract SyncPoller<>
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:
Returns:
beginDelete
public abstract SyncPoller<>
Delete an IoT hub
Delete an IoT hub.
Parameters:
Returns:
beginDelete
public abstract SyncPoller<>
Delete an IoT hub
Delete an IoT hub.
Parameters:
Returns:
beginUpdate
public abstract SyncPoller<>
Update an existing IoT Hubs tags.
Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method.
Parameters:
Returns:
beginUpdate
public abstract SyncPoller<>
Update an existing IoT Hubs tags.
Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method.
Parameters:
Returns:
checkNameAvailability
public abstract IotHubNameAvailabilityInfoInner checkNameAvailability(OperationInputs operationInputs)
Check if an IoT hub name is available
Check if an IoT hub name is available.
Parameters:
Returns:
checkNameAvailabilityWithResponse
public abstract Response
Check if an IoT hub name is available
Check if an IoT hub name is available.
Parameters:
Returns:
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:
Returns:
createEventHubConsumerGroupWithResponse
public abstract Response
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:
Returns:
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:
Returns:
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:
Returns:
delete
public abstract IotHubDescriptionInner delete(String resourceGroupName, String resourceName)
Delete an IoT hub
Delete an IoT hub.
Parameters:
Returns:
delete
public abstract IotHubDescriptionInner delete(String resourceGroupName, String resourceName, Context context)
Delete an IoT hub
Delete an IoT hub.
Parameters:
Returns:
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:
deleteEventHubConsumerGroupWithResponse
public abstract Response
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:
Returns:
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:
Returns:
exportDevicesWithResponse
public abstract Response
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:
Returns:
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:
Returns:
getByResourceGroupWithResponse
public abstract Response
Get the non-security related metadata of an IoT hub
Get the non-security related metadata of an IoT hub.
Parameters:
Returns:
getEndpointHealth
public abstract PagedIterable
Get the health for routing endpoints
Get the health for routing endpoints.
Parameters:
Returns:
getEndpointHealth
public abstract PagedIterable
Get the health for routing endpoints
Get the health for routing endpoints.
Parameters:
Returns:
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:
Returns:
getEventHubConsumerGroupWithResponse
public abstract Response
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:
Returns:
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:
Returns:
getJobWithResponse
public abstract Response
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:
Returns:
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:
Returns:
getKeysForKeyNameWithResponse
public abstract Response
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:
Returns:
getQuotaMetrics
public abstract PagedIterable
Get the quota metrics for an IoT hub
Get the quota metrics for an IoT hub.
Parameters:
Returns:
getQuotaMetrics
public abstract PagedIterable
Get the quota metrics for an IoT hub
Get the quota metrics for an IoT hub.
Parameters:
Returns:
getStats
public abstract RegistryStatisticsInner getStats(String resourceGroupName, String resourceName)
Get the statistics from an IoT hub
Get the statistics from an IoT hub.
Parameters:
Returns:
getStatsWithResponse
public abstract Response
Get the statistics from an IoT hub
Get the statistics from an IoT hub.
Parameters:
Returns:
getValidSkus
public abstract PagedIterable
Get the list of valid SKUs for an IoT hub
Get the list of valid SKUs for an IoT hub.
Parameters:
Returns:
getValidSkus
public abstract PagedIterable
Get the list of valid SKUs for an IoT hub
Get the list of valid SKUs for an IoT hub.
Parameters:
Returns:
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:
Returns:
importDevicesWithResponse
public abstract Response
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:
Returns:
list
public abstract PagedIterable
Get all the IoT hubs in a subscription
Get all the IoT hubs in a subscription.
Returns:
list
public abstract PagedIterable
Get all the IoT hubs in a subscription
Get all the IoT hubs in a subscription.
Parameters:
Returns:
listByResourceGroup
public abstract PagedIterable
Get all the IoT hubs in a resource group
Get all the IoT hubs in a resource group.
Parameters:
Returns:
listByResourceGroup
public abstract PagedIterable
Get all the IoT hubs in a resource group
Get all the IoT hubs in a resource group.
Parameters:
Returns:
listEventHubConsumerGroups
public abstract PagedIterable
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:
Returns:
listEventHubConsumerGroups
public abstract PagedIterable
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:
Returns:
listJobs
public abstract PagedIterable
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:
Returns:
listJobs
public abstract PagedIterable
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:
Returns:
listKeys
public abstract PagedIterable
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:
Returns:
listKeys
public abstract PagedIterable
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:
Returns:
testAllRoutes
public abstract TestAllRoutesResultInner testAllRoutes(String iotHubName, String resourceGroupName, TestAllRoutesInput input)
Test all routes
Test all routes configured in this Iot Hub.
Parameters:
Returns:
testAllRoutesWithResponse
public abstract Response
Test all routes
Test all routes configured in this Iot Hub.
Parameters:
Returns:
testRoute
public abstract TestRouteResultInner testRoute(String iotHubName, String resourceGroupName, TestRouteInput input)
Test the new route
Test the new route for this Iot Hub.
Parameters:
Returns:
testRouteWithResponse
public abstract Response
Test the new route
Test the new route for this Iot Hub.
Parameters:
Returns:
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:
Returns:
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:
Returns:
Applies to
Azure SDK for Java
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for