Set-AzureRmImageOsDisk

NAME Set-AzureRmImageOsDisk



SYNOPSIS

Sets the operating system disk properties on an image object.





SYNTAX

Set-AzureRmImageOsDisk [-Image] <PSImage> [[-OsType] {Windows | Linux}] [[-OsState] {Generalized | Specialized}] [[-BlobUri] <String>] [-Caching

{None | ReadOnly | ReadWrite}] [-DefaultProfile <IAzureContextContainer>] [-DiskSizeGB <Int32>] [-ManagedDiskId <String>] [-SnapshotId <String>]

[-StorageAccountType <String>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Set-AzureRmImageOsDisk cmdlet sets the operating system disk properties on an image object.





PARAMETERS

-BlobUri <String>

Specifies the Uri of the blob.



Required? false

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Caching <CachingTypes>

Specifies the caching mode of the disk.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DiskSizeGB <Int32>

Specifies the size of the disk in GB.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Image <PSImage>

Specifies a local image object.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-ManagedDiskId <String>

Specifies the ID of a managed disk.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-OsState <OperatingSystemStateTypes>

Specifies the OS state.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-OsType <OperatingSystemTypes>

Specifies the OS type.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SnapshotId <String>

Specifies the ID of a snapshot.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-StorageAccountType <String>

The Storage Account type of Os Image Disk



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Microsoft.Azure.Management.Compute.Models.Image

System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=14.0.0.0,

Culture=neutral, PublicKeyToken=31bf3856ad364e35]] System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.OperatingSystemStateTypes,

Microsoft.Azure.Management.Compute, Version=14.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] System.String

System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.CachingTypes, Microsoft.Azure.Management.Compute, Version=14.0.0.0,

Culture=neutral, PublicKeyToken=31bf3856ad364e35]] System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral,

PublicKeyToken=b77a5c561934e089]]





OUTPUTS

Microsoft.Azure.Management.Compute.Models.Image







NOTES









Example 1



PS C:\\> $imageConfig = New-AzureRmImageConfig -Location 'West US';

PS C:\\> $osDiskVhdUri = "https://contoso.blob.core.windows.net/test/os.vhd"

PS C:\\> $dataDiskVhdUri1 = "https://contoso.blob.core.windows.net/test/data1.vhd"

PS C:\\> $dataDiskVhdUri2 = "https://contoso.blob.core.windows.net/test/data2.vhd"

PS C:\\> Set-AzureRmImageOsDisk -Image $imageConfig -OsType 'Windows' -OsState 'Generalized' -BlobUri $osDiskVhdUri;

PS C:\\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 1 -BlobUri $dataDiskVhdUri1;

PS C:\\> Add-AzureRmImageDataDisk -Image $imageConfig -Lun 2 -BlobUri $dataDiskVhdUri2;

PS C:\\> New-AzureRmImage -Image $imageConfig -ImageName 'ImageName01' -ResourceGroupName 'ResourceGroup01';



The first command creates an image object, and then stores it in the $imageConfig variable.



The next three commands assign paths of os disk and two data disks to the $osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2 variables. This

approach is only for readability of the following commands.



The next three commands each adds an os disk and two data disks to the image stored in $imageConfig. The URI of each disk is stored in

$osDiskVhdUri, $dataDiskVhdUri1, and $dataDiskVhdUri2.



The final command creates an image named 'ImageName01' in resource group 'ResourceGroup01'.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... mageosdisk