Remove-VSTeamWiki
SYNOPSIS
Unpublish a project or code wiki in the project provided
SYNTAX
ByName
Remove-VSTeamWiki -WikiName <String> -ProjectName <String> [-WhatIf] [-Confirm] [<CommonParameters>]
ById
Remove-VSTeamWiki -WikiId <Guid> [-ProjectName <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Un-publish a code or project wiki in to the selected repo
You must call Set-VSTeamAccount before calling this function.
EXAMPLES
Example 1
Remove-VSTeamWiki -ProjectName myProject -WikiName myWikiName
This will Un-publish a wiki by name, project name required
Example 2
Remove-VSTeamWiki -WikiId 00000000-0000-0000-0000-000000000000
This will Un-publish a wiki by Id
PARAMETERS
-ProjectName
Specifies the team project for which this function operates.
You can tab complete from a list of available projects.
You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.
Type: String
Parameter Sets: ByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Type: String
Parameter Sets: ById
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WikiName
Name of the Wiki to Un-publish
Type: String
Parameter Sets: ByName
Aliases: Name
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WikiId
Id of the Wiki to Un-publish
Type: Guid
Parameter Sets: ById
Aliases: Id
Required: True
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
-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
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
NOTES
Prerequisites:
Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.
tips:
- check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo
- use Set-VSTeamDefaultProject to set default project for every call
- use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.
- use Profiles to load an account and the correct version