Get-AzStorageBlobContent
Downloads a storage blob.
Syntax
ReceiveManual (Default)
Get-AzStorageBlobContent
[-Blob] <String>
[-Container] <String>
[-Destination <String>]
[-CheckMd5]
[-Context <IStorageContext>]
[-Force]
[-AsJob]
[-TagCondition <String>]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
BlobPipeline
Get-AzStorageBlobContent
-CloudBlob <CloudBlob>
[-BlobBaseClient <BlobBaseClient>]
[-Destination <String>]
[-CheckMd5]
[-Context <IStorageContext>]
[-Force]
[-AsJob]
[-TagCondition <String>]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ContainerPipeline
Get-AzStorageBlobContent
[-Blob] <String>
-CloudBlobContainer <CloudBlobContainer>
[-Destination <String>]
[-CheckMd5]
[-Context <IStorageContext>]
[-Force]
[-AsJob]
[-TagCondition <String>]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UriPipeline
Get-AzStorageBlobContent
-AbsoluteUri <String>
[-Destination <String>]
[-Force]
[-AsJob]
[-TagCondition <String>]
[-ServerTimeoutPerRequest <Int32>]
[-ClientTimeoutPerRequest <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-ConcurrentTaskCount <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Get-AzStorageBlobContent cmdlet downloads the specified storage blob.
If the blob name is not valid for the local computer, this cmdlet automatically resolves it if it is possible.
Examples
Example 1: Download blob content by name
Get-AzStorageBlobContent -Container "ContainerName" -Blob "Blob" -Destination "C:\test\"
This command downloads a blob by name.
Example 2: Download blob content using the pipeline
Get-AzStorageBlob -Container containername -Blob blobname | Get-AzStorageBlobContent
This command uses the pipeline to find and download blob content.
Example 3: Download blob content using the pipeline and a wildcard character
Get-AzStorageContainer container* | Get-AzStorageBlobContent -Blob "cbox.exe" -Destination "C:\test"
This example uses the asterisk wildcard character and the pipeline to find and download blob content.
Example 4: Get a blob object and save it in a variable, then download blob content with the blob object
$blob = Get-AzStorageBlob -Container containername -Blob blobname
Get-AzStorageBlobContent -CloudBlob $blob.ICloudBlob -Destination "C:\test"
This example first get a blob object and save it in a variable, then download blob content with the blob object.
Example 5: Download a blob content with blob Uri
Get-AzStorageBlobContent -Uri $blobUri -Destination "C:\test" -Force
This example will download a blob content with Uri, the Uri can be a Uri with Sas token.
If the blob is on a managed disk account, and server requires a bearer token besides Sas Uri to download, the cmdlet will try to generate a bearer token with server returned audience and the login AAD user credentail, then download blob with both Sas Uri and bearer token.
Parameters
-AbsoluteUri
Blob uri to download from.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: Uri, BlobUri
Parameter sets
UriPipeline
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-AsJob
Run cmdlet in the background.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Blob
Specifies the name of the blob to be downloaded.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ReceiveManual
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ContainerPipeline
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-BlobBaseClient
BlobBaseClient Object
Parameter properties
Type: BlobBaseClient
Default value: None Supports wildcards: False DontShow: False
Parameter sets
BlobPipeline
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-CheckMd5
Specifies whether to check the Md5 sum for the downloaded file.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ReceiveManual
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
BlobPipeline
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ContainerPipeline
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ClientTimeoutPerRequest
Specifies the client-side time-out interval, in seconds, for one service request.
If the previous call fails in the specified interval, this cmdlet retries the request.
If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error.
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False Aliases: ClientTimeoutPerRequestInSeconds
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CloudBlob
Specifies a cloud blob.
To obtain a CloudBlob object, use the Get-AzStorageBlob cmdlet.
Parameter properties
Type: CloudBlob
Default value: None Supports wildcards: False DontShow: False Aliases: ICloudBlob
Parameter sets
BlobPipeline
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-CloudBlobContainer
Specifies a CloudBlobContainer object from the Azure storage client library.
You can create it or use the Get-AzStorageContainer cmdlet.
Parameter properties
Parameter sets
ContainerPipeline
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ConcurrentTaskCount
Specifies the maximum concurrent network calls.
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.
This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second.
The default value is 10.
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Container
Specifies the name of container that has the blob you want to download.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ReceiveManual
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Context
Specifies the Azure storage account from which you want to download blob content.
You can use the New-AzStorageContext cmdlet to create a storage context.
Parameter properties
Type: IStorageContext
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ReceiveManual
Position: Named Mandatory: False Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
BlobPipeline
Position: Named Mandatory: False Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
ContainerPipeline
Position: Named Mandatory: False Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Destination
Specifies the location to store the downloaded file.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: Path
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Force
Overwrites an existing file without confirmation.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ServerTimeoutPerRequest
Specifies the service side time-out interval, in seconds, for a request.
If the specified interval elapses before the service processes the request, the storage service returns an error.
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False Aliases: ServerTimeoutPerRequestInSeconds
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TagCondition
Optional Tag expression statement to check match condition.
The blob request will fail when the blob tags does not match the given expression.
See details in https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations#tags-conditional-operations .
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
Notes
If the blob name is invalid for local computer, this cmdlet autoresolves it, if it is possible.