From fc7cca5426ff723e4da757d2bd8a5091de7c444c Mon Sep 17 00:00:00 2001 From: Denny van Kleef Date: Tue, 21 Aug 2018 13:25:22 +0200 Subject: [PATCH 01/10] Added UpdateUserLicense --- VSTeam.psd1 | 2 ++ src/users.psm1 | 71 +++++++++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 70 insertions(+), 3 deletions(-) diff --git a/VSTeam.psd1 b/VSTeam.psd1 index 0d319e396..35f29ba33 100644 --- a/VSTeam.psd1 +++ b/VSTeam.psd1 @@ -191,6 +191,7 @@ 'Get-VSTeamUser', 'Remove-VSTeamUser', 'Add-VSTeamUser', + 'Update-VSTeamUserLicense', 'Set-VSTeamEnvironmentStatus', 'Get-VSTeamServiceEndpointType', 'Update-VSTeamBuildDefinition', @@ -293,6 +294,7 @@ 'Add-User', 'Remove-User', 'Get-User', + 'Update-UserLicense', 'ata', 'Set-EnvironmentStatus', 'Add-VSTeamReleaseEnvironment', diff --git a/src/users.psm1 b/src/users.psm1 index 9a44bc8d6..80bc3663e 100644 --- a/src/users.psm1 +++ b/src/users.psm1 @@ -126,6 +126,70 @@ function Add-VSTeamUser { } } +function Update-VSTeamUserLicense +{ + [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = "High", DefaultParameterSetName = 'ByEmail')] + param ( + [Parameter(ParameterSetName = 'ById', Mandatory = $True, ValueFromPipelineByPropertyName = $true)] + [Alias('UserId')] + [string]$Id, + + [Parameter(ParameterSetName = 'ByEmail', Mandatory = $True, ValueFromPipelineByPropertyName = $true)] + [Alias('UserEmail')] + [string]$Email, + + [Parameter(Mandatory = $true)] + [ValidateSet('Advanced', 'EarlyAdopter', 'Express', 'None', 'Professional', 'StakeHolder')] + [string]$License, + + [switch]$Force + ) + + process { + # This will throw if this account does not support MemberEntitlementManagement + _supportsMemberEntitlementManagement + + if ($email) + { + # We have to go find the id + $user = Get-VSTeamUser | Where-Object email -eq $email + + if (-not$user) + { + throw "Could not find user with an email equal to $email" + } + + $id = $user.id + $licenseOld = $user.accessLevel.accountLicenseType + + } + else + { + $user = Get-VSTeamUser -Id $id + } + + $obj = @{ + from = "" + op = "replace" + path = "/accessLevel" + value = @{ + accountLicenseType = $License + licensingSource = "account" + } + } + + $body = ConvertTo-Json -InputObject @($obj) + + if ($Force -or $PSCmdlet.ShouldProcess("$( $user.userName ) ($( $user.email ))", "Update user")) + { + # Call the REST API + _callAPI -Method Patch -Body $body -SubDomain 'vsaex' -Resource 'userentitlements' -Id $id -Version $([VSTeamVersions]::MemberEntitlementManagement) -ContentType 'application/json-patch+json' | Out-Null + + Write-Output "Updated user license for $( $user.userName ) ($( $user.email )) from ($licenseOld) to ($License)" + } + } +} + function Remove-VSTeamUser { [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = "High", DefaultParameterSetName = 'ById')] param( @@ -153,6 +217,7 @@ function Remove-VSTeamUser { } $id = $user.id + } else { $user = Get-VSTeamUser -Id $id } @@ -168,9 +233,9 @@ function Remove-VSTeamUser { Set-Alias Get-User Get-VSTeamUser Set-Alias Add-User Add-VSTeamUser -Set-Alias Update-User Update-VSTeamUser +Set-Alias Update-UserLicense Update-VSTeamUserLicense Set-Alias Remove-User Remove-VSTeamUser Export-ModuleMember ` - -Function Get-VSTeamUser, Add-VSTeamUser, Update-VSTeamUser, Remove-VSTeamUser ` - -Alias Get-User, Add-User, Update-User, Remove-User \ No newline at end of file + -Function Get-VSTeamUser, Add-VSTeamUser, Update-VSTeamUserLicense, Remove-VSTeamUser ` + -Alias Get-User, Add-User, Update-UserLicense, Remove-User \ No newline at end of file From 8206521df2298c00bcaa33e733926dc83417bd7d Mon Sep 17 00:00:00 2001 From: Denny van Kleef Date: Wed, 22 Aug 2018 10:05:50 +0200 Subject: [PATCH 02/10] Added documentation, and renamed the method --- .docs/Update-VSTeamUser.md | 42 +++++++++++++++++++++++++++++ .docs/synopsis/Update-VSTeamUser.md | 1 + VSTeam.psd1 | 4 +-- src/users.psm1 | 8 +++--- 4 files changed, 49 insertions(+), 6 deletions(-) create mode 100644 .docs/Update-VSTeamUser.md create mode 100644 .docs/synopsis/Update-VSTeamUser.md diff --git a/.docs/Update-VSTeamUser.md b/.docs/Update-VSTeamUser.md new file mode 100644 index 000000000..b31df7ee1 --- /dev/null +++ b/.docs/Update-VSTeamUser.md @@ -0,0 +1,42 @@ + + +# Update-VSTeamUser + +## SYNOPSIS + + + +## SYNTAX + +## DESCRIPTION + + + +## EXAMPLES + +## PARAMETERS + +### -License + +Type of Account License you want to change to. The acceptable values for this parameter are: + +- Advanced +- EarlyAdopter +- Express +- None +- Professional +- StakeHolder + +```yaml +Type: String +Required: True +Default value: [empty] +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS \ No newline at end of file diff --git a/.docs/synopsis/Update-VSTeamUser.md b/.docs/synopsis/Update-VSTeamUser.md new file mode 100644 index 000000000..ca7f6737a --- /dev/null +++ b/.docs/synopsis/Update-VSTeamUser.md @@ -0,0 +1 @@ +Updates the users for the account. (Currently only supports updating the LicenseType) \ No newline at end of file diff --git a/VSTeam.psd1 b/VSTeam.psd1 index 35f29ba33..c4eed7b72 100644 --- a/VSTeam.psd1 +++ b/VSTeam.psd1 @@ -191,7 +191,7 @@ 'Get-VSTeamUser', 'Remove-VSTeamUser', 'Add-VSTeamUser', - 'Update-VSTeamUserLicense', + 'Update-VSTeamUser', 'Set-VSTeamEnvironmentStatus', 'Get-VSTeamServiceEndpointType', 'Update-VSTeamBuildDefinition', @@ -294,7 +294,7 @@ 'Add-User', 'Remove-User', 'Get-User', - 'Update-UserLicense', + 'Update-User', 'ata', 'Set-EnvironmentStatus', 'Add-VSTeamReleaseEnvironment', diff --git a/src/users.psm1 b/src/users.psm1 index 80bc3663e..e543320a4 100644 --- a/src/users.psm1 +++ b/src/users.psm1 @@ -126,7 +126,7 @@ function Add-VSTeamUser { } } -function Update-VSTeamUserLicense +function Update-VSTeamUser { [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = "High", DefaultParameterSetName = 'ByEmail')] param ( @@ -233,9 +233,9 @@ function Remove-VSTeamUser { Set-Alias Get-User Get-VSTeamUser Set-Alias Add-User Add-VSTeamUser -Set-Alias Update-UserLicense Update-VSTeamUserLicense +Set-Alias Update-User Update-VSTeamUser Set-Alias Remove-User Remove-VSTeamUser Export-ModuleMember ` - -Function Get-VSTeamUser, Add-VSTeamUser, Update-VSTeamUserLicense, Remove-VSTeamUser ` - -Alias Get-User, Add-User, Update-UserLicense, Remove-User \ No newline at end of file + -Function Get-VSTeamUser, Add-VSTeamUser, Update-VSTeamUser, Remove-VSTeamUser ` + -Alias Get-User, Add-User, Update-User, Remove-User \ No newline at end of file From 466f295c12dcd4dfbcf280f1ebc19d114cdcc2a2 Mon Sep 17 00:00:00 2001 From: Denny van Kleef Date: Wed, 5 Sep 2018 13:53:45 +0200 Subject: [PATCH 03/10] added tests for update --- unit/test/users.Tests.ps1 | 60 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/unit/test/users.Tests.ps1 b/unit/test/users.Tests.ps1 index fcacd7c6e..096369bae 100644 --- a/unit/test/users.Tests.ps1 +++ b/unit/test/users.Tests.ps1 @@ -174,6 +174,38 @@ InModuleScope users { } } + Context 'Update-VSTeamUser by invalid email' { + Mock _callAPI { return [PSCustomObject]@{ + count = 1 + value = [PSCustomObject]@{ + accessLevel = [PSCustomObject]@{ } + email = 'test@user.com' + id = '00000000-0000-0000-0000-000000000000' + } + } + } + + It 'Update User with invalid email should throw' { + { Update-VSTeamUser -Email 'not@found.com' -License 'Express' -Force } | Should Throw + } + } + + Context 'Update-VSTeamUser by invalid id' { + Mock _callAPI { return [PSCustomObject]@{ + count = 1 + value = [PSCustomObject]@{ + accessLevel = [PSCustomObject]@{ } + email = 'test@user.com' + id = '00000000-0000-0000-0000-000000000000' + } + } + } + + It 'Update User with invalid id should throw' { + { Update-VSTeamUser -Id '11111111-0000-0000-0000-000000000000' -License 'Express' -Force } | Should Throw + } + } + Context 'Add-VSTeamUser' { $obj = @{ accessLevel = @{ @@ -206,5 +238,33 @@ InModuleScope users { Assert-VerifiableMock } } + + Context 'Update user should update' { + + Mock _callAPI { return [PSCustomObject]@{ + count = 1 + value = [PSCustomObject]@{ + accessLevel = [PSCustomObject]@{ + accountLicenseType = "Stakeholder" + } + email = 'test@user.com' + id = '00000000-0000-0000-0000-000000000000' + } + } + } + + Update-VSTeamUser -License 'Stakeholder' -Email 'test@user.com' -Force + + It 'Should update a user' { + Assert-MockCalled _callAPI -Exactly 1 -ParameterFilter { + $Method -eq 'Patch' -and + $subDomain -eq 'vsaex' -and + $id -eq '00000000-0000-0000-0000-000000000000' -and + $resource -eq 'userentitlements' -and + $version -eq [VSTeamVersions]::MemberEntitlementManagement + } + + } + } } } \ No newline at end of file From ab7c1186545a3d63b55f1038f2c7a5f04574e72d Mon Sep 17 00:00:00 2001 From: Denny van Kleef Date: Wed, 5 Sep 2018 13:58:59 +0200 Subject: [PATCH 04/10] Adjusted help files --- docs/Team.md | 740 +++++++++++++++++++++--------------------- docs/readme.md | 740 +++++++++++++++++++++--------------------- en-US/VSTeam-Help.xml | 65 ++++ 3 files changed, 809 insertions(+), 736 deletions(-) diff --git a/docs/Team.md b/docs/Team.md index 88fa63179..dc6504ec3 100644 --- a/docs/Team.md +++ b/docs/Team.md @@ -13,375 +13,379 @@ Welcome to VSTeam. VSTeam is a [PowerShell module](https://www.powershellgallery ## VSTeam Functions -### [Add-VSTeam](Add-VSTeam.md) - -Adds a team to a team project. - -### [Add-VSTeamAccount](Add-VSTeamAccount.md) - +### [Add-VSTeam](Add-VSTeam.md) + +Adds a team to a team project. + +### [Add-VSTeamAccount](Add-VSTeamAccount.md) + Stores your account name and personal access token for use with the other -functions in this module. - -### [Add-VSTeamAzureRMServiceEndpoint](Add-VSTeamAzureRMServiceEndpoint.md) - -Adds a new Azure Resource Manager service endpoint. - -### [Add-VSTeamBuild](Add-VSTeamBuild.md) - -Queues a new build. - -### [Add-VSTeamBuildDefinition](Add-VSTeamBuildDefinition.md) - -Creates a new build defintion from a JSON file. - -### [Add-VSTeamBuildTag](Add-VSTeamBuildTag.md) - -Adds a tag to a build. - -### [Add-VSTeamFeed](Add-VSTeamFeed.md) - -Adds a new feed to package management. - -### [Add-VSTeamGitRepository](Add-VSTeamGitRepository.md) - -Adds a Git repository to your Visual Studio Team Services or Team Foundation Server account. - -### [Add-VSTeamKubernetesEndpoint](Add-VSTeamKubernetesEndpoint.md) - -Adds connections to Kubernetes clusters - -### [Add-VSTeamNuGetEndpoint](Add-VSTeamNuGetEndpoint.md) - -Adds a new NuGet service endpoint. - -### [Add-VSTeamPolicy](Add-VSTeamPolicy.md) - -Adds a new policy to the specified project. - -### [Add-VSTeamProfile](Add-VSTeamProfile.md) - +functions in this module. + +### [Add-VSTeamAzureRMServiceEndpoint](Add-VSTeamAzureRMServiceEndpoint.md) + +Adds a new Azure Resource Manager service endpoint. + +### [Add-VSTeamBuild](Add-VSTeamBuild.md) + +Queues a new build. + +### [Add-VSTeamBuildDefinition](Add-VSTeamBuildDefinition.md) + +Creates a new build defintion from a JSON file. + +### [Add-VSTeamBuildTag](Add-VSTeamBuildTag.md) + +Adds a tag to a build. + +### [Add-VSTeamFeed](Add-VSTeamFeed.md) + +Adds a new feed to package management. + +### [Add-VSTeamGitRepository](Add-VSTeamGitRepository.md) + +Adds a Git repository to your Visual Studio Team Services or Team Foundation Server account. + +### [Add-VSTeamKubernetesEndpoint](Add-VSTeamKubernetesEndpoint.md) + +Adds connections to Kubernetes clusters + +### [Add-VSTeamNuGetEndpoint](Add-VSTeamNuGetEndpoint.md) + +Adds a new NuGet service endpoint. + +### [Add-VSTeamPolicy](Add-VSTeamPolicy.md) + +Adds a new policy to the specified project. + +### [Add-VSTeamProfile](Add-VSTeamProfile.md) + Stores your account name and personal access token as a profile for use with -the Add-TeamAccount function in this module. - -### [Add-VSTeamProject](Add-VSTeamProject.md) - -Adds a Team Project to your account. - -### [Add-VSTeamRelease](Add-VSTeamRelease.md) - -Queues a new release - -### [Add-VSTeamReleaseDefinition](Add-VSTeamReleaseDefinition.md) - -Creates a new release defintion from a JSON file. - -### [Add-VSTeamServiceEndpoint](Add-VSTeamServiceEndpoint.md) - -Adds a generic service connection - -### [Add-VSTeamServiceFabricEndpoint](Add-VSTeamServiceFabricEndpoint.md) - -Adds a new Service Fabric service endpoint. - -### [Add-VSTeamSonarQubeEndpoint](Add-VSTeamSonarQubeEndpoint.md) - -Adds a new SonarQube service endpoint. - -### [Add-VSTeamUser](Add-VSTeamUser.md) - -Adds a user to the account. - -### [Add-VSTeamWorkItem](Add-VSTeamWorkItem.md) - -Adds a work item to your project. - -### [Clear-VSTeamDefaultProject](Clear-VSTeamDefaultProject.md) - -Clears the value stored in the default project parameter value. - -### [Disable-VSTeamAgent](Disable-VSTeamAgent.md) - -Disables an agent in a pool. - -### [Enable-VSTeamAgent](Enable-VSTeamAgent.md) - -Enables an agent in a pool. - -### [Get-VSTeam](Get-VSTeam.md) - -Returns a team. - -### [Get-VSTeamAgent](Get-VSTeamAgent.md) - -Returns the agents in a pool. - -### [Get-VSTeamApproval](Get-VSTeamApproval.md) - -Gets a list of approvals for all releases for a team project. - -### [Get-VSTeamBuild](Get-VSTeamBuild.md) - -Gets the builds for a team project. - -### [Get-VSTeamBuildArtifact](Get-VSTeamBuildArtifact.md) - -Returns the artifacts of a build. - -### [Get-VSTeamBuildDefinition](Get-VSTeamBuildDefinition.md) - -Gets the build definitions for a team project. - -### [Get-VSTeamBuildLog](Get-VSTeamBuildLog.md) - -Displays the logs for the build. - -### [Get-VSTeamBuildTag](Get-VSTeamBuildTag.md) - -Returns all the tags of a build. - -### [Get-VSTeamCloudSubscription](Get-VSTeamCloudSubscription.md) - -Gets the Azure subscriptions associated with the Team Services account. - -### [Get-VSTeamFeed](Get-VSTeamFeed.md) - -Returns a list of package feeds for the account. - -### [Get-VSTeamGitRef](Get-VSTeamGitRef.md) - -Queries the provided repository for its refs and returns them. - -### [Get-VSTeamGitRepository](Get-VSTeamGitRepository.md) - -Get all the repositories in your Visual Studio Team Services or Team Foundation Server account, or a specific project. - -### [Get-VSTeamInfo](Get-VSTeamInfo.md) - -Displays your current account and default project. - -### [Get-VSTeamMember](Get-VSTeamMember.md) - -Returns a team member. - -### [Get-VSTeamOption](Get-VSTeamOption.md) - -Returns all the versions of supported APIs of your TFS or VSTS. - -### [Get-VSTeamPolicy](Get-VSTeamPolicy.md) - -Get the code policies in the specified Visual Studio Team Services or Team Foundation Server project. - -### [Get-VSTeamPolicyType](Get-VSTeamPolicyType.md) - -Get the policy types in the specified Visual Studio Team Services or Team Foundation Server project. - -### [Get-VSTeamPool](Get-VSTeamPool.md) - -Returns the agent pools. - -### [Get-VSTeamProfile](Get-VSTeamProfile.md) - -Returns the saved profiles. - -### [Get-VSTeamProject](Get-VSTeamProject.md) - -Returns a list of projects in the Team Services or Team Foundation Server account. - -### [Get-VSTeamQueue](Get-VSTeamQueue.md) - -Gets a agent queue. - -### [Get-VSTeamRelease](Get-VSTeamRelease.md) - -Gets the releases for a team project. - -### [Get-VSTeamReleaseDefinition](Get-VSTeamReleaseDefinition.md) - -Gets the release definitions for a team project. - -### [Get-VSTeamResourceArea](Get-VSTeamResourceArea.md) - -List all the areas supported by this instance of TFS/VSTS. - -### [Get-VSTeamServiceEndpoint](Get-VSTeamServiceEndpoint.md) - -Gets a service endpoint. - -### [Get-VSTeamServiceEndpointType](Get-VSTeamServiceEndpointType.md) - -Get service endpoint types. - -### [Get-VSTeamTfvcBranch](Get-VSTeamTfvcBranch.md) - -Gets a branch for a given path from TFVC source control. - -### [Get-VSTeamTfvcRootBranch](Get-VSTeamTfvcRootBranch.md) - -Gets root branches for all projects with TFVC source control. - -### [Get-VSTeamUser](Get-VSTeamUser.md) - -Returns a list of users for the account. - -### [Get-VSTeamWorkItem](Get-VSTeamWorkItem.md) - -Returns one or more a work items from your project. - -### [Get-VSTeamWorkItemType](Get-VSTeamWorkItemType.md) - -Gets a list of all Work Item Types or a single work item type. - -### [Invoke-VSTeamRequest](Invoke-VSTeamRequest.md) - -Allows you to call any TFS/VSTS REST API. All the Auth and Route Structure is taken care of for you. Just provide the parts of the API call you need. If you need to send a non-standard URL use the -Url parameter. If the -Url is used the Url is not changed but the header and UserAgent are added for you. - -### [Remove-VSTeam](Remove-VSTeam.md) - -Removes a team from a project. - -### [Remove-VSTeamAccount](Remove-VSTeamAccount.md) - -Clears your default project, account name and personal access token. - -### [Remove-VSTeamAgent](Remove-VSTeamAgent.md) - -Removes an agent from a pool. - -### [Remove-VSTeamBuild](Remove-VSTeamBuild.md) - -Deletes the build. - -### [Remove-VSTeamBuildDefinition](Remove-VSTeamBuildDefinition.md) - -Removes the build definitions for a team project. - -### [Remove-VSTeamBuildTag](Remove-VSTeamBuildTag.md) - -Removes the tag from a build. - -### [Remove-VSTeamFeed](Remove-VSTeamFeed.md) - -Removes a package feed from the account. - -### [Remove-VSTeamGitRepository](Remove-VSTeamGitRepository.md) - -Removes the Git repository from your Visual Studio Team Services or Team Foundation Server account. - -### [Remove-VSTeamPolicy](Remove-VSTeamPolicy.md) - -Removes the specified policy from the specified project. - -### [Remove-VSTeamProfile](Remove-VSTeamProfile.md) - -Removes the profile. - -### [Remove-VSTeamProject](Remove-VSTeamProject.md) - -Deletes the Team Project from your Team Services account. - -### [Remove-VSTeamRelease](Remove-VSTeamRelease.md) - -Removes the releases for a team project. - -### [Remove-VSTeamReleaseDefinition](Remove-VSTeamReleaseDefinition.md) - -Removes the release definitions for a team project. - -### [Remove-VSTeamServiceEndpoint](Remove-VSTeamServiceEndpoint.md) - -Removes a service endpoint. - -### [Remove-VSTeamUser](Remove-VSTeamUser.md) - -Removes a user from the account. - -### [Set-VSTeamAPIVersion](Set-VSTeamAPIVersion.md) - -Sets the API versions to support either TFS2017, TFS2018 or VSTS. - -### [Set-VSTeamApproval](Set-VSTeamApproval.md) - -Sets the status of approval to Approved, Rejected, Pending, or ReAssigned. - -### [Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) - -Sets the default project to be used with other calls in the module. - -### [Set-VSTeamEnvironmentStatus](Set-VSTeamEnvironmentStatus.md) - -Sets the status of a environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined. - -### [Set-VSTeamReleaseStatus](Set-VSTeamReleaseStatus.md) - -Sets the status of a release to Active or Abandoned. - -### [Show-VSTeam](Show-VSTeam.md) - -Opens TFS or VSTS site in the default browser. - -### [Show-VSTeamApproval](Show-VSTeamApproval.md) - -Opens the release associated with the waiting approval in the default browser. - -### [Show-VSTeamBuild](Show-VSTeamBuild.md) - -Opens the build summary in the default browser. - -### [Show-VSTeamBuildDefinition](Show-VSTeamBuildDefinition.md) - -Opens the build definition in the default browser. - -### [Show-VSTeamFeed](Show-VSTeamFeed.md) - -Opens the feed in the default browser. - -### [Show-VSTeamGitRepository](Show-VSTeamGitRepository.md) - -Opens the Git repository in the default browser. - -### [Show-VSTeamProject](Show-VSTeamProject.md) - -Opens the project in the default browser. - -### [Show-VSTeamRelease](Show-VSTeamRelease.md) - -Opens the release summary in the default browser. - -### [Show-VSTeamReleaseDefinition](Show-VSTeamReleaseDefinition.md) - -Opens the release definitions for a team project in the default browser. - -### [Show-VSTeamWorkItem](Show-VSTeamWorkItem.md) - -Opens the work item in the default browser. - -### [Update-VSTeam](Update-VSTeam.md) - -Updates the team name, description or both. - -### [Update-VSTeamBuild](Update-VSTeamBuild.md) - -Allows you to set the keep forever flag and build number. - -### [Update-VSTeamBuildDefinition](Update-VSTeamBuildDefinition.md) - -Updates a build definition for a team project. - -### [Update-VSTeamPolicy](Update-VSTeamPolicy.md) - -Updates an existing policy in the specified project. - -### [Update-VSTeamProfile](Update-VSTeamProfile.md) - -Allows you to update the Personal Access Token for your profile. - -### [Update-VSTeamProject](Update-VSTeamProject.md) - -Updates the project name, description or both. - -### [Update-VSTeamServiceEndpoint](Update-VSTeamServiceEndpoint.md) - -Updates an existing service connection - +the Add-TeamAccount function in this module. + +### [Add-VSTeamProject](Add-VSTeamProject.md) + +Adds a Team Project to your account. + +### [Add-VSTeamRelease](Add-VSTeamRelease.md) + +Queues a new release + +### [Add-VSTeamReleaseDefinition](Add-VSTeamReleaseDefinition.md) + +Creates a new release defintion from a JSON file. + +### [Add-VSTeamServiceEndpoint](Add-VSTeamServiceEndpoint.md) + +Adds a generic service connection + +### [Add-VSTeamServiceFabricEndpoint](Add-VSTeamServiceFabricEndpoint.md) + +Adds a new Service Fabric service endpoint. + +### [Add-VSTeamSonarQubeEndpoint](Add-VSTeamSonarQubeEndpoint.md) + +Adds a new SonarQube service endpoint. + +### [Add-VSTeamUser](Add-VSTeamUser.md) + +Adds a user to the account. + +### [Add-VSTeamWorkItem](Add-VSTeamWorkItem.md) + +Adds a work item to your project. + +### [Clear-VSTeamDefaultProject](Clear-VSTeamDefaultProject.md) + +Clears the value stored in the default project parameter value. + +### [Disable-VSTeamAgent](Disable-VSTeamAgent.md) + +Disables an agent in a pool. + +### [Enable-VSTeamAgent](Enable-VSTeamAgent.md) + +Enables an agent in a pool. + +### [Get-VSTeam](Get-VSTeam.md) + +Returns a team. + +### [Get-VSTeamAgent](Get-VSTeamAgent.md) + +Returns the agents in a pool. + +### [Get-VSTeamApproval](Get-VSTeamApproval.md) + +Gets a list of approvals for all releases for a team project. + +### [Get-VSTeamBuild](Get-VSTeamBuild.md) + +Gets the builds for a team project. + +### [Get-VSTeamBuildArtifact](Get-VSTeamBuildArtifact.md) + +Returns the artifacts of a build. + +### [Get-VSTeamBuildDefinition](Get-VSTeamBuildDefinition.md) + +Gets the build definitions for a team project. + +### [Get-VSTeamBuildLog](Get-VSTeamBuildLog.md) + +Displays the logs for the build. + +### [Get-VSTeamBuildTag](Get-VSTeamBuildTag.md) + +Returns all the tags of a build. + +### [Get-VSTeamCloudSubscription](Get-VSTeamCloudSubscription.md) + +Gets the Azure subscriptions associated with the Team Services account. + +### [Get-VSTeamFeed](Get-VSTeamFeed.md) + +Returns a list of package feeds for the account. + +### [Get-VSTeamGitRef](Get-VSTeamGitRef.md) + +Queries the provided repository for its refs and returns them. + +### [Get-VSTeamGitRepository](Get-VSTeamGitRepository.md) + +Get all the repositories in your Visual Studio Team Services or Team Foundation Server account, or a specific project. + +### [Get-VSTeamInfo](Get-VSTeamInfo.md) + +Displays your current account and default project. + +### [Get-VSTeamMember](Get-VSTeamMember.md) + +Returns a team member. + +### [Get-VSTeamOption](Get-VSTeamOption.md) + +Returns all the versions of supported APIs of your TFS or VSTS. + +### [Get-VSTeamPolicy](Get-VSTeamPolicy.md) + +Get the code policies in the specified Visual Studio Team Services or Team Foundation Server project. + +### [Get-VSTeamPolicyType](Get-VSTeamPolicyType.md) + +Get the policy types in the specified Visual Studio Team Services or Team Foundation Server project. + +### [Get-VSTeamPool](Get-VSTeamPool.md) + +Returns the agent pools. + +### [Get-VSTeamProfile](Get-VSTeamProfile.md) + +Returns the saved profiles. + +### [Get-VSTeamProject](Get-VSTeamProject.md) + +Returns a list of projects in the Team Services or Team Foundation Server account. + +### [Get-VSTeamQueue](Get-VSTeamQueue.md) + +Gets a agent queue. + +### [Get-VSTeamRelease](Get-VSTeamRelease.md) + +Gets the releases for a team project. + +### [Get-VSTeamReleaseDefinition](Get-VSTeamReleaseDefinition.md) + +Gets the release definitions for a team project. + +### [Get-VSTeamResourceArea](Get-VSTeamResourceArea.md) + +List all the areas supported by this instance of TFS/VSTS. + +### [Get-VSTeamServiceEndpoint](Get-VSTeamServiceEndpoint.md) + +Gets a service endpoint. + +### [Get-VSTeamServiceEndpointType](Get-VSTeamServiceEndpointType.md) + +Get service endpoint types. + +### [Get-VSTeamTfvcBranch](Get-VSTeamTfvcBranch.md) + +Gets a branch for a given path from TFVC source control. + +### [Get-VSTeamTfvcRootBranch](Get-VSTeamTfvcRootBranch.md) + +Gets root branches for all projects with TFVC source control. + +### [Get-VSTeamUser](Get-VSTeamUser.md) + +Returns a list of users for the account. + +### [Get-VSTeamWorkItem](Get-VSTeamWorkItem.md) + +Returns one or more a work items from your project. + +### [Get-VSTeamWorkItemType](Get-VSTeamWorkItemType.md) + +Gets a list of all Work Item Types or a single work item type. + +### [Invoke-VSTeamRequest](Invoke-VSTeamRequest.md) + +Allows you to call any TFS/VSTS REST API. All the Auth and Route Structure is taken care of for you. Just provide the parts of the API call you need. If you need to send a non-standard URL use the -Url parameter. If the -Url is used the Url is not changed but the header and UserAgent are added for you. + +### [Remove-VSTeam](Remove-VSTeam.md) + +Removes a team from a project. + +### [Remove-VSTeamAccount](Remove-VSTeamAccount.md) + +Clears your default project, account name and personal access token. + +### [Remove-VSTeamAgent](Remove-VSTeamAgent.md) + +Removes an agent from a pool. + +### [Remove-VSTeamBuild](Remove-VSTeamBuild.md) + +Deletes the build. + +### [Remove-VSTeamBuildDefinition](Remove-VSTeamBuildDefinition.md) + +Removes the build definitions for a team project. + +### [Remove-VSTeamBuildTag](Remove-VSTeamBuildTag.md) + +Removes the tag from a build. + +### [Remove-VSTeamFeed](Remove-VSTeamFeed.md) + +Removes a package feed from the account. + +### [Remove-VSTeamGitRepository](Remove-VSTeamGitRepository.md) + +Removes the Git repository from your Visual Studio Team Services or Team Foundation Server account. + +### [Remove-VSTeamPolicy](Remove-VSTeamPolicy.md) + +Removes the specified policy from the specified project. + +### [Remove-VSTeamProfile](Remove-VSTeamProfile.md) + +Removes the profile. + +### [Remove-VSTeamProject](Remove-VSTeamProject.md) + +Deletes the Team Project from your Team Services account. + +### [Remove-VSTeamRelease](Remove-VSTeamRelease.md) + +Removes the releases for a team project. + +### [Remove-VSTeamReleaseDefinition](Remove-VSTeamReleaseDefinition.md) + +Removes the release definitions for a team project. + +### [Remove-VSTeamServiceEndpoint](Remove-VSTeamServiceEndpoint.md) + +Removes a service endpoint. + +### [Remove-VSTeamUser](Remove-VSTeamUser.md) + +Removes a user from the account. + +### [Set-VSTeamAPIVersion](Set-VSTeamAPIVersion.md) + +Sets the API versions to support either TFS2017, TFS2018 or VSTS. + +### [Set-VSTeamApproval](Set-VSTeamApproval.md) + +Sets the status of approval to Approved, Rejected, Pending, or ReAssigned. + +### [Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + +Sets the default project to be used with other calls in the module. + +### [Set-VSTeamEnvironmentStatus](Set-VSTeamEnvironmentStatus.md) + +Sets the status of a environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined. + +### [Set-VSTeamReleaseStatus](Set-VSTeamReleaseStatus.md) + +Sets the status of a release to Active or Abandoned. + +### [Show-VSTeam](Show-VSTeam.md) + +Opens TFS or VSTS site in the default browser. + +### [Show-VSTeamApproval](Show-VSTeamApproval.md) + +Opens the release associated with the waiting approval in the default browser. + +### [Show-VSTeamBuild](Show-VSTeamBuild.md) + +Opens the build summary in the default browser. + +### [Show-VSTeamBuildDefinition](Show-VSTeamBuildDefinition.md) + +Opens the build definition in the default browser. + +### [Show-VSTeamFeed](Show-VSTeamFeed.md) + +Opens the feed in the default browser. + +### [Show-VSTeamGitRepository](Show-VSTeamGitRepository.md) + +Opens the Git repository in the default browser. + +### [Show-VSTeamProject](Show-VSTeamProject.md) + +Opens the project in the default browser. + +### [Show-VSTeamRelease](Show-VSTeamRelease.md) + +Opens the release summary in the default browser. + +### [Show-VSTeamReleaseDefinition](Show-VSTeamReleaseDefinition.md) + +Opens the release definitions for a team project in the default browser. + +### [Show-VSTeamWorkItem](Show-VSTeamWorkItem.md) + +Opens the work item in the default browser. + +### [Update-VSTeam](Update-VSTeam.md) + +Updates the team name, description or both. + +### [Update-VSTeamBuild](Update-VSTeamBuild.md) + +Allows you to set the keep forever flag and build number. + +### [Update-VSTeamBuildDefinition](Update-VSTeamBuildDefinition.md) + +Updates a build definition for a team project. + +### [Update-VSTeamPolicy](Update-VSTeamPolicy.md) + +Updates an existing policy in the specified project. + +### [Update-VSTeamProfile](Update-VSTeamProfile.md) + +Allows you to update the Personal Access Token for your profile. + +### [Update-VSTeamProject](Update-VSTeamProject.md) + +Updates the project name, description or both. + +### [Update-VSTeamServiceEndpoint](Update-VSTeamServiceEndpoint.md) + +Updates an existing service connection + +### [Update-VSTeamUser](Update-VSTeamUser.md) + +Updates the users for the account. (Currently only supports updating the LicenseType) + diff --git a/docs/readme.md b/docs/readme.md index c6dc926a7..94d69e4d2 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -18,375 +18,379 @@ The provider allows you to navigate your TFS or VSTS as a file system. ## VSTeam Functions -### [Add-VSTeam](Add-VSTeam.md) - -Adds a team to a team project. - -### [Add-VSTeamAccount](Add-VSTeamAccount.md) - +### [Add-VSTeam](Add-VSTeam.md) + +Adds a team to a team project. + +### [Add-VSTeamAccount](Add-VSTeamAccount.md) + Stores your account name and personal access token for use with the other -functions in this module. - -### [Add-VSTeamAzureRMServiceEndpoint](Add-VSTeamAzureRMServiceEndpoint.md) - -Adds a new Azure Resource Manager service endpoint. - -### [Add-VSTeamBuild](Add-VSTeamBuild.md) - -Queues a new build. - -### [Add-VSTeamBuildDefinition](Add-VSTeamBuildDefinition.md) - -Creates a new build defintion from a JSON file. - -### [Add-VSTeamBuildTag](Add-VSTeamBuildTag.md) - -Adds a tag to a build. - -### [Add-VSTeamFeed](Add-VSTeamFeed.md) - -Adds a new feed to package management. - -### [Add-VSTeamGitRepository](Add-VSTeamGitRepository.md) - -Adds a Git repository to your Visual Studio Team Services or Team Foundation Server account. - -### [Add-VSTeamKubernetesEndpoint](Add-VSTeamKubernetesEndpoint.md) - -Adds connections to Kubernetes clusters - -### [Add-VSTeamNuGetEndpoint](Add-VSTeamNuGetEndpoint.md) - -Adds a new NuGet service endpoint. - -### [Add-VSTeamPolicy](Add-VSTeamPolicy.md) - -Adds a new policy to the specified project. - -### [Add-VSTeamProfile](Add-VSTeamProfile.md) - +functions in this module. + +### [Add-VSTeamAzureRMServiceEndpoint](Add-VSTeamAzureRMServiceEndpoint.md) + +Adds a new Azure Resource Manager service endpoint. + +### [Add-VSTeamBuild](Add-VSTeamBuild.md) + +Queues a new build. + +### [Add-VSTeamBuildDefinition](Add-VSTeamBuildDefinition.md) + +Creates a new build defintion from a JSON file. + +### [Add-VSTeamBuildTag](Add-VSTeamBuildTag.md) + +Adds a tag to a build. + +### [Add-VSTeamFeed](Add-VSTeamFeed.md) + +Adds a new feed to package management. + +### [Add-VSTeamGitRepository](Add-VSTeamGitRepository.md) + +Adds a Git repository to your Visual Studio Team Services or Team Foundation Server account. + +### [Add-VSTeamKubernetesEndpoint](Add-VSTeamKubernetesEndpoint.md) + +Adds connections to Kubernetes clusters + +### [Add-VSTeamNuGetEndpoint](Add-VSTeamNuGetEndpoint.md) + +Adds a new NuGet service endpoint. + +### [Add-VSTeamPolicy](Add-VSTeamPolicy.md) + +Adds a new policy to the specified project. + +### [Add-VSTeamProfile](Add-VSTeamProfile.md) + Stores your account name and personal access token as a profile for use with -the Add-TeamAccount function in this module. - -### [Add-VSTeamProject](Add-VSTeamProject.md) - -Adds a Team Project to your account. - -### [Add-VSTeamRelease](Add-VSTeamRelease.md) - -Queues a new release - -### [Add-VSTeamReleaseDefinition](Add-VSTeamReleaseDefinition.md) - -Creates a new release defintion from a JSON file. - -### [Add-VSTeamServiceEndpoint](Add-VSTeamServiceEndpoint.md) - -Adds a generic service connection - -### [Add-VSTeamServiceFabricEndpoint](Add-VSTeamServiceFabricEndpoint.md) - -Adds a new Service Fabric service endpoint. - -### [Add-VSTeamSonarQubeEndpoint](Add-VSTeamSonarQubeEndpoint.md) - -Adds a new SonarQube service endpoint. - -### [Add-VSTeamUser](Add-VSTeamUser.md) - -Adds a user to the account. - -### [Add-VSTeamWorkItem](Add-VSTeamWorkItem.md) - -Adds a work item to your project. - -### [Clear-VSTeamDefaultProject](Clear-VSTeamDefaultProject.md) - -Clears the value stored in the default project parameter value. - -### [Disable-VSTeamAgent](Disable-VSTeamAgent.md) - -Disables an agent in a pool. - -### [Enable-VSTeamAgent](Enable-VSTeamAgent.md) - -Enables an agent in a pool. - -### [Get-VSTeam](Get-VSTeam.md) - -Returns a team. - -### [Get-VSTeamAgent](Get-VSTeamAgent.md) - -Returns the agents in a pool. - -### [Get-VSTeamApproval](Get-VSTeamApproval.md) - -Gets a list of approvals for all releases for a team project. - -### [Get-VSTeamBuild](Get-VSTeamBuild.md) - -Gets the builds for a team project. - -### [Get-VSTeamBuildArtifact](Get-VSTeamBuildArtifact.md) - -Returns the artifacts of a build. - -### [Get-VSTeamBuildDefinition](Get-VSTeamBuildDefinition.md) - -Gets the build definitions for a team project. - -### [Get-VSTeamBuildLog](Get-VSTeamBuildLog.md) - -Displays the logs for the build. - -### [Get-VSTeamBuildTag](Get-VSTeamBuildTag.md) - -Returns all the tags of a build. - -### [Get-VSTeamCloudSubscription](Get-VSTeamCloudSubscription.md) - -Gets the Azure subscriptions associated with the Team Services account. - -### [Get-VSTeamFeed](Get-VSTeamFeed.md) - -Returns a list of package feeds for the account. - -### [Get-VSTeamGitRef](Get-VSTeamGitRef.md) - -Queries the provided repository for its refs and returns them. - -### [Get-VSTeamGitRepository](Get-VSTeamGitRepository.md) - -Get all the repositories in your Visual Studio Team Services or Team Foundation Server account, or a specific project. - -### [Get-VSTeamInfo](Get-VSTeamInfo.md) - -Displays your current account and default project. - -### [Get-VSTeamMember](Get-VSTeamMember.md) - -Returns a team member. - -### [Get-VSTeamOption](Get-VSTeamOption.md) - -Returns all the versions of supported APIs of your TFS or VSTS. - -### [Get-VSTeamPolicy](Get-VSTeamPolicy.md) - -Get the code policies in the specified Visual Studio Team Services or Team Foundation Server project. - -### [Get-VSTeamPolicyType](Get-VSTeamPolicyType.md) - -Get the policy types in the specified Visual Studio Team Services or Team Foundation Server project. - -### [Get-VSTeamPool](Get-VSTeamPool.md) - -Returns the agent pools. - -### [Get-VSTeamProfile](Get-VSTeamProfile.md) - -Returns the saved profiles. - -### [Get-VSTeamProject](Get-VSTeamProject.md) - -Returns a list of projects in the Team Services or Team Foundation Server account. - -### [Get-VSTeamQueue](Get-VSTeamQueue.md) - -Gets a agent queue. - -### [Get-VSTeamRelease](Get-VSTeamRelease.md) - -Gets the releases for a team project. - -### [Get-VSTeamReleaseDefinition](Get-VSTeamReleaseDefinition.md) - -Gets the release definitions for a team project. - -### [Get-VSTeamResourceArea](Get-VSTeamResourceArea.md) - -List all the areas supported by this instance of TFS/VSTS. - -### [Get-VSTeamServiceEndpoint](Get-VSTeamServiceEndpoint.md) - -Gets a service endpoint. - -### [Get-VSTeamServiceEndpointType](Get-VSTeamServiceEndpointType.md) - -Get service endpoint types. - -### [Get-VSTeamTfvcBranch](Get-VSTeamTfvcBranch.md) - -Gets a branch for a given path from TFVC source control. - -### [Get-VSTeamTfvcRootBranch](Get-VSTeamTfvcRootBranch.md) - -Gets root branches for all projects with TFVC source control. - -### [Get-VSTeamUser](Get-VSTeamUser.md) - -Returns a list of users for the account. - -### [Get-VSTeamWorkItem](Get-VSTeamWorkItem.md) - -Returns one or more a work items from your project. - -### [Get-VSTeamWorkItemType](Get-VSTeamWorkItemType.md) - -Gets a list of all Work Item Types or a single work item type. - -### [Invoke-VSTeamRequest](Invoke-VSTeamRequest.md) - -Allows you to call any TFS/VSTS REST API. All the Auth and Route Structure is taken care of for you. Just provide the parts of the API call you need. If you need to send a non-standard URL use the -Url parameter. If the -Url is used the Url is not changed but the header and UserAgent are added for you. - -### [Remove-VSTeam](Remove-VSTeam.md) - -Removes a team from a project. - -### [Remove-VSTeamAccount](Remove-VSTeamAccount.md) - -Clears your default project, account name and personal access token. - -### [Remove-VSTeamAgent](Remove-VSTeamAgent.md) - -Removes an agent from a pool. - -### [Remove-VSTeamBuild](Remove-VSTeamBuild.md) - -Deletes the build. - -### [Remove-VSTeamBuildDefinition](Remove-VSTeamBuildDefinition.md) - -Removes the build definitions for a team project. - -### [Remove-VSTeamBuildTag](Remove-VSTeamBuildTag.md) - -Removes the tag from a build. - -### [Remove-VSTeamFeed](Remove-VSTeamFeed.md) - -Removes a package feed from the account. - -### [Remove-VSTeamGitRepository](Remove-VSTeamGitRepository.md) - -Removes the Git repository from your Visual Studio Team Services or Team Foundation Server account. - -### [Remove-VSTeamPolicy](Remove-VSTeamPolicy.md) - -Removes the specified policy from the specified project. - -### [Remove-VSTeamProfile](Remove-VSTeamProfile.md) - -Removes the profile. - -### [Remove-VSTeamProject](Remove-VSTeamProject.md) - -Deletes the Team Project from your Team Services account. - -### [Remove-VSTeamRelease](Remove-VSTeamRelease.md) - -Removes the releases for a team project. - -### [Remove-VSTeamReleaseDefinition](Remove-VSTeamReleaseDefinition.md) - -Removes the release definitions for a team project. - -### [Remove-VSTeamServiceEndpoint](Remove-VSTeamServiceEndpoint.md) - -Removes a service endpoint. - -### [Remove-VSTeamUser](Remove-VSTeamUser.md) - -Removes a user from the account. - -### [Set-VSTeamAPIVersion](Set-VSTeamAPIVersion.md) - -Sets the API versions to support either TFS2017, TFS2018 or VSTS. - -### [Set-VSTeamApproval](Set-VSTeamApproval.md) - -Sets the status of approval to Approved, Rejected, Pending, or ReAssigned. - -### [Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) - -Sets the default project to be used with other calls in the module. - -### [Set-VSTeamEnvironmentStatus](Set-VSTeamEnvironmentStatus.md) - -Sets the status of a environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined. - -### [Set-VSTeamReleaseStatus](Set-VSTeamReleaseStatus.md) - -Sets the status of a release to Active or Abandoned. - -### [Show-VSTeam](Show-VSTeam.md) - -Opens TFS or VSTS site in the default browser. - -### [Show-VSTeamApproval](Show-VSTeamApproval.md) - -Opens the release associated with the waiting approval in the default browser. - -### [Show-VSTeamBuild](Show-VSTeamBuild.md) - -Opens the build summary in the default browser. - -### [Show-VSTeamBuildDefinition](Show-VSTeamBuildDefinition.md) - -Opens the build definition in the default browser. - -### [Show-VSTeamFeed](Show-VSTeamFeed.md) - -Opens the feed in the default browser. - -### [Show-VSTeamGitRepository](Show-VSTeamGitRepository.md) - -Opens the Git repository in the default browser. - -### [Show-VSTeamProject](Show-VSTeamProject.md) - -Opens the project in the default browser. - -### [Show-VSTeamRelease](Show-VSTeamRelease.md) - -Opens the release summary in the default browser. - -### [Show-VSTeamReleaseDefinition](Show-VSTeamReleaseDefinition.md) - -Opens the release definitions for a team project in the default browser. - -### [Show-VSTeamWorkItem](Show-VSTeamWorkItem.md) - -Opens the work item in the default browser. - -### [Update-VSTeam](Update-VSTeam.md) - -Updates the team name, description or both. - -### [Update-VSTeamBuild](Update-VSTeamBuild.md) - -Allows you to set the keep forever flag and build number. - -### [Update-VSTeamBuildDefinition](Update-VSTeamBuildDefinition.md) - -Updates a build definition for a team project. - -### [Update-VSTeamPolicy](Update-VSTeamPolicy.md) - -Updates an existing policy in the specified project. - -### [Update-VSTeamProfile](Update-VSTeamProfile.md) - -Allows you to update the Personal Access Token for your profile. - -### [Update-VSTeamProject](Update-VSTeamProject.md) - -Updates the project name, description or both. - -### [Update-VSTeamServiceEndpoint](Update-VSTeamServiceEndpoint.md) - -Updates an existing service connection - +the Add-TeamAccount function in this module. + +### [Add-VSTeamProject](Add-VSTeamProject.md) + +Adds a Team Project to your account. + +### [Add-VSTeamRelease](Add-VSTeamRelease.md) + +Queues a new release + +### [Add-VSTeamReleaseDefinition](Add-VSTeamReleaseDefinition.md) + +Creates a new release defintion from a JSON file. + +### [Add-VSTeamServiceEndpoint](Add-VSTeamServiceEndpoint.md) + +Adds a generic service connection + +### [Add-VSTeamServiceFabricEndpoint](Add-VSTeamServiceFabricEndpoint.md) + +Adds a new Service Fabric service endpoint. + +### [Add-VSTeamSonarQubeEndpoint](Add-VSTeamSonarQubeEndpoint.md) + +Adds a new SonarQube service endpoint. + +### [Add-VSTeamUser](Add-VSTeamUser.md) + +Adds a user to the account. + +### [Add-VSTeamWorkItem](Add-VSTeamWorkItem.md) + +Adds a work item to your project. + +### [Clear-VSTeamDefaultProject](Clear-VSTeamDefaultProject.md) + +Clears the value stored in the default project parameter value. + +### [Disable-VSTeamAgent](Disable-VSTeamAgent.md) + +Disables an agent in a pool. + +### [Enable-VSTeamAgent](Enable-VSTeamAgent.md) + +Enables an agent in a pool. + +### [Get-VSTeam](Get-VSTeam.md) + +Returns a team. + +### [Get-VSTeamAgent](Get-VSTeamAgent.md) + +Returns the agents in a pool. + +### [Get-VSTeamApproval](Get-VSTeamApproval.md) + +Gets a list of approvals for all releases for a team project. + +### [Get-VSTeamBuild](Get-VSTeamBuild.md) + +Gets the builds for a team project. + +### [Get-VSTeamBuildArtifact](Get-VSTeamBuildArtifact.md) + +Returns the artifacts of a build. + +### [Get-VSTeamBuildDefinition](Get-VSTeamBuildDefinition.md) + +Gets the build definitions for a team project. + +### [Get-VSTeamBuildLog](Get-VSTeamBuildLog.md) + +Displays the logs for the build. + +### [Get-VSTeamBuildTag](Get-VSTeamBuildTag.md) + +Returns all the tags of a build. + +### [Get-VSTeamCloudSubscription](Get-VSTeamCloudSubscription.md) + +Gets the Azure subscriptions associated with the Team Services account. + +### [Get-VSTeamFeed](Get-VSTeamFeed.md) + +Returns a list of package feeds for the account. + +### [Get-VSTeamGitRef](Get-VSTeamGitRef.md) + +Queries the provided repository for its refs and returns them. + +### [Get-VSTeamGitRepository](Get-VSTeamGitRepository.md) + +Get all the repositories in your Visual Studio Team Services or Team Foundation Server account, or a specific project. + +### [Get-VSTeamInfo](Get-VSTeamInfo.md) + +Displays your current account and default project. + +### [Get-VSTeamMember](Get-VSTeamMember.md) + +Returns a team member. + +### [Get-VSTeamOption](Get-VSTeamOption.md) + +Returns all the versions of supported APIs of your TFS or VSTS. + +### [Get-VSTeamPolicy](Get-VSTeamPolicy.md) + +Get the code policies in the specified Visual Studio Team Services or Team Foundation Server project. + +### [Get-VSTeamPolicyType](Get-VSTeamPolicyType.md) + +Get the policy types in the specified Visual Studio Team Services or Team Foundation Server project. + +### [Get-VSTeamPool](Get-VSTeamPool.md) + +Returns the agent pools. + +### [Get-VSTeamProfile](Get-VSTeamProfile.md) + +Returns the saved profiles. + +### [Get-VSTeamProject](Get-VSTeamProject.md) + +Returns a list of projects in the Team Services or Team Foundation Server account. + +### [Get-VSTeamQueue](Get-VSTeamQueue.md) + +Gets a agent queue. + +### [Get-VSTeamRelease](Get-VSTeamRelease.md) + +Gets the releases for a team project. + +### [Get-VSTeamReleaseDefinition](Get-VSTeamReleaseDefinition.md) + +Gets the release definitions for a team project. + +### [Get-VSTeamResourceArea](Get-VSTeamResourceArea.md) + +List all the areas supported by this instance of TFS/VSTS. + +### [Get-VSTeamServiceEndpoint](Get-VSTeamServiceEndpoint.md) + +Gets a service endpoint. + +### [Get-VSTeamServiceEndpointType](Get-VSTeamServiceEndpointType.md) + +Get service endpoint types. + +### [Get-VSTeamTfvcBranch](Get-VSTeamTfvcBranch.md) + +Gets a branch for a given path from TFVC source control. + +### [Get-VSTeamTfvcRootBranch](Get-VSTeamTfvcRootBranch.md) + +Gets root branches for all projects with TFVC source control. + +### [Get-VSTeamUser](Get-VSTeamUser.md) + +Returns a list of users for the account. + +### [Get-VSTeamWorkItem](Get-VSTeamWorkItem.md) + +Returns one or more a work items from your project. + +### [Get-VSTeamWorkItemType](Get-VSTeamWorkItemType.md) + +Gets a list of all Work Item Types or a single work item type. + +### [Invoke-VSTeamRequest](Invoke-VSTeamRequest.md) + +Allows you to call any TFS/VSTS REST API. All the Auth and Route Structure is taken care of for you. Just provide the parts of the API call you need. If you need to send a non-standard URL use the -Url parameter. If the -Url is used the Url is not changed but the header and UserAgent are added for you. + +### [Remove-VSTeam](Remove-VSTeam.md) + +Removes a team from a project. + +### [Remove-VSTeamAccount](Remove-VSTeamAccount.md) + +Clears your default project, account name and personal access token. + +### [Remove-VSTeamAgent](Remove-VSTeamAgent.md) + +Removes an agent from a pool. + +### [Remove-VSTeamBuild](Remove-VSTeamBuild.md) + +Deletes the build. + +### [Remove-VSTeamBuildDefinition](Remove-VSTeamBuildDefinition.md) + +Removes the build definitions for a team project. + +### [Remove-VSTeamBuildTag](Remove-VSTeamBuildTag.md) + +Removes the tag from a build. + +### [Remove-VSTeamFeed](Remove-VSTeamFeed.md) + +Removes a package feed from the account. + +### [Remove-VSTeamGitRepository](Remove-VSTeamGitRepository.md) + +Removes the Git repository from your Visual Studio Team Services or Team Foundation Server account. + +### [Remove-VSTeamPolicy](Remove-VSTeamPolicy.md) + +Removes the specified policy from the specified project. + +### [Remove-VSTeamProfile](Remove-VSTeamProfile.md) + +Removes the profile. + +### [Remove-VSTeamProject](Remove-VSTeamProject.md) + +Deletes the Team Project from your Team Services account. + +### [Remove-VSTeamRelease](Remove-VSTeamRelease.md) + +Removes the releases for a team project. + +### [Remove-VSTeamReleaseDefinition](Remove-VSTeamReleaseDefinition.md) + +Removes the release definitions for a team project. + +### [Remove-VSTeamServiceEndpoint](Remove-VSTeamServiceEndpoint.md) + +Removes a service endpoint. + +### [Remove-VSTeamUser](Remove-VSTeamUser.md) + +Removes a user from the account. + +### [Set-VSTeamAPIVersion](Set-VSTeamAPIVersion.md) + +Sets the API versions to support either TFS2017, TFS2018 or VSTS. + +### [Set-VSTeamApproval](Set-VSTeamApproval.md) + +Sets the status of approval to Approved, Rejected, Pending, or ReAssigned. + +### [Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + +Sets the default project to be used with other calls in the module. + +### [Set-VSTeamEnvironmentStatus](Set-VSTeamEnvironmentStatus.md) + +Sets the status of a environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined. + +### [Set-VSTeamReleaseStatus](Set-VSTeamReleaseStatus.md) + +Sets the status of a release to Active or Abandoned. + +### [Show-VSTeam](Show-VSTeam.md) + +Opens TFS or VSTS site in the default browser. + +### [Show-VSTeamApproval](Show-VSTeamApproval.md) + +Opens the release associated with the waiting approval in the default browser. + +### [Show-VSTeamBuild](Show-VSTeamBuild.md) + +Opens the build summary in the default browser. + +### [Show-VSTeamBuildDefinition](Show-VSTeamBuildDefinition.md) + +Opens the build definition in the default browser. + +### [Show-VSTeamFeed](Show-VSTeamFeed.md) + +Opens the feed in the default browser. + +### [Show-VSTeamGitRepository](Show-VSTeamGitRepository.md) + +Opens the Git repository in the default browser. + +### [Show-VSTeamProject](Show-VSTeamProject.md) + +Opens the project in the default browser. + +### [Show-VSTeamRelease](Show-VSTeamRelease.md) + +Opens the release summary in the default browser. + +### [Show-VSTeamReleaseDefinition](Show-VSTeamReleaseDefinition.md) + +Opens the release definitions for a team project in the default browser. + +### [Show-VSTeamWorkItem](Show-VSTeamWorkItem.md) + +Opens the work item in the default browser. + +### [Update-VSTeam](Update-VSTeam.md) + +Updates the team name, description or both. + +### [Update-VSTeamBuild](Update-VSTeamBuild.md) + +Allows you to set the keep forever flag and build number. + +### [Update-VSTeamBuildDefinition](Update-VSTeamBuildDefinition.md) + +Updates a build definition for a team project. + +### [Update-VSTeamPolicy](Update-VSTeamPolicy.md) + +Updates an existing policy in the specified project. + +### [Update-VSTeamProfile](Update-VSTeamProfile.md) + +Allows you to update the Personal Access Token for your profile. + +### [Update-VSTeamProject](Update-VSTeamProject.md) + +Updates the project name, description or both. + +### [Update-VSTeamServiceEndpoint](Update-VSTeamServiceEndpoint.md) + +Updates an existing service connection + +### [Update-VSTeamUser](Update-VSTeamUser.md) + +Updates the users for the account. (Currently only supports updating the LicenseType) + diff --git a/en-US/VSTeam-Help.xml b/en-US/VSTeam-Help.xml index 226d1c62f..ce2fbe22a 100644 --- a/en-US/VSTeam-Help.xml +++ b/en-US/VSTeam-Help.xml @@ -14360,4 +14360,69 @@ Demo-CI Demo-CI-45 notStarted + + + Update-VSTeamUser + Update + VSTeamUser + + Updates the users for the account. (Currently only supports updating the LicenseType) + + + + Updates the users for the account. (Currently only supports updating the LicenseType) + + + + Update-VSTeamUser + + License + + Type of Account License you want to change to. The acceptable values for this parameter are: + - Advanced + - EarlyAdopter + - Express + - None + - Professional + - StakeHolder + + String + + String + + + [empty] + + + + + + License + + Type of Account License you want to change to. The acceptable values for this parameter are: + - Advanced + - EarlyAdopter + - Express + - None + - Professional + - StakeHolder + + String + + String + + + [empty] + + + + + + + + + + + + \ No newline at end of file From e6566cdc7c0decd12142bd5977706047d63c953a Mon Sep 17 00:00:00 2001 From: Denny van Kleef Date: Wed, 5 Sep 2018 14:03:48 +0200 Subject: [PATCH 05/10] Adding docs --- .docs/Update-VSTeamUser.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.docs/Update-VSTeamUser.md b/.docs/Update-VSTeamUser.md index b31df7ee1..8247a4c0a 100644 --- a/.docs/Update-VSTeamUser.md +++ b/.docs/Update-VSTeamUser.md @@ -16,6 +16,8 @@ ## PARAMETERS + + ### -License Type of Account License you want to change to. The acceptable values for this parameter are: From 55947f93e8b053e9f902fbc10f83848c3831b34f Mon Sep 17 00:00:00 2001 From: Denny van Kleef Date: Wed, 5 Sep 2018 14:09:48 +0200 Subject: [PATCH 06/10] docs --- en-US/VSTeam-Help.xml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/en-US/VSTeam-Help.xml b/en-US/VSTeam-Help.xml index ce2fbe22a..ce7d1ab66 100644 --- a/en-US/VSTeam-Help.xml +++ b/en-US/VSTeam-Help.xml @@ -14375,6 +14375,20 @@ Demo-CI Demo-CI-45 notStarted Update-VSTeamUser + + 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. + + String + + String + + + None + License @@ -14396,6 +14410,20 @@ Demo-CI Demo-CI-45 notStarted + + 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. + + String + + String + + + None + License From 9dc436f73524106e36b07b920f82928bae4de5a9 Mon Sep 17 00:00:00 2001 From: Denny van Kleef Date: Wed, 5 Sep 2018 14:17:33 +0200 Subject: [PATCH 07/10] more docs --- .docs/Update-VSTeamUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.docs/Update-VSTeamUser.md b/.docs/Update-VSTeamUser.md index 8247a4c0a..a25a6f447 100644 --- a/.docs/Update-VSTeamUser.md +++ b/.docs/Update-VSTeamUser.md @@ -41,4 +41,4 @@ Default value: [empty] ## NOTES -## RELATED LINKS \ No newline at end of file +## RELATED LINKS From d847dd7b1ac46990ae18fc615769d0543eb541f3 Mon Sep 17 00:00:00 2001 From: dvankleef Date: Wed, 5 Sep 2018 14:19:17 +0200 Subject: [PATCH 08/10] Create Update-VSTeamUser.md --- docs/Update-VSTeamUser.md | 42 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/Update-VSTeamUser.md diff --git a/docs/Update-VSTeamUser.md b/docs/Update-VSTeamUser.md new file mode 100644 index 000000000..9fcb73502 --- /dev/null +++ b/docs/Update-VSTeamUser.md @@ -0,0 +1,42 @@ + + +# Update-VSTeamUser + +## SYNOPSIS + + + +## SYNTAX + +## DESCRIPTION + + + +## EXAMPLES + +## PARAMETERS + +### -License + +Type of Account License you want to change to. The acceptable values for this parameter are: + +- Advanced +- EarlyAdopter +- Express +- None +- Professional +- StakeHolder + +```yaml +Type: String +Required: True +Default value: [empty] +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS From 967284a78431aac695ee7aa6a3e1e545f32582bb Mon Sep 17 00:00:00 2001 From: dvankleef Date: Wed, 5 Sep 2018 14:22:47 +0200 Subject: [PATCH 09/10] Update Update-VSTeamUser.md --- docs/Update-VSTeamUser.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Update-VSTeamUser.md b/docs/Update-VSTeamUser.md index 9fcb73502..cfa44e68a 100644 --- a/docs/Update-VSTeamUser.md +++ b/docs/Update-VSTeamUser.md @@ -4,13 +4,13 @@ ## SYNOPSIS - +Updates the users for the account. (Currently only supports updating the LicenseType) ## SYNTAX ## DESCRIPTION - +Updates the users for the account. (Currently only supports updating the LicenseType) ## EXAMPLES From e40136bacbcf159d0643788428e00ce67e6a7e2a Mon Sep 17 00:00:00 2001 From: Denny van Kleef Date: Fri, 7 Sep 2018 09:11:27 +0200 Subject: [PATCH 10/10] After running gen-help --- .docs/Update-VSTeamUser.md | 6 ++---- docs/Update-VSTeamUser.md | 8 +++++--- en-US/VSTeam-Help.xml | 28 ---------------------------- 3 files changed, 7 insertions(+), 35 deletions(-) diff --git a/.docs/Update-VSTeamUser.md b/.docs/Update-VSTeamUser.md index a25a6f447..cfa44e68a 100644 --- a/.docs/Update-VSTeamUser.md +++ b/.docs/Update-VSTeamUser.md @@ -4,20 +4,18 @@ ## SYNOPSIS - +Updates the users for the account. (Currently only supports updating the LicenseType) ## SYNTAX ## DESCRIPTION - +Updates the users for the account. (Currently only supports updating the LicenseType) ## EXAMPLES ## PARAMETERS - - ### -License Type of Account License you want to change to. The acceptable values for this parameter are: diff --git a/docs/Update-VSTeamUser.md b/docs/Update-VSTeamUser.md index 9fcb73502..6d2c2ba0c 100644 --- a/docs/Update-VSTeamUser.md +++ b/docs/Update-VSTeamUser.md @@ -1,16 +1,17 @@ - + + # Update-VSTeamUser ## SYNOPSIS - +Updates the users for the account. (Currently only supports updating the LicenseType) ## SYNTAX ## DESCRIPTION - +Updates the users for the account. (Currently only supports updating the LicenseType) ## EXAMPLES @@ -40,3 +41,4 @@ Default value: [empty] ## NOTES ## RELATED LINKS + diff --git a/en-US/VSTeam-Help.xml b/en-US/VSTeam-Help.xml index ce7d1ab66..ce2fbe22a 100644 --- a/en-US/VSTeam-Help.xml +++ b/en-US/VSTeam-Help.xml @@ -14375,20 +14375,6 @@ Demo-CI Demo-CI-45 notStarted Update-VSTeamUser - - 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. - - String - - String - - - None - License @@ -14410,20 +14396,6 @@ Demo-CI Demo-CI-45 notStarted - - 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. - - String - - String - - - None - License