Remove-AzureRmDataLakeStoreItem

Deletes a file or folder in Data Lake Store.

Important

Because Az PowerShell modules now have all the capabilities of AzureRM PowerShell modules and more, we'll retire AzureRM PowerShell modules on 29 February 2024.

To avoid service interruptions, update your scripts that use AzureRM PowerShell modules to use Az PowerShell modules by 29 February 2024. To automatically update your scripts, follow the quickstart guide.

Syntax

Remove-AzureRmDataLakeStoreItem
      [-Account] <String>
      [-Paths] <DataLakeStorePathInstance[]>
      [-Recurse]
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<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.

Parameters

-Account

Specifies the name of the Data Lake Store account.

Type:String
Aliases:AccountName
Position:0
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

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

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
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
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
Accept wildcard characters:False
-Paths

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

Type:Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance[]
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Recurse

Indicates that this operation deletes all items in the target folder, including subfolders.

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

Inputs

String

Microsoft.Azure.Commands.DataLakeStore.Models.DataLakeStorePathInstance[]

SwitchParameter

Outputs

Boolean