Rename-Context¶
SYNOPSIS¶
Renames a context.
SYNTAX¶
Rename-Context [-ID] <String> [-NewID] <String> [-Force] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION¶
This function renames a context by retrieving the existing context with the old ID,
setting the new context with the provided new ID, and removing the old context.
If a context with the new ID already exists, the operation will fail unless
the -Force switch is specified.
EXAMPLES¶
EXAMPLE 1¶
Rename-Context -ID 'PSModule.GitHub' -NewID 'PSModule.GitHub2'
Output:
Context 'PSModule.GitHub' renamed to 'PSModule.GitHub2'
Renames the context 'PSModule.GitHub' to 'PSModule.GitHub2'.
EXAMPLE 2¶
'PSModule.GitHub' | Rename-Context -NewID 'PSModule.GitHub2'
Output:
Context 'PSModule.GitHub' renamed to 'PSModule.GitHub2'
Renames the context 'PSModule.GitHub' to 'PSModule.GitHub2' using pipeline input.
PARAMETERS¶
-ID¶
The ID of the context to rename.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-NewID¶
The new ID of the context.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Force¶
Force the rename even if the new ID already exists.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf¶
Shows 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: False
-Confirm¶
Prompts 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: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS¶
OUTPUTS¶
[System.String]¶
NOTES¶
The confirmation message indicating the successful renaming of the context.