Get-ItemProperty

Artigo
10/30/2009

Obtém as propriedades de um item especificado.

Sintaxe

Get-ItemProperty [-LiteralPath] <string[]> [[-Name] <string[]>] [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Include <string[]>] [-UseTransaction] [<CommonParameters>]

Get-ItemProperty [-Path] <string[]> [[-Name] <string[]>] [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Include <string[]>] [-UseTransaction] [<CommonParameters>]

Descrição

O cmdlet Get-ItemProperty obtém as propriedades dos itens especificados. Por exemplo, você pode usar Get-ItemProperty para obter o valor da propriedade LastAccessTime de um objeto de arquivo. Também é possível usar Get-ItemProperty para exibir entradas do Registro e seus valores.

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. 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 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

-Include <string[]>

Inclui os itens especificados.

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

-LiteralPath <string[]>

Especifica o caminho até a propriedade do item. 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

-Name <string[]>

Especifica o nome da propriedade, ou propriedades, a ser copiada.

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

-Path <string[]>

Especifica o caminho para o item ou itens.

Necessário?	true
Posição?	1
Valor padrão
Aceitar entrada do pipeline?	true (ByValue, ByPropertyName)
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 para Get-ItemProperty.

Saídas

Object

Get-ItemProperty retorna um objeto para cada propriedade do item obtido. O tipo do objeto depende do objeto que é recuperado.

Observações

O cmdlet Get-ItemProperty 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>get-itemproperty C:\Windows

Descrição
-----------
Esse comando obtém informações sobre o diretório C:\Windows.

Exemplo 2

C:\PS>get-itemproperty C:\Test\Weather.xls | format-list

Descrição
-----------
Esse comando obtém as propriedades do arquivo C:\Test\Weather.xls. O resultado é enviado por pipe para o cmdlet Format-List, que exibe a saída como uma lista.

Exemplo 3

C:\PS>get-itemproperty -path HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion

Descrição
-----------
Esse comando exibe o nome e os dados do valor de cada uma das entradas do Registro contidas na subchave CurrentVersion. Observe que o comando requer que é uma unidade do Windows PowerShell nomeada HKLM: isso é mapeado para o hive de HKEY_LOCAL_MACHINE do Registro. Uma unidade com esse nome e mapeamento está disponível no Windows PowerShell por padrão. Como alternativa, o caminho para essa subchave do Registro pode ser especificado pelo uso do caminho alternativo a seguir, que começa pelo nome do provedor seguido de dois sinais de dois-pontos: 
Registry::HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion.

Exemplo 4

C:\PS>get-itemproperty -path HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion `
-name "ProgramFilesDir"

Descrição
-----------
Esse comando obtém o nome e os dados do valor da entrada do Registro ProgramFilesDir na subchave CurrentVersion. O comando usa o parâmetro Path para especificar a subchave e o parâmetro Name para especificar o nome do valor da entrada.

Exemplo 5

C:\PS>get-itemproperty -path HKLM:\SOFTWARE\Microsoft\PowerShell\1\PowerShellEngine

ApplicationBase         : C:\Windows\system32\WindowsPowerShell\v1.0\
ConsoleHostAssemblyName : Microsoft.PowerShell.ConsoleHost, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad
                          364e35, ProcessorArchitecture=msil
PowerShellVersion       : 2.0
RuntimeVersion          : v2.0.50727
CTPVersion              : 5
PSCompatibleVersion     : 1.0,2.0

Descrição
-----------
Esse comando obtém os nomes e os dados do valor das entradas do Registro na chave PowerShellEngine. Os resultados são mostrados na saída de exemplo a seguir.

Exemplo 6

C:\PS>get-itemproperty -path HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds\Microsoft.PowerShell

Path                                                        ExecutionPolicy
----                                                        ---------------
C:\Windows\system32\WindowsPowerShell\v1.0\powershell.exe   RemoteSigned


C:\PS>get-itemproperty -path HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds\Microsoft.PowerShell | format-list -property *

PSPath          : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\Software\Microsoft\PowerShell\1\ShellIds\Micro
                  soft.PowerShell
PSParentPath    : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\Software\Microsoft\PowerShell\1\ShellIds
PSChildName     : Microsoft.PowerShell
PSDrive         : HKLM
PSProvider      : Microsoft.PowerShell.Core\Registry
Path            : C:\Windows\system32\WindowsPowerShell\v1.0\powershell.exe
ExecutionPolicy : RemoteSigned

Descrição
-----------
Este exemplo mostra como formatar a saída de um comando Get-ItemProperty em uma lista para facilitar a consulta dos valores e dos dados do Registro e a interpretação dos resultados.

O primeiro comando usa o cmdlet Get-ItemProperty para obter as entradas do Registro na subchave Microsoft.PowerShell. Esta subchave armazena opções do shell padrão para o Windows PowerShell. Os resultados são mostrados na saída de exemplo a seguir.

A saída mostra que há duas entradas do Registro, Path e ExecutionPolicy. Quando uma chave do Registro contiver menos do que cinco entradas, por padrão, ela será exibida em uma tabela, mas é frequentemente mais fácil de exibir em uma lista.

O segundo comando usa o mesmo comando Get-ItemProperty. Porém, agora, o comando usa um operador de pipeline (|) para enviar os resultados do comando para o cmdlet Format-List. O comando Format-List usa o parâmetro Property com o valor * (tudo) para exibir em uma lista todas as propriedades dos objetos.  Os resultados são mostrados na saída de exemplo a seguir.

A exibição resultante mostra as entradas do Registro Path e ExecutionPolicy, junto com várias propriedades menos familiares do objeto de chave do Registro. As outras propriedades, prefixadas com "PS", são propriedades de objetos personalizados do Windows PowerShell, como os objetos que representam as chaves do Registro.

Consulte também

Conceitos

about_Providers
Set-ItemProperty
Clear-ItemProperty
Copy-ItemProperty
Move-ItemProperty
New-ItemProperty
Remove-ItemProperty
Rename-ItemProperty

Compartilhar via