Set-Item

  • Referência
Módulo:
Microsoft.PowerShell.Management

Altera o valor de um item para o valor especificado no comando.

Sintaxe

Set-Item
   [-Path] <String[]>
   [[-Value] <Object>]
   [-Force]
   [-PassThru]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-Item
   -LiteralPath <String[]>
   [[-Value] <Object>]
   [-Force]
   [-PassThru]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-Item
   [-Path] <string[]>
   [[-Value] <Object>]
   [-Force]
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-Options <ScopedItemOptions>]
   [<CommonParameters>]
Set-Item
   [[-Value] <Object>]
   -LiteralPath <string[]>
   [-Force]
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-Options <ScopedItemOptions>]
   [<CommonParameters>]
Set-Item
   [-Path] <string[]>
   [[-Value] <Object>]
   [-Force]
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-Type <RegistryValueKind>]
   [<CommonParameters>]
Set-Item
   [[-Value] <Object>]
   -LiteralPath <string[]>
   [-Force]
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-Type <RegistryValueKind>]
   [<CommonParameters>]

Description

O Set-Item cmdlet altera o valor de um item, como uma variável ou chave do Registro, para o valor especificado no comando.

Exemplos

Exemplo 1: Criar um alias

Este comando cria um alias de np para o Bloco de Notas.

Set-Item -Path alias:np -Value "c:\windows\notepad.exe"

Exemplo 2: Alterar o valor de uma variável de ambiente

Este comando altera o valor da variável de ambiente UserRole para Administrator.

Set-Item -Path env:UserRole -Value "Administrator"

Exemplo 3: Modificar a função de prompt

Este comando altera a função de prompt para que ela exiba o tempo antes do caminho.

Set-Item -Path function:prompt -Value {'PS '+ (Get-Date -Format t) + " " + (Get-Location) + '> '}

Exemplo 4: Definir opções para a função de prompt

Este comando define as opções AllScope e ReadOnly para a função prompt. Este comando usa o parâmetro dinâmico Options de Set-Item. O parâmetro Options está disponível somente quando Set-Item você o usa com o provedor Alias ou Function .

Set-Item -Path function:prompt -Options "AllScope,ReadOnly"

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 itens que não podem ser alterados de outra forma, como alias ou variáveis somente leitura. O cmdlet não pode alterar aliases ou variáveis constantes. A implementação varia de fornecedor para fornecedor. Para obter mais informações, consulte about_Providers. Mesmo usando o parâmetro Force , o cmdlet não pode substituir restrições de segurança.

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

-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

-Options

Este é um parâmetro dinâmico disponibilizado pelos provedores Alias e Function . Para obter mais informações, consulte about_Alias_Provider e about_Function_Provider.

Especifica o valor da propriedade Options de um alias.

Os valores válidos são:

  • None: O alias não tem restrições (valor padrão)
  • ReadOnly: O alias pode ser excluído, mas não pode ser alterado sem usar o parâmetro Force
  • Constant: O alias não pode ser excluído ou alterado
  • Private: O alias está disponível apenas no escopo atual
  • AllScope: O alias é copiado para todos os novos escopos criados
  • Unspecified: A opção não está especificada
Tipo:ScopedItemOptions
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-PassThru

Passa um objeto que representa o item para o pipeline. Por padrão, esse cmdlet não gera nenhuma saída.

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

-Path

Especifica um caminho do local dos itens. 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 um novo valor para o item.

Tipo:Object
Position:1
Default value:None
Necessário:False
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

Object

Você pode canalizar um objeto que representa o novo valor do item para este cmdlet.

Saídas

None

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

Object

Quando você usa o parâmetro PassThru , esse cmdlet retorna um objeto que representa o item.

Notas

O PowerShell inclui os seguintes aliases para Set-Item:

  • Todas as plataformas:

    • si

  • Set-Item não é suportado pelo provedor do Sistema de Arquivos do PowerShell. Para alterar os valores dos itens no sistema de arquivos, use o Set-Content cmdlet.

  • Nas unidades HKLM: do Registro e HKCU:, Set-Item altera os dados no valor (Padrão) de uma chave do Registro.

    • Para criar e alterar os nomes das chaves do Registro, use o New-Item cmdlet e Rename-Item .
    • Para alterar os nomes e os dados nos valores do Registro, use os New-ItemPropertycmdlets , Set-ItemPropertye Rename-ItemProperty .

  • Set-Item é 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.