API version change log for deployment of Microsoft.DocumentDB/databaseAccounts
This article describes the properties that changed in each API version for Microsoft.DocumentDB/databaseAccounts. It only covers properties that are available during deployments.
2024-02-15-preview
Added:
- defaultPriorityLevel
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
- enableMaterializedViews
- enablePerRegionPerPartitionAutoscale
- enablePriorityBasedExecution
- restoreWithTtlDisabled
- sourceBackupLocation
Updated:
- identity.userAssignedIdentities.createMode - Added values: 'PointInTimeRestore'
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2024-02-15-preview' - Removed values: '2023-11-15'
- identity.createMode - Added values: 'PointInTimeRestore'
2023-11-15
Removed:
- defaultPriorityLevel
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
- enableMaterializedViews
- enablePriorityBasedExecution
- sourceBackupLocation
Updated:
- identity.userAssignedIdentities.createMode - Removed values: 'PointInTimeRestore'
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2023-11-15' - Removed values: '2023-11-15-preview'
- identity.createMode - Removed values: 'PointInTimeRestore'
2023-11-15-preview
Added:
- defaultPriorityLevel
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
- enableMaterializedViews
- enablePriorityBasedExecution
- sourceBackupLocation
Updated:
- identity.userAssignedIdentities.createMode - Added values: 'PointInTimeRestore'
- identity.userAssignedIdentities.customerManagedKeyStatus - Removed values: 'Access to the configured customer managed key confirmed.' 'Access to your account is currently revoked because the Azure Cosmos DB account has an undefined default identity; for more details about this error and how to restore access to your account please visit
https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#invalid-azure-cosmos-db-default-identity(4015).' 'Access to your account is currently revoked because the Azure Cosmos DB account's key vault key URI does not follow the expected format; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#improper-syntax-detected-on-the-key-vault-uri-property(4006).' 'Access to your account is currently revoked because the Azure Cosmos DB service is unable to obtain the AAD authentication token for the account's default identity; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-active-directory-token-acquisition-error(4000).' 'Access to your account is currently revoked because the Azure Cosmos DB service is unable to wrap or unwrap the key; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#internal-unwrapping-procedure-error(4005).' 'Access to your account is currently revoked because the Azure Key Vault DNS name specified by the account's keyvaultkeyuri property could not be resolved; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#unable-to-resolve-the-key-vaults-dns(4009).' 'Access to your account is currently revoked because the access rules are blocking outbound requests to the Azure Key Vault service; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide(4016).' 'Access to your account is currently revoked because the correspondent Azure Key Vault was not found; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found(4017).' 'Access to your account is currently revoked because the correspondent key is not found on the specified Key Vault; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found(4003).' 'Access to your account is currently revoked because the current default identity no longer has permission to the associated Key Vault key; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#default-identity-is-unauthorized-to-access-the-azure-key-vault-key(4002).' 'Access to your account is currently revoked; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide' - identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2023-11-15-preview' - Removed values: '2023-09-15'
- identity.createMode - Added values: 'PointInTimeRestore'
- identity.customerManagedKeyStatus - Removed values: 'Access to the configured customer managed key confirmed.' 'Access to your account is currently revoked because the Azure Cosmos DB account has an undefined default identity; for more details about this error and how to restore access to your account please visit
https://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#invalid-azure-cosmos-db-default-identity(4015).' 'Access to your account is currently revoked because the Azure Cosmos DB account's key vault key URI does not follow the expected format; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#improper-syntax-detected-on-the-key-vault-uri-property(4006).' 'Access to your account is currently revoked because the Azure Cosmos DB service is unable to obtain the AAD authentication token for the account's default identity; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-active-directory-token-acquisition-error(4000).' 'Access to your account is currently revoked because the Azure Cosmos DB service is unable to wrap or unwrap the key; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#internal-unwrapping-procedure-error(4005).' 'Access to your account is currently revoked because the Azure Key Vault DNS name specified by the account's keyvaultkeyuri property could not be resolved; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#unable-to-resolve-the-key-vaults-dns(4009).' 'Access to your account is currently revoked because the access rules are blocking outbound requests to the Azure Key Vault service; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide(4016).' 'Access to your account is currently revoked because the correspondent Azure Key Vault was not found; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found(4017).' 'Access to your account is currently revoked because the correspondent key is not found on the specified Key Vault; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#azure-key-vault-resource-not-found(4003).' 'Access to your account is currently revoked because the current default identity no longer has permission to the associated Key Vault key; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide#default-identity-is-unauthorized-to-access-the-azure-key-vault-key(4002).' 'Access to your account is currently revoked; for more details about this error and how to restore access to your account please visithttps://learn.microsoft.com/en-us/azure/cosmos-db/cmk-troubleshooting-guide'
2023-09-15
Removed:
- defaultPriorityLevel
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
- enableMaterializedViews
- enablePriorityBasedExecution
- sourceBackupLocation
Updated:
- identity.userAssignedIdentities.createMode - Removed values: 'PointInTimeRestore'
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2023-09-15' - Removed values: '2023-09-15-preview'
- identity.createMode - Removed values: 'PointInTimeRestore'
2023-09-15-preview
Added:
- customerManagedKeyStatus
- defaultPriorityLevel
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
- enableBurstCapacity
- enableMaterializedViews
- enablePriorityBasedExecution
- sourceBackupLocation
Updated:
- identity.userAssignedIdentities.createMode - Added values: 'PointInTimeRestore'
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2023-09-15-preview' - Removed values: '2023-04-15'
- identity.createMode - Added values: 'PointInTimeRestore'
2023-04-15
Added:
- properties.backupPolicy.continuousModeProperties
- properties.backupPolicy.continuousModeProperties.tier
Updated:
- identity.userAssignedIdentities.publicNetworkAccess - Added values: 'SecuredByPerimeter'
- identity.userAssignedIdentities.backupPolicy.type - Removed values: 'Periodic' (required)
- identity.userAssignedIdentities.backupPolicy.migrationState.type - Removed values: 'Periodic' (required)
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2023-04-15' - Removed values: '2023-03-15'
- identity.publicNetworkAccess - Added values: 'SecuredByPerimeter'
2023-03-15
Removed:
- properties.backupPolicy.continuousModeProperties
- properties.backupPolicy.continuousModeProperties.tier
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
- enableBurstCapacity
- enableMaterializedViews
- sourceBackupLocation
Updated:
- identity.userAssignedIdentities.createMode - Removed values: 'PointInTimeRestore'
- identity.userAssignedIdentities.backupPolicy.type - Added values: 'Periodic' (required)
- identity.userAssignedIdentities.backupPolicy.migrationState.type - Added values: 'Periodic' (required)
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2023-03-15' - Removed values: '2023-03-15-preview'
- identity.createMode - Removed values: 'PointInTimeRestore'
2023-03-15-preview
Updated:
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2023-03-15-preview' - Removed values: '2023-03-01-preview'
2023-03-01-preview
Added:
- properties.backupPolicy.continuousModeProperties
- properties.backupPolicy.continuousModeProperties.tier
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
- enableBurstCapacity
- enableMaterializedViews
- sourceBackupLocation
Updated:
- identity.userAssignedIdentities.createMode - Added values: 'PointInTimeRestore'
- identity.userAssignedIdentities.backupPolicy.type - Removed values: 'Periodic' (required)
- identity.userAssignedIdentities.backupPolicy.migrationState.type - Removed values: 'Periodic' (required)
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2023-03-01-preview' - Removed values: '2022-11-15'
- identity.createMode - Added values: 'PointInTimeRestore'
2022-11-15
Removed:
- properties.backupPolicy.continuousModeProperties
- properties.backupPolicy.continuousModeProperties.tier
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
- enableBurstCapacity
- enableMaterializedViews
- sourceBackupLocation
Updated:
- identity.userAssignedIdentities.backupPolicy.type - Added values: 'Periodic' (required)
- identity.userAssignedIdentities.backupPolicy.migrationState.type - Added values: 'Periodic' (required)
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2022-11-15' - Removed values: '2022-11-15-preview'
2022-11-15-preview
Added:
- properties.backupPolicy.continuousModeProperties
- properties.backupPolicy.continuousModeProperties.tier
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
- enableBurstCapacity
- enableMaterializedViews
- failoverPriority
- isZoneRedundant
- locationName
- minimalTlsVersion
- restoreParameters.collectionNames.databaseName
- restoreParameters.gremlinDatabasesToRestore
- restoreParameters.graphNames
- sourceBackupLocation
- tablesToRestore
Removed:
- locations.failoverPriority
- locations.isZoneRedundant
- locations.locationName
Updated:
- identity.userAssignedIdentities.backupPolicy.type - Removed values: 'Periodic' (required)
- identity.userAssignedIdentities.backupPolicy.migrationState.type - Removed values: 'Periodic' (required)
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2022-11-15-preview' - Removed values: '2022-08-15'
2022-08-15
Removed:
- properties.backupPolicy.continuousModeProperties
- properties.backupPolicy.continuousModeProperties.tier
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
- enableMaterializedViews
- restoreParameters.collectionNames.databaseName
- restoreParameters.gremlinDatabasesToRestore
- restoreParameters.graphNames
- tablesToRestore
Updated:
- identity.userAssignedIdentities.backupPolicy.type - Added values: 'Periodic' (required)
- identity.userAssignedIdentities.backupPolicy.migrationState.type - Added values: 'Periodic' (required)
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2022-08-15' - Removed values: '2022-08-15-preview'
2022-08-15-preview
Added:
- properties.backupPolicy.continuousModeProperties
- properties.backupPolicy.continuousModeProperties.tier
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
- enableMaterializedViews
- enablePartitionMerge
- restoreParameters.collectionNames.databaseName
- restoreParameters.gremlinDatabasesToRestore
- restoreParameters.graphNames
- tablesToRestore
Updated:
- identity.userAssignedIdentities.backupPolicy.type - Removed values: 'Periodic' (required)
- identity.userAssignedIdentities.backupPolicy.migrationState.type - Removed values: 'Periodic' (required)
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2022-08-15-preview' - Removed values: '2022-05-15'
2022-05-15
Added:
- ipAddressOrRange
- locations.failoverPriority
- locations.isZoneRedundant
- locations.locationName
Removed:
- properties.backupPolicy.continuousModeProperties
- properties.backupPolicy.continuousModeProperties.tier
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
- enableMaterializedViews
- ipRules.ipAddressOrRange
- keysMetadata
- keysMetadata.primaryMasterKey
- keysMetadata.primaryReadonlyMasterKey
- keysMetadata.secondaryMasterKey
- keysMetadata.secondaryReadonlyMasterKey
- failoverPriority
- isZoneRedundant
- locationName
- gremlinDatabasesToRestore
- databaseName
- graphNames
- tablesToRestore
Updated:
- identity.userAssignedIdentities.backupPolicy.type - Added values: 'Periodic' (required)
- identity.userAssignedIdentities.backupPolicy.migrationState.type - Added values: 'Periodic' (required)
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2022-05-15' - Removed values: '2022-05-15-preview'
2022-05-15-preview
Added:
- ipRules.ipAddressOrRange
- keysMetadata
- keysMetadata.primaryMasterKey
- keysMetadata.primaryReadonlyMasterKey
- keysMetadata.secondaryMasterKey
- keysMetadata.secondaryReadonlyMasterKey
- failoverPriority
- isZoneRedundant
- locationName
- gremlinDatabasesToRestore
- databaseName
- graphNames
Removed:
- ipAddressOrRange
- locations.failoverPriority
- locations.isZoneRedundant
- locations.locationName
- restoreParameters.collectionNames.databaseName
- restoreParameters.gremlinDatabasesToRestore
- restoreParameters.graphNames
Updated:
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2022-05-15-preview' - Removed values: '2022-02-15-preview'
2022-02-15-preview
Added:
- properties.backupPolicy.continuousModeProperties
- properties.backupPolicy.continuousModeProperties.tier
Updated:
- identity.userAssignedIdentities.apiProperties.serverVersion - Added values: '4.2'
- identity.userAssignedIdentities.backupPolicy.type - Removed values: 'Periodic' (required)
- identity.userAssignedIdentities.backupPolicy.migrationState.type - Removed values: 'Periodic' (required)
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2022-02-15-preview' - Removed values: '2021-11-15-preview'
2021-11-15-preview
Added:
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
- enableMaterializedViews
- restoreParameters.collectionNames.databaseName
- restoreParameters.gremlinDatabasesToRestore
- restoreParameters.graphNames
- tablesToRestore
Updated:
- identity.userAssignedIdentities.apiProperties.serverVersion - Removed values: '4.2'
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2021-11-15-preview' - Removed values: '2021-10-15'
2021-10-15
Removed:
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
Updated:
- identity.userAssignedIdentities.apiProperties.serverVersion - Added values: '4.2'
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2021-10-15' - Removed values: '2021-10-15-preview'
2021-10-15-preview
Added:
- properties.capacity
- properties.capacity.totalThroughputLimit
Updated:
- identity.userAssignedIdentities.createMode - Added values: 'Restore' - Removed values: 'Restore' (required)
- identity.userAssignedIdentities.createMode changed to not required.
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2021-10-15-preview' - Removed values: '2021-07-01-preview'
- identity.createMode - Added values: 'Restore' - Removed values: 'Restore' (required)
- identity.createMode changed to not required.
2021-07-01-preview
Added:
- properties.backupPolicy.periodicModeProperties.backupStorageRedundancy
- diagnosticLogSettings
- diagnosticLogSettings.enableFullTextQuery
Updated:
- identity.userAssignedIdentities.createMode - Added values: 'Restore' (required) - Removed values: 'Restore'
- identity.userAssignedIdentities.createMode changed to required.
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2021-07-01-preview' - Removed values: '2021-06-15'
- identity.createMode - Added values: 'Restore' (required) - Removed values: 'Restore'
- identity.createMode changed to required.
2021-06-15
Added:
- properties.backupPolicy.migrationState
- properties.backupPolicy.migrationState.startTime
- properties.backupPolicy.migrationState.status
- properties.backupPolicy.migrationState.targetType
- createMode
- disableLocalAuth
- locations.failoverPriority
- locations.isZoneRedundant
- locations.locationName
- restoreParameters
- restoreParameters.databasesToRestore
- restoreParameters.collectionNames
- restoreParameters.databaseName
- restoreMode
- restoreSource
- restoreTimestampInUtc
Removed:
- failoverPriority
- isZoneRedundant
- locationName
Updated:
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2021-06-15' - Removed values: '2021-05-15'
2021-05-15
Added:
- properties.analyticalStorageConfiguration
- properties.analyticalStorageConfiguration.schemaType
Updated:
- identity.userAssignedIdentities.virtualNetworkRules.apiVersion - Added values: '2021-05-15' - Removed values: '2021-04-15'
2021-04-15
Removed:
- properties.backupPolicy.periodicModeProperties.backupStorageRedundancy
- createMode
2021-04-01-preview
Added:
- properties.backupPolicy.periodicModeProperties.backupStorageRedundancy
- createMode
2021-03-15
Added:
- defaultIdentity
Removed:
- properties.backupPolicy.periodicModeProperties.backupStorageRedundancy
- createMode
2021-03-01-preview
Added:
- properties.backupPolicy.periodicModeProperties.backupStorageRedundancy
- createMode
2021-01-15
Added:
- identity
- identity.type
- identity.userAssignedIdentities
- identity.userAssignedIdentities.{customized property}
- networkAclBypass
- networkAclBypassResourceIds
- publicNetworkAccess
2020-09-01
Removed:
- identity
- identity.type
- identity.userAssignedIdentities
- identity.userAssignedIdentities.{customized property}
- properties.backupPolicy.periodicModeProperties.backupStorageRedundancy
- createMode
2020-06-01-preview
Added:
- identity
- identity.type
- identity.userAssignedIdentities
- identity.userAssignedIdentities.{customized property}
- properties.backupPolicy
- properties.backupPolicy.type
- properties.backupPolicy.periodicModeProperties
- properties.backupPolicy.periodicModeProperties.backupIntervalInMinutes
- properties.backupPolicy.periodicModeProperties.backupRetentionIntervalInHours
- properties.backupPolicy.periodicModeProperties.backupStorageRedundancy
- createMode
2020-04-01
Added:
- properties.apiProperties
- properties.apiProperties.serverVersion
- properties.cors
- properties.allowedHeaders
- properties.allowedMethods
- properties.allowedOrigins
- properties.exposedHeaders
- properties.maxAgeInSeconds
- databaseAccountOfferType
- disableKeyBasedMetadataWriteAccess
- enableAnalyticalStorage
- enableAutomaticFailover
- enableCassandraConnector
- enableFreeTier
- enableMultipleWriteLocations
- ipRules
- ipAddressOrRange
- isVirtualNetworkFilterEnabled
- keyVaultKeyUri
- locations
- failoverPriority
- isZoneRedundant
- locationName
Removed:
- properties.databaseAccountOfferType
- properties.disableKeyBasedMetadataWriteAccess
- properties.enableAutomaticFailover
- properties.enableCassandraConnector
- properties.enableMultipleWriteLocations
- properties.ipRangeFilter
- properties.isVirtualNetworkFilterEnabled
- properties.keyVaultKeyUri
- properties.locations
- properties.failoverPriority
- properties.isZoneRedundant
- properties.locationName
Updated:
- virtualNetworkRules.apiVersion - Added values: '2020-04-01' - Removed values: '2020-03-01'
2020-03-01
Updated:
- virtualNetworkRules.apiVersion - Added values: '2020-03-01' - Removed values: '2019-12-12'
2019-12-12
Added:
- properties.keyVaultKeyUri
Updated:
- virtualNetworkRules.apiVersion - Added values: '2019-12-12' - Removed values: '2019-08-01'
2019-08-01
Added:
- properties.disableKeyBasedMetadataWriteAccess
Updated:
- virtualNetworkRules.apiVersion - Added values: '2019-08-01' - Removed values: '2016-03-31'
2016-03-31
Updated:
- virtualNetworkRules.apiVersion - Added values: '2016-03-31' - Removed values: '2016-03-19'
2016-03-19
Updated:
- virtualNetworkRules.apiVersion - Added values: '2016-03-19' - Removed values: '2015-11-06'
2015-11-06
Updated:
- virtualNetworkRules.apiVersion - Added values: '2015-11-06' - Removed values: '2015-04-08'
2015-04-08
Updated:
- virtualNetworkRules.apiVersion - Added values: '2015-04-08' - Removed values: '2015-04-01'
2015-04-01
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