Remove-​Azure​Rm​Data​Lake​Store​Item

Deletes a file or folder in Data Lake Store.

Syntax

Remove-AzureRmDataLakeStoreItem
      [-Account] <String>
      [-Paths] <DataLakeStorePathInstance[]>
      [-Recurse]
      [-Clean]
      [-Force]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The Remove-AzureRmDataLakeStoreItem cmdlet deletes a file or folder in Data Lake Store.

Examples

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.

Required Parameters

-Account

Specifies the name of the Data Lake Store account.

Type:String
Aliases:AccountName
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Paths

Specifies an array of Data Lake Store paths of the files to remove, starting with the root directory (/).

Type:DataLakeStorePathInstance[]
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Clean

Indicates that this operation removes all of the contents of the target folder and retains the folder. Use this parameter with the Recurse parameter.

Type:SwitchParameter
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
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
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:5
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Recurse

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.

Type:SwitchParameter
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
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

Outputs

bool

If PassThru is specified, returns the result of the operation.