< Back
Export-AzureRmDataLakeStoreItem
Post
NAME Export-AzureRmDataLakeStoreItem
SYNOPSIS
Downloads a file from Data Lake Store.
SYNTAX
Export-AzureRmDataLakeStoreItem [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Destination] <String> [[-Recurse]] [[-Resume]]
[[-PerFileThreadCount] <Int32>] [[-ConcurrentFileCount] <Int32>] [[-Force]] [-Concurrency <Int32>] [-DefaultProfile <IAzureContextContainer>]
[-DiagnosticLogLevel {Debug | Information | Error | None}] -DiagnosticLogPath <String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Export-AzureRmDataLakeStoreItem cmdlet downloads a file from Data Lake Store.
PARAMETERS
-Account <String>
Specifies the name of the Data Lake Store account.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Concurrency <Int32>
Indicates the number of files or chunks to download in parallel. Default will be computed as a best effort based on system specifications.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConcurrentFileCount <Int32>
Indicates the maximum number of files to download in parallel for a folder download. Default will be computed as a best effort based on
folder and file size
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Destination <String>
Specifies the local file path to which to download the file.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DiagnosticLogLevel <LogLevel>
Optionally indicates the diagnostic log level to use to record events during the file or folder import. Default is Error.
Required? false
Position? named
Default value Error
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DiagnosticLogPath <String>
Specifies the path for the diagnostic log to record events to during the file or folder import.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Force [<SwitchParameter>]
Indicates that this operation can overwrite the destination file if it already exists.
Required? false
Position? 7
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Path <DataLakeStorePathInstance>
Specifies the path of the item to download from the Data Lake Store, starting from the root directory (/).
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PerFileThreadCount <Int32>
Indicates the maximum number of threads to use per file. Default will be computed as a best effort based on folder and file size
Required? false
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Recurse [<SwitchParameter>]
Indicates that a folder download is recursive.
Required? false
Position? 3
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Resume [<SwitchParameter>]
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.
Required? false
Position? 4
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
string
The path where the file or folder was downloaded to.
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... estoreitem
Get-AzureRmDataLakeStoreItem
Import-AzureRmDataLakeStoreItem
Join-AzureRmDataLakeStoreItem
Move-AzureRmDataLakeStoreItem
New-AzureRmDataLakeStoreItem
Remove-AzureRmDataLakeStoreItem
Test-AzureRmDataLakeStoreItem
SYNOPSIS
Downloads a file from Data Lake Store.
SYNTAX
Export-AzureRmDataLakeStoreItem [-Account] <String> [-Path] <DataLakeStorePathInstance> [-Destination] <String> [[-Recurse]] [[-Resume]]
[[-PerFileThreadCount] <Int32>] [[-ConcurrentFileCount] <Int32>] [[-Force]] [-Concurrency <Int32>] [-DefaultProfile <IAzureContextContainer>]
[-DiagnosticLogLevel {Debug | Information | Error | None}] -DiagnosticLogPath <String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Export-AzureRmDataLakeStoreItem cmdlet downloads a file from Data Lake Store.
PARAMETERS
-Account <String>
Specifies the name of the Data Lake Store account.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Concurrency <Int32>
Indicates the number of files or chunks to download in parallel. Default will be computed as a best effort based on system specifications.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConcurrentFileCount <Int32>
Indicates the maximum number of files to download in parallel for a folder download. Default will be computed as a best effort based on
folder and file size
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Destination <String>
Specifies the local file path to which to download the file.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DiagnosticLogLevel <LogLevel>
Optionally indicates the diagnostic log level to use to record events during the file or folder import. Default is Error.
Required? false
Position? named
Default value Error
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DiagnosticLogPath <String>
Specifies the path for the diagnostic log to record events to during the file or folder import.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Force [<SwitchParameter>]
Indicates that this operation can overwrite the destination file if it already exists.
Required? false
Position? 7
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Path <DataLakeStorePathInstance>
Specifies the path of the item to download from the Data Lake Store, starting from the root directory (/).
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PerFileThreadCount <Int32>
Indicates the maximum number of threads to use per file. Default will be computed as a best effort based on folder and file size
Required? false
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Recurse [<SwitchParameter>]
Indicates that a folder download is recursive.
Required? false
Position? 3
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Resume [<SwitchParameter>]
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.
Required? false
Position? 4
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
string
The path where the file or folder was downloaded to.
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... estoreitem
Get-AzureRmDataLakeStoreItem
Import-AzureRmDataLakeStoreItem
Join-AzureRmDataLakeStoreItem
Move-AzureRmDataLakeStoreItem
New-AzureRmDataLakeStoreItem
Remove-AzureRmDataLakeStoreItem
Test-AzureRmDataLakeStoreItem