API version change log for deployment of Microsoft.Devices/IotHubs
This article describes the properties that changed in each API version for Microsoft.Devices/IotHubs. It only covers properties that are available during deployments.
2023-06-30
Added:
- disableDeviceSAS
- disableLocalAuth
- disableModuleSAS
- enableDataResidency
- enableFileUploadNotifications
- routing.endpoints.cosmosDBSqlContainers.authenticationType
- routing.endpoints.cosmosDBSqlContainers.containerName
- routing.endpoints.cosmosDBSqlContainers.databaseName
- routing.endpoints.cosmosDBSqlContainers.endpointUri
- routing.endpoints.cosmosDBSqlContainers.identity
- routing.endpoints.cosmosDBSqlContainers.identity.userAssignedIdentity
- routing.endpoints.cosmosDBSqlContainers.name
- routing.endpoints.cosmosDBSqlContainers.partitionKeyName
- routing.endpoints.cosmosDBSqlContainers.partitionKeyTemplate
- routing.endpoints.cosmosDBSqlContainers.primaryKey
- routing.endpoints.cosmosDBSqlContainers.resourceGroup
- routing.endpoints.cosmosDBSqlContainers.secondaryKey
- routing.endpoints.cosmosDBSqlContainers.subscriptionId
- routing.endpoints.eventHubs
- routing.endpoints.connectionString
- routing.endpoints.entityPath
- routing.serviceBusQueues
Removed:
- deviceStreams
- deviceStreams.streamingEndpoints
- deviceStreams.disableDeviceSAS
- deviceStreams.disableLocalAuth
- deviceStreams.disableModuleSAS
- deviceStreams.enableDataResidency
- deviceStreams.enableFileUploadNotifications
- deviceStreams.encryption
- deviceStreams.encryption.keySource
- deviceStreams.encryption.keyVaultProperties
- deviceStreams.encryption.identity
- deviceStreams.encryption.identity.userAssignedIdentity
- deviceStreams.encryption.keyIdentifier
- ipVersion
- rootCertificate
- rootCertificate.enableRootCertificateV2
- routing.endpoints.containerName
- routing.endpoints.databaseName
- routing.endpoints.partitionKeyName
- routing.endpoints.partitionKeyTemplate
- routing.endpoints.primaryKey
- routing.endpoints.secondaryKey
- routing.eventHubs
- serviceBusQueues
Updated:
- properties.routing.fallbackRoute.source - Removed values: 'DigitalTwinChangeEvents' 'MqttBrokerMessages'
- properties.routing.routes.source - Removed values: 'DigitalTwinChangeEvents' 'MqttBrokerMessages'
- sku.apiVersion - Added values: '2023-06-30' - Removed values: '2023-06-30-preview'
2023-06-30-preview
Added:
- routing.endpoints.cosmosDBSqlContainers
- routing.endpoints.containerName
Removed:
- routing.endpoints.cosmosDBSqlCollections
- routing.endpoints.collectionName
Updated:
- sku.apiVersion - Added values: '2023-06-30-preview' - Removed values: '2022-11-15-preview'
2022-11-15-preview
Added:
- ipVersion
- properties.privateEndpoint
- properties.privateLinkServiceConnectionState
- properties.privateLinkServiceConnectionState.actionsRequired
- properties.privateLinkServiceConnectionState.description
- properties.privateLinkServiceConnectionState.status
Removed:
- privateEndpointConnections.properties
- privateEndpointConnections.properties.privateEndpoint
- privateEndpointConnections.properties.privateLinkServiceConnectionState
- privateEndpointConnections.properties.privateLinkServiceConnectionState.actionsRequired
- privateEndpointConnections.properties.privateLinkServiceConnectionState.description
- privateEndpointConnections.properties.privateLinkServiceConnectionState.status
Updated:
- sku.apiVersion - Added values: '2022-11-15-preview' - Removed values: '2022-04-30-preview'
2022-04-30-preview
Added:
- deviceStreams
- deviceStreams.streamingEndpoints
- deviceStreams.disableDeviceSAS
- deviceStreams.disableLocalAuth
- deviceStreams.disableModuleSAS
- deviceStreams.enableDataResidency
- deviceStreams.enableFileUploadNotifications
- deviceStreams.encryption
- deviceStreams.encryption.keySource
- deviceStreams.encryption.keyVaultProperties
- deviceStreams.encryption.identity
- deviceStreams.encryption.identity.userAssignedIdentity
- deviceStreams.encryption.keyIdentifier
- privateEndpointConnections.properties
- privateEndpointConnections.properties.privateEndpoint
- privateEndpointConnections.properties.privateLinkServiceConnectionState
- privateEndpointConnections.properties.privateLinkServiceConnectionState.actionsRequired
- privateEndpointConnections.properties.privateLinkServiceConnectionState.description
- privateEndpointConnections.properties.privateLinkServiceConnectionState.status
- rootCertificate
- rootCertificate.enableRootCertificateV2
- routing.endpoints.cosmosDBSqlCollections
- routing.endpoints.collectionName
- routing.endpoints.databaseName
- routing.endpoints.partitionKeyName
- routing.endpoints.partitionKeyTemplate
- routing.endpoints.primaryKey
- routing.endpoints.secondaryKey
- routing.eventHubs
- serviceBusQueues
- entityPath
- serviceBusTopics
Removed:
- disableDeviceSAS
- disableLocalAuth
- disableModuleSAS
- enableDataResidency
- enableFileUploadNotifications
- properties.privateEndpoint
- properties.privateLinkServiceConnectionState
- properties.privateLinkServiceConnectionState.actionsRequired
- properties.privateLinkServiceConnectionState.description
- properties.privateLinkServiceConnectionState.status
- routing.endpoints.eventHubs
- routing.endpoints.eventHubs.authenticationType
- routing.endpoints.eventHubs.connectionString
- routing.endpoints.eventHubs.endpointUri
- routing.endpoints.eventHubs.entityPath
- routing.endpoints.eventHubs.id
- routing.endpoints.eventHubs.identity
- routing.endpoints.eventHubs.identity.userAssignedIdentity
- routing.endpoints.eventHubs.name
- routing.endpoints.eventHubs.resourceGroup
- routing.endpoints.eventHubs.subscriptionId
- routing.endpoints.serviceBusQueues
- routing.endpoints.connectionString
- routing.endpoints.entityPath
- routing.serviceBusTopics
Updated:
- properties.routing.fallbackRoute.source - Added values: 'DigitalTwinChangeEvents' 'MqttBrokerMessages'
- properties.routing.routes.source - Added values: 'DigitalTwinChangeEvents' 'MqttBrokerMessages'
- sku.apiVersion - Added values: '2022-04-30-preview' - Removed values: '2021-07-02'
- properties.routing.endpoints.endpointUri changed to required.
2021-07-02
Added:
- disableDeviceSAS
- disableLocalAuth
- disableModuleSAS
- enableDataResidency
- enableFileUploadNotifications
Removed:
- deviceStreams
- deviceStreams.streamingEndpoints
- deviceStreams.disableDeviceSAS
- deviceStreams.disableLocalAuth
- deviceStreams.disableModuleSAS
- deviceStreams.enableDataResidency
- deviceStreams.enableFileUploadNotifications
- deviceStreams.encryption
- deviceStreams.encryption.keySource
- deviceStreams.encryption.keyVaultProperties
- deviceStreams.encryption.identity
- deviceStreams.encryption.identity.userAssignedIdentity
- deviceStreams.encryption.keyIdentifier
Updated:
- properties.routing.fallbackRoute.source - Removed values: 'DigitalTwinChangeEvents' 'MqttBrokerMessages'
- properties.routing.routes.source - Removed values: 'DigitalTwinChangeEvents' 'MqttBrokerMessages'
- sku.apiVersion - Added values: '2021-07-02' - Removed values: '2021-07-02-preview'
2021-07-02-preview
Added:
- deviceStreams
- deviceStreams.streamingEndpoints
- deviceStreams.disableDeviceSAS
- deviceStreams.disableLocalAuth
- deviceStreams.disableModuleSAS
- deviceStreams.enableDataResidency
- deviceStreams.enableFileUploadNotifications
- deviceStreams.encryption
- deviceStreams.encryption.keySource
- deviceStreams.encryption.keyVaultProperties
- deviceStreams.encryption.identity
- deviceStreams.encryption.identity.userAssignedIdentity
- deviceStreams.encryption.keyIdentifier
Removed:
- disableDeviceSAS
- disableLocalAuth
- disableModuleSAS
- enableFileUploadNotifications
Updated:
- properties.routing.fallbackRoute.source - Added values: 'DigitalTwinChangeEvents' 'MqttBrokerMessages'
- properties.routing.routes.source - Added values: 'DigitalTwinChangeEvents' 'MqttBrokerMessages'
- sku.apiVersion - Added values: '2021-07-02-preview' - Removed values: '2021-07-01'
2021-07-01
Added:
- disableDeviceSAS
- disableLocalAuth
- disableModuleSAS
- enableFileUploadNotifications
Removed:
- deviceStreams
- deviceStreams.streamingEndpoints
- deviceStreams.disableDeviceSAS
- deviceStreams.disableLocalAuth
- deviceStreams.disableModuleSAS
- deviceStreams.enableFileUploadNotifications
- deviceStreams.encryption
- deviceStreams.encryption.keySource
- deviceStreams.encryption.keyVaultProperties
- deviceStreams.encryption.identity
- deviceStreams.encryption.identity.userAssignedIdentity
- deviceStreams.encryption.keyIdentifier
Updated:
- properties.routing.fallbackRoute.source - Removed values: 'DigitalTwinChangeEvents' 'MqttBrokerMessages'
- properties.routing.routes.source - Removed values: 'DigitalTwinChangeEvents' 'MqttBrokerMessages'
- sku.apiVersion - Added values: '2021-07-01' - Removed values: '2021-07-01-preview'
2021-07-01-preview
Added:
- properties.allowedFqdnList
- properties.keyName
- properties.primaryKey
- properties.rights
- properties.secondaryKey
- cloudToDevice
- cloudToDevice.defaultTtlAsIso8601
- cloudToDevice.feedback
- cloudToDevice.feedback.lockDurationAsIso8601
- cloudToDevice.feedback.maxDeliveryCount
- cloudToDevice.feedback.ttlAsIso8601
- cloudToDevice.maxDeliveryCount
- comments
- deviceStreams
- deviceStreams.streamingEndpoints
- deviceStreams.disableDeviceSAS
- deviceStreams.disableLocalAuth
- deviceStreams.disableModuleSAS
- deviceStreams.enableFileUploadNotifications
- deviceStreams.encryption
- deviceStreams.encryption.keySource
- deviceStreams.encryption.keyVaultProperties
- deviceStreams.encryption.identity
- deviceStreams.encryption.identity.userAssignedIdentity
- deviceStreams.encryption.keyIdentifier
- eventHubEndpoints
- eventHubEndpoints.{customized property}
- eventHubEndpoints.partitionCount
- eventHubEndpoints.retentionTimeInDays
- networkRuleSets.ipRules.action
- networkRuleSets.ipRules.filterName
- networkRuleSets.ipRules.ipMask
- restrictOutboundNetworkAccess
- routing.endpoints.eventHubs.authenticationType
- routing.endpoints.eventHubs.connectionString
- routing.endpoints.eventHubs.endpointUri
- routing.endpoints.eventHubs.entityPath
- routing.endpoints.eventHubs.id
- routing.endpoints.eventHubs.identity
- routing.endpoints.eventHubs.identity.userAssignedIdentity
- routing.endpoints.eventHubs.name
- routing.endpoints.eventHubs.resourceGroup
- routing.endpoints.eventHubs.subscriptionId
- routing.endpoints.serviceBusQueues
- routing.serviceBusTopics
Removed:
- properties.authorizationPolicies.keyName
- properties.authorizationPolicies.primaryKey
- properties.authorizationPolicies.rights
- properties.authorizationPolicies.secondaryKey
- properties.cloudToDevice
- properties.cloudToDevice.defaultTtlAsIso8601
- properties.cloudToDevice.feedback
- properties.cloudToDevice.feedback.lockDurationAsIso8601
- properties.cloudToDevice.feedback.maxDeliveryCount
- properties.cloudToDevice.feedback.ttlAsIso8601
- properties.cloudToDevice.maxDeliveryCount
- properties.comments
- properties.enableFileUploadNotifications
- properties.eventHubEndpoints
- properties.eventHubEndpoints.{customized property}
- properties.eventHubEndpoints.partitionCount
- properties.eventHubEndpoints.retentionTimeInDays
- networkRuleSets.action
- networkRuleSets.filterName
- networkRuleSets.ipMask
- routing.serviceBusQueues
- serviceBusTopics
- entityPath
Updated:
- properties.routing.fallbackRoute.source - Added values: 'DigitalTwinChangeEvents' 'MqttBrokerMessages'
- properties.routing.routes.source - Added values: 'DigitalTwinChangeEvents' 'MqttBrokerMessages'
- sku.apiVersion - Added values: '2021-07-01-preview' - Removed values: '2021-03-31'
2021-03-31
Added:
- properties.eventHubEndpoints
- properties.eventHubEndpoints.{customized property}
- properties.eventHubEndpoints.partitionCount
- properties.eventHubEndpoints.retentionTimeInDays
- action
- filterName
- ipMask
- networkRuleSets.action
- networkRuleSets.filterName
- networkRuleSets.ipMask
Removed:
- properties.deviceStreams
- properties.deviceStreams.streamingEndpoints
- properties.encryption
- properties.encryption.keySource
- properties.encryption.keyVaultProperties
- properties.encryption.identity
- properties.encryption.identity.userAssignedIdentity
- properties.encryption.keyIdentifier
- eventHubEndpoints
- eventHubEndpoints.{customized property}
- eventHubEndpoints.partitionCount
- eventHubEndpoints.retentionTimeInDays
- ipFilterRules.action
- ipFilterRules.filterName
- ipFilterRules.ipMask
- networkRuleSets.ipRules.action
- networkRuleSets.ipRules.filterName
- networkRuleSets.ipRules.ipMask
Updated:
- properties.routing.fallbackRoute.source - Removed values: 'DigitalTwinChangeEvents'
- properties.routing.routes.source - Removed values: 'DigitalTwinChangeEvents'
- sku.apiVersion - Added values: '2021-03-31' - Removed values: '2021-03-03-preview'
2021-03-03-preview
Added:
- routing.endpoints.identity
- routing.endpoints.identity.userAssignedIdentity
- routing.identity
- routing.identity.userAssignedIdentity
- identity.userAssignedIdentity
- storageEndpoints.identity
- storageEndpoints.identity.userAssignedIdentity
Updated:
- sku.apiVersion - Added values: '2021-03-03-preview' - Removed values: '2021-02-01-preview'
2021-02-01-preview
Oldest version tracked in change log
Feedback
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: https://aka.ms/ContentUserFeedback.
Submit and view feedback for