Export-AzureRmDataLakeStoreItem

Reference

Module:: AzureRM.DataLakeStore

Downloads a file from Data Lake Store.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

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
Required:	True
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
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
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
Required:	True
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:	LogLevel
Accepted values:	Debug, Information, Error, None
Position:	Named
Default value:	Error
Required:	False
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
Required:	True
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
Required:	False
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:	DataLakeStorePathInstance
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Recurse

Indicates that a folder download is recursive.

Type:	SwitchParameter
Position:	3
Default value:	None
Required:	False
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.