Skip to content

Latest commit

History

History
200 lines (144 loc) · 4.76 KB

File metadata and controls

200 lines (144 loc) · 4.76 KB
external help fileAzDevOps-help.xml
Module NameAzDevOps
online versionhttps://github.com/Azure-Devops-PowerShell-Module/projects/blob/master/docs/Update-AdoProject.md#update-adoproject
schema2.0.0

Update-AdoProject

SYNOPSIS

Update Name, Description or Abbreviation of a project

SYNTAX

Update-AdoProject [[-Name] <String>] [[-Description] <String>] [-Project] <Object> [[-ApiVersion] <String>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This function allows you to update the Name or Description or Abbreviation of a given project within Azure DevOps.

EXAMPLES

Example 1

PS C:\>Get-AdoProject-ProjectId 2e6901c2-7cfb-40ea-901b-dfb439566e13 |Update-AdoProject-Name newproject
id : 2e6901c2-7cfb-40ea-901b-dfb439566e13
name : newproject
url : https://dev.azure.com/patton-tech/_apis/projects/2e6901c2-7cfb-40ea-901b-dfb439566e13
state : wellFormed
revision : 515330771
_links : @{self=; collection=; web=}
visibility : private
defaultTeam : @{id=cb24c842-7e32-4438-bf5d-fc67ac28a5c1; name=123abc Team; url=https://dev.azure.com/patton-tech/_apis/projects/2e6901c2-7cfb-40ea-901b-dfb439566e13/teams/cb24c842-7e32-4438-bf5d-fc67ac28a5c1}
lastUpdateTime : 2020-04-14T14:54:32.91Z

Changing the name of a project

Example 2

PS C:\>Get-AdoProject-ProjectId 2e6901c2-7cfb-40ea-901b-dfb439566e13 |Update-AdoProject-Name updatedproject -Description 'a new project description'
id : 2e6901c2-7cfb-40ea-901b-dfb439566e13
name : updatedproject
description : a new project description
url : https://dev.azure.com/patton-tech/_apis/projects/2e6901c2-7cfb-40ea-901b-dfb439566e13
state : wellFormed
revision : 515330772
_links : @{self=; collection=; web=}
visibility : private
defaultTeam : @{id=cb24c842-7e32-4438-bf5d-fc67ac28a5c1; name=newproject Team; url=https://dev.azure.com/patton-tech/_apis/projects/2e6901c2-7cfb-40ea-901b-dfb439566e13/teams/cb24c842-7e32-4438-bf5d-fc67ac28a5c1}

Changing the name and description of a project

PARAMETERS

-ApiVersion

A valid API Version for this endpoint

Type: System.StringParameter Sets: (All)Aliases:
Accepted values: 5.1, 7.1-preview.4, 7.2-preview.4Required: FalsePosition: 3Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False

-Description

A descriptive name for the project

Type: System.StringParameter Sets: (All)Aliases:
Required: FalsePosition: 1Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False

-Name

A name for the project

Type: System.StringParameter Sets: (All)Aliases:
Required: FalsePosition: 0Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: System.Management.Automation.ActionPreferenceParameter Sets: (All)Aliases: progaRequired: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False

-Project

A project object as returned from Get-AdoProject

Type: System.ObjectParameter Sets: (All)Aliases:
Required: TruePosition: 2Default value: NoneAccept pipeline input: FalseAccept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameterParameter Sets: (All)Aliases: cfRequired: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameterParameter Sets: (All)Aliases: wiRequired: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept 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

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

Connect-AdoOrganization

Get-AdoOperation

Get-AdoProject