Set-ItemProperty

Referência

Módulo:: Microsoft.PowerShell.Management

Cria ou altera o valor de uma propriedade de um item.

Sintaxe

Set-ItemProperty
   [-Path] <string[]>
   [-Name] <string>
   [-Value] <Object>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-ItemProperty
   [-Path] <string[]>
   -InputObject <psobject>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-ItemProperty
   [-Name] <string>
   [-Value] <Object>
   -LiteralPath <string[]>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-ItemProperty
   -LiteralPath <string[]>
   -InputObject <psobject>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-ItemProperty
   [-Path] <string[]>
   [-Name] <string>
   [-Value] <Object>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-Type <RegistryValueKind>]
   [<CommonParameters>]

Set-ItemProperty
   [-Path] <string[]>
   -InputObject <psobject>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-Type <RegistryValueKind>]
   [<CommonParameters>]

Set-ItemProperty
   [-Name] <string>
   [-Value] <Object>
   -LiteralPath <string[]>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-Type <RegistryValueKind>]
   [<CommonParameters>]

Set-ItemProperty
   -LiteralPath <string[]>
   -InputObject <psobject>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-Type <RegistryValueKind>]
   [<CommonParameters>]

Description

O Set-ItemProperty cmdlet altera o valor da propriedade do item especificado. Você pode usar o cmdlet para estabelecer ou alterar as propriedades dos itens. Por exemplo, você pode usar Set-ItemProperty para definir o valor da propriedade IsReadOnly de um objeto de arquivo como $True.

Você também usa Set-ItemProperty para criar e alterar valores e dados do Registro. Por exemplo, você pode adicionar uma nova entrada do Registro a uma chave e estabelecer ou alterar seu valor.

Exemplos

Exemplo 1: Definir uma propriedade de um arquivo

Este comando define o valor da propriedade IsReadOnly do arquivo "final.doc" como "true". Ele usa Path para especificar o arquivo, Name para especificar o nome da propriedade e o parâmetro Value para especificar o novo valor.

O arquivo é um objeto System.IO.FileInfo e IsReadOnly é apenas uma de suas propriedades. Para ver todas as propriedades, digite Get-Item C:\GroupFiles\final.doc | Get-Member -MemberType Property.

A $true variável automática representa um valor de "TRUE". Para obter mais informações, consulte about_Automatic_Variables.

Set-ItemProperty -Path C:\GroupFiles\final.doc -Name IsReadOnly -Value $true

Exemplo 2: Criar uma entrada e um valor do Registro

Este exemplo mostra como usar Set-ItemProperty para criar uma nova entrada do Registro e atribuir um valor à entrada. Ele cria a entrada "NoOfEmployees" na chave "ContosoCompany" na HKLM\Software chave e define seu valor como 823.

Como as entradas do Registro são consideradas propriedades das chaves do Registro, que são itens, você usa Set-ItemProperty para criar entradas do Registro e para estabelecer e alterar seus valores.

Set-ItemProperty -Path "HKLM:\Software\ContosoCompany" -Name "NoOfEmployees" -Value 823
Get-ItemProperty -Path "HKLM:\Software\ContosoCompany"

PSPath        : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\contosocompany
PSParentPath  : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software
PSChildName   : contosocompany
PSDrive       : HKLM
PSProvider    : Microsoft.PowerShell.Core\Registry
NoOfLocations : 2
NoOfEmployees : 823

Set-ItemProperty -Path "HKLM:\Software\ContosoCompany" -Name "NoOfEmployees" -Value 824
Get-ItemProperty -Path "HKLM:\Software\ContosoCompany"

PSPath        : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\contosocompany
PSParentPath  : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software
PSChildName   : contosocompany
PSDrive       : HKLM
PSProvider    : Microsoft.PowerShell.Core\Registry
NoOfLocations : 2
NoOfEmployees : 824

O primeiro comando cria a entrada do Registro. Ele usa Path para especificar o HKLM: caminho da unidade e a Software\MyCompany chave. O comando usa Name para especificar o nome da entrada e Value para especificar um valor.

O segundo comando usa o Get-ItemProperty cmdlet para ver a nova entrada do Registro. Se você usar os Get-Item cmdlets or Get-ChildItem , as entradas não aparecerão porque são propriedades de uma chave, não itens ou itens filho.

O terceiro comando altera o valor da entrada NoOfEmployees para 824.

Você também pode usar o New-ItemProperty cmdlet para criar a entrada do Registro e seu valor e, em seguida, usar Set-ItemProperty para alterar o valor.

Para obter mais informações sobre a HKLM: unidade, digite Get-Help Get-PSDrive. Para obter mais informações sobre como usar o PowerShell para gerenciar o registro, digite Get-Help Registry.

Exemplo 3: Modificar um item usando o pipeline

O exemplo usa Get-ChildItem para obter o weekly.txt arquivo. O objeto de arquivo é canalizado para Set-ItemProperty. O Set-ItemProperty comando usa os parâmetros Name e Value para especificar a propriedade e seu novo valor.

Get-ChildItem weekly.txt | Set-ItemProperty -Name IsReadOnly -Value $True

Parâmetros

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Credential

Nota

Esse parâmetro não é suportado por nenhum provedor instalado com o PowerShell. Para representar outro usuário ou elevar suas credenciais ao executar esse cmdlet, use Invoke-Command.

Tipo:	PSCredential
Position:	Named
Default value:	Current user
Necessário:	False
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	False

