Add `azurerm_cosmosdb_fleet` resource by v-yhyeo0202 · Pull Request #31546 · hashicorp/terraform-provider-azurerm

v-yhyeo0202 · 2026-01-21T00:18:01Z

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

azurerm_cosmosdb_fleet resource is added in this PR. The related sources are listed below:

Azure REST API specification
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/fleet.json

Documentation
https://learn.microsoft.com/en-us/azure/cosmos-db/fleet

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)

https://hashicorp.teamcity.com/buildConfiguration/TF_AzureRM_AZURERM_SERVICE_PUBLIC_COSMOS/652361?buildTab=overview

Change Log

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

azurerm_cosmosdb_fleet - add resource

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 #31243

Rollback Plan

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

Note

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

saikrishna397 · 2026-03-25T18:46:36Z

@v-yhyeo0202 Thanks for working on this. When do you expect this to be merged?

v-yhyeo0202 · 2026-03-26T00:52:05Z

@saikrishna397 due to the large number of PRs and shortage of reviewers, I cannot be sure when will this PR be merged. Meanwhile you may try to use azapi_resource to create the resource. Let me know if you face any issues when applying the workaround.

sesmyrnov · 2026-04-16T13:44:10Z

Hello @v-yhyeo0202 and @gerrytan. I want to check how the review of this PR going and if you have any updates on ETA on when it will be merged as I see it was requested for review 3 weeks ago?
( we have several Azure Cosmos DB customers inquiring on the supportability of Fleet feature and not ready to commit to use azapi workaround.)

herquan-docusign · 2026-04-20T20:50:45Z

