New-AzStackHCIVMVirtualHardDisk

Reference

Module:: Az.StackHCIVM

The operation to create or update a virtual hard disk. Please note some properties can be set only during virtual hard disk creation.

Syntax

New-AzStackHCIVMVirtualHardDisk
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -Location <String>
   -CustomLocationId <String>
   [-BlockSizeByte <Int32>]
   [-StoragePathId <String>]
   [-StoragePathName <String>]
   [-StoragePathResourceGroup <String>]
   [-DiskFileFormat <Object>]
   [-SizeGb <Int64>]
   [-Dynamic]
   [-HyperVGeneration <Object>]
   [-LogicalSectorByte <Int32>]
   [-PhysicalSectorByte <Int32>]
   [-Tag <Hashtable>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The operation to create or update a virtual hard disk. Please note some properties can be set only during virtual hard disk creation.

Examples

Example 1: Create a Virtual Hard Disk

New-AzStackHCIVMVirtualHardDisk -Name "testVhd" -ResourceGroupName "test-rg" -CustomLocationId "/subscriptions/{subscriptionID}/resourcegroups/{resourceGroupName}/providers/microsoft.extendedlocation/customlocations/{customLocationName}" -Location "eastus" -SizeGb 2

Name            ResourceGroupName
----            -----------------
testVhd       test-rg

This command creates a virtual hard disk in the specified resource group.

Parameters

-AsJob

Run the command as a job

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

-BlockSizeByte

The block size, in bytes, of the virtual hard disk.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomLocationId

The ARM Id of the extended location to create virtual hard disk resource in.

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

-DefaultProfile

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

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

-DiskFileFormat

The format of the actual VHD file [vhd, vhdx]

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

-Dynamic

Boolean for enabling dynamic sizing on the virtual hard disk

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

-HyperVGeneration

The hypervisor generation of the Virtual Machine [V1, V2]

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

-Location

The geo-location where the resource lives

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

-LogicalSectorByte

Logical Sector Bytes of the Disk

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

-Name

Name of the virtual hard disk.

Must contain all alphanumeric characters or '-' or '_'. Max length is 80 characters, and min length is 1 character.

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

-NoWait

Run the command asynchronously

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

-PhysicalSectorByte

Physical Sector Bytes of the Disk

Type:	Int32
Position:	Named
Default value:	None
Required:	False
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

-SizeGb

Size of the disk in GB

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

-StoragePathId

Storage ContainerID of the storage container to be used for VHD

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

-StoragePathName

Storage Container Name to be used for the VHD

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

-StoragePathResourceGroup

Storage Container resource group. The resource group of the virtual hard disk will be used if this value is not provided.

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

-SubscriptionId

The ID of the target subscription.

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

-Tag

Resource tags.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

IVirtualHardDisks

Share via