-Exclude

Especifica, como uma matriz de cadeia de caracteres, um item ou itens que esse cmdlet exclui na operação. O valor desse parâmetro qualifica o parâmetro Path . Insira um elemento ou padrão de caminho, como *.txt. Caracteres curinga são permitidos. O parâmetro Exclude é efetivo somente quando o comando inclui o conteúdo de um item, como , onde C:\Windows\*o caractere curinga especifica o C:\Windows conteúdo do diretório.

Tipo:	String[]
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	True

-Filter

Especifica um filtro para qualificar o parâmetro Path . O provedor FileSystem é o único provedor PowerShell instalado que oferece suporte ao uso de filtros. Você pode encontrar a sintaxe para a linguagem de filtro FileSystem em about_Wildcards. Os filtros são mais eficientes do que outros parâmetros, porque o provedor os aplica quando o cmdlet obtém os objetos em vez de fazer com que o PowerShell filtre os objetos depois que eles são recuperados.

Tipo:	String
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	True

-Force

Força o cmdlet a definir uma propriedade em itens que não podem ser acessados pelo usuário de outra forma. A implementação varia de acordo com o fornecedor. Para obter mais informações, consulte about_Providers.

Tipo:	SwitchParameter
Position:	Named
Default value:	False
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Include

Especifica, como uma matriz de cadeia de caracteres, um item ou itens que esse cmdlet inclui na operação. O valor desse parâmetro qualifica o parâmetro Path . Insira um elemento ou padrão de caminho, como "*.txt". Caracteres curinga são permitidos. O parâmetro Include só é efetivo quando o comando inclui o conteúdo de um item, como , onde C:\Windows\*o caractere curinga especifica o C:\Windows conteúdo do diretório.

Tipo:	String[]
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	True

-InputObject

Especifica o objeto que tem as propriedades que esse cmdlet altera. Insira uma variável que contenha o objeto ou um comando que obtenha o objeto.

Tipo:	PSObject
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	False

-LiteralPath

Especifica um caminho para um ou mais locais. O valor de LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.

Para obter mais informações, consulte about_Quoting_Rules.

Tipo:	String[]
Aliases:	PSPath, LP
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	False

-Name

Especifica o nome da propriedade.

Tipo:	String
Aliases:	PSProperty
Position:	1
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	False

-PassThru

Retorna um objeto que representa a propriedade item. Por padrão, esse cmdlet não gera nenhuma saída.

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Path

Especifica o caminho dos itens com a propriedade a ser modificada. Caracteres curinga são permitidos.

Tipo:	String[]
Position:	0
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	True

-Type

Este é um parâmetro dinâmico disponibilizado pelo provedor do Registro . O provedor do Registro e esse parâmetro só estão disponíveis no Windows.

Especifica o tipo de propriedade que esse cmdlet adiciona. Os valores aceitáveis para este parâmetro são:

String: Especifica uma cadeia de caracteres terminada em nulo. Usado para REG_SZ valores.
ExpandString: Especifica uma cadeia de caracteres terminada em nulo que contém referências não expandidas a variáveis de ambiente que são expandidas quando o valor é recuperado. Usado para REG_EXPAND_SZ valores.
Binary: Especifica dados binários em qualquer formato. Usado para REG_BINARY valores.
DWord: Especifica um número binário de 32 bits. Usado para REG_DWORD valores.
MultiString: Especifica uma matriz de cadeias de caracteres terminadas em nulo terminadas por dois caracteres nulos. Usado para REG_MULTI_SZ valores.
Qword: Especifica um número binário de 64 bits. Usado para REG_QWORD valores.
Unknown: Indica um tipo de dados do Registro sem suporte, como valores REG_RESOURCE_LIST .

Tipo:	RegistryValueKind
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	False

-Value

Especifica o valor da propriedade.

Tipo:	Object
Position:	2
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

Entradas

PSObject

Você pode canalizar objetos para este cmdlet.

Saídas

None

Por padrão, esse cmdlet não retorna nenhuma saída.

PSCustomObject

Quando você usa o parâmetro PassThru , esse cmdlet retorna um objeto PSCustomObject que representa o item que foi alterado e seu novo valor de propriedade.

Notas

O PowerShell inclui os seguintes aliases para Set-ItemProperty:

Todas as plataformas:
- sp

Set-ItemProperty é projetado para trabalhar 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.

Partilhar via

Set-ItemProperty

Sintaxe

Description

Exemplos

Exemplo 1: Definir uma propriedade de um arquivo

Exemplo 2: Criar uma entrada e um valor do Registro

Exemplo 3: Modificar um item usando o pipeline

Parâmetros

-Confirm

-Credential

-Exclude

-Filter

-Force

-Include

-InputObject

-LiteralPath

-Name

-PassThru

-Path

-Type

-Value

-WhatIf

Entradas

Saídas

Notas

Recursos adicionais

Partilhar via

Set-ItemProperty

Sintaxe

Description

Exemplos

Exemplo 1: Definir uma propriedade de um arquivo

Exemplo 2: Criar uma entrada e um valor do Registro

Exemplo 3: Modificar um item usando o pipeline

Parâmetros

-Confirm

-Credential

-Exclude

-Filter

-Force

-Include

-InputObject

-LiteralPath

-Name

-PassThru

-Path

-Type

-Value

-WhatIf

Entradas

Saídas

Notas

Ligações Relacionadas

Recursos adicionais