1. Packages
  2. Azure Classic
  3. API Docs
  4. cosmosdb
  5. CassandraDatacenter

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.cosmosdb.CassandraDatacenter

Explore with Pulumi AI

Manages a Cassandra Datacenter.

NOTE: In order for the Azure Managed Instances for Apache Cassandra to work properly the product requires the Azure Cosmos DB Application ID to be present and working in your tenant. If the Azure Cosmos DB Application ID is missing in your environment you will need to have an administrator of your tenant run the following command to add the Azure Cosmos DB Application ID to your tenant:

New-AzADServicePrincipal -ApplicationId a232010e-820c-4083-83bb-3ace5fc29d0b
Copy

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as azuread from "@pulumi/azuread";

const exampleResourceGroup = new azure.core.ResourceGroup("example", {
    name: "accexample-rg",
    location: "West Europe",
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
    name: "example-vnet",
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    addressSpaces: ["10.0.0.0/16"],
});
const exampleSubnet = new azure.network.Subnet("example", {
    name: "example-subnet",
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.0.1.0/24"],
});
const example = azuread.getServicePrincipal({
    displayName: "Azure Cosmos DB",
});
const exampleAssignment = new azure.authorization.Assignment("example", {
    scope: exampleVirtualNetwork.id,
    roleDefinitionName: "Network Contributor",
    principalId: example.then(example => example.objectId),
});
const exampleCassandraCluster = new azure.cosmosdb.CassandraCluster("example", {
    name: "example-cluster",
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    delegatedManagementSubnetId: exampleSubnet.id,
    defaultAdminPassword: "Password1234",
}, {
    dependsOn: [exampleAssignment],
});
const exampleCassandraDatacenter = new azure.cosmosdb.CassandraDatacenter("example", {
    name: "example-datacenter",
    location: exampleCassandraCluster.location,
    cassandraClusterId: exampleCassandraCluster.id,
    delegatedManagementSubnetId: exampleSubnet.id,
    nodeCount: 3,
    diskCount: 4,
    skuName: "Standard_DS14_v2",
    availabilityZonesEnabled: false,
});
Copy
import pulumi
import pulumi_azure as azure
import pulumi_azuread as azuread

example_resource_group = azure.core.ResourceGroup("example",
    name="accexample-rg",
    location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("example",
    name="example-vnet",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    address_spaces=["10.0.0.0/16"])
example_subnet = azure.network.Subnet("example",
    name="example-subnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.0.1.0/24"])
example = azuread.get_service_principal(display_name="Azure Cosmos DB")
example_assignment = azure.authorization.Assignment("example",
    scope=example_virtual_network.id,
    role_definition_name="Network Contributor",
    principal_id=example.object_id)
example_cassandra_cluster = azure.cosmosdb.CassandraCluster("example",
    name="example-cluster",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    delegated_management_subnet_id=example_subnet.id,
    default_admin_password="Password1234",
    opts = pulumi.ResourceOptions(depends_on=[example_assignment]))
