Set-AzDiskImageReference

Reference

Module:: Az.Compute

Sets the image reference properties on a disk object.

Syntax

Set-AzDiskImageReference
   [-Disk] <PSDisk>
   [[-Id] <String>]
   [[-Lun] <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzDiskImageReference cmdlet sets the image reference properties on a disk object.

Examples

Example 1

$diskconfig = New-AzDiskConfig -Location "East US" -DiskSizeGB 10 -AccountType Premium_LRS -OsType Windows -CreateOption FromImage
$image = '/Subscriptions/00000000-0000-0000-0000-000000000000/Providers/Microsoft.Compute/Locations/westeurope/Publishers/MicrosoftWindowsDesktop/ArtifactTypes/VMImage/Offers/Windows-10/Skus/win10-21h2-avd-g2/Versions/19044.1526.220204'
$diskconfig = Set-AzDiskImageReference -Disk $diskconfig -Id $image -Lun 0
New-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig

The first command creates a local disk object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type. The second command sets the image id and the logical unit number 0 for the disk object. The last command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'.

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

-DefaultProfile

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

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

-Disk

Specifies a local disk object.

Type:	PSDisk
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Id

Specifies the ID of PIR or user image.

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

-Lun

Specifies the logical unit number (LUN). If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.

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

PSDisk

String

Int32

Outputs