Edit

Share via

Get-AzConnectedVMwareCluster

Module:
Az.ConnectedVMware Module

Implements cluster GET method.

Syntax

List (Default) 

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

Get 

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

List1 

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

GetViaIdentity 

Get-AzConnectedVMwareCluster
    -InputObject <IConnectedVMwareIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Implements cluster GET method.

Examples

Example 1: List Clusters in current subscription

Get-AzConnectedVMwareCluster -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d"

Kind   Location      Name                                                             ResourceGroupName
----   --------      ----                                                             -----------------
       eastus        test-cluster1                                                    test-rg1
       eastus        test-cluster2                                                    test-rg2
       eastus        test-cluster3                                                    test-rg3
       eastus        test-cluster4                                                    test-rg4
       eastus        test-cluster5                                                    test-rg5
       eastus        test-cluster6                                                    test-rg6
       eastus        test-cluster7                                                    test-rg7
       eastus        test-cluster8                                                    test-rg8

This command lists Clusters in current subscription.

Example 2: List Clusters in a resource group

Get-AzConnectedVMwareCluster -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d"

Kind   Location Name          ResourceGroupName
----   -------- ----          -----------------
       eastus   test-cluster1 test-rg
       eastus   test-cluster2 test-rg

This command lists Clusters in a resource group named test-rg.

Example 3: Get a specific Cluster

Get-AzConnectedVMwareCluster -Name "test-cluster" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d"

CustomResourceName           : dd163232-210f-4f82-8b0c-9866a2eac862
DatastoreId                  :
ExtendedLocationName         : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl
ExtendedLocationType         : CustomLocation
Id                           : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/clusters/test-cluster
InventoryItemId              :
Kind                         :
Location                     : eastus2euap
MoName                       : Cluster-1
MoRefId                      : domain-c7
Name                         : test-cluster
NetworkId                    :
ProvisioningState            : Succeeded
ResourceGroupName            : test-rg
Statuses                     : {{
                                 "type": "Ready",
                                 "status": "True",
                                 "lastUpdatedAt": "2021-08-25T09:48:12.9989085Z"
                               }, {
                                 "type": "Idle",
                                 "status": "True",
                                 "lastUpdatedAt": "2021-08-25T09:48:12.9989085Z"
                               }}
SystemDataCreatedAt          : 8/25/2021 9:38:06 AM
SystemDataCreatedBy          : xyz
SystemDataCreatedByType      : User
SystemDataLastModifiedAt     : 8/25/2021 9:48:13 AM
SystemDataLastModifiedBy     : ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7
SystemDataLastModifiedByType : Application
Tag                          : {
                               }
TotalCpuMHz                  :
TotalMemoryGb                :
Type                         : microsoft.connectedvmwarevsphere/clusters
UsedCpuMHz                   :
UsedMemoryGb                 :
Uuid                         : dd163232-210f-4f82-8b0c-9866a2eac862
VCenterId                    : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/test-vc

This command gets a Cluster named test-cluster in a resource group named test-rg.

Parameters

-DefaultProfile

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

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases: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

Identity Parameter

Parameter properties

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

Parameter sets

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

-Name

Name of the cluster.

Parameter properties

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

Parameter sets

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

-ResourceGroupName

The Resource Group Name.

Parameter properties

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

Parameter sets

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

-SubscriptionId

The Subscription ID.

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

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

IConnectedVMwareIdentity

Outputs

ICluster