Export-AzDataLakeStoreItem
Downloads a file from Data Lake Store.
Syntax
NoDiagnosticLogging (Default)
Export-AzDataLakeStoreItem
[-Account] <String>
[-Path] <DataLakeStorePathInstance>
[-Destination] <String>
[-Recurse]
[-Resume]
[-Force]
[-Concurrency <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
IncludeDiagnosticLogging
Export-AzDataLakeStoreItem
[-Account] <String>
[-Path] <DataLakeStorePathInstance>
[-Destination] <String>
-DiagnosticLogPath <String>
[-Recurse]
[-Resume]
[-Force]
[-Concurrency <Int32>]
[-DiagnosticLogLevel <LogLevel>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Export-AzDataLakeStoreItem cmdlet downloads a file from Data Lake Store.
Examples
Example 1: Download an item from the Data Lake Store
Export-AzDataLakeStoreItem -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.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Aliases: AccountName
Parameter sets
(All)
Position: 0
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: 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.
Parameter properties
Type: Int32
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: False
Supports wildcards: False
DontShow: False
Aliases: cf
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
Type: IAzureContextContainer
Default value: None
Supports wildcards: False
DontShow: False
Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-Destination
Specifies the local file path to which to download the file.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: 2
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-DiagnosticLogLevel
Optionally indicates the diagnostic log level to use to record events during the file or folder import. Default is Error.
Parameter properties
Type: LogLevel
Default value: Error
Accepted values: Debug, Information, Error, None
Supports wildcards: False
DontShow: False
Parameter sets
IncludeDiagnosticLogging
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-DiagnosticLogPath
Specifies the path for the diagnostic log to record events to during the file or folder import.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
IncludeDiagnosticLogging
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-Force
Indicates that this operation can overwrite the destination file if it already exists.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: 7
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-Path
Specifies the path of the item to download from the Data Lake Store, starting from the root directory (/).
Parameter properties
Parameter sets
(All)
Position: 1
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-Recurse
Indicates that a folder download is recursive.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: 3
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: 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.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: 4
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: False
Supports wildcards: False
DontShow: False
Aliases: wi
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs