< Back
Remove-AzureRmDataLakeStoreItem
Post
NAME Remove-AzureRmDataLakeStoreItem
SYNOPSIS
Deletes a file or folder in Data Lake Store.
SYNTAX
Remove-AzureRmDataLakeStoreItem [-Account] <String> [-Paths] <DataLakeStorePathInstance[]> [[-Recurse]] [[-Clean]] [[-Force]] [[-PassThru]]
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmDataLakeStoreItem cmdlet deletes a file or folder in 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
-Clean [<SwitchParameter>]
Indicates the user wants to remove all of the contents of the folder, but not the folder itself
Required? false
Position? 3
Default value False
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
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? 4
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? 5
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Paths <DataLakeStorePathInstance[]>
Specifies an array of Data Lake Store paths of the files to remove, starting with the root directory (/).
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Recurse [<SwitchParameter>]
Indicates that this operation deletes all items in the target folder, including subfolders. Unless you specify the Clean parameter, the target
folder is also deleted.
Required? false
Position? 2
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
bool
If PassThru is specified, returns the result of the operation.
NOTES
Example 1: Remove multiple items
PS C:\\>Remove-AzureRmDataLakeStoreItem -AccountName "ContosoADL" -Paths "/File01.txt","/MyFiles/File.csv"
This command removes the files File01.txt and File.csv from the Data Lake Store.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... estoreitem
Get-AzureRmDataLakeStoreItem
Export-AzureRmDataLakeStoreItem
Import-AzureRmDataLakeStoreItem
Join-AzureRmDataLakeStoreItem
New-AzureRmDataLakeStoreItem
Test-AzureRmDataLakeStoreItem
SYNOPSIS
Deletes a file or folder in Data Lake Store.
SYNTAX
Remove-AzureRmDataLakeStoreItem [-Account] <String> [-Paths] <DataLakeStorePathInstance[]> [[-Recurse]] [[-Clean]] [[-Force]] [[-PassThru]]
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmDataLakeStoreItem cmdlet deletes a file or folder in 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
-Clean [<SwitchParameter>]
Indicates the user wants to remove all of the contents of the folder, but not the folder itself
Required? false
Position? 3
Default value False
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
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? 4
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? 5
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Paths <DataLakeStorePathInstance[]>
Specifies an array of Data Lake Store paths of the files to remove, starting with the root directory (/).
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Recurse [<SwitchParameter>]
Indicates that this operation deletes all items in the target folder, including subfolders. Unless you specify the Clean parameter, the target
folder is also deleted.
Required? false
Position? 2
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
bool
If PassThru is specified, returns the result of the operation.
NOTES
Example 1: Remove multiple items
PS C:\\>Remove-AzureRmDataLakeStoreItem -AccountName "ContosoADL" -Paths "/File01.txt","/MyFiles/File.csv"
This command removes the files File01.txt and File.csv from the Data Lake Store.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... estoreitem
Get-AzureRmDataLakeStoreItem
Export-AzureRmDataLakeStoreItem
Import-AzureRmDataLakeStoreItem
Join-AzureRmDataLakeStoreItem
New-AzureRmDataLakeStoreItem
Test-AzureRmDataLakeStoreItem