Remove-Item

Exclui os itens especificados.

Sintaxe

Remove-Item [-LiteralPath] <string[]> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-Recurse] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]

Remove-Item [-Path] <string[]> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-Recurse] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]

Descrição

O cmdlet Remove-Item exclui um ou mais itens. Como ele é suportado por vários provedores, pode excluir muitos tipos diferentes de itens, incluindo arquivos, diretórios, chaves do Registro, variáveis, aliases e funções.

Parâmetros

-Credential <PSCredential>

Especifica uma conta de usuário com permissão para executar essa ação. O padrão é o usuário atual.

Digite um nome de usuário, como "User01" ou "Domain01\User01", ou insira um objeto PSCredential, como aquele gerado pelo cmdlet Get-Credential. Uma senha será solicitada após a digitação do nome do usuário.

Este parâmetro não tem suporte em nenhum dos provedores instalados com o Windows PowerShell.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	true (ByPropertyName)
Aceitar caracteres curinga?	false

-Exclude <string[]>

Omite os itens especificados. O valor desse parâmetro qualifica o parâmetro Path. Digite um elemento ou padrão do caminho, como "*.txt". Os caracteres curinga são permitidos.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Filter <string>

Especifica um filtro no formato ou no idioma do provedor. O valor desse parâmetro qualifica o parâmetro Path. A sintaxe do filtro, incluindo o uso dos caracteres curinga, depende do provedor. Os filtros são mais eficientes do que outros parâmetros porque o provedor os aplica durante a recuperação dos objetos, em vez de fazer com que o Windows PowerShell os filtre depois de recuperados.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Force

Permite que o cmdlet remova os itens que não podem ser alterados, como variáveis, aliases ou arquivos somente leitura ou ocultos. O cmdlet não pode remover os aliases nem as variáveis constantes. A implementação varia de provedor para provedor. Para obter mais informações, consulte about_Providers. Mesmo usando o parâmetro Force, o cmdlet não pode substituir as restrições de segurança.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Include <string[]>

Exclui somente os itens especificados. O valor desse parâmetro qualifica o parâmetro Path. Digite um elemento ou padrão do caminho, como "*.txt". Os caracteres curinga são permitidos.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-LiteralPath <string[]>

Especifica um caminho até os itens que serão removidos. Ao contrário de Path, o valor de LiteralPath é usado exatamente como é digitado. Nenhum caractere será interpretado como curinga. Se o caminho incluir caracteres de escape, coloque-os entre aspas simples. As aspas simples dizem ao Windows PowerShell para não interpretar quaisquer caracteres que tenham sequências de escape.

Necessário?	true
Posição?	1
Valor padrão
Aceitar entrada do pipeline?	true (ByPropertyName)
Aceitar caracteres curinga?	false

-Path <string[]>

Especifica um caminho até os itens que serão removidos. Os caracteres curinga são permitidos. O nome do parâmetro ("-Path") é opcional.

Necessário?	true
Posição?	1
Valor padrão
Aceitar entrada do pipeline?	true (ByValue, ByPropertyName)
Aceitar caracteres curinga?	false

-Recurse

Exclui os itens que estão nos locais especificados e em todos os itens filhos desses locais.

O parâmetro Recurse não funciona adequadamente nesse cmdlet.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Confirm

Solicita confirmação antes da execução do comando.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-WhatIf

Descreve o que aconteceria se você executasse o comando, sem executá-lo de fato.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-UseTransaction

Inclui o comando na transação ativa. Este parâmetro é válido apenas quando uma transação está em andamento. Para obter mais informações, consulte about_Transactions.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

<CommonParameters>

Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.

Entradas e saídas

O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.

Entradas	System.String Você pode enviar uma cadeia de caracteres que contém um caminho (mas não um caminho literal) para Remove-Item.
Saídas	Nenhum Este cmdlet não retorna nenhuma saída.

Observações

Você também pode fazer referência a Remove-Item usando qualquer um de seus aliases internos, "del", "erase", "rmdir", "rd", "ri" ou "rm". Para obter mais informações, consulte about_Aliases.

O cmdlet Remove-Item foi desenvolvido para funcionar com os dados expostos por qualquer provedor. Para listar os provedores disponíveis em sua sessão, digite "Get-PsProvider". Para obter mais informações, consulte about_Providers.

Exemplo 1

C:\PS>remove-item C:\Test\*.*

Descrição
-----------
Esse comando exclui todos os arquivos do diretório C:\Test com nomes que incluem um ponto (.). Como o comando especifica um ponto, ele não exclui diretórios ou arquivos sem uma extensão de nome de arquivo.

Exemplo 2

C:\PS>remove-item * -include *.doc -exclude *1*

Descrição
-----------
Esse comando exclui todos os arquivos no diretório atual com a extensão de nome de arquivo .doc e um nome que não inclua "1". Ele usa o caractere curinga (*) para especificar o conteúdo do diretório atual. Utiliza os parâmetros Include e Exclude para especificar os arquivos a serem excluídos.

Exemplo 3

C:\PS>remove-item -path C:\Test\hidden-RO-file.txt -force

Descrição
-----------
Esse comando exclui um arquivo que seja oculto e somente leitura. Ele usa o parâmetro Path para especificar o arquivo. Utiliza o parâmetro Force para conceder a permissão para excluí-lo. Sem Force, não é possível excluir arquivos somente leitura ou ocultos.

Exemplo 4

C:\PS>get-childitem * -include *.csv -recurse | remove-item

Descrição
-----------
Esse comando exclui todos os arquivos CSV do diretório atual e todos os subdiretórios, recursivamente.

Como o parâmetro Recurse nesse cmdlet não funciona muito bem, o comando utiliza o cmdlet Get-Childitem para obter os arquivos desejados, e o operador de pipeline os transmitir para o cmdlet Remove-Item.

No comando Get-ChildItem, o parâmetro Path possui um valor *, que representa o conteúdo do diretório atual. Ele usa o parâmetro Include para especificar o tipo do arquivo CSV, e o parâmetro Recurse tornar a recuperação recursiva. 

Se você tentar especificar o tipo de arquivo no caminho, como "-path *.csv", o cmdlet interpretará o objeto da pesquisa como um arquivo sem itens filhos, e então Recurse falhará.

Exemplo 5

C:\PS>remove-item hklm:\software\mycompany\OldApp -recurse

Descrição
-----------
Esse comando exclui a chave de Registro OldApp e todos as subchaves e valores. Ele usa o cmdlet Remove-Item para remover a chave. O caminho é especificado, mas o nome opcional do parâmetro (Path) é omitido. 

O parâmetro Recurse exclui recursivamente todo o conteúdo da chave OldApp. Caso a chave contenha subchaves e o parâmetro Recurse seja omitido, será solicitado que você confirme que deseja excluir o conteúdo da chave.

Consulte também

Conceitos

about_Providers
Clear-Item
Copy-Item
Get-Item
Invoke-Item
Move-Item
New-Item
Remove-ItemProperty
Rename-Item
Set-Item