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

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    Manages a Cassandra Cluster.

    Example Usage

    using Pulumi;
    using Azure = Pulumi.Azure;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
            {
                Location = "West Europe",
            });
            var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new Azure.Network.VirtualNetworkArgs
            {
                Location = exampleResourceGroup.Location,
                ResourceGroupName = exampleResourceGroup.Name,
                AddressSpaces = 
                {
                    "10.0.0.0/16",
                },
            });
            var exampleSubnet = new Azure.Network.Subnet("exampleSubnet", new Azure.Network.SubnetArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                VirtualNetworkName = exampleVirtualNetwork.Name,
                AddressPrefixes = 
                {
                    "10.0.1.0/24",
                },
            });
            var exampleAssignment = new Azure.Authorization.Assignment("exampleAssignment", new Azure.Authorization.AssignmentArgs
            {
                Scope = exampleVirtualNetwork.Id,
                RoleDefinitionName = "Network Contributor",
                PrincipalId = "e5007d2c-4b13-4a74-9b6a-605d99f03501",
            });
            var exampleCassandraCluster = new Azure.CosmosDB.CassandraCluster("exampleCassandraCluster", new Azure.CosmosDB.CassandraClusterArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                Location = exampleResourceGroup.Location,
                DelegatedManagementSubnetId = exampleSubnet.Id,
                DefaultAdminPassword = "Password1234",
            });
        }
    
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/authorization"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/cosmosdb"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/network"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "exampleVirtualNetwork", &network.VirtualNetworkArgs{
    			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, "exampleSubnet", &network.SubnetArgs{
    			ResourceGroupName:  exampleResourceGroup.Name,
    			VirtualNetworkName: exampleVirtualNetwork.Name,
    			AddressPrefixes: pulumi.StringArray{
    				pulumi.String("10.0.1.0/24"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = authorization.NewAssignment(ctx, "exampleAssignment", &authorization.AssignmentArgs{
    			Scope:              exampleVirtualNetwork.ID(),
    			RoleDefinitionName: pulumi.String("Network Contributor"),
    			PrincipalId:        pulumi.String("e5007d2c-4b13-4a74-9b6a-605d99f03501"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = cosmosdb.NewCassandraCluster(ctx, "exampleCassandraCluster", &cosmosdb.CassandraClusterArgs{
    			ResourceGroupName:           exampleResourceGroup.Name,
    			Location:                    exampleResourceGroup.Location,
    			DelegatedManagementSubnetId: exampleSubnet.ID(),
    			DefaultAdminPassword:        pulumi.String("Password1234"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
        addressSpaces: ["10.0.0.0/16"],
    });
    const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
        resourceGroupName: exampleResourceGroup.name,
        virtualNetworkName: exampleVirtualNetwork.name,
        addressPrefixes: ["10.0.1.0/24"],
    });
    const exampleAssignment = new azure.authorization.Assignment("exampleAssignment", {
        scope: exampleVirtualNetwork.id,
        roleDefinitionName: "Network Contributor",
        principalId: "e5007d2c-4b13-4a74-9b6a-605d99f03501",
    });
    const exampleCassandraCluster = new azure.cosmosdb.CassandraCluster("exampleCassandraCluster", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.location,
        delegatedManagementSubnetId: exampleSubnet.id,
        defaultAdminPassword: "Password1234",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name,
        address_spaces=["10.0.0.0/16"])
    example_subnet = azure.network.Subnet("exampleSubnet",
        resource_group_name=example_resource_group.name,
        virtual_network_name=example_virtual_network.name,
        address_prefixes=["10.0.1.0/24"])
    example_assignment = azure.authorization.Assignment("exampleAssignment",
        scope=example_virtual_network.id,
        role_definition_name="Network Contributor",
        principal_id="e5007d2c-4b13-4a74-9b6a-605d99f03501")
    example_cassandra_cluster = azure.cosmosdb.CassandraCluster("exampleCassandraCluster",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.location,
        delegated_management_subnet_id=example_subnet.id,
        default_admin_password="Password1234")
    

    Example coming soon!

    Create CassandraCluster Resource

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

    Constructor syntax

    new CassandraCluster(name: string, args: CassandraClusterArgs, opts?: CustomResourceOptions);
    @overload
    def CassandraCluster(resource_name: str,
                         args: CassandraClusterArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def CassandraCluster(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         default_admin_password: Optional[str] = None,
                         delegated_management_subnet_id: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         location: Optional[str] = None,
                         name: Optional[str] = None)
    func NewCassandraCluster(ctx *Context, name string, args CassandraClusterArgs, opts ...ResourceOption) (*CassandraCluster, error)
    public CassandraCluster(string name, CassandraClusterArgs args, CustomResourceOptions? opts = null)
    public CassandraCluster(String name, CassandraClusterArgs args)
    public CassandraCluster(String name, CassandraClusterArgs args, CustomResourceOptions options)
    
    type: azure:cosmosdb:CassandraCluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args CassandraClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CassandraClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CassandraClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CassandraClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CassandraClusterArgs
    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 cassandraClusterResource = new Azure.CosmosDB.CassandraCluster("cassandraClusterResource", new()
    {
        DefaultAdminPassword = "string",
        DelegatedManagementSubnetId = "string",
        ResourceGroupName = "string",
        Location = "string",
        Name = "string",
    });
    
    example, err := cosmosdb.NewCassandraCluster(ctx, "cassandraClusterResource", &cosmosdb.CassandraClusterArgs{
    	DefaultAdminPassword:        pulumi.String("string"),
    	DelegatedManagementSubnetId: pulumi.String("string"),
    	ResourceGroupName:           pulumi.String("string"),
    	Location:                    pulumi.String("string"),
    	Name:                        pulumi.String("string"),
    })
    
    var cassandraClusterResource = new CassandraCluster("cassandraClusterResource", CassandraClusterArgs.builder()
        .defaultAdminPassword("string")
        .delegatedManagementSubnetId("string")
        .resourceGroupName("string")
        .location("string")
        .name("string")
        .build());
    
    cassandra_cluster_resource = azure.cosmosdb.CassandraCluster("cassandraClusterResource",
        default_admin_password="string",
        delegated_management_subnet_id="string",
        resource_group_name="string",
        location="string",
        name="string")
    
    const cassandraClusterResource = new azure.cosmosdb.CassandraCluster("cassandraClusterResource", {
        defaultAdminPassword: "string",
        delegatedManagementSubnetId: "string",
        resourceGroupName: "string",
        location: "string",
        name: "string",
    });
    
    type: azure:cosmosdb:CassandraCluster
    properties:
        defaultAdminPassword: string
        delegatedManagementSubnetId: string
        location: string
        name: string
        resourceGroupName: string
    

    CassandraCluster 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 CassandraCluster resource accepts the following input properties:

    DefaultAdminPassword string
    The initial admin password for this Cassandra Cluster.
    DelegatedManagementSubnetId string
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    ResourceGroupName string
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    Location string
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    Name string
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    DefaultAdminPassword string
    The initial admin password for this Cassandra Cluster.
    DelegatedManagementSubnetId string
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    ResourceGroupName string
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    Location string
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    Name string
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    defaultAdminPassword String
    The initial admin password for this Cassandra Cluster.
    delegatedManagementSubnetId String
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    resourceGroupName String
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    location String
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name String
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    defaultAdminPassword string
    The initial admin password for this Cassandra Cluster.
    delegatedManagementSubnetId string
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    resourceGroupName string
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    location string
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name string
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    default_admin_password str
    The initial admin password for this Cassandra Cluster.
    delegated_management_subnet_id str
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    resource_group_name str
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    location str
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name str
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    defaultAdminPassword String
    The initial admin password for this Cassandra Cluster.
    delegatedManagementSubnetId String
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    resourceGroupName String
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    location String
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name String
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CassandraCluster Resource

    Get an existing CassandraCluster 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?: CassandraClusterState, opts?: CustomResourceOptions): CassandraCluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            default_admin_password: Optional[str] = None,
            delegated_management_subnet_id: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None) -> CassandraCluster
    func GetCassandraCluster(ctx *Context, name string, id IDInput, state *CassandraClusterState, opts ...ResourceOption) (*CassandraCluster, error)
    public static CassandraCluster Get(string name, Input<string> id, CassandraClusterState? state, CustomResourceOptions? opts = null)
    public static CassandraCluster get(String name, Output<String> id, CassandraClusterState state, CustomResourceOptions options)
    resources:  _:    type: azure:cosmosdb:CassandraCluster    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    DefaultAdminPassword string
    The initial admin password for this Cassandra Cluster.
    DelegatedManagementSubnetId string
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    Location string
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    Name string
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    ResourceGroupName string
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    DefaultAdminPassword string
    The initial admin password for this Cassandra Cluster.
    DelegatedManagementSubnetId string
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    Location string
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    Name string
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    ResourceGroupName string
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    defaultAdminPassword String
    The initial admin password for this Cassandra Cluster.
    delegatedManagementSubnetId String
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    location String
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name String
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    resourceGroupName String
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    defaultAdminPassword string
    The initial admin password for this Cassandra Cluster.
    delegatedManagementSubnetId string
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    location string
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name string
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    resourceGroupName string
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    default_admin_password str
    The initial admin password for this Cassandra Cluster.
    delegated_management_subnet_id str
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    location str
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name str
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    resource_group_name str
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    defaultAdminPassword String
    The initial admin password for this Cassandra Cluster.
    delegatedManagementSubnetId String
    The ID of the delegated management subnet for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    location String
    The Azure Region where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.
    name String
    The name which should be used for this Cassandra Cluster. Changing this forces a new Cassandra Cluster to be created.
    resourceGroupName String
    The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.

    Import

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

     $ pulumi import azure:cosmosdb/cassandraCluster:CassandraCluster example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.DocumentDB/cassandraClusters/cluster1
    

    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.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial