Set-AzVmssStorageProfile
Sets the storage profile properties for the VMSS.
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>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzVmssStorageProfile cmdlet sets the storage profile properties for the Virtual Machine Scale Set (VMSS).
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
This command sets the storage profile properties for the VMSS named ContosoVMSS.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DataDisk
Specifies the data disk object.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-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
-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
Type: String
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: True Value from remaining arguments: False
-DiffDiskSetting
Specifies the differencing disk settings for operating system disk.
Parameter properties
Type: String
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: True Value from remaining arguments: False
-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 ) . https://aka.ms/azure-diskcontrollertypes .
Parameter properties
Type: String
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
-DiskEncryptionSetId
Specifies the resource Id of customer managed disk encryption set. This can only be specified for managed disk.
Parameter properties
Type: String
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: True Value from remaining arguments: False
-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
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 9 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ImageReferenceId
Specifies the image reference ID.
Parameter properties
Type: String
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: True Value from remaining arguments: False
-ImageReferenceOffer
Specifies the type of virtual machine image (VMImage) offer.
To obtain an image offer, use the Get-AzVMImageOffer cmdlet.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 2 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ImageReferencePublisher
Specifies the name of a publisher of a VMImage.
To obtain a publisher, use the Get-AzVMImagePublisher cmdlet.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 1 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ImageReferenceSku
Specifies the VMImage SKU.
To obtain SKUs, use the Get-AzVMImageSku cmdlet.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 3 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ImageReferenceVersion
Specifies the version of the VMImage.
To use the latest version, specify a value of latest instead of a particular version.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 4 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ManagedDisk
Specifies the managed disk.
Parameter properties
Type: String
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: True Value from remaining arguments: False
-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
Type: Nullable<T> [ CachingTypes ]
Default value: None Accepted values: None, ReadOnly, ReadWrite Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 6 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-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
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 7 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-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
Type: String
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: True Value from remaining arguments: False
-OsDiskName
Specifies the name of the operating system disk.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: Name
Parameter sets
(All)
Position: 5 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-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
(All)
Position: 8 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-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
Type: Int32
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: True Value from remaining arguments: False
-OsDiskWriteAccelerator
Specifies whether WriteAccelerator should be enabled or disabled on the OS disk.
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
-SecureVMDiskEncryptionSet
ResourceId of the disk encryption set to use for enabling encryption at rest.
Parameter properties
Type: String
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: True Value from remaining arguments: False
-SecurityEncryptionType
Sets the SecurityEncryptionType of the virtual machine scale set. Possible values include: DiskWithVMGuestState, VMGuestStateOnly
Parameter properties
Type: String
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: True Value from remaining arguments: False
-SharedGalleryImageId
Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.
Parameter properties
Type: String
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
-VhdContainer
Specifies the container URLs that are used to store operating system disks for the VMSS.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 10 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-VirtualMachineScaleSet
Specifies the VMSS object.
To obtain the object, use the New-AzVmssConfig object.
Parameter properties
Parameter sets
(All)
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False 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 .
Outputs
