Set-Item

Módulo:

Microsoft.PowerShell.Management

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

Syntax

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

Esse comando altera o valor da variável de ambiente UserRole para Administrador.

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

Exemplo 3: Modificar a função de prompt

Esse comando altera a função de prompt para que ele 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 sua função de prompt

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

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

Parâmetros

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

Observação

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.

Type:	PSCredential
Position:	Named
Default value:	Current user
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	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 , em C:\Windows\*que o caractere curinga C:\Windows especifica o conteúdo do diretório.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Filter

Especifica um filtro para qualificar o parâmetro Path . O provedor FileSystem é o único provedor do PowerShell instalado que oferece suporte ao uso de filtros. Você pode encontrar a sintaxe do idioma 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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Force

Força o cmdlet a definir itens que não podem ser alterados, como alias somente leitura ou variáveis. O cmdlet não pode alterar variáveis nem aliases 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.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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 é efetivo somente quando o comando inclui o conteúdo de um item, como , onde C:\Windows\*o caractere curinga C:\Windows especifica o conteúdo do diretório.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-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 dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.

Para obter mais informações, consulte about_Quoting_Rules.

Type:	String[]
Aliases:	PSPath, LP
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	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 somente no escopo atual
• AllScope: O alias é copiado para todos os novos escopos criados
• Unspecified: A opção não está especificada

Type:	ScopedItemOptions
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

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

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

Especifica um caminho do local dos itens. Caracteres curinga são permitidos.

Type:	String[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	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 esse parâmetro são:

• String: Especifica uma cadeia de caracteres terminada em nulo. Usado para valores 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 formato. 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 terminadas 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 REG_RESOURCE_LIST .

Type:	RegistryValueKind
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Value

Especifica um novo valor para o item.

Type:	Object
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entradas

Object

Você pode canalizar um objeto que representa o novo valor do item para esse 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.

Observações

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 and Rename-Item .
  • Para alterar os nomes e 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.

Links Relacionados

• Clear-Item
• Copy-Item
• Get-Item
• Invoke-Item
• Move-Item
• New-Item
• Remove-Item
• Rename-Item
• about_Providers