Get-AzHost
Get or list hosts.
Syntax
DefaultParameter (Default)
Get-AzHost
[-ResourceGroupName] <String>
[-HostGroupName] <String>
[[-Name] <String>]
[-InstanceView]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ResourceIdParameter
Get-AzHost
[-ResourceId] <String>
[-InstanceView]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
This cmdlet will get a host in a host group. This cmdlet also lists all hosts in a host group if a host name is not given.
Examples
Example 1
Get-AzHost -ResourceGroupName $resourceGroupName -HostGroupName $hostGroupName -Name $hostName
ResourceGroupName : myrg01
PlatformFaultDomain : 1
AutoReplaceOnFailure : True
HostId : 00000000-0000-0000-0000-000000000000
VirtualMachines[0] :
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg01/providers/Microsoft.Compute/virtualMachines/myvm01
VirtualMachines[1] :
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg01/providers/Microsoft.Compute/virtualMachines/myvm02
ProvisioningTime : 7/27/2019 3:22:59 AM
ProvisioningState : Succeeded
Sku :
Name : ESv3-Type1
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg01/providers/Microsoft.Compute/hostGroups/myhostgroup01/hosts/myhost01
Name : myhost01
Location : eastus
Tags : {"key1":"val2"}
This command returns a host.
Example 2
Get-AzHost -ResourceGroupName $resourceGroupName -HostGroupName $hostGroupName -Name $hostName -InstanceView
ResourceGroupName : myrg01
PlatformFaultDomain : 0
AutoReplaceOnFailure : True
HostId : 00000000-0000-0000-0000-000000000000
ProvisioningTime : 8/19/2019 9:13:19 PM
ProvisioningState : Succeeded
InstanceView :
AssetId : 00000000-0000-0000-0000-000000000000
AvailableCapacity :
AllocatableVMs[0] :
VmSize : Standard_E2s_v3
Count : 28
AllocatableVMs[1] :
VmSize : Standard_E4-2s_v3
Count : 14
AllocatableVMs[2] :
VmSize : Standard_E4s_v3
Count : 14
Statuses[0] :
Code : ProvisioningState/succeeded
Level : Info
DisplayStatus : Provisioning succeeded
Time : 8/19/2019 9:13:19 PM
Statuses[1] :
Code : HealthState/available
Level : Info
DisplayStatus : Host available
Sku :
Name : ESv3-Type1
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg01/providers/Microsoft.Compute/hostGroups/myhostgroup01/hosts/myhost01
Name : crptestps2264host
Location : eastus
Tags : {"key1":"val2"}
This command returns the instance view of a host.
Example 3
Get-AzHost -ResourceGroupName $resourceGroupName -HostGroupName $hostGroupName
ResourceGroupName Name Location Tags Sku FD
----------------- ---- -------- ---- --- --
myrg01 myhost01 eastus {[key1, val2]} ESv3-Type1 0
myrg01 myhost02 eastus {[key1, val2]} ESv3-Type1 1
This command returns all hosts in the given host group.
Example 4: This command returns a Host for provided -ResourceId.
$rgname = "rgname"
$loc = "eastus"
$hostGroupName = $rgname + "HostGroup"
$hostName = $rgname + "Host"
$Sku = "ESv3-Type1"
# Create Hostgroup and Hostgroupname
New-AzHostGroup -ResourceGroupName $rgname -Name $hostGroupName -Location $loc -PlatformFaultDomain 1 -Zone "2"
New-AzHost -ResourceGroupName $rgname -HostGroupName $hostGroupName -Name $hostName -Location $loc -Sku $Sku
# Fetch Host using -ResourceId
$dedicatedHost = Get-AzHost -ResourceGroupName $rgname -HostGroupName $hostGroupName -Name $hostName
$host = Get-AzHost -ResourceId $dedicatedHost.Id
ResourceGroupName : rgname
PlatformFaultDomain : 0
AutoReplaceOnFailure : True
HostId : 0730655b-051d-4559-a83a-5d579d15fec2
ProvisioningTime : 10/14/2022 7:28:47 AM
ProvisioningState : Succeeded
Sku :
Name : ESv3-Type1
Id : /subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/rgname/providers/Microsoft.Compute/hostGroups/rgnameHostGroup/hosts/rgnameHost
Name : rgnameHost
Type : Microsoft.Compute/hostGroups/hosts
Location : eastus
Tags : {}
Parameters
-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 |
-HostGroupName
The name of the host group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
DefaultParameter
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-InstanceView
Indicates that this cmdlet gets only the instance view of the host.
Parameter properties
| Type: | SwitchParameter |
| 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 |
-Name
The name of the host.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | HostName |
Parameter sets
DefaultParameter
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
The name of the resource group
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
DefaultParameter
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceId
The ID of the resource.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ResourceIdParameter
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| 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.