example_cassandra_datacenter = azure.cosmosdb.CassandraDatacenter("example",
    name="example-datacenter",
    location=example_cassandra_cluster.location,
    cassandra_cluster_id=example_cassandra_cluster.id,
    delegated_management_subnet_id=example_subnet.id,
    node_count=3,
    disk_count=4,
    sku_name="Standard_DS14_v2",
    availability_zones_enabled=False)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/authorization"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/cosmosdb"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi-azuread/sdk/v5/go/azuread"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("accexample-rg"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
			Name:              pulumi.String("example-vnet"),
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.0.0.0/16"),
			},
		})
		if err != nil {
			return err
		}
		exampleSubnet, err := network.NewSubnet(ctx, "example", &network.SubnetArgs{
			Name:               pulumi.String("example-subnet"),
			ResourceGroupName:  exampleResourceGroup.Name,
			VirtualNetworkName: exampleVirtualNetwork.Name,
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("10.0.1.0/24"),
			},
		})
		if err != nil {
			return err
		}
		example, err := azuread.LookupServicePrincipal(ctx, &azuread.LookupServicePrincipalArgs{
			DisplayName: pulumi.StringRef("Azure Cosmos DB"),
		}, nil)
		if err != nil {
			return err
		}
		exampleAssignment, err := authorization.NewAssignment(ctx, "example", &authorization.AssignmentArgs{
			Scope:              exampleVirtualNetwork.ID(),
			RoleDefinitionName: pulumi.String("Network Contributor"),
			PrincipalId:        pulumi.String(example.ObjectId),
		})
		if err != nil {
			return err
		}
		exampleCassandraCluster, err := cosmosdb.NewCassandraCluster(ctx, "example", &cosmosdb.CassandraClusterArgs{
			Name:                        pulumi.String("example-cluster"),
			ResourceGroupName:           exampleResourceGroup.Name,
			Location:                    exampleResourceGroup.Location,
			DelegatedManagementSubnetId: exampleSubnet.ID(),
			DefaultAdminPassword:        pulumi.String("Password1234"),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAssignment,
		}))
		if err != nil {
			return err
		}
		_, err = cosmosdb.NewCassandraDatacenter(ctx, "example", &cosmosdb.CassandraDatacenterArgs{
			Name:                        pulumi.String("example-datacenter"),
			Location:                    exampleCassandraCluster.Location,
			CassandraClusterId:          exampleCassandraCluster.ID(),
			DelegatedManagementSubnetId: exampleSubnet.ID(),
			NodeCount:                   pulumi.Int(3),
			DiskCount:                   pulumi.Int(4),
			SkuName:                     pulumi.String("Standard_DS14_v2"),
			AvailabilityZonesEnabled:    pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
using AzureAD = Pulumi.AzureAD;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "accexample-rg",
        Location = "West Europe",
    });

    var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
    {
        Name = "example-vnet",
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        AddressSpaces = new[]
        {
            "10.0.0.0/16",
        },
    });

    var exampleSubnet = new Azure.Network.Subnet("example", new()
    {
        Name = "example-subnet",
        ResourceGroupName = exampleResourceGroup.Name,
        VirtualNetworkName = exampleVirtualNetwork.Name,
        AddressPrefixes = new[]
        {
            "10.0.1.0/24",
        },
    });

    var example = AzureAD.GetServicePrincipal.Invoke(new()
    {
        DisplayName = "Azure Cosmos DB",
    });

    var exampleAssignment = new Azure.Authorization.Assignment("example", new()
    {
        Scope = exampleVirtualNetwork.Id,
        RoleDefinitionName = "Network Contributor",
        PrincipalId = example.Apply(getServicePrincipalResult => getServicePrincipalResult.ObjectId),
    });

    var exampleCassandraCluster = new Azure.CosmosDB.CassandraCluster("example", new()
    {
        Name = "example-cluster",
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        DelegatedManagementSubnetId = exampleSubnet.Id,
        DefaultAdminPassword = "Password1234",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleAssignment,
        },
    });

    var exampleCassandraDatacenter = new Azure.CosmosDB.CassandraDatacenter("example", new()
    {
        Name = "example-datacenter",
        Location = exampleCassandraCluster.Location,
        CassandraClusterId = exampleCassandraCluster.Id,
        DelegatedManagementSubnetId = exampleSubnet.Id,
        NodeCount = 3,
        DiskCount = 4,
        SkuName = "Standard_DS14_v2",
        AvailabilityZonesEnabled = false,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azuread.AzureadFunctions;
import com.pulumi.azuread.inputs.GetServicePrincipalArgs;
import com.pulumi.azure.authorization.Assignment;
import com.pulumi.azure.authorization.AssignmentArgs;
import com.pulumi.azure.cosmosdb.CassandraCluster;
import com.pulumi.azure.cosmosdb.CassandraClusterArgs;
import com.pulumi.azure.cosmosdb.CassandraDatacenter;
import com.pulumi.azure.cosmosdb.CassandraDatacenterArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .name("accexample-rg")
            .location("West Europe")
            .build());

        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
            .name("example-vnet")
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .addressSpaces("10.0.0.0/16")
            .build());

        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
            .name("example-subnet")
            .resourceGroupName(exampleResourceGroup.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.1.0/24")
            .build());

        final var example = AzureadFunctions.getServicePrincipal(GetServicePrincipalArgs.builder()
            .displayName("Azure Cosmos DB")
            .build());

        var exampleAssignment = new Assignment("exampleAssignment", AssignmentArgs.builder()
            .scope(exampleVirtualNetwork.id())
            .roleDefinitionName("Network Contributor")
            .principalId(example.applyValue(getServicePrincipalResult -> getServicePrincipalResult.objectId()))
            .build());

        var exampleCassandraCluster = new CassandraCluster("exampleCassandraCluster", CassandraClusterArgs.builder()
            .name("example-cluster")
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .delegatedManagementSubnetId(exampleSubnet.id())
            .defaultAdminPassword("Password1234")
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleAssignment)
                .build());

        var exampleCassandraDatacenter = new CassandraDatacenter("exampleCassandraDatacenter", CassandraDatacenterArgs.builder()
            .name("example-datacenter")
            .location(exampleCassandraCluster.location())
            .cassandraClusterId(exampleCassandraCluster.id())
            .delegatedManagementSubnetId(exampleSubnet.id())
            .nodeCount(3)
            .diskCount(4)
            .skuName("Standard_DS14_v2")
            .availabilityZonesEnabled(false)
            .build());

    }
}
Copy
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    name: example
    properties:
      name: accexample-rg
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    name: example
    properties:
      name: example-vnet
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      addressSpaces:
        - 10.0.0.0/16
  exampleSubnet:
    type: azure:network:Subnet
    name: example
    properties:
      name: example-subnet
      resourceGroupName: ${exampleResourceGroup.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.0.1.0/24
  exampleAssignment:
    type: azure:authorization:Assignment
    name: example
    properties:
      scope: ${exampleVirtualNetwork.id}
      roleDefinitionName: Network Contributor
      principalId: ${example.objectId}
  exampleCassandraCluster:
    type: azure:cosmosdb:CassandraCluster
    name: example
    properties:
      name: example-cluster
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      delegatedManagementSubnetId: ${exampleSubnet.id}
      defaultAdminPassword: Password1234
    options:
      dependsOn:
        - ${exampleAssignment}
  exampleCassandraDatacenter:
    type: azure:cosmosdb:CassandraDatacenter
    name: example
    properties:
      name: example-datacenter
      location: ${exampleCassandraCluster.location}
      cassandraClusterId: ${exampleCassandraCluster.id}
      delegatedManagementSubnetId: ${exampleSubnet.id}
      nodeCount: 3
      diskCount: 4
      skuName: Standard_DS14_v2
      availabilityZonesEnabled: false
variables:
  example:
    fn::invoke:
      function: azuread:getServicePrincipal
      arguments:
        displayName: Azure Cosmos DB
Copy

Create CassandraDatacenter Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CassandraDatacenter(name: string, args: CassandraDatacenterArgs, opts?: CustomResourceOptions);
@overload
def CassandraDatacenter(resource_name: str,
                        args: CassandraDatacenterArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def CassandraDatacenter(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        cassandra_cluster_id: Optional[str] = None,
                        delegated_management_subnet_id: Optional[str] = None,
                        availability_zones_enabled: Optional[bool] = None,
                        backup_storage_customer_key_uri: Optional[str] = None,
                        base64_encoded_yaml_fragment: Optional[str] = None,
                        disk_count: Optional[int] = None,
                        disk_sku: Optional[str] = None,
                        location: Optional[str] = None,
                        managed_disk_customer_key_uri: Optional[str] = None,
                        name: Optional[str] = None,
                        node_count: Optional[int] = None,
                        sku_name: Optional[str] = None)
func NewCassandraDatacenter(ctx *Context, name string, args CassandraDatacenterArgs, opts ...ResourceOption) (*CassandraDatacenter, error)
public CassandraDatacenter(string name, CassandraDatacenterArgs args, CustomResourceOptions? opts = null)
public CassandraDatacenter(String name, CassandraDatacenterArgs args)
public CassandraDatacenter(String name, CassandraDatacenterArgs args, CustomResourceOptions options)
type: azure:cosmosdb:CassandraDatacenter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CassandraDatacenterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CassandraDatacenterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CassandraDatacenterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CassandraDatacenterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CassandraDatacenterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var cassandraDatacenterResource = new Azure.CosmosDB.CassandraDatacenter("cassandraDatacenterResource", new()
{
    CassandraClusterId = "string",
    DelegatedManagementSubnetId = "string",
    AvailabilityZonesEnabled = false,
    BackupStorageCustomerKeyUri = "string",
    Base64EncodedYamlFragment = "string",
    DiskCount = 0,
    DiskSku = "string",
    Location = "string",
    ManagedDiskCustomerKeyUri = "string",
    Name = "string",
    NodeCount = 0,
    SkuName = "string",
});
Copy
example, err := cosmosdb.NewCassandraDatacenter(ctx, "cassandraDatacenterResource", &cosmosdb.CassandraDatacenterArgs{
	CassandraClusterId:          pulumi.String("string"),
	DelegatedManagementSubnetId: pulumi.String("string"),
	AvailabilityZonesEnabled:    pulumi.Bool(false),
	BackupStorageCustomerKeyUri: pulumi.String("string"),
	Base64EncodedYamlFragment:   pulumi.String("string"),
	DiskCount:                   pulumi.Int(0),
	DiskSku:                     pulumi.String("string"),
	Location:                    pulumi.String("string"),
	ManagedDiskCustomerKeyUri:   pulumi.String("string"),
	Name:                        pulumi.String("string"),
	NodeCount:                   pulumi.Int(0),
	SkuName:                     pulumi.String("string"),
})
Copy
var cassandraDatacenterResource = new CassandraDatacenter("cassandraDatacenterResource", CassandraDatacenterArgs.builder()
    .cassandraClusterId("string")
    .delegatedManagementSubnetId("string")
    .availabilityZonesEnabled(false)
    .backupStorageCustomerKeyUri("string")
    .base64EncodedYamlFragment("string")
    .diskCount(0)
    .diskSku("string")
    .location("string")
    .managedDiskCustomerKeyUri("string")
    .name("string")
    .nodeCount(0)
    .skuName("string")
    .build());
Copy
cassandra_datacenter_resource = azure.cosmosdb.CassandraDatacenter("cassandraDatacenterResource",
    cassandra_cluster_id="string",
    delegated_management_subnet_id="string",
    availability_zones_enabled=False,
    backup_storage_customer_key_uri="string",
    base64_encoded_yaml_fragment="string",
    disk_count=0,
    disk_sku="string",
    location="string",
    managed_disk_customer_key_uri="string",
    name="string",
    node_count=0,
    sku_name="string")
Copy
const cassandraDatacenterResource = new azure.cosmosdb.CassandraDatacenter("cassandraDatacenterResource", {
    cassandraClusterId: "string",
    delegatedManagementSubnetId: "string",
    availabilityZonesEnabled: false,
    backupStorageCustomerKeyUri: "string",
    base64EncodedYamlFragment: "string",
    diskCount: 0,
    diskSku: "string",
    location: "string",
    managedDiskCustomerKeyUri: "string",
    name: "string",
    nodeCount: 0,
    skuName: "string",
});
Copy
type: azure:cosmosdb:CassandraDatacenter
properties:
    availabilityZonesEnabled: false
    backupStorageCustomerKeyUri: string
    base64EncodedYamlFragment: string
    cassandraClusterId: string
    delegatedManagementSubnetId: string
    diskCount: 0
    diskSku: string
    location: string
    managedDiskCustomerKeyUri: string
    name: string
    nodeCount: 0
    skuName: string
Copy

CassandraDatacenter Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CassandraDatacenter resource accepts the following input properties:

CassandraClusterId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Cassandra Cluster. Changing this forces a new Cassandra Datacenter to be created.
DelegatedManagementSubnetId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the delegated management subnet for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
AvailabilityZonesEnabled bool
Determines whether availability zones are enabled. Defaults to true.
BackupStorageCustomerKeyUri string
The key URI of the customer key to use for the encryption of the backup Storage Account.
Base64EncodedYamlFragment string
The fragment of the cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this Cassandra Datacenter. The fragment should be Base64 encoded and only a subset of keys is allowed.
DiskCount int
Determines the number of p30 disks that are attached to each node.
DiskSku string
The Disk SKU that is used for this Cassandra Datacenter. Defaults to P30.
Location Changes to this property will trigger replacement. string
The Azure Region where the Cassandra Datacenter should exist. Changing this forces a new Cassandra Datacenter to be created.
ManagedDiskCustomerKeyUri string
The key URI of the customer key to use for the encryption of the Managed Disk.
Name Changes to this property will trigger replacement. string
The name which should be used for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
NodeCount int
The number of nodes the Cassandra Datacenter should have. The number should be equal or greater than 3. Defaults to 3.
SkuName string

Determines the selected sku.

NOTE: In v4.0 of the provider the sku_name will have a default value of Standard_E16s_v5.

CassandraClusterId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Cassandra Cluster. Changing this forces a new Cassandra Datacenter to be created.
DelegatedManagementSubnetId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the delegated management subnet for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
AvailabilityZonesEnabled bool
Determines whether availability zones are enabled. Defaults to true.
BackupStorageCustomerKeyUri string
The key URI of the customer key to use for the encryption of the backup Storage Account.
Base64EncodedYamlFragment string
The fragment of the cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this Cassandra Datacenter. The fragment should be Base64 encoded and only a subset of keys is allowed.
DiskCount int
Determines the number of p30 disks that are attached to each node.
DiskSku string
The Disk SKU that is used for this Cassandra Datacenter. Defaults to P30.
Location Changes to this property will trigger replacement. string
The Azure Region where the Cassandra Datacenter should exist. Changing this forces a new Cassandra Datacenter to be created.
ManagedDiskCustomerKeyUri string
The key URI of the customer key to use for the encryption of the Managed Disk.
Name Changes to this property will trigger replacement. string
The name which should be used for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
NodeCount int
The number of nodes the Cassandra Datacenter should have. The number should be equal or greater than 3. Defaults to 3.
SkuName string

Determines the selected sku.

NOTE: In v4.0 of the provider the sku_name will have a default value of Standard_E16s_v5.

cassandraClusterId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Cassandra Cluster. Changing this forces a new Cassandra Datacenter to be created.
delegatedManagementSubnetId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the delegated management subnet for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
availabilityZonesEnabled Boolean
Determines whether availability zones are enabled. Defaults to true.
backupStorageCustomerKeyUri String
The key URI of the customer key to use for the encryption of the backup Storage Account.
base64EncodedYamlFragment String
The fragment of the cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this Cassandra Datacenter. The fragment should be Base64 encoded and only a subset of keys is allowed.
diskCount Integer
Determines the number of p30 disks that are attached to each node.
diskSku String
The Disk SKU that is used for this Cassandra Datacenter. Defaults to P30.
location Changes to this property will trigger replacement. String
The Azure Region where the Cassandra Datacenter should exist. Changing this forces a new Cassandra Datacenter to be created.
managedDiskCustomerKeyUri String
The key URI of the customer key to use for the encryption of the Managed Disk.
name Changes to this property will trigger replacement. String
The name which should be used for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
nodeCount Integer
The number of nodes the Cassandra Datacenter should have. The number should be equal or greater than 3. Defaults to 3.
skuName String

Determines the selected sku.

NOTE: In v4.0 of the provider the sku_name will have a default value of Standard_E16s_v5.

cassandraClusterId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Cassandra Cluster. Changing this forces a new Cassandra Datacenter to be created.
delegatedManagementSubnetId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the delegated management subnet for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
availabilityZonesEnabled boolean
Determines whether availability zones are enabled. Defaults to true.
backupStorageCustomerKeyUri string
The key URI of the customer key to use for the encryption of the backup Storage Account.
base64EncodedYamlFragment string
The fragment of the cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this Cassandra Datacenter. The fragment should be Base64 encoded and only a subset of keys is allowed.
diskCount number
Determines the number of p30 disks that are attached to each node.
diskSku string
The Disk SKU that is used for this Cassandra Datacenter. Defaults to P30.
location Changes to this property will trigger replacement. string
The Azure Region where the Cassandra Datacenter should exist. Changing this forces a new Cassandra Datacenter to be created.
managedDiskCustomerKeyUri string
The key URI of the customer key to use for the encryption of the Managed Disk.
name Changes to this property will trigger replacement. string
The name which should be used for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
nodeCount number
The number of nodes the Cassandra Datacenter should have. The number should be equal or greater than 3. Defaults to 3.
skuName string

Determines the selected sku.

NOTE: In v4.0 of the provider the sku_name will have a default value of Standard_E16s_v5.

cassandra_cluster_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Cassandra Cluster. Changing this forces a new Cassandra Datacenter to be created.
delegated_management_subnet_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the delegated management subnet for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
availability_zones_enabled bool
Determines whether availability zones are enabled. Defaults to true.
backup_storage_customer_key_uri str
The key URI of the customer key to use for the encryption of the backup Storage Account.
base64_encoded_yaml_fragment str
The fragment of the cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this Cassandra Datacenter. The fragment should be Base64 encoded and only a subset of keys is allowed.
disk_count int
Determines the number of p30 disks that are attached to each node.
disk_sku str
The Disk SKU that is used for this Cassandra Datacenter. Defaults to P30.
location Changes to this property will trigger replacement. str
The Azure Region where the Cassandra Datacenter should exist. Changing this forces a new Cassandra Datacenter to be created.
managed_disk_customer_key_uri str
The key URI of the customer key to use for the encryption of the Managed Disk.
name Changes to this property will trigger replacement. str
The name which should be used for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
node_count int
The number of nodes the Cassandra Datacenter should have. The number should be equal or greater than 3. Defaults to 3.
sku_name str

Determines the selected sku.

NOTE: In v4.0 of the provider the sku_name will have a default value of Standard_E16s_v5.

cassandraClusterId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Cassandra Cluster. Changing this forces a new Cassandra Datacenter to be created.
delegatedManagementSubnetId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the delegated management subnet for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
availabilityZonesEnabled Boolean
Determines whether availability zones are enabled. Defaults to true.
backupStorageCustomerKeyUri String
The key URI of the customer key to use for the encryption of the backup Storage Account.
base64EncodedYamlFragment String
The fragment of the cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this Cassandra Datacenter. The fragment should be Base64 encoded and only a subset of keys is allowed.
diskCount Number
Determines the number of p30 disks that are attached to each node.
diskSku String
The Disk SKU that is used for this Cassandra Datacenter. Defaults to P30.
location Changes to this property will trigger replacement. String
The Azure Region where the Cassandra Datacenter should exist. Changing this forces a new Cassandra Datacenter to be created.
managedDiskCustomerKeyUri String
The key URI of the customer key to use for the encryption of the Managed Disk.
name Changes to this property will trigger replacement. String
The name which should be used for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
nodeCount Number
The number of nodes the Cassandra Datacenter should have. The number should be equal or greater than 3. Defaults to 3.
skuName String

Determines the selected sku.

NOTE: In v4.0 of the provider the sku_name will have a default value of Standard_E16s_v5.

Outputs

All input properties are implicitly available as output properties. Additionally, the CassandraDatacenter resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
SeedNodeIpAddresses List<string>
A list of IP Address for the seed nodes in this Cassandra Datacenter.
Id string
The provider-assigned unique ID for this managed resource.
SeedNodeIpAddresses []string
A list of IP Address for the seed nodes in this Cassandra Datacenter.
id String
The provider-assigned unique ID for this managed resource.
seedNodeIpAddresses List<String>
A list of IP Address for the seed nodes in this Cassandra Datacenter.
id string
The provider-assigned unique ID for this managed resource.
seedNodeIpAddresses string[]
A list of IP Address for the seed nodes in this Cassandra Datacenter.
id str
The provider-assigned unique ID for this managed resource.
seed_node_ip_addresses Sequence[str]
A list of IP Address for the seed nodes in this Cassandra Datacenter.
id String
The provider-assigned unique ID for this managed resource.
seedNodeIpAddresses List<String>
A list of IP Address for the seed nodes in this Cassandra Datacenter.

Look up Existing CassandraDatacenter Resource

Get an existing CassandraDatacenter resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CassandraDatacenterState, opts?: CustomResourceOptions): CassandraDatacenter
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_zones_enabled: Optional[bool] = None,
        backup_storage_customer_key_uri: Optional[str] = None,
        base64_encoded_yaml_fragment: Optional[str] = None,
        cassandra_cluster_id: Optional[str] = None,
        delegated_management_subnet_id: Optional[str] = None,
        disk_count: Optional[int] = None,
        disk_sku: Optional[str] = None,
        location: Optional[str] = None,
        managed_disk_customer_key_uri: Optional[str] = None,
        name: Optional[str] = None,
        node_count: Optional[int] = None,
        seed_node_ip_addresses: Optional[Sequence[str]] = None,
        sku_name: Optional[str] = None) -> CassandraDatacenter
