Edit

Share via

Get-AzVMwareHost

Module:
Az.VMware Module

Get a Host

Syntax

List (Default) 

Get-AzVMwareHost
    -ClusterName <String>
    -PrivateCloudName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityPrivateCloud 

Get-AzVMwareHost
    -ClusterName <String>
    -Id <String>
    -PrivateCloudInputObject <IVMwareIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get 

Get-AzVMwareHost
    -ClusterName <String>
    -Id <String>
    -PrivateCloudName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityCluster 

Get-AzVMwareHost
    -Id <String>
    -ClusterInputObject <IVMwareIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

Get-AzVMwareHost
    -InputObject <IVMwareIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get a Host

Examples

Example 1: List all hosts in a cluster

Get-AzVMwareHost -ClusterName azps_test_cluster -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group

Name                                                       Type                                       SkuName ResourceGroupName Kind          Maintenance
----                                                       ----                                       ------- ----------------- ------------- -----------
esx03-r52.1111111111111111111.westcentralus.prod.azure.com Microsoft.AVS/privateClouds/clusters/hosts av64    azps_test_group    General
esx03-r60.1111111111111111111.westcentralus.prod.azure.com Microsoft.AVS/privateClouds/clusters/hosts av64    azps_test_group    General      Replacement
esx03-r65.1111111111111111111.westcentralus.prod.azure.com Microsoft.AVS/privateClouds/clusters/hosts         azps_test_group    Specialized

Lists all hosts in the specified cluster within the private cloud and resource group.

Example 2: Get a host by ID in a cluster

Get-AzVMwareHost -ClusterName azps_test_cluster -Id esx03-r52.1111111111111111111.westcentralus.prod.azure.com -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group

Name                                                       Type                                       ResourceGroupName SkuName Kind
----                                                       ----                                       ----------------- ------- ----
esx03-r52.1111111111111111111.westcentralus.prod.azure.com Microsoft.AVS/privateClouds/clusters/hosts azps_test_group   av64    General

Gets a specific host by its ID in the specified cluster, private cloud, and resource group.

Parameters

-ClusterInputObject

Identity Parameter

Parameter properties

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

Parameter sets

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

-ClusterName

Name of the cluster

Parameter properties

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

Parameter sets

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

-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

-Id

The host identifier.

Parameter properties

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

Parameter sets

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

-InputObject

Identity Parameter

Parameter properties

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

-PrivateCloudInputObject

Identity Parameter

Parameter properties

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

Parameter sets

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

-PrivateCloudName

Name of the private cloud

Parameter properties

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

Parameter sets

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

-ResourceGroupName

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

Parameter properties

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

Parameter sets

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

-SubscriptionId

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

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

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

IVMwareIdentity

Outputs

IHost