Set-Item

模块:

Microsoft.PowerShell.Management Module

将项的值更改为命令中指定的值。

语法

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>]

说明

该 cmdlet 将 Set-Item 项的值（如变量或注册表项）更改为命令中指定的值。

示例

示例 1：创建别名

此命令为记事本创建 np 的别名。

Set-Item -Path Alias:np -Value "C:\windows\notepad.exe"

示例 2：更改环境变量的值

此命令将 UserRole 环境变量的值更改为 Administrator。

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

示例 3：修改提示函数

此命令更改提示函数，以便显示路径前的时间。

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

示例 4：设置提示函数的选项

此命令设置提示函数的 AllScope 和 ReadOnly 选项。 此命令使用选项动态参数 。Set-Item 只有在将选项参数与Set-Item或函数提供程序一起使用时才可用。

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

参数

-Confirm

在运行 cmdlet 之前，提示你进行确认。

参数属性

类型:	SwitchParameter
默认值:	False
支持通配符:	False
不显示:	False
别名:	Cf

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Credential

注释

任何随 PowerShell 一起安装的提供程序都不支持此参数。 要模拟其他用户，或在运行此 cmdlet 时提升凭据，请使用 Invoke-Command。

参数属性

类型:	PSCredential
默认值:	Current user
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-Exclude

指定一个或多个在操作中被此 cmdlet 排除的项目，以字符串数组的形式表示。 此参数的值定义了 Path 参数的限定条件。 输入路径元素或模式，例如 *.txt。 允许使用通配符。 仅当命令包含项（如 ）的内容（其中通配符指定 C:\Windows\* 目录的内容）时，C:\Windows 参数才有效。

参数属性

类型:	String[]
默认值:	None
支持通配符:	True
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Filter

指定筛选器以限定 Path 参数。 唯一支持使用筛选器的 PowerShell 提供程序是已安装的 FileSystem 提供程序。 可以在 about_Wildcards中找到 FileSystem 筛选器语言的语法。 筛选器比其他参数更有效，因为提供程序在 cmdlet 获取对象时应用它们，而不是在检索对象后让 PowerShell 筛选对象。

参数属性

类型:	String
默认值:	None
支持通配符:	True
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Force

强制 cmdlet 设置无法更改的项，例如只读别名或变量。 cmdlet 无法更改常量别名或变量。 实现因服务提供商而异。 有关详细信息，请参阅 about_Providers。 即使使用 Force 参数，cmdlet 也无法替代安全限制。

参数属性

类型:	SwitchParameter
默认值:	False
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Include

指定一个或多个此 cmdlet 在操作中包含的项，这些项以字符串数组形式表示。 此参数的值定义了 Path 参数的限定条件。 输入路径元素或模式，例如 "*.txt"。 允许使用通配符。 仅当命令包含某项的内容（例如 ，其中通配符指定 C:\Windows\* 目录的内容）时，C:\Windows 参数才有效。

参数属性

类型:	String[]
默认值:	None
支持通配符:	True
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-LiteralPath

指定通向一个或多个位置的路径。 LiteralPath 的值严格按照所键入的形式使用。 不会将任何字符解释为通配符。 如果路径包含转义字符，请将它括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。

有关详细信息，请参阅 about_Quoting_Rules。

参数属性

类型:	String[]
默认值:	None
支持通配符:	False
不显示:	False
别名:	PSPath, LP

参数集

LiteralPath

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-Options

这是 别名 和 函数 提供程序提供的动态参数。 有关详细信息，请参阅 about_Alias_Provider 和 about_Function_Provider。

指定别名的 Options 属性的值。

有效值为：

• None：别名没有约束（默认值）
• ReadOnly：别名可以删除，但除非使用 Force 参数，否则无法更改。
• Constant：无法删除或更改别名
• Private：别名仅在当前范围内可用
• AllScope：别名复制到任何创建的新作用域。
• Unspecified：未指定选项

参数属性

类型:	ScopedItemOptions
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-PassThru

将表示项的对象传递给管道。 默认情况下，此 cmdlet 不生成任何输出。

参数属性

类型:	SwitchParameter
默认值:	False
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Path

指定项位置的路径。 允许使用通配符。

参数属性

类型:	String[]
默认值:	None
支持通配符:	True
不显示:	False

参数集

Path

Position:	0
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-Type

这是 注册表 提供程序提供的动态参数。 Registry 提供程序，此参数仅在Windows上可用。

指定此 cmdlet 添加的属性的类型。 此参数的可接受值为：

• String：指定以 null 结尾的字符串。 用于 REG_SZ 值。
• ExpandString：指定一个以 null 结尾的字符串，该字符串包含对检索值时展开的环境变量的未扩展引用。 用于 REG_EXPAND_SZ 值。
• Binary：以任意形式指定二进制数据。 用于 REG_BINARY 值。
• DWord：指定 32 位二进制数字。 用于 REG_DWORD 值。
• MultiString：指定以两个 null 字符结尾的以 null 结尾的字符串数组。 用于 REG_MULTI_SZ 值。
• Qword：指定 64 位二进制数字。 用于 REG_QWORD 值。
• Unknown：指示不受支持的注册表数据类型，例如 REG_RESOURCE_LIST 值。

参数属性

类型:	RegistryValueKind
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-Value

指定项的新值。

参数属性

类型:	Object
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	1
必需:	False
来自管道的值:	True
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:	SwitchParameter
默认值:	False
支持通配符:	False
不显示:	False
别名:	无线

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

输入

Object

可以通过管道将表示项的新值的对象传递给此 cmdlet。

输出

None

默认情况下，此 cmdlet 不返回任何输出。

Object

使用 PassThru 参数时，此 cmdlet 返回一个表示该项的对象。

备注

PowerShell 包含以下与 Set-Item相关的别名：

• 所有平台：

  • si

• Set-Item PowerShell FileSystem 提供程序不支持。 若要更改文件系统中项的值，请使用 Set-Content cmdlet。

• 在注册表驱动器中，HKLM:更改HKCU:Set-Item注册表项的 （默认值） 值中的数据。

  • 若要创建和更改注册表项的名称，请使用 New-Item 和 Rename-Item cmdlet。
  • 若要更改注册表值中的名称和数据，请使用New-ItemProperty和 Set-ItemPropertyRename-ItemProperty cmdlet。

• Set-Item 被设计用于处理任何供应商公开的数据。 若要列出会话中可用的提供程序，请键入 Get-PSProvider。 有关详细信息，请参阅 about_Providers。

相关链接

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