func GetCassandraDatacenter(ctx *Context, name string, id IDInput, state *CassandraDatacenterState, opts ...ResourceOption) (*CassandraDatacenter, error)
public static CassandraDatacenter Get(string name, Input<string> id, CassandraDatacenterState? state, CustomResourceOptions? opts = null)
public static CassandraDatacenter get(String name, Output<String> id, CassandraDatacenterState state, CustomResourceOptions options)
resources:  _:    type: azure:cosmosdb:CassandraDatacenter    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AvailabilityZonesEnabled bool
Determines whether availability zones are enabled. Defaults to true.
BackupStorageCustomerKeyUri string
The key URI of the customer key to use for the encryption of the backup Storage Account.
Base64EncodedYamlFragment string
The fragment of the cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this Cassandra Datacenter. The fragment should be Base64 encoded and only a subset of keys is allowed.
CassandraClusterId Changes to this property will trigger replacement. string
The ID of the Cassandra Cluster. Changing this forces a new Cassandra Datacenter to be created.
DelegatedManagementSubnetId Changes to this property will trigger replacement. string
The ID of the delegated management subnet for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
DiskCount int
Determines the number of p30 disks that are attached to each node.
DiskSku string
The Disk SKU that is used for this Cassandra Datacenter. Defaults to P30.
Location Changes to this property will trigger replacement. string
The Azure Region where the Cassandra Datacenter should exist. Changing this forces a new Cassandra Datacenter to be created.
ManagedDiskCustomerKeyUri string
The key URI of the customer key to use for the encryption of the Managed Disk.
Name Changes to this property will trigger replacement. string
The name which should be used for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
NodeCount int
The number of nodes the Cassandra Datacenter should have. The number should be equal or greater than 3. Defaults to 3.
SeedNodeIpAddresses List<string>
A list of IP Address for the seed nodes in this Cassandra Datacenter.
SkuName string

