Skip to main content

Command List

note

Currently there are 187 commandlets in the module.

Add-VSTeam​

Adds a team to a team project.

Add-VSTeamAccessControlEntry​

Add or update ACEs in the ACL for the provided token. The request contains the target token, a list of ACEs and a optional merge parameter. In the case of a collision (by identity descriptor) with an existing ACE in the ACL, the "merge" parameter determines the behavior. If set, the existing ACE has its allow and deny merged with the incoming ACE's allow and deny. If unset, the existing ACE is displaced.

Note: This is a low-level function. You should really use a high level function (Add-VSTeam Permission / Set-VSTeam Permission / Get-VSTeam*Permission) unless you know what you are doing.

Add-VSTeamArea​

Adds a new area to the project

Add-VSTeamAzureRMServiceEndpoint​

Adds a new Azure Resource Manager service endpoint.

Add-VSTeamBanner​

Adds a new banner message to an Azure DevOps organization.

Add-VSTeamBuild​

Queues a new build.

Add-VSTeamBuildDefinition​

Creates a new build definition from a JSON file.

Add-VSTeamBuildPermission​

Add Permissions to builds and multi staging pipelines

Add-VSTeamBuildTag​

Adds a tag to a build.

Add-VSTeamClassificationNode​

Adds either a new iteration or area to the project

Add-VSTeamExtension​

Install the specified extension into the account / project collection.

Add-VSTeamFeed​

Adds a new feed to package management.

Add-VSTeamGitRepository​

Adds a Git repository to your Azure DevOps or Team Foundation Server account.

Add-VSTeamGitRepositoryPermission​

Add permissions to a git repository, all repositories in a project, or a specific branch

Add-VSTeamIteration​

Adds a new iteration to the project

Add-VSTeamKubernetesEndpoint​

Adds connections to Kubernetes clusters

Add-VSTeamMembership​

Adds a membership to a container.

Add-VSTeamNuGetEndpoint​

Adds a new NuGet service endpoint.

Add-VSTeamPolicy​

Adds a new policy to the specified project.

Add-VSTeamPool​

Adds a new agent pool.

Add-VSTeamProfile​

Stores your account name and personal access token as a profile for use with the Add-TeamAccount function in this module.

Add-VSTeamProject​

Adds a Team Project to your account.

Add-VSTeamProjectPermission​

Add Permissions on Project Level

Add-VSTeamPullRequest​

Creates a new Pull Request.

Add-VSTeamRelease​

Queues a new release.

Add-VSTeamReleaseDefinition​

Creates a new release definition from a JSON file.

Add-VSTeamServiceEndpoint​

Adds a generic service connection

Add-VSTeamServiceFabricEndpoint​

Adds a new Service Fabric service endpoint.

Add-VSTeamSonarQubeEndpoint​

Adds a new SonarQube service endpoint.

Add-VSTeamTaskGroup​

Adds a task group.

Add-VSTeamUserEntitlement​

Add a user, assign license and extensions and make them a member of a project group in an account.

Add-VSTeamVariableGroup​

Adds a variable group.

Add-VSTeamWiki​

Publish a project or code wiki in the project provided

Add-VSTeamWorkItem​

Adds a work item to your project.

Add-VSTeamWorkItemAreaPermission​

Add Permissions to a Work Item Area

Add-VSTeamWorkItemIterationPermission​

Add Permissions to an Iteration

Clear-VSTeamDefaultAPITimeout​

Clears the value stored in the default timeout parameter value.

Clear-VSTeamDefaultProject​

Clears the value stored in the default project parameter value.

Clear-VSTeamDefaultProjectCount​

Clears the value stored in the default project count parameter value.

Disable-VSTeamAgent​

Disables an agent in a pool.

Enable-VSTeamAgent​

Enables an agent in a pool.

Get-VSTeam​

Returns a team.

Get-VSTeamAccessControlList​

Return a list of access control lists for the specified security namespace and token. All ACLs in the security namespace will be retrieved if no optional parameters are provided.

Get-VSTeamAccountBilling​

