Set-AzVmssStorageProfile

Syntax

Default (Default)

Set-AzVmssStorageProfile
 [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>
 [[-ImageReferencePublisher] <String>]
 [[-ImageReferenceOffer] <String>]
 [[-ImageReferenceSku] <String>]
 [[-ImageReferenceVersion] <String>]
 [[-OsDiskName] <String>]
 [[-OsDiskCaching] <CachingTypes>]
 [[-OsDiskCreateOption] <String>]
 [-OsDiskDeleteOption <String>]
 [[-OsDiskOsType] <OperatingSystemTypes>]
 [[-Image] <String>]
 [[-VhdContainer] <String[]>]
 [-ImageReferenceId <String>]
 [-OsDiskWriteAccelerator]
 [-DiffDiskSetting <String>]
 [-DiffDiskPlacement <String>]
 [-ManagedDisk <String>]
 [-DiskEncryptionSetId <String>]
 [-DataDisk <VirtualMachineScaleSetDataDisk[]>]
 [-OSDiskSizeGB <Int32>]
 [-DiskControllerType <String>]
 [-SecurityEncryptionType <String>]
 [-SecureVMDiskEncryptionSet <String>]
 [-SharedGalleryImageId <String>]
 [-OsDiskStorageFaultDomainAlignment <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Examples

Example 1: Set the storage profile properties for the VMSS

Set-AzVmssStorageProfile -VirtualMachineScaleSet "ContosoVMSS" -Name "Test" -OsDiskCreateOption "FromImage" -OsDiskCaching "None" `
 -ImageReferenceOffer $ImgRef.Offer -ImageReferenceSku $ImgRef.Skus -ImageReferenceVersion $ImgRef.Version `
 -ImageReferencePublisher $ImgRef.PublisherName -VhdContainer $VhdContainer

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Parameter sets

-DataDisk

Specifies the data disk object.

Parameter properties

Parameter sets

-DefaultProfile

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

Parameter properties

Parameter sets

-DiffDiskPlacement

Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e. cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. This parameter can only be used if the parameter DiffDiskSetting is set to 'Local'.

Parameter properties

Parameter sets

-DiffDiskSetting

Specifies the differencing disk settings for operating system disk.

Parameter properties

Parameter sets

-DiskControllerType

Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://learn.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://learn.microsoft.com/rest/api/compute/resourceskus/list) .
For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes.

Parameter properties

Parameter sets

-DiskEncryptionSetId

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

Parameter properties

Parameter sets

-Image

Specifies the blob URI for the user image. VMSS creates an operating system disk in the same container of the user image.

Parameter properties

Parameter sets

-ImageReferenceId

Specifies the image reference ID.

Parameter properties

Parameter sets

-ImageReferenceOffer

Specifies the type of virtual machine image (VMImage) offer. To obtain an image offer, use the Get-AzVMImageOffer cmdlet.

Parameter properties

Parameter sets

-ImageReferencePublisher

Specifies the name of a publisher of a VMImage. To obtain a publisher, use the Get-AzVMImagePublisher cmdlet.

Parameter properties

Parameter sets

-ImageReferenceSku

Specifies the VMImage SKU. To obtain SKUs, use the Get-AzVMImageSku cmdlet.

Parameter properties

Parameter sets

-ImageReferenceVersion

Specifies the version of the VMImage. To use the latest version, specify a value of latest instead of a particular version.

Parameter properties

Parameter sets

-ManagedDisk

Specifies the managed disk.

Parameter properties

Parameter sets

-OsDiskCaching

Specifies the caching mode of the operating system disk. The acceptable values for this parameter are:

• ReadOnly
• ReadWrite The default value is ReadWrite. If you change the caching value, the cmdlet will restart the virtual machine. This setting affects the consistency and performance of the disk.

Parameter properties

Parameter sets

-OsDiskCreateOption

Specifies how this cmdlet creates the VMSS virtual machines. The acceptable values for this parameter are:

• Attach : This value is used when you are using a specialized disk to create the VMSS virtual machine.
• FromImage : This value is used when you are using an image to create the VMSS virtual machine. If you are using a platform image, you will also use the imageReference parameter.

Parameter properties

Parameter sets

-OsDiskDeleteOption

Specifies whether OS disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Accepted Values Delete - If this value is used, the OS disk is deleted when the VMSS Flex VM is deleted. Detach - If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

Parameter properties

Parameter sets

-OsDiskName

Specifies the name of the operating system disk.

Parameter properties

Parameter sets

-OsDiskOsType

Specifies the type of operating system on the disk. This is only needed for user image scenarios and not for a platform image.

Parameter properties

Parameter sets

-OSDiskSizeGB

Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

Parameter properties

Parameter sets

-OsDiskStorageFaultDomainAlignment

Specifies the storage fault domain alignment type for the OS disk in the VMSS template. Valid values are 'Aligned' and 'BestEffortAligned'. 'Aligned' maps disk Storage Fault Domains to Compute Fault Domains; deployment fails if disk doesn't support enough FDs. 'BestEffortAligned' attempts mapping but leaves the disk unaligned if it doesn't support enough FDs. Applicable to VMSS Flex only.

Parameter properties

Parameter sets

-OsDiskWriteAccelerator

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

Parameter properties

Parameter sets

-SecureVMDiskEncryptionSet

ResourceId of the disk encryption set to use for enabling encryption at rest.

Parameter properties

Parameter sets

-SecurityEncryptionType

Sets the SecurityEncryptionType of the virtual machine scale set. Possible values include: DiskWithVMGuestState, VMGuestStateOnly

Parameter properties

Parameter sets

-SharedGalleryImageId

Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.

Parameter properties

Parameter sets

-VhdContainer

Specifies the container URLs that are used to store operating system disks for the VMSS.

Parameter properties

Parameter sets

-VirtualMachineScaleSet

Specifies the VMSS object. To obtain the object, use the New-AzVmssConfig object.

Parameter properties

Parameter sets

-WhatIf

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

Parameter properties

Parameter sets

CommonParameters

Inputs

PSVirtualMachineScaleSet

String

Nullable<T>

Nullable<T>

String

VirtualMachineScaleSetDataDisk

Outputs

PSVirtualMachineScaleSet

Related Links

• Get-AzVMImageOffer
• Get-AzVMImagePublisher
• Get-AzVMImageSku
• New-AzVmssConfig