Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The garnetClusters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DocumentDB/garnetClusters resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/garnetClusters@2026-04-01-preview' = {
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
allocationState: 'string'
authenticationMethod: 'string'
availabilityZone: bool
clusterType: 'string'
extensions: [
'string'
]
nodeSku: 'string'
persistence: bool
provisionError: {}
replicationFactor: int
shardCount: int
subnetId: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.DocumentDB/garnetClusters
| Name | Description | Value |
|---|---|---|
| identity | Identity for the resource. | ManagedCassandraManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 100 Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (required) |
| properties | The resource-specific properties for this resource. | GarnetClusterResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ErrorDetail
| Name | Description | Value |
|---|
GarnetClusterResourceProperties
| Name | Description | Value |
|---|---|---|
| allocationState | Allocation state of the cluster and data center resources. Active implies the virtual machines of the cluster are allocated, deallocated implies virtual machines and resources are deallocated. | 'Active' 'Deallocated' |
| authenticationMethod | The authentication method used for the Garnet cluster. | 'Entra' |
| availabilityZone | If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines. | bool |
| clusterType | Type of the cluster. If set to Production, some operations might not be permitted on cluster. | 'NonProduction' 'Production' |
| extensions | Extensions to be added or updated on cluster. | string[] |
| nodeSku | Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2. | string |
| persistence | Flag to indicate if persistence is enabled for the Garnet cluster. | bool |
| provisionError | Error related to resource provisioning. | ErrorDetail |
| replicationFactor | Number of copies of data maintained by the cluster. | int |
| shardCount | Number of shards in the cluster. | int |
| subnetId | Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>' | string |
ManagedCassandraManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of the resource. | 'None' 'SystemAssigned' |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The garnetClusters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.
Usage Examples
Resource format
To create a Microsoft.DocumentDB/garnetClusters resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/garnetClusters",
"apiVersion": "2026-04-01-preview",
"name": "string",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"allocationState": "string",
"authenticationMethod": "string",
"availabilityZone": "bool",
"clusterType": "string",
"extensions": [ "string" ],
"nodeSku": "string",
"persistence": "bool",
"provisionError": {
},
"replicationFactor": "int",
"shardCount": "int",
"subnetId": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.DocumentDB/garnetClusters
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-04-01-preview' |
| identity | Identity for the resource. | ManagedCassandraManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 100 Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (required) |
| properties | The resource-specific properties for this resource. | GarnetClusterResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.DocumentDB/garnetClusters' |
ErrorDetail
| Name | Description | Value |
|---|
GarnetClusterResourceProperties
| Name | Description | Value |
|---|---|---|
| allocationState | Allocation state of the cluster and data center resources. Active implies the virtual machines of the cluster are allocated, deallocated implies virtual machines and resources are deallocated. | 'Active' 'Deallocated' |
| authenticationMethod | The authentication method used for the Garnet cluster. | 'Entra' |
| availabilityZone | If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines. | bool |
| clusterType | Type of the cluster. If set to Production, some operations might not be permitted on cluster. | 'NonProduction' 'Production' |
| extensions | Extensions to be added or updated on cluster. | string[] |
| nodeSku | Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2. | string |
| persistence | Flag to indicate if persistence is enabled for the Garnet cluster. | bool |
| provisionError | Error related to resource provisioning. | ErrorDetail |
| replicationFactor | Number of copies of data maintained by the cluster. | int |
| shardCount | Number of shards in the cluster. | int |
| subnetId | Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>' | string |
ManagedCassandraManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of the resource. | 'None' 'SystemAssigned' |
TrackedResourceTags
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The garnetClusters resource type can be deployed with operations that target:
- Resource groups For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DocumentDB/garnetClusters resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/garnetClusters@2026-04-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
allocationState = "string"
authenticationMethod = "string"
availabilityZone = bool
clusterType = "string"
extensions = [
"string"
]
nodeSku = "string"
persistence = bool
provisionError = {
}
replicationFactor = int
shardCount = int
subnetId = "string"
}
}
}
Property Values
Microsoft.DocumentDB/garnetClusters
| Name | Description | Value |
|---|---|---|
| identity | Identity for the resource. | ManagedCassandraManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 100 Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (required) |
| properties | The resource-specific properties for this resource. | GarnetClusterResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.DocumentDB/garnetClusters@2026-04-01-preview" |
ErrorDetail
| Name | Description | Value |
|---|
GarnetClusterResourceProperties
| Name | Description | Value |
|---|---|---|
| allocationState | Allocation state of the cluster and data center resources. Active implies the virtual machines of the cluster are allocated, deallocated implies virtual machines and resources are deallocated. | 'Active' 'Deallocated' |
| authenticationMethod | The authentication method used for the Garnet cluster. | 'Entra' |
| availabilityZone | If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines. | bool |
| clusterType | Type of the cluster. If set to Production, some operations might not be permitted on cluster. | 'NonProduction' 'Production' |
| extensions | Extensions to be added or updated on cluster. | string[] |
| nodeSku | Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2. | string |
| persistence | Flag to indicate if persistence is enabled for the Garnet cluster. | bool |
| provisionError | Error related to resource provisioning. | ErrorDetail |
| replicationFactor | Number of copies of data maintained by the cluster. | int |
| shardCount | Number of shards in the cluster. | int |
| subnetId | Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>' | string |
ManagedCassandraManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of the resource. | 'None' 'SystemAssigned' |
TrackedResourceTags
| Name | Description | Value |
|---|