Determines the selected sku.

NOTE: In v4.0 of the provider the sku_name will have a default value of Standard_E16s_v5.

AvailabilityZonesEnabled bool
Determines whether availability zones are enabled. Defaults to true.
BackupStorageCustomerKeyUri string
The key URI of the customer key to use for the encryption of the backup Storage Account.
Base64EncodedYamlFragment string
The fragment of the cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this Cassandra Datacenter. The fragment should be Base64 encoded and only a subset of keys is allowed.
CassandraClusterId Changes to this property will trigger replacement. string
The ID of the Cassandra Cluster. Changing this forces a new Cassandra Datacenter to be created.
DelegatedManagementSubnetId Changes to this property will trigger replacement. string
The ID of the delegated management subnet for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
DiskCount int
Determines the number of p30 disks that are attached to each node.
DiskSku string
The Disk SKU that is used for this Cassandra Datacenter. Defaults to P30.
Location Changes to this property will trigger replacement. string
The Azure Region where the Cassandra Datacenter should exist. Changing this forces a new Cassandra Datacenter to be created.
ManagedDiskCustomerKeyUri string
The key URI of the customer key to use for the encryption of the Managed Disk.
Name Changes to this property will trigger replacement. string
The name which should be used for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
NodeCount int
The number of nodes the Cassandra Datacenter should have. The number should be equal or greater than 3. Defaults to 3.
SeedNodeIpAddresses []string
A list of IP Address for the seed nodes in this Cassandra Datacenter.
SkuName string

