| external help file | Locale | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Microsoft.PowerShell.Commands.Management.dll-Help.xml |
en-US |
Microsoft.PowerShell.Management |
12/12/2022 |
2.0.0 |
New-ItemProperty |
Creates a new property for an item and sets its value.
New-ItemProperty [-Path] <String[]> [-Name] <String> [-PropertyType <String>] [-Value <Object>] [-Force]
[-Filter <String>] [-Include <String[]>] [-Exclude <String[]>] [-Credential <PSCredential>] [-WhatIf]
[-Confirm] [-UseTransaction] [<CommonParameters>]
New-ItemProperty -LiteralPath <String[]> [-Name] <String> [-PropertyType <String>] [-Value <Object>] [-Force]
[-Filter <String>] [-Include <String[]>] [-Exclude <String[]>] [-Credential <PSCredential>] [-WhatIf]
[-Confirm] [-UseTransaction] [<CommonParameters>]
The New-ItemProperty cmdlet creates a new property for a specified item and sets its value.
Typically, this cmdlet is used to create new registry values, because registry values are properties
of a registry key item.
This cmdlet does not add properties to an object.
- To add a property to an instance of an object, use the
Add-Membercmdlet. - To add a property to all objects of a particular type, modify the Types.ps1xml file.
This command adds a new registry entry, NoOfEmployees, to the MyCompany key of the
HKLM:\Software hive.
The first command uses the Path parameter to specify the path of the MyCompany registry key.
It uses the Name parameter to specify a name for the entry and the Value parameter to
specify its value.
The second command uses the Get-ItemProperty cmdlet to see the new registry entry.
New-ItemProperty -Path "HKLM:\Software\MyCompany" -Name "NoOfEmployees" -Value 822
Get-ItemProperty "HKLM:\Software\MyCompany"PSPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\mycompany
PSParentPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software
PSChildName : mycompany
PSDrive : HKLM
PSProvider : Microsoft.PowerShell.Core\Registry
NoOfLocations : 2
NoOfEmployees : 822
This command adds a new registry entry to a registry key. To specify the key, it uses a pipeline
operator (|) to send an object that represents the key to New-ItemProperty.
The first part of the command uses the Get-Item cmdlet to get the MyCompany registry key. The
pipeline operator sends the results of the command to New-ItemProperty, which adds the new
registry entry (NoOfLocations), and its value (3), to the MyCompany key.
Get-Item -Path "HKLM:\Software\MyCompany" | New-ItemProperty -Name NoOfLocations -Value 3This command works because the parameter-binding feature of Windows PowerShell associates the path
of the RegistryKey object that Get-Item returns with the LiteralPath parameter of
New-ItemProperty. For more information, see
about_Pipelines.
This example creates a MultiString value using a Here-String.
$newValue = New-ItemProperty -Path "HKLM:\SOFTWARE\ContosoCompany\" -Name 'HereString' -PropertyType MultiString -Value @"
This is text which contains newlines
It can also contain "quoted" strings
"@
$newValue.multistringThis is text which contains newlines
It can also contain "quoted" strings
The example shows how to use an array of values to create the MultiString value.
$newValue = New-ItemProperty -Path "HKLM:\SOFTWARE\ContosoCompany\" -Name 'MultiString' -PropertyType MultiString -Value ('a','b','c')
$newValue.multistring[0]a
Specifies a user account that has permission to perform this action. The default is the current user.
Type a user name, such as User01 or Domain01\User01, or enter a PSCredential object, such as
one generated by the Get-Credential cmdlet. If you type a user name, you are prompted for a
password.
Note
This parameter is not supported by any providers installed with PowerShell. To impersonate another user, or elevate your credentials when running this cmdlet, use Invoke-Command.
Type: System.Management.Automation.PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Current user
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies, as a string array, a property or property that this cmdlet excludes from the operation.
The value of this parameter qualifies the Path parameter.
Enter a path element or pattern, such as *.txt.
Wildcard characters are permitted.
Type: System.String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies a filter in the format or language of the provider. The value of this parameter qualifies the Path parameter.
The syntax of the filter, including the use of wildcard characters, depends on the provider. Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseForces the cmdlet to create a property on an object that cannot otherwise be accessed by the user. Implementation varies from provider to provider. For more information, see about_Providers.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies, as a string array, an item or items that this cmdlet includes in the operation. The value
of this parameter qualifies the Path parameter. Enter a path element or pattern, such as
*.txt. Wildcard characters are permitted. The Include parameter is effective only when the
command includes the contents of an item, such as C:\Windows\*, where the wildcard character
specifies the contents of the C:\Windows directory.
Type: System.String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies a path to one or more locations. The value of LiteralPath is used exactly as it is
typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose
it in single quotation marks ('). Single quotation marks tell PowerShell not to interpret any
characters as escape sequences.
For more information, see about_Quoting_Rules.
Type: System.String[]
Parameter Sets: LiteralPath
Aliases: PSPath
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies a name for the new property. If the property is a registry entry, this parameter specifies the name of the entry.
Type: System.String
Parameter Sets: (All)
Aliases: PSProperty
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies the path of the item. This parameter identifies the item to which this cmdlet adds the new property.
Type: System.String[]
Parameter Sets: Path
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the type of property that this cmdlet adds. The acceptable values for this parameter are:
String: Specifies a null-terminated string. Used for REG_SZ values.ExpandString: Specifies a null-terminated string that contains unexpanded references to environment variables that are expanded when the value is retrieved. Used for REG_EXPAND_SZ values.Binary: Specifies binary data in any form. Used for REG_BINARY values.DWord: Specifies a 32-bit binary number. Used for REG_DWORD values.MultiString: Specifies an array of null-terminated strings terminated by two null characters. Used for REG_MULTI_SZ values.Qword: Specifies a 64-bit binary number. Used for REG_QWORD values.Unknown: Indicates an unsupported registry data type, such as REG_RESOURCE_LIST values.
Type: System.String
Parameter Sets: (All)
Aliases: Type
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseIncludes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see about_Transactions.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: usetx
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the property value. If the property is a registry entry, this parameter specifies the value of the entry.
Type: System.Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable,
-Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.
You can't pipe objects to this cmdlet.
This cmdlet returns a custom object representing the new property.
New-ItemProperty is designed to work with the data exposed by any provider. To list the providers
available in your session, type Get-PSProvider. For more information, see
about_Providers.