< Back

Save-AzureVhd

Wed Jan 30, 2019 5:52 pm

NAME Save-AzureVhd



SYNOPSIS

Enables download of .vhd images.





SYNTAX

Save-AzureVhd [-Source] <Uri> [-LocalFilePath] <FileInfo> [[-NumberOfThreads] <Int32>] [[-StorageKey] <String>] [[-OverWrite]] [-Profile

<AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]





DESCRIPTION

The Save-AzureVhd cmdlet enables download of .vhd images from a blob where they are stored to a file. It has parameters to configure the download

process by specifying the number of downloader threads that are used or overwriting the file which already exists in the specified file path.



Save-AzureVhd does not do any VHD format conversion and the blob is downloaded as it is.





PARAMETERS

-Source <Uri>

Specifies the Uniform Resource Identifier (URI) to the blob in azure_2.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-LocalFilePath <FileInfo>

Specifies the local file path.



Required? true

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-NumberOfThreads <Int32>

Specifies the number of download threads that this cmdlet uses during download.



Required? false

Position? 3

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-StorageKey <String>

Specifies the storage key of the blob storage account. If it is not provided, Save-AzureVhd attempts to determine the storage key of the account in

SourceUri from Azure.



Required? false

Position? 4

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-OverWrite [<SwitchParameter>]

Specifies that this cmdlet deletes the file specified by LocalFilePath file if it exists.



Required? false

Position? 5

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Profile <AzureSMProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

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 (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









-------------------------- Example 1: Download a VHD file --------------------------



PS C:\\>Save-AzureVhd -Source "http://contosoaccount.blob.core.windows ... eimage.vhd" -LocalFilePath "C:\\vhd\\Win7Image.vhd"



This command downloads a .vhd file.

-------------------------- Example 2: Download a VHD file and overwrite the local file --------------------------



PS C:\\>Save-AzureVhd -Source "http://contosoaccount.blob.core.windows ... eimage.vhd" -LocalFilePath "C:\\vhd\\Win7Image.vhd" -Overwrite



This command downloads a .vhd file and overwrites any file in the destination path.

-------------------------- Example 3: Download a VHD file and specify the number of threads --------------------------



PS C:\\>Save-AzureVhd -Source "http://contosoaccount.blob.core.windows ... eimage.vhd" -LocalFilePath "C:\\vhd\\Win7Image.vhd"

-NumberOfThreads 32



This command downloads a .vhd file and specifies the number of threads.

-------------------------- Example 4: Download a VHD file and specify the storage key --------------------------



PS C:\\>Save-AzureVhd -Source "http://contosoaccount.blob.core.windows ... eimage.vhd" -LocalFilePath "C:\\vhd\\Win7Image.vhd" -StorageKey

"zNvcH0r5vAGmC5AbwEtpcyWCMyBd3eMDbdaa4ua6kwxq6vTZH3Y+sw=="



This command downloads a .vhd file and specifies the storage key.



RELATED LINKS

Add-AzureVhd