external help file | Module Name | online version | schema |
---|---|---|---|
PSShlink-help.xml |
PSShlink |
2.0.0 |
Remove a tag from an existing Shlink server.
Remove-ShlinkTag [-Tag] <String[]> [[-ShlinkServer] <String>] [[-ShlinkApiKey] <SecureString>] [-WhatIf]
[-Confirm] [<CommonParameters>]
Remove a tag from an existing Shlink server.
Remove-ShlinkTag -Tags "oldwebsite" -WhatIf
Reports what would happen if the command was invoked, because the -WhatIf parameter is present.
Remove-ShlinkTag -Tags "oldwebsite", "newwebsite"
Removes the following tags from the Shlink server: "oldwebsite", "newwebsite"
"tag1","tag2" | Remove-ShlinkTag
Removes "tag1" and "tag2" from your Shlink instance.
Get-ShlinkUrl -ShortCode "profile" | Remove-ShlinkTag
Removes all the tags which are associated with the short code "profile" from the Shlink instance.
Name(s) of the tag(s) you want to remove.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
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: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
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
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.