| external help file | Module Name | online version | schema |
|---|---|---|---|
PSScriptTools-help.xml |
PSScriptTools |
2.0.0 |
Rename a hashtable key.
Rename-Hashtable [-InputObject] <Object> [-Key] <String> [-NewKey] <String>
[-PassThru] [-Scope <String>] [-WhatIf] [-Confirm] [<CommonParameters>]Rename-Hashtable [-Name] <String> [-Key] <String> [-NewKey] <String>
[-PassThru] [-Scope <String>] [-WhatIf] [-Confirm] [<CommonParameters>]This command will rename a key in an existing hashtable or ordered dictionary. You can either pipe a hashtable object to this command or you can specify a variable name for a pre-defined hashtable. If you use this option, specify the variable name without the $.
This command will create a temporary copy of the hashtable, create the new key, and copy the value from the old key, before removing the old key. The temporary hashtable is then set as the new value for your original variable.
This command does not write anything to the pipeline when you use a variable name unless you use -PassThru. If you pipe a hashtable to this command, the new hashtable will automatically be written to the pipeline.
You might find this command useful when building a hashtable that you intend to use with splatting where you need to align key names with parameter names.
PS C:\> Rename-Hashtable -name MyHash -key Name -newKey ComputernamePS C:\> $newhash = Get-Service spooler |
ConvertTo-HashTable |
Rename-Hashtable -Key Machinename -NewKey ComputernameThis command uses the ConvertTo-Hashtable command from the PSScriptTools module to turn an object into a hashtable. The Machinename key is then renamed to Computername.
The variable name of your hash table. DO NOT include the $.
Type: String
Parameter Sets: Name
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA piped in hashtable object
Type: Object
Parameter Sets: Pipeline
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseThe name of the existing hashtable key you want to rename.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe new name of the hashtable key.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseWrite the revised hashtable back to the pipeline. If you pipe a variable to this command, PassThru will happen automatically.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThe scope where your variable is defined. The default is the global scope.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Global
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
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.
Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/
This code was first described at http://jdhitsolutions.com/blog/2013/01/Rename-Hashtable-key-revised