Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Friday, Jun 10, 2022 by Pulumi

CassandraCluster

Manages a Cassandra Cluster.

** 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:

import * as pulumi from "@pulumi/pulumi";
import pulumi
using Pulumi;

class MyStack : Stack
{
    public MyStack()
    {
    }

}
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

    public static void stack(Context ctx) {
    }
}
{}

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;
using AzureAD = Pulumi.AzureAD;

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 exampleServicePrincipal = Output.Create(AzureAD.GetServicePrincipal.InvokeAsync(new AzureAD.GetServicePrincipalArgs
        {
            DisplayName = "Azure Cosmos DB",
        }));
        var exampleAssignment = new Azure.Authorization.Assignment("exampleAssignment", new Azure.Authorization.AssignmentArgs
        {
            Scope = exampleVirtualNetwork.Id,
            RoleDefinitionName = "Network Contributor",
            PrincipalId = exampleServicePrincipal.Apply(exampleServicePrincipal => exampleServicePrincipal.ObjectId),
        });
        var exampleCassandraCluster = new Azure.CosmosDB.CassandraCluster("exampleCassandraCluster", new Azure.CosmosDB.CassandraClusterArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            DelegatedManagementSubnetId = exampleSubnet.Id,
            DefaultAdminPassword = "Password1234",
        }, new CustomResourceOptions
        {
            DependsOn = 
            {
                exampleAssignment,
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/authorization"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cosmosdb"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
	"github.com/pulumi/pulumi-azuread/sdk/v4/go/azuread"
	"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
		}
		exampleServicePrincipal, err := azuread.LookupServicePrincipal(ctx, &GetServicePrincipalArgs{
			DisplayName: pulumi.StringRef("Azure Cosmos DB"),
		}, nil)
		if err != nil {
			return err
		}
		exampleAssignment, err := authorization.NewAssignment(ctx, "exampleAssignment", &authorization.AssignmentArgs{
			Scope:              exampleVirtualNetwork.ID(),
			RoleDefinitionName: pulumi.String("Network Contributor"),
			PrincipalId:        pulumi.String(exampleServicePrincipal.ObjectId),
		})
		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"),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAssignment,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
import com.pulumi.resources.CustomResourceOptions;

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()        
            .location("West Europe")
            .build());

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

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

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

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

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

    }
}
import pulumi
import pulumi_azure as azure
import pulumi_azuread as azuread

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_service_principal = azuread.get_service_principal(display_name="Azure Cosmos DB")
example_assignment = azure.authorization.Assignment("exampleAssignment",
    scope=example_virtual_network.id,
    role_definition_name="Network Contributor",
    principal_id=example_service_principal.object_id)
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",
    opts=pulumi.ResourceOptions(depends_on=[example_assignment]))
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as azuread from "@pulumi/azuread";

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 exampleServicePrincipal = azuread.getServicePrincipal({
    displayName: "Azure Cosmos DB",
});
const exampleAssignment = new azure.authorization.Assignment("exampleAssignment", {
    scope: exampleVirtualNetwork.id,
    roleDefinitionName: "Network Contributor",
    principalId: exampleServicePrincipal.then(exampleServicePrincipal => exampleServicePrincipal.objectId),
});
const exampleCassandraCluster = new azure.cosmosdb.CassandraCluster("exampleCassandraCluster", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    delegatedManagementSubnetId: exampleSubnet.id,
    defaultAdminPassword: "Password1234",
}, {
    dependsOn: [exampleAssignment],
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      addressSpaces:
        - 10.0.0.0/16
  exampleSubnet:
    type: azure:network:Subnet
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.0.1.0/24
  exampleAssignment:
    type: azure:authorization:Assignment
    properties:
      scope: ${exampleVirtualNetwork.id}
      roleDefinitionName: Network Contributor
      principalId: ${exampleServicePrincipal.objectId}
  exampleCassandraCluster:
    type: azure:cosmosdb:CassandraCluster
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      delegatedManagementSubnetId: ${exampleSubnet.id}
      defaultAdminPassword: Password1234
    options:
      dependson:
        - ${exampleAssignment}
variables:
  exampleServicePrincipal:
    Fn::Invoke:
      Function: azuread:getServicePrincipal
      Arguments:
        displayName: Azure Cosmos DB

Create a CassandraCluster Resource

new CassandraCluster(name: string, args: CassandraClusterArgs, opts?: CustomResourceOptions);
@overload
def CassandraCluster(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     authentication_method: Optional[str] = None,
                     client_certificate_pems: Optional[Sequence[str]] = None,
                     default_admin_password: Optional[str] = None,
                     delegated_management_subnet_id: Optional[str] = None,
                     external_gossip_certificate_pems: Optional[Sequence[str]] = None,
                     external_seed_node_ip_addresses: Optional[Sequence[str]] = None,
                     identity: Optional[CassandraClusterIdentityArgs] = None,
                     location: Optional[str] = None,
                     name: Optional[str] = None,
                     repair_enabled: Optional[bool] = None,
                     resource_group_name: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     version: Optional[str] = None)
@overload
def CassandraCluster(resource_name: str,
                     args: CassandraClusterArgs,
                     opts: Optional[ResourceOptions] = 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.

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.

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

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.

AuthenticationMethod string

The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.

ClientCertificatePems List<string>

A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.

ExternalGossipCertificatePems List<string>

A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.

ExternalSeedNodeIpAddresses List<string>

A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.

Identity CassandraClusterIdentityArgs

An identity block as defined below.

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.

RepairEnabled bool

Is the automatic repair enabled on the Cassandra Cluster?

Tags Dictionary<string, string>

A mapping of tags assigned to the resource.

Version string

The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. 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.

AuthenticationMethod string

The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.

ClientCertificatePems []string

A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.

ExternalGossipCertificatePems []string

A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.

ExternalSeedNodeIpAddresses []string

A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.

Identity CassandraClusterIdentityArgs

An identity block as defined below.

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.

RepairEnabled bool

Is the automatic repair enabled on the Cassandra Cluster?

Tags map[string]string

A mapping of tags assigned to the resource.

Version string

The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. 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.

authenticationMethod String

The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.

clientCertificatePems List<String>

A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.

externalGossipCertificatePems List<String>

A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.

externalSeedNodeIpAddresses List<String>

A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.

identity CassandraClusterIdentityArgs

An identity block as defined below.

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.

repairEnabled Boolean

Is the automatic repair enabled on the Cassandra Cluster?

tags Map<String,String>

A mapping of tags assigned to the resource.

version String

The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. 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.

authenticationMethod string

The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.

clientCertificatePems string[]

A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.

externalGossipCertificatePems string[]

A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.

externalSeedNodeIpAddresses string[]

A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.

identity CassandraClusterIdentityArgs

An identity block as defined below.

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.

repairEnabled boolean

Is the automatic repair enabled on the Cassandra Cluster?

tags {[key: string]: string}

A mapping of tags assigned to the resource.

version string

The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. 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.

authentication_method str

The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.

client_certificate_pems Sequence[str]

A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.

external_gossip_certificate_pems Sequence[str]

A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.

external_seed_node_ip_addresses Sequence[str]

A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.

identity CassandraClusterIdentityArgs

An identity block as defined below.

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.

repair_enabled bool

Is the automatic repair enabled on the Cassandra Cluster?

tags Mapping[str, str]

A mapping of tags assigned to the resource.

version str

The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. 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.

authenticationMethod String

The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.

clientCertificatePems List<String>

A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.

externalGossipCertificatePems List<String>

A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.

externalSeedNodeIpAddresses List<String>

A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.

identity Property Map

An identity block as defined below.

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.

repairEnabled Boolean

Is the automatic repair enabled on the Cassandra Cluster?

tags Map<String>

A mapping of tags assigned to the resource.

version String

The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. 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 an 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,
        authentication_method: Optional[str] = None,
        client_certificate_pems: Optional[Sequence[str]] = None,
        default_admin_password: Optional[str] = None,
        delegated_management_subnet_id: Optional[str] = None,
        external_gossip_certificate_pems: Optional[Sequence[str]] = None,
        external_seed_node_ip_addresses: Optional[Sequence[str]] = None,
        identity: Optional[CassandraClusterIdentityArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        repair_enabled: Optional[bool] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        version: 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)
Resource lookup is not supported in YAML
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:
AuthenticationMethod string

The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.

ClientCertificatePems List<string>

A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.

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.

ExternalGossipCertificatePems List<string>

A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.

ExternalSeedNodeIpAddresses List<string>

A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.

Identity CassandraClusterIdentityArgs

An identity block as defined below.

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.

RepairEnabled bool

Is the automatic repair enabled on the Cassandra Cluster?

ResourceGroupName string

The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.

Tags Dictionary<string, string>

A mapping of tags assigned to the resource.

Version string

The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.

AuthenticationMethod string

The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.

ClientCertificatePems []string

A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.

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.

ExternalGossipCertificatePems []string

A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.

ExternalSeedNodeIpAddresses []string

A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.

Identity CassandraClusterIdentityArgs

An identity block as defined below.

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.

RepairEnabled bool

Is the automatic repair enabled on the Cassandra Cluster?

ResourceGroupName string

The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.

Tags map[string]string

A mapping of tags assigned to the resource.

Version string

The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.

authenticationMethod String

The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.

clientCertificatePems List<String>

A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.

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.

externalGossipCertificatePems List<String>

A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.

externalSeedNodeIpAddresses List<String>

A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.

identity CassandraClusterIdentityArgs

An identity block as defined below.

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.

repairEnabled Boolean

Is the automatic repair enabled on the Cassandra Cluster?

resourceGroupName String

The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.

tags Map<String,String>

A mapping of tags assigned to the resource.

version String

The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.

authenticationMethod string

The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.

clientCertificatePems string[]

A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.

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.

externalGossipCertificatePems string[]

A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.

externalSeedNodeIpAddresses string[]

A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.

identity CassandraClusterIdentityArgs

An identity block as defined below.

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.

repairEnabled boolean

Is the automatic repair enabled on the Cassandra Cluster?

resourceGroupName string

The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.

tags {[key: string]: string}

A mapping of tags assigned to the resource.

version string

The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.

authentication_method str

The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.

client_certificate_pems Sequence[str]

A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.

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.

external_gossip_certificate_pems Sequence[str]

A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.

external_seed_node_ip_addresses Sequence[str]

A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.

identity CassandraClusterIdentityArgs

An identity block as defined below.

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.

repair_enabled bool

Is the automatic repair enabled on the Cassandra Cluster?

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.

tags Mapping[str, str]

A mapping of tags assigned to the resource.

version str

The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.

authenticationMethod String

The authentication method that is used to authenticate clients. Possible values are None and Cassandra. Defaults to Cassandra.

clientCertificatePems List<String>

A list of TLS certificates that is used to authorize client connecting to the Cassandra Cluster.

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.

externalGossipCertificatePems List<String>

A list of TLS certificates that is used to authorize gossip from unmanaged Cassandra Data Center.

externalSeedNodeIpAddresses List<String>

A list of IP Addresses of the seed nodes in unmanaged the Cassandra Data Center which will be added to the seed node lists of all managed nodes.

identity Property Map

An identity block as defined below.

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.

repairEnabled Boolean

Is the automatic repair enabled on the Cassandra Cluster?

resourceGroupName String

The name of the Resource Group where the Cassandra Cluster should exist. Changing this forces a new Cassandra Cluster to be created.

tags Map<String>

A mapping of tags assigned to the resource.

version String

The version of Cassandra what the Cluster converges to run. Possible values are 3.11 and 4.0. Defaults to 3.11. Changing this forces a new Cassandra Cluster to be created.

Supporting Types

CassandraClusterIdentity

Type string

Specifies the type of Managed Service Identity that should be configured on this Cassandra Cluster. The only possible value is SystemAssigned.

PrincipalId string
TenantId string
Type string

Specifies the type of Managed Service Identity that should be configured on this Cassandra Cluster. The only possible value is SystemAssigned.

PrincipalId string
TenantId string
type String

Specifies the type of Managed Service Identity that should be configured on this Cassandra Cluster. The only possible value is SystemAssigned.

principalId String
tenantId String
type string

Specifies the type of Managed Service Identity that should be configured on this Cassandra Cluster. The only possible value is SystemAssigned.

principalId string
tenantId string
type str

Specifies the type of Managed Service Identity that should be configured on this Cassandra Cluster. The only possible value is SystemAssigned.

principal_id str
tenant_id str
type String

Specifies the type of Managed Service Identity that should be configured on this Cassandra Cluster. The only possible value is SystemAssigned.

principalId String
tenantId String

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.