Determines the selected sku.

NOTE: In v4.0 of the provider the sku_name will have a default value of Standard_E16s_v5.

availabilityZonesEnabled Boolean
Determines whether availability zones are enabled. Defaults to true.
backupStorageCustomerKeyUri String
The key URI of the customer key to use for the encryption of the backup Storage Account.
base64EncodedYamlFragment String
The fragment of the cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this Cassandra Datacenter. The fragment should be Base64 encoded and only a subset of keys is allowed.
cassandraClusterId Changes to this property will trigger replacement. String
The ID of the Cassandra Cluster. Changing this forces a new Cassandra Datacenter to be created.
delegatedManagementSubnetId Changes to this property will trigger replacement. String
The ID of the delegated management subnet for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
diskCount Integer
Determines the number of p30 disks that are attached to each node.
diskSku String
The Disk SKU that is used for this Cassandra Datacenter. Defaults to P30.
location Changes to this property will trigger replacement. String
The Azure Region where the Cassandra Datacenter should exist. Changing this forces a new Cassandra Datacenter to be created.
managedDiskCustomerKeyUri String
The key URI of the customer key to use for the encryption of the Managed Disk.
name Changes to this property will trigger replacement. String
The name which should be used for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
nodeCount Integer
The number of nodes the Cassandra Datacenter should have. The number should be equal or greater than 3. Defaults to 3.
seedNodeIpAddresses List<String>
A list of IP Address for the seed nodes in this Cassandra Datacenter.
skuName String