+)
+
+func FleetName(v interface{}, k string) (warnings []string, errors []error) {
+	name := v.(string)


Put the link as a comment, so other people will know where those restrictions are from.

gerrytan

Thanks @v-yhyeo0202, I left comments on few area of concerns.

Also I note that there are child / releated resources that have to be implemented in a separate PR:

gerrytan · 2026-04-21T01:01:11Z

+
+resource "azurerm_cosmosdb_fleet" "example" {
+  name                = "fleet-test"
+  resource_group_name = "azurerm_resource_group.example.name"


Wrong RG name syntax. Remove the quote.

Suggested change

resource_group_name = "azurerm_resource_group.example.name"

resource_group_name = azurerm_resource_group.example.name

Same problem with location below

Thanks @gerrytan for the review. The issue is fixed accordingly. Let me know if I have to work on the related resources.

gerrytan · 2026-04-21T01:26:16Z

+
+The following arguments are supported:
+
+* `location` - (Required) The Azure Region where the Cosmos DB Fleets should exist. Changing this forces new Cosmos DB Fleets to be created.


Please follow the ordering described in reference-documentation-standards.md, part of id (name and resource_group_name) has to be ordered at the top. Please apply this to the schema arguments and other parts of the code too.

gerrytan · 2026-04-21T01:28:36Z

+layout: "azurerm"
+page_title: "Azure Resource Manager: azurerm_cosmosdb_fleet"
+description: |-
+  Manages a Cosmos DB Fleets.


Use singular Fleet instead of plural Fleets. Please change other places too.

gerrytan · 2026-04-21T01:29:54Z

+}
+
+func (CosmosDbFleetResource) ModelObject() interface{} {
+	return &CosmosDbFleetResource{}


This should return the Model, not the resource. Please have a look at the example in guide-new-resource.md

gerrytan · 2026-04-21T01:44:36Z

+		"tags": {
+			Type:     schema.TypeMap,
+			Optional: true,
+			// `ForceNew` behavior is added as `tags` property is absent in update model


The "Create" SDK method uses PUT HTTP method, can you please check if we can use this for update?

By applying a typical Update method and test which involves only change in Tags property, an error occurs mentioning that it is unable to create a resource with same ID. Following are the REST API request and response.

Request body before update

{ "location": "southeastasia", "tags": null }

Request body during update

{ "id": "/subscriptions/REDACTED/resourceGroups/REDACTED/providers/Microsoft.DocumentDB/fleets/REDACTED", "location": "Southeast Asia", "name": "REDACTED", "properties": { "provisioningState": "Succeeded" }, "tags": { "env": "test" }, "type": "Microsoft.DocumentDB/fleets" }

Error from response body during update

{ "code": "BadRequest", "message": "Exception occurred trying to create Fleet with Name: REDACTED and SubscriptionID: REDACTED, Message: Entity with the specified id already exists in the system.\r\nActivityId: REDACTED, Microsoft.Azure.Documents.Common/2.14.0, Microsoft.Azure.Documents.Common/2.14.0" }

Update FleetPool use PATCH - see details here: https://learn.microsoft.com/en-us/rest/api/cosmos-db-resource-provider/fleet/update?view=rest-cosmos-db-resource-provider-2025-10-15&tabs=HTTP

But that is not useful @sesmyrnov , the only updatable property (tags) is not supported by that PATCH API.

gerrytan · 2026-04-21T01:52:42Z


 func (r Registration) Resources() []sdk.Resource {
 	return []sdk.Resource{
+		CosmosDbFleetResource{},


This has to be sorted alphabetically. Please run azurerm-linter and check violations.

v-yhyeo0202 · 2026-04-21T05:27:23Z

Latest test results
https://hashicorp.teamcity.com/buildConfiguration/TF_AzureRM_AZURERM_SERVICE_PUBLIC_COSMOS/652361?buildTab=overview

gerrytan

Thank you @v-yhyeo0202 this PR looks good to me.

Thanks for addressing all the feedbacks and rerunning the acctests.

Please do not close the linked issue yet and do the (child / related?) resources as a follow up work in a separate PR (1 resource per PR). This resource is only a container and not useful by itself.

I assume we also need azurerm_cosmosdb_fleet_space and azurerm_cosmosdb_fleet_database_account as a minimum. @sesmyrnov can you help confirm this for us?

Add azurerm_cosmosdb_fleets resource

3191b8e

github-actions Bot added documentation dependencies service/cosmosdb size/XL waiting-response labels Jan 21, 2026

Run make fmt and make terrafmt

3bf3db1

github-actions Bot added waiting-response and removed waiting-response labels Jan 21, 2026

azurerm_cosmosdb_fleets - fix document

f3e96a7

github-actions Bot added waiting-response and removed waiting-response labels Jan 21, 2026

azurerm_cosmosdb_fleets - fix documentation

4299628

github-actions Bot added waiting-response and removed waiting-response labels Jan 21, 2026

rcskosir added the new-resource label Jan 21, 2026

azurerm_cosmosdb_fleets - fix with azurerm-linter

034e586

github-actions Bot added waiting-response and removed waiting-response labels Jan 22, 2026

azurerm_cosmosdb_fleet - fix resource name

99bb218

github-actions Bot added waiting-response service/storage service/network and removed waiting-response labels Feb 10, 2026

v-yhyeo0202 force-pushed the add-cosmosdb-fleets branch from 703523b to 99bb218 Compare February 10, 2026 02:51

github-actions Bot removed the waiting-response label Feb 10, 2026

azurerm_cosmosdb_fleet - run make document-fix

9f37cb0

github-actions Bot added the waiting-response label Feb 10, 2026

v-yhyeo0202 changed the title ~~Add azurerm_cosmosdb_fleets resource~~ Add azurerm_cosmosdb_fleet resource Feb 10, 2026

azurerm_cosmosdb_fleet - minor fix

46fef7c

github-actions Bot removed the waiting-response label Feb 10, 2026

v-yhyeo0202 requested a review from gerrytan March 26, 2026 00:49

Merge branch 'main' into add-cosmosdb-fleets

4de3868

github-actions Bot added the waiting-response label Apr 8, 2026

Run make fmt

0fce9e4

github-actions Bot removed the waiting-response label Apr 8, 2026

herquan-docusign reviewed Apr 20, 2026

View reviewed changes

github-actions Bot added the waiting-response label Apr 20, 2026

azurerm_cosmosdb_fleet - fix according to review comments

7d57ab9

github-actions Bot removed the waiting-response label Apr 21, 2026

v-yhyeo0202 requested a review from teowa April 21, 2026 00:20

gerrytan suggested changes Apr 21, 2026

View reviewed changes

github-actions Bot assigned gerrytan Apr 21, 2026

github-actions Bot added the waiting-response label Apr 21, 2026

azurerm_cosmosdb_fleet - fix according to review comments

f72f330

github-actions Bot removed the waiting-response label Apr 21, 2026

v-yhyeo0202 requested a review from gerrytan April 21, 2026 06:05

github-actions Bot added the waiting-response label Apr 22, 2026

gerrytan approved these changes Apr 22, 2026

View reviewed changes

This comment has been minimized.

Sign in to view

Merge branch 'main' into add-cosmosdb-fleets

c38d77b

github-actions Bot removed the waiting-response label Apr 22, 2026

	resource_group_name = "azurerm_resource_group.example.name"
	resource_group_name = azurerm_resource_group.example.name


		The following arguments are supported:

		* `location` - (Required) The Azure Region where the Cosmos DB Fleets should exist. Changing this forces new Cosmos DB Fleets to be created.

Conversation

v-yhyeo0202 commented Jan 21, 2026 • 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)

Rollback Plan

Uh oh!

saikrishna397 commented Mar 25, 2026

Uh oh!

v-yhyeo0202 commented Mar 26, 2026

Uh oh!

sesmyrnov commented Apr 16, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gerrytan 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!

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!

v-yhyeo0202 commented Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gerrytan left a comment • 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!

This comment has been minimized.

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

v-yhyeo0202 commented Jan 21, 2026 •

edited

Loading

v-yhyeo0202 commented Apr 21, 2026 •

edited

Loading

gerrytan left a comment •

edited

Loading