(PowerShell) Azure Storage: Download Blob to File

See more Azure Cloud Storage Examples

Sample code to download an Azure blob to a file.

For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$rest = New-Object Chilkat.Rest

# Connect to the Azure Storage Blob Service
$bTls = $true
$port = 443
$bAutoReconnect = $true
# In this example, the storage account name is "chilkat".
$success = $rest.Connect("chilkat.blob.core.windows.net",$port,$bTls,$bAutoReconnect)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

# Provide Azure Cloud credentials for the REST call.
$azAuth = New-Object Chilkat.AuthAzureStorage
$azAuth.AccessKey = "AZURE_ACCESS_KEY"
# The account name used here should match the 1st part of the domain passed in the call to Connect (above).
$azAuth.Account = "chilkat"
$azAuth.Scheme = "SharedKey"
$azAuth.Service = "Blob"
# This causes the "x-ms-version: 2021-08-06" header to be automatically added.
$azAuth.XMsVersion = "2021-08-06"
$success = $rest.SetAuthAzureStorage($azAuth)

# Note: The application does not need to explicitly set the following
# headers: Content-Length, x-ms-date, Authorization.  These headers
# are automatically set by Chilkat.

# Setup a file stream for the download
$fileStream = New-Object Chilkat.Stream
$fileStream.SinkFile = "qa_output/starfish.jpg"

# Indicate that the call to FullRequestNoBody should send the response body
# to fileStream if the response status code is 200.
# If a non-success response status code is received, then nothing
# is streamed to the output file and the error response is returned by FullRequestNoBody.
$expectedStatus = 200
$rest.SetResponseBodyStream($expectedStatus,$true,$fileStream)

# The Azure blob container is "test", the file is "starfish.jpg"
$responseStr = $rest.FullRequestNoBody("GET","/test/starfish.jpg")
if ($rest.LastMethodSuccess -ne $true) {
    # Examine the request/response to see what happened.
    $("response status code = " + $rest.ResponseStatusCode)
    $("response status text = " + $rest.ResponseStatusText)
    $("response header: " + $rest.ResponseHeader)
    $("response body (if any): " + $responseStr)
    $("---")
    $("LastRequestStartLine: " + $rest.LastRequestStartLine)
    $("LastRequestHeader: " + $rest.LastRequestHeader)
    exit
}

$("Success.")