Add-AzVmssDataDisk

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Module:

Az.Compute

Adds a data disk to the VMSS.

Syntax

Add-AzVmssDataDisk
   [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>
   [[-Name] <String>]
   [[-Lun] <Int32>]
   [[-Caching] <CachingTypes>]
   [-WriteAccelerator]
   [-CreateOption <String>]
   [-DiskSizeGB <Int32>]
   [-DiskIOPSReadWrite <Int64>]
   [-DiskMBpsReadWrite <Int64>]
   [-StorageAccountType <String>]
   [-DiskEncryptionSetId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-AzVmssDataDisk cmdlet adds a data disk to the Virtual Machine Scale Set (VMSS) instance.

Examples

Example 1: Add a data disk

$vmss = New-AzVmssConfig -Location $Loc -SkuCapacity 2 -SkuName "Standard_A0" -UpgradePolicyMode "Automatic"
$vmss = Add-AzVmssDataDisk -VirtualMachineScaleSet $vmss -Name 'DataDisk1' -Lun 0 -Caching 'ReadOnly' -CreateOption Empty -DiskSizeGB 10 -StorageAccountType StandardLRS

This command adds an empty data disk to the VMSS object.

Parameters

-Caching

Specifies the caching type of the disk.

Type:	Nullable<T>[CachingTypes]
Accepted values:	None, ReadOnly, ReadWrite
Position:	3
Default value:	None
Accept pipeline input:	True
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

-CreateOption

Specifies the create option of the disk.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	True
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

-DiskEncryptionSetId

Specifies the resource Id of customer managed disk encryption set. This can only be specified for managed disk.

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

-DiskIOPSReadWrite

Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.

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

-DiskMBpsReadWrite

Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.

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

-DiskSizeGB

Specifies the size of the disk in GB.

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

-Lun

Specifies the logical unit number of the disk.

Type:	Int32
Position:	2
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Specifies the name of the disk.

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

-StorageAccountType

Specifies the storage account type of the disk.

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

-VirtualMachineScaleSet

Specify the VMSS object. You can use the New-AzVmssConfig cmdlet to create the object.

Type:	PSVirtualMachineScaleSet
Position:	0
Default value:	None
Accept pipeline input:	True
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

-WriteAccelerator

Specifies whether WriteAccelerator should be enabled or disabled on the data disk.

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

Inputs

PSVirtualMachineScaleSet

String

Int32

Nullable<T>[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]

Outputs

PSVirtualMachineScaleSet