Get-AzStackHciCluster

Module:

Az.StackHCI

Get HCI cluster.

Syntax

Get-AzStackHciCluster
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzStackHciCluster
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzStackHciCluster
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzStackHciCluster
   -InputObject <IStackHciIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get HCI cluster.

Examples

Example 1:

Get-AzStackHciCluster -ResourceGroupName test-rg

Location   Name       Resource Group
--------   ----       -----------------
eastus     myCluster3 test-rg
eastus     myCluster  test-rg
westeurope myCluster2 test-rg

Gets all the clusters in a RG

Example 2:

Get-AzStackHciCluster -ResourceGroupName test-rg -ClusterName myCluster

Location Name      Resource Group
-------- ----      -----------------
eastus   myCluster test-rg

Gets the details of a particular cluster. To see the details use : "Write-Host( $cluster | Format-List | Out-String)"

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-Name

The name of the cluster.

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IStackHciIdentity

Outputs

ICluster