Set-ItemProperty

Módulo:: Microsoft.PowerShell.Management Module

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

Sintaxe

propertyValuePathSet (Default) - All providers

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

propertyPSObjectPathSet - All providers

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

propertyValueLiteralPathSet - All providers

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

propertyPSObjectLiteralPathSet - All providers

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

propertyValuePathSet (Default) - Registry provider

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

propertyPSObjectPathSet - Registry provider

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

propertyValueLiteralPathSet - Registry provider

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

propertyPSObjectLiteralPathSet - Registry provider

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

Description

O cmdlet Set-ItemProperty 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 para definir o valor da propriedade IsReadOnly de um objeto de arquivo para .

Você também usa Set-ItemProperty para criar e alterar dados e valores 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

Esse 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 variável $true automática representa um valor de "TRUE". Para obter mais informações, confira 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" em 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 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 o caminho para especificar o caminho da unidade HKLM: e a chave Software\MyCompany. O comando usa Name para especificar o nome de entrada e o valor para especificar um valor.

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

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

Você também pode usar o cmdlet New-ItemProperty 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 unidade HKLM:, 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 arquivo weekly.txt. O objeto de arquivo é canalizado para Set-ItemProperty. O comando Set-ItemProperty 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 sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	False
Dá suporte a curingas:	False
DontShow:	False
Aliases:	cf

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Credential

Observação

Esse parâmetro não tem suporte para nenhum provedor instalado com o PowerShell. Para executar este cmdlet em nome de outro usuário ou elevar suas credenciais, use Invoke-Command.

Propriedades do parâmetro

Tipo:	PSCredential
Valor padrão:	Current user
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	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 Excluir só é eficaz quando o comando inclui o conteúdo de um item, como C:\Windows\*, em que o caractere curinga especifica o conteúdo do diretório C:\Windows.

Propriedades do parâmetro

Tipo:	String[]
Valor padrão:	None
Dá suporte a curingas:	True
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Filter

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

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	True
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Force

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

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	False
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	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ó é eficaz quando o comando inclui o conteúdo de um item, como C:\Windows\*, em que o caractere curinga especifica o conteúdo do diretório C:\Windows.

Propriedades do parâmetro

Tipo:	String[]
Valor padrão:	None
Dá suporte a curingas:	True
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-InputObject

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

Propriedades do parâmetro

Tipo:	PSObject
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

propertyPSObjectPathSet

Cargo:	Named
Obrigatório:	True
Valor do pipeline:	True
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

propertyPSObjectLiteralPathSet

Cargo:	Named
Obrigatório:	True
Valor do pipeline:	True
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

-LiteralPath

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

Para mais informações, consulte sobre_Regras_de_Citação.

Propriedades do parâmetro

Tipo:	String[]
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	PSPath, LP

Conjuntos de parâmetros

propertyValueLiteralPathSet

Cargo:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

propertyPSObjectLiteralPathSet

Cargo:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

-Name

Especifica o nome da propriedade.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	PSProperty

Conjuntos de parâmetros

propertyValuePathSet

Cargo:	1
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

propertyValueLiteralPathSet

Cargo:	1
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

-PassThru

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

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Path

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

Propriedades do parâmetro

Tipo:	String[]
Valor padrão:	None
Dá suporte a curingas:	True
DontShow:	False

Conjuntos de parâmetros

propertyValuePathSet

Cargo:	0
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

propertyPSObjectPathSet

Cargo:	0
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

-Type

Esse é 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 este cmdlet adiciona. Os valores aceitáveis para este parâmetro são:

String: especifica uma cadeia de caracteres terminada em nulo. Usado para valores de REG_SZ.
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 valores REG_EXPAND_SZ.
Binary: especifica dados binários em qualquer forma. Usado para valores REG_BINARY.
DWord: especifica um número binário de 32 bits. Usado para valores REG_DWORD.
MultiString: especifica uma matriz de cadeias de caracteres terminadas em nulo encerradas por dois caracteres nulos. Usado para valores REG_MULTI_SZ.
Qword: especifica um número binário de 64 bits. Usado para valores REG_QWORD.
Unknown: indica um tipo de dados do Registro sem suporte, como valores de REG_RESOURCE_LIST.

Propriedades do parâmetro

Tipo:	RegistryValueKind
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

-Value

Especifica o valor da propriedade.

Propriedades do parâmetro

Tipo:	Object
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

propertyValuePathSet

Cargo:	2
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

propertyValueLiteralPathSet

Cargo:	2
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	False
Dá suporte a curingas:	False
DontShow:	False
Aliases:	wi

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSObject

Você pode redirecionar 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.

Observações

O PowerShell inclui os seguintes aliases para Set-ItemProperty:

Todas as plataformas:
- sp

Set-ItemProperty foi projetado para trabalhar com os dados expostos por qualquer provedor. Para listar os provedores disponíveis na sessão, digite Get-PSProvider. Para obter mais informações, consulte about_Providers.

Comentários

Esta página foi útil?

Compartilhar via

Set-ItemProperty

Sintaxe

propertyValuePathSet (Default) - All providers

propertyPSObjectPathSet - All providers

propertyValueLiteralPathSet - All providers

propertyPSObjectLiteralPathSet - All providers

propertyValuePathSet (Default) - Registry provider

propertyPSObjectPathSet - Registry provider

propertyValueLiteralPathSet - Registry provider

propertyPSObjectLiteralPathSet - Registry provider

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

Propriedades do parâmetro

Conjuntos de parâmetros

-Credential

Propriedades do parâmetro

Conjuntos de parâmetros

-Exclude

Propriedades do parâmetro

Conjuntos de parâmetros

-Filter

Propriedades do parâmetro

Conjuntos de parâmetros

-Force

Propriedades do parâmetro

Conjuntos de parâmetros

-Include

Propriedades do parâmetro

Conjuntos de parâmetros

-InputObject

Propriedades do parâmetro

Conjuntos de parâmetros

-LiteralPath

Propriedades do parâmetro

Conjuntos de parâmetros

-Name

Propriedades do parâmetro

Conjuntos de parâmetros

-PassThru

Propriedades do parâmetro

Conjuntos de parâmetros

-Path

Propriedades do parâmetro

Conjuntos de parâmetros

-Type

Propriedades do parâmetro

Conjuntos de parâmetros

-Value

Propriedades do parâmetro

Conjuntos de parâmetros

-WhatIf

Propriedades do parâmetro

Conjuntos de parâmetros

CommonParameters

Entradas

PSObject

Saídas

None

PSCustomObject

Observações

Links Relacionados

Comentários