Save-AzVhd
Saves downloaded .vhd images locally.
Syntax
Save-AzVhd
[-ResourceGroupName] <String>
[-SourceUri] <Uri>
[-LocalFilePath] <FileInfo>
[[-NumberOfThreads] <Int32>]
[-OverWrite]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Save-AzVhd
[-StorageKey] <String>
[-SourceUri] <Uri>
[-LocalFilePath] <FileInfo>
[[-NumberOfThreads] <Int32>]
[-OverWrite]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Save-AzVhd cmdlet saves .vhd images from a blob where they are stored to a file. You can specify the number of downloader threads that the process uses and whether to replace a file that already exists. This cmdlet downloads content as it is. It does not apply any Virtual Hard Disk (VHD) format conversion.
Examples
Example 1: Download an image
Save-AzVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -ResourceGroupName "rgname"This command downloads a .vhd file, and stores it in the local path C:\vhd\Win7Image.vhd.
Example 2: Download an image and overwrite the local file
Save-AzVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -Overwrite -ResourceGroupName "rgname"This command downloads a .vhd file, and stores it in the local path. The command includes the Overwrite parameter. Therefore, if C:\vhd\Win7Image.vhd already exists, this command replaces it.
Example 3: Download an image by using a specified number of threads
Save-AzVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -NumberOfThreads 32 -ResourceGroupName "rgname"This command downloads a .vhd file, and stores it in the local path. The command specifies a value of 32 for the NumberOfThreads parameter. Therefore, the cmdlet uses 32 threads for this action.
Example 4: Download an image and specify the storage key
Save-AzVhd -SourceUri "http://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd" -LocalFilePath "C:\vhd\Win7Image.vhd" -StorageKey "zNvcH0r5vAGmC5AbwEtpcyWCMyBd3eMDbdaa4ua6kwxq6vTZH3Y+sw=="This command downloads a .vhd file and specifies the storage key.
Parameters
-AsJob
Run cmdlet in the background and return a Job to track progress.
| Type: | SwitchParameter |
| 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 |
-LocalFilePath
Specifies the local file path of the saved image.
| Type: | FileInfo |
| Aliases: | lf |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NumberOfThreads
Specifies the number of download threads that this cmdlet uses during download.
| Type: | Int32 |
| Aliases: | th |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OverWrite
Indicates that this cmdlet replaces the file specified by LocalFilePath file if it exists.
| Type: | SwitchParameter |
| Aliases: | o |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of the resource group of the storage account.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SourceUri
Specifies the Uniform Resource Identifier (URI) of the blob in Azure.
| Type: | Uri |
| Aliases: | src, Source |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageKey
Specifies the storage key of the blob storage account. If you do not specify a key, this cmdlet attempts to determine the storage key of the account in SourceUri from Azure.
| Type: | String |
| Aliases: | sk |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |