< Back

Receive-AzureBlob

Sat Jan 11, 2020 4:48 am

NAME Receive-AzureBlob



SYNOPSIS

Downloads a file from a BLOB container





SYNTAX

Receive-AzureBlob -Uri <Uri[]> [-Destination <String>] -AccessKey <String> [-ApiVersion <String>] [-BufferSize

<Int32>] [<CommonParameters>]



Receive-AzureBlob -StorageAccountName <String> [-StorageAccountDomain <String>] [-ContainerName <String>]

-BlobName <String> -AccessKey <String> [-ApiVersion <String>] [-BufferSize <Int32>] [<CommonParameters>]



Receive-AzureBlob -Uri <Uri[]> [-Destination <String>] [-IsPublic] [-ApiVersion <String>] [-BufferSize <Int32>]

[<CommonParameters>]





DESCRIPTION





PARAMETERS

-StorageAccountName <String>

The storage account name



Required? true

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-StorageAccountDomain <String>

The FQDN for the storage account service



Required? false

Position? named

Default value blob.core.windows.net

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ContainerName <String>

The storage account BLOB container name



Required? false

Position? named

Default value $root

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-BlobName <String>

The name of the BLOB to download



Required? true

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Uri <Uri[]>

The location of the item(s) to be downloaded



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-Destination <String>

The download destination folder path



Required? false

Position? named

Default value $env:TEMP

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-AccessKey <String>

The storage service access key



Required? true

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-IsPublic [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ApiVersion <String>

The version of the BLOB service API



Required? false

Position? named

Default value 2016-05-31

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-BufferSize <Int32>

The size of the download buffer



Required? false

Position? named

Default value 4096000

Accept pipeline input? true (ByPropertyName)

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





RELATED LINKS