Export-​Azure​Rm​Data​Lake​Store​Item

Downloads a file from Data Lake Store.

Syntax

Export-AzureRmDataLakeStoreItem
      [-Account] <String>
      [-Path] <DataLakeStorePathInstance>
      [-Destination] <String>
      [-Recurse]
      [-Resume]
      [[-PerFileThreadCount] <Int32>]
      [[-ConcurrentFileCount] <Int32>]
      [-Force]
      [-DiagnosticLogLevel <LogLevel>]
      -DiagnosticLogPath <String>
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The Export-AzureRmDataLakeStoreItem cmdlet downloads a file from Data Lake Store.

Examples

Example 1: Download an item from the Data Lake Store

PS C:\>Export-AzureRmDataLakeStoreItem -AccountName "ContosoADL" -Path /myFiles/TestSource.csv -Destination "C:\Test.csv"

This command downloads the file TestSource.csv from the Data Lake Store to C:\Test.csv.

Required Parameters

-Account

Specifies the name of the Data Lake Store account.

Type:String
Aliases:AccountName
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Destination

Specifies the local file path to which to download the file.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DiagnosticLogPath

Specifies the path for the diagnostic log to record events to during the file or folder import.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Path

Specifies the path of the item to download from the Data Lake Store, starting from the root directory (/).

Type:DataLakeStorePathInstance
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-ConcurrentFileCount

Specifies the maximum number of files to download in parallel for a folder download. The default value is five (5).

Type:Int32
Position:6
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-DiagnosticLogLevel

Optionally indicates the diagnostic log level to use to record events during the file or folder import. Default is Error.

Type:LogLevel
Parameter Sets:Debug, Information, Error, None
Position:Named
Default value:Error
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Force

Indicates that this operation can overwrite the destination file if it already exists.

Type:SwitchParameter
Position:7
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PerFileThreadCount

Specifies the maximum number of threads to use per file. The default value is ten (10).

Type:Int32
Position:5
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Recurse

Indicates that a folder download is recursive.

Type:SwitchParameter
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Resume

Indicates that the file or files being copied are a continuation of a previous download. The download attempts to resume from the last file that was not fully downloaded.

Type:SwitchParameter
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

string

The path where the file or folder was downloaded to.