Troca o valor de um item pelo valor especificado no comando.
Sintaxe
Set-Item [-LiteralPath] <string[]> [[-Value] <Object>] [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>] Set-Item [-Path] <string[]> [[-Value] <Object>] [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]
Descrição
O cmdlet Set-Item altera o valor de um item, como uma variável ou uma chave do Registro, para o valor especificado no comando.
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 defina os itens que não podem ser alterados, como variáveis ou aliases somente leitura. O cmdlet não pode alterar 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[]>
Altera 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é o local atual dos novos itens. 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 |
-PassThru
Passa um objeto que representa o item para o pipeline. Por padrão, este cmdlet não gera nenhuma saída.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-Path <string[]>
Especifica um caminho até o local atual dos novos itens. Os caracteres curinga são permitidos.
|
Necessário? |
true |
|
Posição? |
1 |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
true (ByPropertyName) |
|
Aceitar caracteres curinga? |
false |
-Value <Object>
Especifica um novo valor para o item.
|
Necessário? |
false |
|
Posição? |
2 |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
true (ByValue, 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 |
System.Object Você pode enviar um objeto que representa o novo valor do item para Set-Item. |
|
Saídas |
None ou um objeto que representa o item novo ou alterado. Quando você usa o parâmetro Passthru, Set-Item gera um objeto que representa o item. Caso contrário, esse cmdlet não gera nenhuma saída. |
Observações
Você também pode fazer referência a Set-Item usando seu alias interno, "si". Para obter mais informações, consulte about_Aliases.
O cmdlet Set-Item não tem suporte do provedor FileSystem do Windows PowerShell. Para alterar o valor dos itens no sistema de arquivos, utilize Set-Content.
Nas unidades Registry, HKLM: e HKCU:, Set-Item altera os dados no valor (Padrão) de uma chave do Registro. Para criar e alterar os nomes de chaves do Registro, use New-Item e Rename-Item. Para alterar os nomes e os dados nos valores do Registro, use New-ItemProperty, Set-ItemProperty e Rename-ItemProperty.
O cmdlet Set-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>set-item -path alias:np -value c:\windows\notepad.exe Descrição ----------- Esse comando cria um alias "np" para o Bloco de Notas.
Exemplo 2
C:\PS>set-item -path env:UserRole -value Administrator Descrição ----------- Esse comando usa o cmdlet Set-Item para trocar o valor da variável de ambiente "UserRole" para "Administrator".
Exemplo 3
C:\PS>set-item -path function:prompt -value {'PS '+ $(Get-Date -format t) + " " + $(Get-Location) + '> '}
Descrição
-----------
Esse comando utiliza o cmdlet Set-Item para alterar a função "prompt" de forma que ela exiba a hora antes do caminho.
Exemplo 4
C:\PS>set-item -path function:prompt -options "AllScope,ReadOnly" Descrição ----------- Esse comando define as opções AllScope e ReadOnly para a função "prompt". Ele usa o parâmetro dinâmico Options do cmdlet Set-Item. O parâmetro Options fica disponível em Set-Item somente quando é utilizado com o provedor Alias ou Function.
See Also