Set-Item

Módulo:

Microsoft.PowerShell.Management Module

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

Sintaxe

Path (Default) - All providers

Set-Item
    [-Path] <String[]>
    [[-Value] <Object>]
    [-Force]
    [-PassThru]
    [-Filter <String>]
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-Credential <PSCredential>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

LiteralPath - All providers

Set-Item
    [[-Value] <Object>]
    -LiteralPath <String[]>
    [-Force]
    [-PassThru]
    [-Filter <String>]
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-Credential <PSCredential>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Path (Default) - Alias and Function providers

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

LiteralPath - Alias and Function providers

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

Path (Default) - Registry provider

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

LiteralPath - Registry provider

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

Description

O cmdlet Set-Item 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

Esse 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 sua função de prompt

Esse comando altera a função de solicitação para que ela exiba a hora anterior ao 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 solicitação. Esse comando usa o parâmetro dinâmico Opções de Set-Item. O parâmetro Opções só está disponível no Set-Item quando você o usa com o provedor Alias ou Função.

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

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

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

-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

LiteralPath

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

-Options

Esse é um parâmetro dinâmico disponibilizado pelos provedores Alias e Function. Para 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 qualquer novo escopo criado.
• Unspecified: a opção não está especificada

Propriedades do parâmetro

Tipo:	ScopedItemOptions
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

-PassThru

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

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

-Path

Especifica um caminho para a localização dos itens. 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

Path

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 um novo valor para o item.

Propriedades do parâmetro

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

Conjuntos de parâmetros

(All)

Cargo:	1
Obrigatório:	False
Valor do pipeline:	True
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

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.

Observações

O PowerShell inclui os seguintes aliases para Set-Item:

• Todas as plataformas:

  • si

• Set-Item não é compatível com o provedor do PowerShell FileSystem. Para alterar os valores dos itens no sistema de arquivos, use o cmdlet Set-Content.

• Nas unidades Registry, HKLM: e HKCU:, o 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 cmdlet New-Item e Rename-Item.
  • Para alterar os nomes e dados nos valores do registro, use os cmdlets New-ItemProperty, Set-ItemPropertye Rename-ItemProperty.

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

Links Relacionados

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