New-AzureRmImageConfig

NAME New-AzureRmImageConfig



SYNOPSIS

Creates a configurable image object.





SYNTAX

New-AzureRmImageConfig [[-Location] <String>] [[-Tag] <Hashtable>] [[-SourceVirtualMachineId] <String>] [[-OsDisk] <ImageOSDisk>] [-DataDisk

<ImageDataDisk[]>] [-DefaultProfile <IAzureContextContainer>] [-ZoneResilient] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The New-AzureRmImageConfig cmdlet creates a configurable image object.





PARAMETERS

-DataDisk <ImageDataDisk[]>

Specifies the data disk object.



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



-Location <String>

Specifies a location.



Required? false

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-OsDisk <ImageOSDisk>

Specifies the operating system Disk.



Required? false

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SourceVirtualMachineId <String>

Specifies the source virtual machine ID.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Tag <Hashtable>

Key-value pairs in the form of a hash table. For example:



@{key0="value0";key1=$null;key2="value2"}



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ZoneResilient [<SwitchParameter>]

Enable zone resilient



Required? false

Position? named

Default value False

Accept pipeline input? False

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

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.Compute.Automation.Models.PSImage







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 ... mageconfig