New-AzManagedCassandraCluster

Reference

Module:: Az.CosmosDB

Creates a new Azure Managed Instances for Apache Cassandra cluster.

Syntax

PowerShell

New-AzManagedCassandraCluster
   -Location <String>
   -DelegatedManagementSubnetId <String>
   [-InitialCassandraAdminPassword <String>]
   [-ClusterNameOverride <String>]
   [-RestoreFromBackupId <String>]
   -ResourceGroupName <String>
   -ClusterName <String>
   [-Tag <Hashtable>]
   [-ExternalGossipCertificate <String[]>]
   [-ClientCertificate <String[]>]
   [-RepairEnabled <Boolean>]
   [-TimeBetweenBackupInHours <Int32>]
   [-AuthenticationMethod <String>]
   [-CassandraVersion <String>]
   [-ExternalSeedNode <String[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzManagedCassandraCluster cmdlet creates a new managed Cassandra cluster.

Examples

Example 1

PowerShell

New-AzManagedCassandraCluster `
 -ResourceGroupName "resourceGroupName" `
 -ClusterName "clusterName" `
 -DelegatedManagementSubnetId "resourceId" `
 -Location "location" `
 -InitialCassandraAdminPassword "password"

Parameters

-AuthenticationMethod

How to authenticate clients, one of Cassandra (for password authentication), Ldap (for LDAP/AD authentication), or None (for no authentication required).

Type:	String
Position:	Named
Default value:	Cassandra
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CassandraVersion

Which version of Cassandra to run. Currently only 3.11 is supported.

Type:	String
Position:	Named
Default value:	3.11
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClientCertificate

The list of TLS certificates to use to authenticate clients. If this is omitted, all client connections still connect with TLS, but are not required to provide valid client certificates. If this is provided, clients most provide a valid TLS client certificate to connect to the cluster.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClusterName

Name of the managed Cassandra cluster.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ClusterNameOverride

If the cluster name in cassandra.yaml needs to be different than the argument of -ClusterName, use this property to set.

Type:	String
Position:	Named
Default value:	Same as -ClusterName
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DelegatedManagementSubnetId

The resource id of the virtual network subnet where managed Cassandra should attach network interfaces.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ExternalGossipCertificate

A list of additional TLS certificates the managed Cassandra cluster will use to authenticate gossip.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExternalSeedNode

List of IP addresses of external seed nodes to bridge this cluster to.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InitialCassandraAdminPassword

The initial password for the admin account on the cluster if the cluster is using password auth.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Location

The location to create the managed Cassandra cluster in.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-RepairEnabled

If true, managed Cassandra will run reaper to repair the database regularly. This should only be disabled for hybrid clusters which run their own repair process outside of Azure.

Type:	Nullable<T>[Boolean]
Position:	Named
Default value:	True
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Name of resource group.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-RestoreFromBackupId

Resource id of backup to restore into this cluster. If omitted, creates a new, empty cluster.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

Hashtable of tags to set on the cluster resource.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TimeBetweenBackupInHours

Hours between taking full backups of the cluster.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

PSClusterResource

Share via