Determines the selected sku.

NOTE: In v4.0 of the provider the sku_name will have a default value of Standard_E16s_v5.

availabilityZonesEnabled boolean
Determines whether availability zones are enabled. Defaults to true.
backupStorageCustomerKeyUri string
The key URI of the customer key to use for the encryption of the backup Storage Account.
base64EncodedYamlFragment string
The fragment of the cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this Cassandra Datacenter. The fragment should be Base64 encoded and only a subset of keys is allowed.
cassandraClusterId Changes to this property will trigger replacement. string
The ID of the Cassandra Cluster. Changing this forces a new Cassandra Datacenter to be created.
delegatedManagementSubnetId Changes to this property will trigger replacement. string
The ID of the delegated management subnet for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
diskCount number
Determines the number of p30 disks that are attached to each node.
diskSku string
The Disk SKU that is used for this Cassandra Datacenter. Defaults to P30.
location Changes to this property will trigger replacement. string
The Azure Region where the Cassandra Datacenter should exist. Changing this forces a new Cassandra Datacenter to be created.
managedDiskCustomerKeyUri string
The key URI of the customer key to use for the encryption of the Managed Disk.
name Changes to this property will trigger replacement. string
The name which should be used for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
nodeCount number
The number of nodes the Cassandra Datacenter should have. The number should be equal or greater than 3. Defaults to 3.
seedNodeIpAddresses string[]
A list of IP Address for the seed nodes in this Cassandra Datacenter.
skuName string

