Skip to main content

Get-VSTeamWiki

SYNOPSIS​

Returns a list of wikis for the selected project.

SYNTAX​

ListAllProjects (Default)​

Get-VSTeamWiki [<CommonParameters>]

ById​

Get-VSTeamWiki -Name <String> -ProjectName <String> [<CommonParameters>]

ListSingleProject​

Get-VSTeamWiki -ProjectName <String> [<CommonParameters>]

DESCRIPTION​

Returns a list of wikis in a project

A single wiki can be returned by providing the wiki namd or Id

You must call Set-VSTeamAccount before calling this function.

EXAMPLES​

Example 1​

Get-VSTeamWiki

This will return a list of all the wikis for all the projects

Example 2​

Get-VSTeamWiki -ProjectName myProject

This will return all the wikis for the specified project

Example 3​

Get-VSTeamWiki -ProjectName myProject -WikiName my-code-wiki

This will return the specified wiki in the project provided

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: ById, ListSingleProject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name​

Name or ID of the Wiki to return

Type: String
Parameter Sets: ById
Aliases: WikiId, WikiName

Required: True
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

Add-VSTeamWiki

Remove-VSTeamWiki