Export-AzureRmDataLakeStoreItem

Downloads a file from Data Lake Store.

Important

Because Az PowerShell modules now have all the capabilities of AzureRM PowerShell modules and more, we'll retire AzureRM PowerShell modules on 29 February 2024.

To avoid service interruptions, update your scripts that use AzureRM PowerShell modules to use Az PowerShell modules by 29 February 2024. To automatically update your scripts, follow the quickstart guide.

Syntax

Export-AzureRmDataLakeStoreItem
      [-Account] <String>
      [-Path] <DataLakeStorePathInstance>
      [-Destination] <String>
      [-Recurse]
      [-Resume]
      [-Force]
      [-Concurrency <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Export-AzureRmDataLakeStoreItem
      [-Account] <String>
      [-Path] <DataLakeStorePathInstance>
      [-Destination] <String>
      [-Recurse]
      [-Resume]
      [-Force]
      [-Concurrency <Int32>]
      [-DiagnosticLogLevel <LogLevel>]
      -DiagnosticLogPath <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<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" -Concurrency 4

This command downloads the file TestSource.csv from the Data Lake Store to C:\Test.csv with a concurrency of 4.

Parameters

-Account

Specifies the name of the Data Lake Store account.

Type:String
Aliases:AccountName
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Concurrency

Indicates the number of files or chunks to download in parallel. Default will be computed as a best effort based on system specifications.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:True
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
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
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
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:Microsoft.Azure.Commands.DataLakeStore.Models.LogLevel
Accepted values:Debug, Information, Error, None
Position:Named
Default value:Error
Accept pipeline input:True
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
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
Accept wildcard characters:False
-Path

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

Type:Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Recurse

Indicates that a folder download is recursive.

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

Indicates that the file(s) being copied are a continuation of a previous download. This will cause the system to attempt to resume from the last file that was not fully downloaded.

Type:SwitchParameter
Position:4
Default value:None
Accept pipeline input:True
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

Inputs

String

Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance

SwitchParameter

Int32

Microsoft.Azure.Commands.DataLakeStore.Models.LogLevel

Outputs

String

The path where the file or folder was downloaded to.