DevicesFunctions

Functions

Link copied to clipboard

Returns the certificate. Uses Azure REST API version 2022-04-30-preview. Other available API versions: 2020-04-01, 2022-11-15-preview, 2023-06-30, 2023-06-30-preview.

suspend fun getCertificate(certificateName: String, resourceGroupName: String, resourceName: String): GetCertificateResult
Link copied to clipboard

Get the certificate from the provisioning service. Uses Azure REST API version 2022-12-12. Other available API versions: 2021-10-15, 2023-03-01-preview, 2025-02-01-preview.

suspend fun getDpsCertificate(certificateName: String, provisioningServiceName: String, resourceGroupName: String): GetDpsCertificateResult
Link copied to clipboard

Get the metadata of the provisioning service without SAS keys. Uses Azure REST API version 2022-12-12. Other available API versions: 2020-09-01-preview, 2023-03-01-preview, 2025-02-01-preview.

suspend fun getIotDpsResource(provisioningServiceName: String, resourceGroupName: String): GetIotDpsResourceResult

Get private endpoint connection properties Uses Azure REST API version 2022-12-12. Other available API versions: 2023-03-01-preview, 2025-02-01-preview.

suspend fun getIotDpsResourcePrivateEndpointConnection(privateEndpointConnectionName: String, resourceGroupName: String, resourceName: String): GetIotDpsResourcePrivateEndpointConnectionResult
Link copied to clipboard

Get the non-security related metadata of an IoT hub. Uses Azure REST API version 2022-04-30-preview. Other available API versions: 2022-11-15-preview, 2023-06-30, 2023-06-30-preview.

suspend fun getIotHubResource(resourceGroupName: String, resourceName: String): GetIotHubResourceResult
Link copied to clipboard

Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub. Uses Azure REST API version 2022-04-30-preview. Other available API versions: 2021-03-03-preview, 2022-11-15-preview, 2023-06-30, 2023-06-30-preview.

suspend fun getIotHubResourceEventHubConsumerGroup(eventHubEndpointName: String, name: String, resourceGroupName: String, resourceName: String): GetIotHubResourceEventHubConsumerGroupResult
Link copied to clipboard

Get private endpoint connection properties Uses Azure REST API version 2022-04-30-preview. Other available API versions: 2022-11-15-preview, 2023-06-30, 2023-06-30-preview.

suspend fun getPrivateEndpointConnection(privateEndpointConnectionName: String, resourceGroupName: String, resourceName: String): GetPrivateEndpointConnectionResult
Link copied to clipboard

List the primary and secondary keys for a provisioning service. Uses Azure REST API version 2022-12-12. Other available API versions: 2020-09-01-preview, 2023-03-01-preview, 2025-02-01-preview.

suspend fun listIotDpsResourceKeys(provisioningServiceName: String, resourceGroupName: String): ListIotDpsResourceKeysResult
Link copied to clipboard

List primary and secondary keys for a specific key name Uses Azure REST API version 2022-12-12. Other available API versions: 2020-09-01-preview, 2023-03-01-preview, 2025-02-01-preview.

suspend fun listIotDpsResourceKeysForKeyName(keyName: String, provisioningServiceName: String, resourceGroupName: String): ListIotDpsResourceKeysForKeyNameResult
Link copied to clipboard

Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Uses Azure REST API version 2022-04-30-preview. Other available API versions: 2022-11-15-preview, 2023-06-30, 2023-06-30-preview.

suspend fun listIotHubResourceKeys(resourceGroupName: String, resourceName: String): ListIotHubResourceKeysResult
Link copied to clipboard

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. Uses Azure REST API version 2022-04-30-preview. Other available API versions: 2022-11-15-preview, 2023-06-30, 2023-06-30-preview.

suspend fun listIotHubResourceKeysForKeyName(keyName: String, resourceGroupName: String, resourceName: String): ListIotHubResourceKeysForKeyNameResult