Edit

Share via

Set-AzVmssStorageProfile

  • Reference
Module:
Az.Compute

Sets the storage profile properties for the VMSS.

Syntax

Set-AzVmssStorageProfile
   [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>
   [[-ImageReferencePublisher] <String>]
   [[-ImageReferenceOffer] <String>]
   [[-ImageReferenceSku] <String>]
   [[-ImageReferenceVersion] <String>]
   [[-OsDiskName] <String>]
   [[-OsDiskCaching] <CachingTypes>]
   [[-OsDiskCreateOption] <DiskCreateOptionTypes>]
   [[-OsDiskOsType] <OperatingSystemTypes>]
   [[-Image] <String>]
   [[-VhdContainer] <String[]>]
   [-ImageReferenceId <String>]
   [-OsDiskWriteAccelerator]
   [-ManagedDisk <StorageAccountTypes>]
   [-DataDisk <VirtualMachineScaleSetDataDisk[]>]
   [-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

PS C:\> 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.

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

-DataDisk

Specifies the data disk object.

Type:VirtualMachineScaleSetDataDisk[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

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

-Image

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

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

-ImageReferenceId

Specifies the image reference ID.

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

-ImageReferenceOffer

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

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

-ImageReferencePublisher

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

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

-ImageReferenceSku

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

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

-ImageReferenceVersion

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

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

-ManagedDisk

Specifies the managed disk.

Type:StorageAccountTypes
Accepted values:StandardLRS, PremiumLRS
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:CachingTypes
Accepted values:None, ReadOnly, ReadWrite
Position:6
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.
Type:DiskCreateOptionTypes
Accepted values:FromImage, Empty, Attach
Position:7
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-OsDiskName

Specifies the name of the operating system disk.

Type:String
Aliases:Name
Position:5
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:OperatingSystemTypes
Accepted values:Windows, Linux
Position:8
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-OsDiskWriteAccelerator

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

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

-VhdContainer

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

Type:String[]
Position:10
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VirtualMachineScaleSet

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

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

Inputs

None

This cmdlet does not generate any output.

Outputs

PSVirtualMachineScaleSet