IotHubResourcesClient Interface

Definition

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

public interface IotHubResourcesClient

Methods

beginCreateOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription, String ifMatch)

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.

beginCreateOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription, String ifMatch, Context context)

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.

beginDelete(String resourceGroupName, String resourceName)

Delete an IoT hub.

beginDelete(String resourceGroupName, String resourceName, Context context)

Delete an IoT hub.

beginUpdate(String resourceGroupName, String resourceName, TagsResource iotHubTags)

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

beginUpdate(String resourceGroupName, String resourceName, TagsResource iotHubTags, Context context)

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

checkNameAvailability(OperationInputs operationInputs)

Check if an IoT hub name is available.

checkNameAvailabilityWithResponse(OperationInputs operationInputs, Context context)

Check if an IoT hub name is available.

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.

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.

createOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription)

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.

createOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription, String ifMatch)

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.

createOrUpdate(String resourceGroupName, String resourceName, IotHubDescriptionInner iotHubDescription, String ifMatch, Context context)

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.

delete(String resourceGroupName, String resourceName)

Delete an IoT hub.

delete(String resourceGroupName, String resourceName, Context context)

Delete an IoT hub.

deleteEventHubConsumerGroup(String resourceGroupName, String resourceName, String eventHubEndpointName, String name)

Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.

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.

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.

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.

getByResourceGroup(String resourceGroupName, String resourceName)

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

getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)

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

getEndpointHealth(String resourceGroupName, String iotHubName)

Get the health for routing endpoints.

getEndpointHealth(String resourceGroupName, String iotHubName, Context context)

Get the health for routing endpoints.

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.

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.

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.

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.

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.

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.

getQuotaMetrics(String resourceGroupName, String resourceName)

Get the quota metrics for an IoT hub.

getQuotaMetrics(String resourceGroupName, String resourceName, Context context)

Get the quota metrics for an IoT hub.

getStats(String resourceGroupName, String resourceName)

Get the statistics from an IoT hub.

getStatsWithResponse(String resourceGroupName, String resourceName, Context context)

Get the statistics from an IoT hub.

getValidSkus(String resourceGroupName, String resourceName)

Get the list of valid SKUs for an IoT hub.

getValidSkus(String resourceGroupName, String resourceName, Context context)

Get the list of valid SKUs for an IoT hub.

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.

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.

list()

Get all the IoT hubs in a subscription.

list(Context context)

Get all the IoT hubs in a subscription.

listByResourceGroup(String resourceGroupName)

Get all the IoT hubs in a resource group.

listByResourceGroup(String resourceGroupName, Context context)

Get all the IoT hubs in a resource group.

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.

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.

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.

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.

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.

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.

testAllRoutes(String iotHubName, String resourceGroupName, TestAllRoutesInput input)

Test all routes configured in this Iot Hub.

testAllRoutesWithResponse(String iotHubName, String resourceGroupName, TestAllRoutesInput input, Context context)

Test all routes configured in this Iot Hub.

testRoute(String iotHubName, String resourceGroupName, TestRouteInput input)

Test the new route for this Iot Hub.

testRouteWithResponse(String iotHubName, String resourceGroupName, TestRouteInput input, Context context)

Test the new route for this Iot Hub.

update(String resourceGroupName, String resourceName, TagsResource iotHubTags)

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

update(String resourceGroupName, String resourceName, TagsResource iotHubTags, Context context)

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

Applies to