IoT Hub and DPS api versions

Question

IoT Hub and DPS api versions

Måns Andersson 1

Hi,

We're building products connecting to Azure Device Provisioning Service and IoT Hub using MQTT protocol. We are rolling our own implementation and not utilizing the SDKs as they are not compatible with our application.

We are wondering if there's any documentation available on the api version numbers? Which ones are supported, what the difference is etc.

All we've been able to find is the following

IoT Hub

Docs page specifying 2018-06-30 but not mentioning anything else about the parameter
https://learn.microsoft.com/en-us/azure/iot-hub/iot-hub-mqtt-support#using-the-mqtt-protocol-directly-as-a-device

SDK code which uses 2020-09-30
https://github.com/Azure/azure-iot-sdk-c/blob/32942abb994f6855edc2a4dee8afd80735df4151/iothub_client/inc/internal/iothub_internal_consts.h#L12

DPS

Docs page specifying 2019-03-31 but not mentioning anything else about the parameter
https://learn.microsoft.com/en-us/azure/iot-dps/iot-dps-mqtt-support#using-the-mqtt-protocol-directly-as-a-device

SDK code which uses 2019-03-31
https://github.com/Azure/azure-iot-sdk-c/blob/main/provisioning_client/inc/azure_prov_client/prov_client_const.h#L18

Best regards
Måns

AshokPeddakotla-MSFT 35,971 Reputation points Moderator

2022-02-09T07:39:36.373+00:00

@Måns Andersson Welcome to Microsoft Q&A forum!
You have mentioned, "We are rolling our own implementation and not utilizing the SDKs as they are not compatible with our application.", Could you please share more details regarding this application? Do you have any specific requirement regarding the versions? Did you try with the api-version "2019-03-31" and not working as expected?
AshokPeddakotla-MSFT 35,971 Reputation points Moderator

2022-03-03T16:36:37.977+00:00

@Måns Andersson Did you get a chance to see my response? Do let us know more details to help you accordingly.
I haven't found the documentation on the supported api version numbers. If you are blocked and looking for any specific details, do let us know
Måns Andersson 1 Reputation point

2022-03-09T07:53:32.457+00:00

@AshokPeddakotla-MSFT We are currently using 2018-04-01 and don't have any issues with that. However we'd like to be up-to-date with recommendations from Microsoft so as to not start getting issues at a later date when/if Microsoft starts to obsolete some API versions.

We are still on the lookout for the official documentation on these versions.
Måns Andersson 1 Reputation point

2022-09-22T08:31:32.5+00:00

@AshokPeddakotla-MSFT We are still waiting for a response to these questions on what is the official documented versions and what the differences are. Any progress on your end?

2 answers

Your answer

AshokPeddakotla-MSFT 35,971 Reputation points Moderator

2022-02-09T07:39:36.373+00:00

@Måns Andersson Welcome to Microsoft Q&A forum!
You have mentioned, "We are rolling our own implementation and not utilizing the SDKs as they are not compatible with our application.", Could you please share more details regarding this application? Do you have any specific requirement regarding the versions? Did you try with the api-version "2019-03-31" and not working as expected?
AshokPeddakotla-MSFT 35,971 Reputation points Moderator

2022-03-03T16:36:37.977+00:00

@Måns Andersson Did you get a chance to see my response? Do let us know more details to help you accordingly.
I haven't found the documentation on the supported api version numbers. If you are blocked and looking for any specific details, do let us know
Måns Andersson 1 Reputation point

2022-03-09T07:53:32.457+00:00

@AshokPeddakotla-MSFT We are currently using 2018-04-01 and don't have any issues with that. However we'd like to be up-to-date with recommendations from Microsoft so as to not start getting issues at a later date when/if Microsoft starts to obsolete some API versions.

We are still on the lookout for the official documentation on these versions.
Måns Andersson 1 Reputation point

2022-09-22T08:31:32.5+00:00

@AshokPeddakotla-MSFT We are still waiting for a response to these questions on what is the official documented versions and what the differences are. Any progress on your end?

Answer 1

Hello @Måns Andersson Thanks for your feedback, we will make sure the question on the API version is addressed as soon as possible on the documentation side also

For the Username field, It's strongly recommended to include api-version. I hope this helps with your initial query!

I have tested quickly with MQTTBox client, with both the versions on IoTHub: 2020-09-30, 2018-06-30, you should be good with either of them. Please let us know if it fails on your side and we can log a product issue.

Monitoring on Azure IoTHub Side:

Please comment in the below section for further help in this regard, Happy to help you!

Answer 2

Dominic 1,631 Microsoft Employee

The REST API reference pages show the latest version for each API. For example: https://learn.microsoft.com/en-us/rest/api/iot-dps/device/runtime-registration/register-device shows API Version:
2021-06-01

Share via

IoT Hub and DPS api versions

2 answers

Your answer