`azurerm_mongo_cluster` - support for new properties `customer_managed_key`, `data_api_mode_enabled`, `identity`, `restore`, `auth_config_allowed_modes` and `storage_type` by neil-yechenwei · Pull Request #31100 · hashicorp/terraform-provider-azurerm

neil-yechenwei · 2025-11-14T04:11:27Z

Community Note

Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

Service team reached out to us to support new features in the new API version 2025-09-01 for Mongo Cluster.

PR Checklist

I have followed the guidelines in our Contributing Documentation.
I have checked to ensure there aren't other open Pull Requests for the same update/change.
I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
I have written new tests for my resource or datasource changes & updated any relevant documentation.
I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
(For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

--- PASS: TestAccMongoClusterFreeTier/freeTier/basic (842.46s)
--- PASS: TestAccMongoClusterFreeTier/freeTier/update (2300.17s)
--- PASS: TestAccMongoClusterFreeTier/freeTier/import (780.58s)
--- PASS: TestAccMongoCluster_previewFeature (2518.00s)
--- PASS: TestAccMongoCluster_geoReplica (2393.81s)
--- PASS: TestAccMongoCluster_pointInTimeRestore (2570.64s)
--- PASS: TestAccMongoCluster_customerManagedKey (1055.90s)

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

azurerm_mongo_cluster - support for new properties customer_managed_key, data_api_mode_enabled, identity, restore, auth_config_allowed_modes and storage_type

This is a (please select all that apply):

Bug Fix
New Feature (ie adding a service, resource, or data source)
Enhancement
Breaking Change

Related Issue(s)

Fixes #30255

AI Assistance Disclosure

AI Assisted - This contribution was made by, or with the assistance of, AI/LLMs

Rollback Plan

If a change needs to be reverted, we will publish an updated version of the provider.

Changes to Security Controls

Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

teowa

Hi @neil-yechenwei , thank you for the PR. I have added some comments.

teowa · 2025-11-14T05:36:10Z

internal/services/mongocluster/mongo_cluster_resource.go

 			if metadata.ResourceData.HasChange("storage_size_in_gb") {
 				payload.Properties.Storage = &mongoclusters.StorageProperties{
 					SizeGb: pointer.To(state.StorageSizeInGb),
+					Type:   pointer.To(mongoclusters.StorageType(state.StorageType)),


pointer.ToEnum is preferred when working with enums.

Suggested change

Type: pointer.To(mongoclusters.StorageType(state.StorageType)),

Type: pointer.ToEnum[mongoclusters.StorageType](state.StorageType),

teowa · 2025-11-14T05:41:56Z

internal/services/mongocluster/mongo_cluster_resource.go


 					if v := props.Storage; v != nil {
 						state.StorageSizeInGb = pointer.From(v.SizeGb)
+						state.StorageType = string(pointer.From(v.Type))


Suggested change

state.StorageType = string(pointer.From(v.Type))

state.StorageType = pointer.FromEnum(v.Type)

teowa · 2025-11-14T05:53:18Z

internal/services/mongocluster/mongo_cluster_resource_test.go

+    point_in_time_utc = timeadd(timestamp(), "-1s")
+  }
+
+  // As "point_in_time_utc" is retrieved dynamically, so it would cause diff when tf plan. So we have to ignore it here.


This can be solved with time_static resource, here is an example

terraform-provider-azurerm/internal/services/authorization/pim_active_role_assignment_resource_test.go

Line 274 in acba5de

resource "time_static" "test" {}

teowa · 2025-11-14T06:09:15Z

website/docs/r/mongo_cluster.html.markdown

@@ -99,10 +113,36 @@ The following arguments are supported:

 * `storage_size_in_gb` - (Optional) The size of the data disk space for the MongoDB Cluster.

+* `storage_type` - (Optional) The type of the storage type for the MongoDB Cluster. Possible values are `PremiumSSD` and `PremiumSSDv2`. Defaults to `PremiumSSD`. Changing this forces a new resource to be created.


Suggested change

* `storage_type` - (Optional) The type of the storage type for the MongoDB Cluster. Possible values are `PremiumSSD` and `PremiumSSDv2`. Defaults to `PremiumSSD`. Changing this forces a new resource to be created.

* `storage_type` - (Optional) The storage type for the MongoDB Cluster. Possible values are `PremiumSSD` and `PremiumSSDv2`. Defaults to `PremiumSSD`. Changing this forces a new resource to be created.

teowa · 2025-11-17T03:58:10Z

Hi @neil-yechenwei , LGTM!

WodansSon

Hi @neil-yechenwei, thanks for the PR! I reviewed the code and found a number of things to address - documented everything below.

Status: Changes Requested

Next Steps:

Please go through my comments and make those updates
Push your changes when ready
Reply here for re-review

Thanks! Reach out if you have any questions. 🚀

WodansSon · 2025-11-20T06:51:11Z

internal/services/mongocluster/mongo_cluster_resource.go

+			// Update it separately if user wants it enabled
+			if state.CreateMode == string(mongoclusters.CreateModeDefault) {
+				parameter.Properties.DataApi = &mongoclusters.DataApiProperties{
+					Mode: pointer.To(mongoclusters.DataApiModeDisabled),


Missing use of pointer.ToEnum for enum values.

Suggested change

Mode: pointer.To(mongoclusters.DataApiModeDisabled),

Mode: pointer.ToEnum[mongoclusters.DataApiMode](mongoclusters.DataApiModeDisabled),

mongoclusters.DataApiModeDisabled is not string. So we aren't able to use pointer.ToEnum.

WodansSon · 2025-11-20T07:04:00Z

internal/services/mongocluster/mongo_cluster_resource.go

+				if err != nil {
+					return err
+				}


We should add consistent error handling per the contributor guidelines:

Suggested change

if err != nil {

return err

}

if err != nil {

fmt.Errorf("flattening identity: %+v", err)

}

Reference: reference-errors

WodansSon · 2025-11-20T07:07:29Z

internal/services/mongocluster/mongo_cluster_resource.go


 					if v := props.Storage; v != nil {
 						state.StorageSizeInGb = pointer.From(v.SizeGb)
+						state.StorageType = pointer.FromEnum(v.Type)


Can we update the usage of pointer.ToEnum for enum values here:

Suggested change

state.StorageType = pointer.FromEnum(v.Type)

state.StorageType = pointer.ToEnum[mongoclusters.StorageType](v.Type)

Nope. "v.Type" is not string.

WodansSon · 2025-11-20T07:18:41Z

internal/services/mongocluster/mongo_cluster_resource.go

+	return &identity.LegacySystemAndUserAssignedMap{
+		Type:        identityObj.Type,
+		IdentityIds: identityIds,
+	}


Missing usage of pointer.ToEnum for enum values.

Suggested change

return &identity.LegacySystemAndUserAssignedMap{

Type: identityObj.Type,

IdentityIds: identityIds,

}

return &identity.LegacySystemAndUserAssignedMap{

Type: pointer.ToEnum[identity.Type](identityObj.Type),

IdentityIds: identityIds,

}

Nope. identityObj.Type is not string.

WodansSon · 2025-11-20T07:22:24Z

website/docs/r/mongo_cluster.html.markdown

 * `administrator_username` - (Optional) The administrator username of the MongoDB Cluster. Changing this forces a new resource to be created.

-* `create_mode` - (Optional) The creation mode for the MongoDB Cluster. Possibles values are `Default` and `GeoReplica`. Defaults to `Default`. Changing this forces a new resource to be created.
+* `create_mode` - (Optional) The creation mode for the MongoDB Cluster. Possibles values are `Default`, `GeoReplica` and `PointInTimeRestore`. Defaults to `Default`. Changing this forces a new resource to be created.


Typo in documentation: Possibles values should be Possible values. This should also be corrected for the high_availability_mode, public_network_access and version fields as well, while I know that wasn't your contribution since we are in the code we should fix those up too.

Suggested change

* `create_mode` - (Optional) The creation mode for the MongoDB Cluster. Possibles values are `Default`, `GeoReplica` and `PointInTimeRestore`. Defaults to `Default`. Changing this forces a new resource to be created.

* `create_mode` - (Optional) The creation mode for the MongoDB Cluster. Possible values are `Default`, `GeoReplica` and `PointInTimeRestore`. Defaults to `Default`. Changing this forces a new resource to be created.

WodansSon · 2025-11-20T07:38:42Z

website/docs/r/mongo_cluster.html.markdown

+
+* `type` - (Required) The type of managed identity to assign. Possible value is `UserAssigned`.
+
+* `identity_ids` - (Optional) - A list of one or more Resource IDs for User Assigned Managed identities to assign. Required when `type` is set to `UserAssigned`.


Suggested change

* `identity_ids` - (Optional) - A list of one or more Resource IDs for User Assigned Managed identities to assign. Required when `type` is set to `UserAssigned`.

* `identity_ids` - (Optional) - A list of one or more Resource IDs for User Assigned Managed identities to assign.

-> **Note:** Required when `type` is set to `UserAssigned`.

~> **Note:** Modifying the `identity_ids` field will trigger a resource recreation.

WodansSon

This is a pre-existing issue that wasn't your fault, but since we are touching this code we should fix up the Arguments Reference order as well. I don't know why this didn't show up in my previous review, sorry.

Status: Changes Requested

Next Steps:

Please go through my comments and make those updates
Push your changes when ready
Reply here for re-review

Thanks! Reach out if you have any questions.

WodansSon · 2025-11-20T07:56:05Z

website/docs/r/mongo_cluster.html.markdown

 * `tags` - (Optional) A mapping of tags to assign to the MongoDB Cluster.

 * `version` - (Optional) The version for the MongoDB Cluster. Possibles values are `5.0`, `6.0`, `7.0` and `8.0`.


The tags field should always appear at the bottom of the Arguments Reference:

Suggested change

* `tags` - (Optional) A mapping of tags to assign to the MongoDB Cluster.

* `version` - (Optional) The version for the MongoDB Cluster. Possibles values are `5.0`, `6.0`, `7.0` and `8.0`.

* `version` - (Optional) The version for the MongoDB Cluster. Possible values are `5.0`, `6.0`, `7.0` and `8.0`.

* `tags` - (Optional) A mapping of tags to assign to the MongoDB Cluster.

WodansSon · 2025-11-20T08:10:30Z

internal/services/mongocluster/mongo_cluster_resource.go

+			Optional: true,
+			Computed: true,


Missing required O+C comment between Optional and Computed properties. Add a comment explaining why this property is Optional+Computed.

Reference: Best Practices

neil-yechenwei · 2025-11-21T06:01:35Z

@WodansSon , thanks for the comments. I updated PR. Please take another look. Below is the latest test result.

--- PASS: TestAccMongoClusterFreeTier/freeTier/basic (804.96s)
--- PASS: TestAccMongoClusterFreeTier/freeTier/update (3013.06s)
--- PASS: TestAccMongoClusterFreeTier/freeTier/import (803.84s)
--- PASS: TestAccMongoCluster_dataApiModeEnabled (977.75s)
--- PASS: TestAccMongoCluster_customerManagedKey (1154.42s)
--- PASS: TestAccMongoCluster_pointInTimeRestore (2553.17s)
--- PASS: TestAccMongoCluster_previewFeature (2449.76s)
--- PASS: TestAccMongoCluster_geoReplica (2370.44s)

WodansSon

@neil-yechenwei, thank you for pushing those changes, this LGTM now. I have kicked off the TC tests, if those pass, I think this is good to merge. Thank you for all of your hard work getting this fixed up and ready to go! 🚀

WodansSon · 2025-11-26T06:45:02Z

github-actions · 2025-12-27T02:26:28Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

“neil-yechenwei” and others added 18 commits November 5, 2025 14:29

azurerm_mongo_cluster - support for new properties

78ea886

support new property identity

d1581cd

update the logic of identity

618b0b1

support new property cmk

387c224

support new property restoreParameters

3140ff7

merge latest change

adfdb97

support new property dataapi.mode

8de2719

support new property dataapi

7ad28bf

support new property authConfig

4081712

update the logic of identity

2bba621

update the logic of identity

838ba08

update the logic of dataapi

89742c4

support new property storage.type

fe4632a

update the logic of dataapi

2664d13

update the logic of storage.type

ab3ab2c

update the logic of restoreParameters

094b4e5

update compute_tier

9f85824

adjust the parameters in test case

a192120

neil-yechenwei requested review from a team, WodansSon and magodo as code owners November 14, 2025 04:11

neil-yechenwei marked this pull request as draft November 14, 2025 04:11

github-actions bot added documentation service/mongo-cluster size/XL enhancement waiting-response labels Nov 14, 2025

format file

1f358e4

github-actions bot removed the waiting-response label Nov 14, 2025

teowa reviewed Nov 14, 2025

View reviewed changes

neil-yechenwei requested a review from teowa November 17, 2025 02:31

teowa mentioned this pull request Nov 17, 2025

azurerm_mongo_cluster - add customer_managed_key and identity #31106

Closed

15 tasks

add tc for dataapi

1005515

mybayern1974 assigned WodansSon Nov 20, 2025

WodansSon requested changes Nov 20, 2025

View reviewed changes

WodansSon reviewed Nov 20, 2025

View reviewed changes

“neil-yechenwei” added 3 commits November 21, 2025 08:52

update per comments

513372c

add comment for o+c

593458f

merge latest change

4ab0d9a

github-actions bot added the waiting-response label Nov 21, 2025

update comment for o+c

c5a93f7

github-actions bot added waiting-response and removed waiting-response labels Nov 21, 2025

update the identity logic

2109525

github-actions bot added waiting-response and removed waiting-response labels Nov 21, 2025

update the logic of identity

6c1b64b

github-actions bot removed the waiting-response label Nov 21, 2025

neil-yechenwei requested a review from WodansSon November 21, 2025 06:59

neil-yechenwei marked this pull request as ready for review November 25, 2025 09:14

WodansSon approved these changes Nov 25, 2025

View reviewed changes

mybayern1974 unassigned WodansSon Nov 26, 2025

WodansSon merged commit 005c449 into hashicorp:main Nov 26, 2025
33 checks passed

github-actions bot added this to the v4.55.0 milestone Nov 26, 2025

github-actions bot locked as resolved and limited conversation to collaborators Dec 27, 2025

	Type: pointer.To(mongoclusters.StorageType(state.StorageType)),
	Type: pointer.ToEnum[mongoclusters.StorageType](state.StorageType),

	state.StorageType = string(pointer.From(v.Type))
	state.StorageType = pointer.FromEnum(v.Type)

		@@ -99,10 +113,36 @@ The following arguments are supported:

		* `storage_size_in_gb` - (Optional) The size of the data disk space for the MongoDB Cluster.

		* `storage_type` - (Optional) The type of the storage type for the MongoDB Cluster. Possible values are `PremiumSSD` and `PremiumSSDv2`. Defaults to `PremiumSSD`. Changing this forces a new resource to be created.

	* `storage_type` - (Optional) The type of the storage type for the MongoDB Cluster. Possible values are `PremiumSSD` and `PremiumSSDv2`. Defaults to `PremiumSSD`. Changing this forces a new resource to be created.
	* `storage_type` - (Optional) The storage type for the MongoDB Cluster. Possible values are `PremiumSSD` and `PremiumSSDv2`. Defaults to `PremiumSSD`. Changing this forces a new resource to be created.

	Mode: pointer.To(mongoclusters.DataApiModeDisabled),
	Mode: pointer.ToEnum[mongoclusters.DataApiMode](mongoclusters.DataApiModeDisabled),

	state.StorageType = pointer.FromEnum(v.Type)
	state.StorageType = pointer.ToEnum[mongoclusters.StorageType](v.Type)

	* `create_mode` - (Optional) The creation mode for the MongoDB Cluster. Possibles values are `Default`, `GeoReplica` and `PointInTimeRestore`. Defaults to `Default`. Changing this forces a new resource to be created.
	* `create_mode` - (Optional) The creation mode for the MongoDB Cluster. Possible values are `Default`, `GeoReplica` and `PointInTimeRestore`. Defaults to `Default`. Changing this forces a new resource to be created.


		* `type` - (Required) The type of managed identity to assign. Possible value is `UserAssigned`.

		* `identity_ids` - (Optional) - A list of one or more Resource IDs for User Assigned Managed identities to assign. Required when `type` is set to `UserAssigned`.

		* `tags` - (Optional) A mapping of tags to assign to the MongoDB Cluster.

		* `version` - (Optional) The version for the MongoDB Cluster. Possibles values are `5.0`, `6.0`, `7.0` and `8.0`.

Conversation

neil-yechenwei commented Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Community Note

Description

PR Checklist

Changes to existing Resource / Data Source

Testing

Change Log

Related Issue(s)

AI Assistance Disclosure

Rollback Plan

Changes to Security Controls

Uh oh!

teowa left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

teowa commented Nov 17, 2025

Uh oh!

WodansSon left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neil-yechenwei Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WodansSon Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WodansSon Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WodansSon left a comment

Choose a reason for hiding this comment

Uh oh!

WodansSon Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

neil-yechenwei commented Nov 14, 2025 •

edited

Loading

neil-yechenwei Nov 21, 2025 •

edited

Loading

WodansSon Nov 20, 2025 •

edited

Loading

WodansSon Nov 20, 2025 •

edited

Loading

WodansSon Nov 20, 2025 •

edited

Loading

neil-yechenwei commented Nov 21, 2025 •

edited

Loading