Gets the current account billing setup.

Get-VSTeamAccounts​

Gets the organizations where the user has access. Where the given user is either a member or an owner.

Get-VSTeamAgent​

Returns the agents in a pool.

Get-VSTeamAgentPoolMaintenance​

{{ Fill in the Synopsis }}

Get-VSTeamAPIVersion​

Returns the versions of APIs used.

Get-VSTeamApproval​

Gets a list of approvals for all releases for a team project.

Get-VSTeamArea​

Gets the area node for a given area path.

Get-VSTeamBanner​

Retrieves a banner from Azure DevOps based on its ID.

Get-VSTeamBuild​

Gets the builds for a team project.

Get-VSTeamBuildArtifact​

Returns the artifacts of a build.

Get-VSTeamBuildDefinition​

Gets the build definitions for a team project.

Get-VSTeamBuildLog​

Displays the logs for the build.

Get-VSTeamBuildTag​

Returns all the tags of a build.

Get-VSTeamBuildTimeline​

Get the timelines for builds

Get-VSTeamClassificationNode​

Gets the classification node for a given node path.

Get-VSTeamCloudSubscription​

Gets the Azure subscriptions associated with the Team Services account.

Get-VSTeamDescriptor​

Resolve a storage key to a descriptor.

Get-VSTeamExtension​

Get the installed extensions in the specified Azure DevOps or Team Foundation Server project.

Get-VSTeamFeed​

Returns a list of package feeds for the account.

Get-VSTeamGitCommit​

Retrieve git commits for a project

Get-VSTeamGitRef​

Queries the provided repository for its refs and returns them.

Get-VSTeamGitRepository​

Get all the repositories in your Azure DevOps or Team Foundation Server account, or a specific project.

Get-VSTeamGitStat​

Retrieves statistics about branches within a repository.

Get-VSTeamGroup​

Returns a Group or List of Groups.

Get-VSTeamInfo​

Displays your current account and default project.

Get-VSTeamIteration​

Gets the iteration node for a given iteration path.

Get-VSTeamJobRequest​

Returns all the job requests of an agent.

Get-VSTeamMember​

Returns a team member.

Get-VSTeamMembership​

Gets a memberships for a container or member.

Get-VSTeamOption​

Returns all the versions of supported APIs of your TFS or AzD.

Get-VSTeamPackage​

Returns a list of packages for a feed.

Get-VSTeamPackageVersion​

Returns a list of versions for a package.

Get-VSTeamPermissionInheritance​

Undocumented API Returns true or false.

Get-VSTeamPolicy​

Get the code policies in the specified Azure DevOps or Team Foundation Server project.

Get-VSTeamPolicyType​

Get the policy types in the specified Azure DevOps or Team Foundation Server project.

Get-VSTeamPool​

Returns the agent pools.

Get-VSTeamProcess​

Returns a list of process templates in the Team Services or Team Foundation Server account.

Get-VSTeamProfile​

Returns the saved profiles.

Get-VSTeamProject​

Returns a list of projects in the Team Services or Team Foundation Server account.

Get-VSTeamPullRequest​

Returns one or more open pull requests from your team, project, or Id.

Get-VSTeamQuery​

Gets the root queries and their children.

Get-VSTeamQueue​

Gets a agent queue.

Get-VSTeamRelease​

Gets the releases for a team project.

Get-VSTeamReleaseDefinition​

Gets the release definitions for a team project.

Get-VSTeamResourceArea​

List all the areas supported by this instance of TFS/VSTS.

Get-VSTeamSecurityNamespace​

List all security namespaces or just the specified namespace.

Get-VSTeamServiceEndpoint​

Gets a service endpoint.

Get-VSTeamServiceEndpointType​

Get service endpoint types.

Get-VSTeamTaskGroup​

Gets a task group

Get-VSTeamTfvcBranch​

Gets a branch for a given path from TFVC source control.

Get-VSTeamTfvcRootBranch​

Gets root branches for all projects with TFVC source control.

Get-VSTeamUser​

Returns a list of users for the account.