Determines the selected sku.

NOTE: In v4.0 of the provider the sku_name will have a default value of Standard_E16s_v5.

availability_zones_enabled bool
Determines whether availability zones are enabled. Defaults to true.
backup_storage_customer_key_uri str
The key URI of the customer key to use for the encryption of the backup Storage Account.
base64_encoded_yaml_fragment str
The fragment of the cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this Cassandra Datacenter. The fragment should be Base64 encoded and only a subset of keys is allowed.
cassandra_cluster_id Changes to this property will trigger replacement. str
The ID of the Cassandra Cluster. Changing this forces a new Cassandra Datacenter to be created.
delegated_management_subnet_id Changes to this property will trigger replacement. str
The ID of the delegated management subnet for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
disk_count int
Determines the number of p30 disks that are attached to each node.
disk_sku str
The Disk SKU that is used for this Cassandra Datacenter. Defaults to P30.
location Changes to this property will trigger replacement. str
The Azure Region where the Cassandra Datacenter should exist. Changing this forces a new Cassandra Datacenter to be created.
managed_disk_customer_key_uri str
The key URI of the customer key to use for the encryption of the Managed Disk.
name Changes to this property will trigger replacement. str
The name which should be used for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
node_count int
The number of nodes the Cassandra Datacenter should have. The number should be equal or greater than 3. Defaults to 3.
seed_node_ip_addresses Sequence[str]
A list of IP Address for the seed nodes in this Cassandra Datacenter.
sku_name str

