Update-AzManagedCassandraCluster

Module:

Az.CosmosDB Module

Update an existing Azure Managed Instances for Apache Cassandra cluster.

Syntax

ByNameParameterSet (Default)

Update-AzManagedCassandraCluster
    -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>]

ByResourceIdParameterSet

Update-AzManagedCassandraCluster
    -ResourceId <String>
    [-Tag <Hashtable>]
    [-ExternalGossipCertificate <String[]>]
    [-ClientCertificate <String[]>]
    [-RepairEnabled <Boolean>]
    [-TimeBetweenBackupInHours <Int32>]
    [-AuthenticationMethod <String>]
    [-CassandraVersion <String>]
    [-ExternalSeedNode <String[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObjectParameterSet

Update-AzManagedCassandraCluster
    -InputObject <PSClusterResource>
    [-Tag <Hashtable>]
    [-ExternalGossipCertificate <String[]>]
    [-ClientCertificate <String[]>]
    [-RepairEnabled <Boolean>]
    [-TimeBetweenBackupInHours <Int32>]
    [-AuthenticationMethod <String>]
    [-CassandraVersion <String>]
    [-ExternalSeedNode <String[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Update-AzManagedCassandraCluster cmdlet alters an existing managed Cassandra cluster.

Examples

Example 1

Update-AzManagedCassandraCluster `
 -ResourceGroupName "resourceGroupName" `
 -ClusterName "clusterName" `
 -ExternalGossipCertificate "certificates" `
 -ClientCertificate "certificates" `
 -RepairEnabled $true

Example 2

Update-AzManagedCassandraCluster `
 -ResourceId "clusterResourceId" `
 -ExternalGossipCertificate "certificates" `
 -ClientCertificate "certificates" `
 -RepairEnabled $true

Example 3

$clusterResource | Update-AzManagedCassandraCluster `
 -ExternalGossipCertificate "certificates" `
 -ClientCertificate "certificates" `
 -RepairEnabled $true

Parameters

-AuthenticationMethod

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

Parameter properties

Type:	String
Default value:	Cassandra
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CassandraVersion

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

Parameter properties

Type:	String
Default value:	3.11
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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.

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ClusterName

Name of the managed Cassandra cluster.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByNameParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

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

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ExternalGossipCertificate

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

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ExternalSeedNode

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

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Managed Cassandra Cluster object

Parameter properties

Type:	PSClusterResource
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByObjectParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	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.

Parameter properties

Type:	Nullable<T>[Boolean]
Default value:	True
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

Name of resource group.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByNameParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceId

ResourceId of the resource.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByResourceIdParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Tag

Hashtable of tags to set on the data center resource.

Parameter properties

Type:	Hashtable
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-TimeBetweenBackupInHours

Hours between taking full backups of the cluster.

Parameter properties

Type:	Nullable<T>[Int32]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSClusterResource

Outputs

PSClusterResource