Get-VSTeamUserEntitlement​

Get User Entitlement for a user, or a paged list of users matching the specified filter

Please note that Filter, Name, UserType and License parameters only works when MemberEntitlementManagement module version is 6.0 or upper In the same way Top and Skip paramerers only works up to version 5.1

You can setup the specific version for the MemberEntitlementManagement calling Set-VSTeamAPIVersion -Service MemberEntitlementManagement -Version VersionNumberYouNeed.

Get-VSTeamUserProfile​

Gets the user profile of an account.

Get-VSTeamVariableGroup​

Gets a variable group

Get-VSTeamWiki​

Returns a list of wikis for the selected project.

Get-VSTeamWiql​

Returns work items from the given WIQL query or a saved query by ID from your projects team.

Get-VSTeamWorkItem​

Returns one or more a work items from your project.

Get-VSTeamWorkItemTag​

Gets a work item tag

Get-VSTeamWorkItemType​

Gets a list of all Work Item Types or a single work item type.

Invoke-VSTeamRequest​

Allows you to call any TFS/AzD 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​

Removes a team from a project.

Remove-VSTeamAccessControlEntry​

Removes specified ACEs in the ACL for the provided token. The request URI contains the namespace ID, the target token, and a single or list of descriptors that should be removed. Only supports removing AzD based users/groups.

Remove-VSTeamAccessControlList​

Remove access control lists under the specified security namespace.

Remove-VSTeamAccount​

Clears your default project, account name and personal access token.

Remove-VSTeamAgent​

Removes an agent from a pool.

Remove-VSTeamArea​

Removes an existing area from the project

Remove-VSTeamBanner​

Removes a banner message from an Azure DevOps organization by its identifier.

Remove-VSTeamBuild​

Deletes the build.

Remove-VSTeamBuildDefinition​

Removes the build definitions for a team project.

Remove-VSTeamBuildTag​

Removes the tag from a build.

Remove-VSTeamClassificationNode​

Removes either an existing iteration or area from the project

Remove-VSTeamDirectAssignment​

Removes explicit assignments of users by their IDs. Operates in either preview mode or normal mode. In normal mode, it chunks user IDs into groups of 20 to avoid timeouts.

Remove-VSTeamExtension​

Uninstall the specified extension from the account / project collection.

Remove-VSTeamFeed​

Removes a package feed from the account.

Remove-VSTeamGitRepository​

Removes the Git repository from your Azure DevOps or Team Foundation Server account.

Remove-VSTeamIteration​

Removes an existing iteration from the project

Remove-VSTeamMembership​

Removes a membership to a container.

Remove-VSTeamPolicy​

Removes the specified policy from the specified project.

Remove-VSTeamPool​

Removes the agent pool.

Remove-VSTeamProfile​

Removes the profile.

Remove-VSTeamProject​

Deletes the Team Project from your Team Services account.

Remove-VSTeamRelease​

Removes the releases for a team project.

Remove-VSTeamReleaseDefinition​

Removes the release definitions for a team project.

Remove-VSTeamServiceEndpoint​

Removes a service endpoint.

Remove-VSTeamTaskGroup​

Removes a task group

Remove-VSTeamUserEntitlement​

Delete a user from the account.

The delete operation includes unassigning Extensions and Licenses and removing the user from all project memberships. The user would continue to have access to the account if she is member of an AAD group, that is added directly to the account.

Remove-VSTeamVariableGroup​

Removes a variable group

Remove-VSTeamWiki​

Unpublish a project or code wiki in the project provided

Remove-VSTeamWorkItem​

Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution.

Remove-VSTeamWorkItemTag​

Gets a work item tag

Set-VSTeamAccount​

Stores your account name and personal access token for use with the other functions in this module.

Set-VSTeamAgentPoolMaintenance​

{{ Fill in the Synopsis }}

Set-VSTeamAlias​

In version 6.0 the default aliases were removed to prevent conflicts with other modules. If you want to use the original aliases you can run this function to restore them.

Set-VSTeamAPIVersion​

