Edit

New-AzHost

  • Reference
Module:
Az.Compute

Creates a host.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

New-AzHost
   [-ResourceGroupName] <String>
   [-HostGroupName] <String>
   [-Name] <String>
   [-Location] <String>
   -Sku <String>
   [-PlatformFaultDomain <Int32>]
   [-AutoReplaceOnFailure <Boolean>]
   [-LicenseType <DedicatedHostLicenseTypes>]
   [-Tag <Hashtable>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

This cmdlet will create a Host.

Examples

Example 1

New-AzHost -ResourceGroupName $resourceGroupName -HostGroupName $hostGroupName -Name $hostName -Location $location -Sku $skuName

ResourceGroupName    : myrg01
PlatformFaultDomain  : 0
AutoReplaceOnFailure : True
HostId               : 00000000-0000-0000-0000-000000000000
ProvisioningTime     : 7/25/2019 8:34:16 PM
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 creates a host of the given Sku in the given host group and the given location.

Parameters

-AsJob

Run cmdlet in the background

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AutoReplaceOnFailure

Specifies whether the host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-HostGroupName

Specifies the name of the host group.

Type:String
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-LicenseType

Specifies the software license type that will be applied to the VMs deployed on the host. Possible values are: None, Windows_Server_Hybrid, and Windows_Server_Perpetual. Default value is None.

Type:DedicatedHostLicenseTypes
Accepted values:None, WindowsServerHybrid, WindowsServerPerpetual
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Location

Specifies the location.

Type:String
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the host.

Type:String
Aliases:HostName
Position:2
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-PlatformFaultDomain

Specifies the number of platform fault domain of the host. Then minimum value is 0 and the maximum value is 2.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

The name of the resource group.

Type:String
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Sku

Specifies the name of the SKU.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Tag

Specifies Tags.

Type:Hashtable
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

PSHost