Set-TfsProject

SYNOPSIS

Change an existing team project's name and description

SYNTAX

Tfs

Set-TfsProject -InstanceName <String> [-CollectionName <String>] [-Port <UInt32>] [-ApiVersion <String>]
 -ProjectGuid <String> [-NewName <String>] [-NewDescription <String>] [-UseSsl] [-Credential <PSCredential>]
 [<CommonParameters>]

Vsts

Set-TfsProject -InstanceName <String> [-CollectionName <String>] [-Port <UInt32>] [-ApiVersion <String>]
 -ProjectGuid <String> [-NewName <String>] [-NewDescription <String>] [-UseSsl] [-PersonalAccessToken <String>]
 [<CommonParameters>]

DESCRIPTION

Change an existing team project's name and description

EXAMPLES

Example 1

PS C:\> Set-TfsProject -InstanceName DSCTFS01 -Port 8080 -UseSsl -ProjectGuid ca8a6f46-66d7-4c9b-af99-61d97c9c407f -NewName TheOnlyConstantIsChange

Renames the project with the GUID ca8a6f46-66d7-4c9b-af99-61d97c9c407f to "TheOnlyConstantIsChange"

PARAMETERS

-InstanceName

The instance name (dev.azure.com/username or your TFS host name)

Type: String
Parameter Sets: (All)
Aliases:

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

-CollectionName

Your collection. Defaults to DefaultCollection

Type: String
Parameter Sets: (All)
Aliases:

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

-Port

The port of your installation/VSTS instance

Type: UInt32
Parameter Sets: (All)
Aliases:

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

-ApiVersion

The API version to use. Refer to https://www.visualstudio.com/en-us/docs/integrate/api/overview for details

Type: String
Parameter Sets: (All)
Aliases:

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

-ProjectGuid

The GUID of your team project (Hint: Get-TfsProject)

Type: String
Parameter Sets: (All)
Aliases:

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

-NewName

The new name of the project

Type: String
Parameter Sets: (All)
Aliases:

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

-NewDescription

The new description of a project

Type: String
Parameter Sets: (All)
Aliases:

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

-UseSsl

Indicates that SSL should be used

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Credential

The TFS credential to use

Type: PSCredential
Parameter Sets: Tfs
Aliases:

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

-PersonalAccessToken

The VSTS access token as returned by Get-TfsAccessTokenString

Type: String
Parameter Sets: Vsts
Aliases:

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