Get-AzureStorageBlobContent
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Get-AzureStorageBlobContent
Downloads a storage blob.
Parameter Set: ReceiveManual
Get-AzureStorageBlobContent [-Blob] <String> [-Container] <String> [-CheckMd5] [-ConcurrentTaskCount <Int32> ] [-Context <AzureStorageContext> ] [-Destination <String> ] [-Force] [ <CommonParameters>]
Parameter Set: BlobPipeline
Get-AzureStorageBlobContent -ICloudBlob <ICloudBlob> [-CheckMd5] [-ConcurrentTaskCount <Int32> ] [-Context <AzureStorageContext> ] [-Destination <String> ] [-Force] [ <CommonParameters>]
Parameter Set: ContainerPipeline
Get-AzureStorageBlobContent [-Blob] <String> -CloudBlobContainer <CloudBlobContainer> [-CheckMd5] [-ConcurrentTaskCount <Int32> ] [-Context <AzureStorageContext> ] [-Destination <String> ] [-Force] [ <CommonParameters>]
This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.
Downloads the specified storage blob. If the blob name is not valid for the local computer, this cmdlet automatically resolves it if possible.
-Blob<String>
Specifies the name of the blob to be downloaded.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CheckMd5
Specifies whether to check the Md5 sum for the downloaded file.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
False |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CloudBlobContainer<CloudBlobContainer>
Specifies a CloudBlobContainer object from the Windows Azure storage client library. You can create it or use the Get-AzureStorageContainer cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ConcurrentTaskCount<Int32>
Specifies the concurrent network calls. By default if no value is specified for this paramater, this cmdlet initiates network calls up to eight times the number of cores available for concurrent tasks on your computer when you upload files to Windows Azure storage. For example, if your computer has four cores, the cmdlet initiates up to 32 (eight times of 4) network calls at one time. You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. The specified value is an absolute count and is not multiplied by the core count. For example, set ‘-ConcurrentTaskCount 1’ uploads or downloads in sequence without any parallel network request. This parameter can help mitigate network connection problems in low bandwidth environments, such as 100 kilobits per second.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
ProcessorCount * 8 |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Container<String>
Specifies the name of container that has the blob you want to download.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Context<AzureStorageContext>
Specifies the Windows Azure storage account from which you want to download blob content. You can use the New-AzureStorageContext cmdlet to create a storage account.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Destination<String>
Specifies the location to store the downloaded file.
Aliases |
Path |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Overwrites an existing file without confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ICloudBlob<ICloudBlob>
Specifies an ICloudBlob object from the Windows Azure storage client library. You can create it or use Get-AzureStorageBlob cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- AzureStorageContainer
Download blob content by name
This example downloads a blob by name.
C:\PS>Get-AzureStorageBlobContent -Container containername -Blob blob -Destination C:\test\
Download blob content using the pipeline
This example uses the pipeline to find and download blob content.
C:\PS>Get-AzureStorageBlob -Container containername -Blob blobname | Get-AzureStorageBlobContent
Download blob content using the pipeline and a wildcard character
This example uses the asterisk wildcard character and the pipeline to find and download blob content.
C:\PS>Get-AzureStorageContainer container* | Get-AzureStorageBlobContent -Blob cbox.exe -Destination C:\test