Sets the API versions to support either TFS2017, TFS2018, AzD2019 or AzD.

Set-VSTeamApproval​

Sets the status of approval to Approved, Rejected, Pending, or ReAssigned.

Set-VSTeamDefaultAPITimeout​

Sets the default timeout to be used with other calls in the module.

Set-VSTeamDefaultProject​

Sets the default project to be used with other calls in the module.

Set-VSTeamDefaultProjectCount​

Sets the default project count to be used with other calls in the module. This is important if you have more than 100 projects.

Set-VSTeamEnvironmentStatus​

Sets the status of a environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined.

Set-VSTeamPermissionInheritance​

Undocumented API Sets the permission inheritance to true or false.

Set-VSTeamPipelineAuthorization​

Authorizes pipelines to use the given resources.

Set-VSTeamPipelineBilling​

Purchases private and Microsoft hosted concurrent jobs for pipelines.

Set-VSTeamReleaseStatus​

Sets the status of a release to Active or Abandoned.

Set-VSTeamVariableGroupVariable​

Adds a variable to an existing variable group, or changes its value if the variable is already present.

Show-VSTeam​

Opens TFS or AzD site in the default browser.

Show-VSTeamApproval​

Opens the release associated with the waiting approval in the default browser.

Show-VSTeamBuild​

Opens the build summary in the default browser.

Show-VSTeamBuildDefinition​

Opens the build definition in the default browser.

Show-VSTeamFeed​

Opens the feed in the default browser.

Show-VSTeamGitRepository​

Opens the Git repository in the default browser.

Show-VSTeamPackage​

Opens the package in the default browser.

Show-VSTeamProject​

Opens the project in the default browser.

Show-VSTeamPullRequest​

Opens the pull request in the default browser.

Show-VSTeamRelease​

Opens the release summary in the default browser.

Show-VSTeamReleaseDefinition​

Opens the release definitions for a team project in the default browser.

Show-VSTeamWorkItem​

Opens the work item in the default browser.

Stop-VSTeamBuild​

Allows you to cancel a running build.

Test-VSTeamMembership​

Tests the membership in a container.

Test-VSTeamYamlPipeline​

Validates the local YAML pipeline against Azure DevOps.

Update-VSTeam​

Updates the team name, description or both.

Update-VSTeamAgent​

Instructs the agent to download and install the lastest version of the agent on self-hosted agents.

Update-VSTeamArea​

Updates the area name in a project

Update-VSTeamBanner​

Updates an existing banner message in an Azure DevOps organization.

Update-VSTeamBuild​

Allows you to set the keep forever flag and build number.

Update-VSTeamBuildDefinition​

Updates a build definition for a team project.

Update-VSTeamClassificationNode​

Updates a pre-existing iteration or area in the project

Update-VSTeamExtension​

Update an installed extension. Typically this API is used to enable or disable an extension.

Update-VSTeamGitRepositoryDefaultBranch​

Update the default branch of an existing respository.

Update-VSTeamIteration​

Updates an iteration's properties in a project

Update-VSTeamNuGetPackageVersion​

Set mutable state on a package version.

Update-VSTeamPolicy​

Updates an existing policy in the specified project.

Update-VSTeamPool​

Updates an agent pool.

Update-VSTeamProfile​

Allows you to update the Personal Access Token for your profile.

Update-VSTeamProject​

Updates the project name, description or both.

Update-VSTeamPullRequest​

Update a pull request

Update-VSTeamRelease​

Allows you to update release variables for future stages to read.

Update-VSTeamReleaseDefinition​

Updates a build definition for a team project.

Update-VSTeamServiceEndpoint​

Updates an existing service connection

Update-VSTeamTaskGroup​

Updates an existing task group

Update-VSTeamUserEntitlement​

Edit the entitlements (License, Extensions, Projects, Teams etc) for a user.

Update-VSTeamVariableGroup​

Updates an existing variable group

Update-VSTeamWorkItem​

Update a work item in your project.

Update-VSTeamWorkItemTag​

Gets a work item tag