Skip to content

Latest commit

 

History

History
110 lines (84 loc) · 2.7 KB

Set-ShlinkTag.md

File metadata and controls

110 lines (84 loc) · 2.7 KB
external help file Module Name online version schema
PSShlink-help.xml
PSShlink
2.0.0

Set-ShlinkTag

SYNOPSIS

Renames an existing tag to a new value on the Shlink server.

SYNTAX

Set-ShlinkTag [-OldTagName] <String> [-NewTagName] <String> [[-ShlinkServer] <String>]
 [[-ShlinkApiKey] <SecureString>] [<CommonParameters>]

DESCRIPTION

Renames an existing tag to a new value on the Shlink server.

EXAMPLES

EXAMPLE 1

Set-ShlinkTag -OldTagName "oldwebsite" -NewTagName "veryoldwebsite"

Updates the tag with the name "oldwebsite" to have a new name of "veryoldwebsite".

PARAMETERS

-OldTagName

The name of the old tag you want to change the name of.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NewTagName

The name fo the new tag you want to the new name to be.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ShlinkServer

The URL of your Shlink server (including schema). For example "https://example.com". It is not required to use this parameter for every use of this function. When it is used once for any of the functions in the PSShlink module, its value is retained throughout the life of the PowerShell session and its value is only accessible within the module's scope.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ShlinkApiKey

A SecureString object of your Shlink server's API key. It is not required to use this parameter for every use of this function. When it is used once for any of the functions in the PSShlink module, its value is retained throughout the life of the PowerShell session and its value is only accessible within the module's scope.

Type: SecureString
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
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

This function does not accept pipeline input.

OUTPUTS

System.Management.Automation.PSObject

NOTES

RELATED LINKS