New-ItemProperty
Cria uma nova propriedade para um item e define seu valor. Por exemplo, você pode usar New-ItemProperty para criar e alterar dados e valores do Registro, que são propriedades de uma chave do Registro.
Sintaxe
New-ItemProperty [-LiteralPath] <string[]> [-Name] <string> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-PropertyType <string>] [-Value <Object>] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]
New-ItemProperty [-Path] <string[]> [-Name] <string> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-PropertyType <string>] [-Value <Object>] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]
Descrição
O cmdlet New-ItemProperty cria uma nova propriedade para um item especificado e define seu valor. Em geral, este cmdlet é usado para criar novos valores de Registro, porque os valores de Registro são propriedades de um item de chave do Registro.
Este cmdlet não adiciona propriedades a um objeto. Para adicionar uma propriedade a uma instância de um objeto, use o cmdlet Add-Member. Para adicionar uma propriedade a todos os objetos de um determinado tipo, edite o arquivo Types.ps1xml.
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 |
-Force
Permite que o cmdlet crie uma propriedade em um objeto que não podem ser acessados de outra forma pelo usuário. A implementação varia de provedor para provedor. Para obter mais informações, consulte about_Providers.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Include <string[]>
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 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 um nome para a nova propriedade. Se a propriedade for uma entrada do Registro, este parâmetro especificará o nome da entrada.
Necessário? |
true |
Posição? |
2 |
Valor padrão |
|
Aceitar entrada do pipeline? |
true (ByPropertyName) |
Aceitar caracteres curinga? |
false |
-Path <string[]>
Especifica o caminho até o item. Este parâmetro identifica o item ao qual a nova propriedade será adicionada.
Necessário? |
true |
Posição? |
1 |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-PropertyType <string>
Especifica o tipo de propriedade que será adicionado.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
true (ByPropertyName) |
Aceitar caracteres curinga? |
false |
-Value <Object>
Especifica o valor da propriedade. Se a propriedade for uma entrada do Registro, este parâmetro especificará o valor da entrada.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
true (ByPropertyName) |
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 |
Nenhum Não é possível enviar a entrada para New-ItemProperty. |
Saídas |
System.Management.Automation.PSCustomObject New-ItemProperty retorna um objeto personalizado que contém a nova propriedade. |
Observações
O cmdlet New-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>new-itemproperty -path HKLM:\Software\MyCompany -name NoOfEmployees -value 822
C:\PS> get-itemproperty hklm:\software\mycompany
PSPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\mycompany
PSParentPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software
PSChildName : mycompany
PSDrive : HKLM
PSProvider : Microsoft.PowerShell.Core\Registry
NoOfLocations : 2
NoOfEmployees : 822
Descrição
-----------
Esse comando adiciona uma nova entrada do Registro, NoOfEmployees, à chave MyCompany do hive HKLM:\Software.
O primeiro comando usa o parâmetro Path para especificar o caminho até a chave do Registro MyCompany. Ele usa o parâmetro Name para especificar um nome para a entrada e parâmetro Value para especificar seu valor.
O segundo comando usa o cmdlet Get-ItemProperty para ver a nova entrada do Registro.
Exemplo 2
C:\PS>get-item -path HKLM:\Software\MyCompany | new-Itemproperty -name NoOfLocations -value 3
Descrição
-----------
Esse comando adiciona uma nova entrada do Registro a uma chave do Registro. Para especificar a chave, ele usa um operador de pipeline (|) para enviar um objeto que representa a chave para o cmdlet New-ItemProperty.
A primeira parte do comando usa o cmdlet Get-Item para obter a chave do Registro MyCompany. O operador de pipeline (|) envia os resultados do comando para o cmdlet New-ItemProperty, que adiciona a nova entrada do Registro, NoOfLocations, e seu valor, 3, à chave MyCompany.
Esse comando funciona porque o recurso de ligação de parâmetros do Windows PowerShell associa o caminho do objeto RegistryKey retornado por Get-Item ao parâmetro LiteralPath de New-ItemProperty. Para obter mais informações, consulte about_Pipelines.
Consulte também
Conceitos
about_Providers
Clear-ItemProperty
Copy-ItemProperty
Move-ItemProperty
Rename-ItemProperty
Get-ItemProperty
Set-ItemProperty
Remove-ItemProperty