Edit

Share via

Get-AzManagedCassandraCluster

Module:
Az.CosmosDB Module

Gets a Azure Managed Instances for Apache Cassandra cluster.

Syntax

ByNameParameterSet (Default) 

Get-AzManagedCassandraCluster
    [-ResourceGroupName <String>]
    [-ClusterName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByResourceIdParameterSet 

Get-AzManagedCassandraCluster
    -ResourceId <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByObjectParameterSet 

Get-AzManagedCassandraCluster
    -InputObject <PSClusterResource>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzManagedCassandraCluster cmdlet fetches the properties of an existing managed Cassandra cluster.

Examples

Example 1

Get-AzManagedCassandraCluster -ResourceGroupName "resourceGroupName" -ClusterName "clusterName"

Example 2

Get-AzManagedCassandraCluster -ResourceId "resourceId"

Example 3

$clusterResource | Get-AzManagedCassandraCluster

Parameters

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

-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

-ResourceGroupName

Name of resource group.

Parameter properties

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

Parameter sets

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

-ResourceId

Resource id of the managed Cassandra cluster.

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

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