Determines the selected sku.

NOTE: In v4.0 of the provider the sku_name will have a default value of Standard_E16s_v5.

availabilityZonesEnabled Boolean
Determines whether availability zones are enabled. Defaults to true.
backupStorageCustomerKeyUri String
The key URI of the customer key to use for the encryption of the backup Storage Account.
base64EncodedYamlFragment String
The fragment of the cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this Cassandra Datacenter. The fragment should be Base64 encoded and only a subset of keys is allowed.
cassandraClusterId Changes to this property will trigger replacement. String
The ID of the Cassandra Cluster. Changing this forces a new Cassandra Datacenter to be created.
delegatedManagementSubnetId Changes to this property will trigger replacement. String
The ID of the delegated management subnet for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
diskCount Number
Determines the number of p30 disks that are attached to each node.
diskSku String
The Disk SKU that is used for this Cassandra Datacenter. Defaults to P30.
location Changes to this property will trigger replacement. String
The Azure Region where the Cassandra Datacenter should exist. Changing this forces a new Cassandra Datacenter to be created.
managedDiskCustomerKeyUri String
The key URI of the customer key to use for the encryption of the Managed Disk.
name Changes to this property will trigger replacement. String
The name which should be used for this Cassandra Datacenter. Changing this forces a new Cassandra Datacenter to be created.
nodeCount Number
The number of nodes the Cassandra Datacenter should have. The number should be equal or greater than 3. Defaults to 3.
seedNodeIpAddresses List<String>
A list of IP Address for the seed nodes in this Cassandra Datacenter.
skuName String

Determines the selected sku.

NOTE: In v4.0 of the provider the sku_name will have a default value of Standard_E16s_v5.

Import

Cassandra Datacenters can be imported using the resource id, e.g.

$ pulumi import azure:cosmosdb/cassandraDatacenter:CassandraDatacenter example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.DocumentDB/cassandraClusters/cluster1/dataCenters/dc1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.