Data API enablement in Azure Cosmos DocumentDB vCore

Question

Data API enablement in Azure Cosmos DocumentDB vCore

Pete Cordova 0

I have attempted to enable the Data API feature for my Cosmos DB. It is accepted, I see the Data API change to ON but is greyed out, and the Status on Overview changes to Updating. This goes for about an hour then status changes to Ready. I check the Data API feature, and it is back but in the Off setting. The Activity log still shows my action in Accepted. Does not change to Failed. Any idea on this or where to look for more details on the task?

0 comments

1 answer

Your answer

Answer 1

Hi Pete,

The first thing I would check is whether this is an older/existing Azure DocumentDB vCore cluster.

The Data API is currently in preview and Microsoft documentation lists this limitation:

Data API works on newly created cluster.

So if the cluster was created before the Data API capability was available, the portal may accept the request, move the cluster to Updating, and then return to Ready with Data API still Off.

A few things to try/check:

Confirm whether this is a newly created cluster or an older cluster.

Check the setting from ARM/CLI instead of only the portal:

az resource show \
  --ids "/subscriptions/<subId>/resourceGroups/<rg>/providers/Microsoft.DocumentDB/mongoClusters/<clusterName>" \
  --api-version 2024-10-01-preview \
  --query "properties.dataApi"

Try enabling it through ARM/REST once, because it may return a clearer error than the portal.

Check Activity Log > Administrative events for the cluster update operation and capture the correlation ID, timestamp, and operation ID.

If the cluster is newly created and still reverts to Off, open a Microsoft support case, because that looks like a backend/service issue rather than a configuration issue.

Docs:

Data API for Azure DocumentDB: https://learn.microsoft.com/en-us/azure/documentdb/data-api

The key point is that the portal showing Accepted only means the update request was accepted by the control plane. It does not always mean the feature was successfully enabled. If it ends in Ready but Data API returns to Off, either the cluster is not eligible for the preview feature or Microsoft Support needs to check the backend operation.

Peram Venkateswara Reddy 5 Reputation points Microsoft External Staff Moderator

2026-08-06T06:55:13.48+00:00

Hi @Pete Cordova , Hope you are doing well. In addition to @Ravi Kiran Pagidi answer I would like to add below points.

The behavior you're describing aligns with a documented limitation of the Data API feature.

According to the documentation, Data API currently works only on newly created Azure DocumentDB vCore clusters. If the cluster was provisioned before Data API support became available, the enablement request may be accepted and the cluster may enter an Updating state, but the operation can subsequently revert the setting back to Off once validation completes.

To further validate this, you can:

Confirm whether the cluster is newly provisioned or an older existing cluster.

Check the cluster configuration through ARM/CLI and verify the properties.dataApi value rather than relying solely on the portal UI.

Review the Azure Activity Log entry for the cluster update operation and capture the Correlation ID, Operation ID, and timestamp for additional diagnostics.

If the cluster is newly created and the setting still reverts to Off, this may indicate a backend service issue requiring further investigation.

The documentation also notes that if Data API is not supported on a cluster, the operation may return "Data API isn't supported on this cluster" when performed through ARM/REST APIs.

Reference:

Data API for Azure DocumentDB (Preview)

I hope this helps clarify the behavior you're seeing.

Kind Regards,
Microsoft Support Team.