diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 000000000..b7c6b4d15 Binary files /dev/null and b/.DS_Store differ diff --git a/.gitignore b/.gitignore index 3cbe28239..42964151b 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,11 @@ integration/prime.ps1 .vs/slnx.sqlite unit/results.xml en-US/VSTeam-Help.xml +Source/Classes/classes.ps1 +Source/formats/formats.ps1xml +Source/types/vsteam.types.ps1xml +Source/formats/vsteam.format.ps1xml +Source/Public/vsteam.public.ps1 +Source/Private/vsteam.private.ps1 +Source/Classes/vsteam.classes.ps1 +/dist \ No newline at end of file diff --git a/Build-Module.ps1 b/Build-Module.ps1 new file mode 100644 index 000000000..6f8f8d436 --- /dev/null +++ b/Build-Module.ps1 @@ -0,0 +1,55 @@ +[CmdletBinding()] +param( + [string]$outputDir = './dist', + + # Building help is skipped by default to speed your inner loop. + # Use this flag to include building the help + [switch]$buildHelp, + + # By default the build will not install dependencies + [switch]$installDep +) + +. ./Merge-File.ps1 + +if ($installDep.IsPresent) { + # Load the psd1 file so you can read the required modules and install them + $manifest = Import-PowerShellDataFile .\Source\VSTeam.psd1 + + # Install each module + $manifest.RequiredModules | ForEach-Object { if (-not (get-module $_ -ListAvailable)) { Write-Host "Installing $_"; Install-Module -Name $_ -Repository PSGallery -F -Scope CurrentUser } } +} + +if ([System.IO.Path]::IsPathRooted($outputDir)) { + $output = $outputDir +} +else { + $output = Join-Path (Get-Location) $outputDir +} + +Merge-File -inputFile ./Source/_functions.json -outputDir $output +Merge-File -inputFile ./Source/types/_types.json -outputDir $output +Merge-File -inputFile ./Source/Classes/_classes.json -outputDir $output +Merge-File -inputFile ./Source/formats/_formats.json -outputDir $output + +# Build the help +if ($buildHelp.IsPresent) { + Write-Output 'Creating help files' + Push-Location + Set-Location ./.docs + ./gen-help.ps1 + Pop-Location +} + +Write-Output 'Publishing help files' +Copy-Item -Path ./Source/en-US -Destination "$output/" -Recurse -Force +Copy-Item -Path ./Source/VSTeam.psm1 -Destination "$output/VSTeam.psm1" -Force + +Write-Output 'Updating Functions To Export' +$newValue = ((Get-ChildItem -Path "./Source/Public" -Filter '*.ps1').BaseName | + ForEach-Object -Process { Write-Output "'$_'" }) -join ',' + +(Get-Content "./Source/VSTeam.psd1") -Replace ("FunctionsToExport.+", "FunctionsToExport = ($newValue)") | + Set-Content "$output/VSTeam.psd1" + +Write-Output "Publish complete to $output" \ No newline at end of file diff --git a/Merge-File.ps1 b/Merge-File.ps1 new file mode 100644 index 000000000..358bce10b --- /dev/null +++ b/Merge-File.ps1 @@ -0,0 +1,206 @@ +function Merge-File { + <# +.SYNOPSIS +Combines all the files in the provided inputFile into a single file. + +.DESCRIPTION +The input file must be a JSON file in the following format: +{ + output: "outputFileName.ps1", + files: ["file1.ps1", "file2.ps1"] +} + +All the files are read and any using statements removed. All the +removed using statements are collected and written at the top of the +output file. All comments will also be removed from the output file. + +.PARAMETER InputFile +The JSON file to process. + +.PARAMETER outputDir +The destination folder. + +.EXAMPLE +PS C:\> Merge-File -InputFile .\Source\Classes\classes.json + +#> + [CmdletBinding()] + param( + [Parameter(Mandatory = $True)] + [string] + $inputFile, + + [Parameter(Mandatory = $True)] + [string] + $outputDir + ) + + $fullPath = $(Resolve-Path $inputFile) + Write-Verbose "Full Path: $fullPath" + + $fileOrder = Get-Content $fullPath -Raw | ConvertFrom-Json + Write-Output "Processing: $($fileOrder.fileType) in $fullPath" + + $workingDir = Split-Path $fullPath + Write-Verbose "Working Directory: $workingDir" + + $output = Join-Path $outputDir $fileOrder.outputFile + + Push-Location + Set-Location $workingDir + + try { + $files = $() + + foreach ($file in $fileOrder.files) { + foreach ($item in $(Get-ChildItem -Filter $file)) { + $files += , (Resolve-Path $item.FullName) + } + } + + # This makes sure the file is there and empty. + # If the file already exisit it will be overwritten. + $null = New-Item -ItemType file -Path $output -Force + Write-Output "Creating: $output" + + switch ($fileOrder.fileType) { + 'formats' { + Merge-Format $files | Add-Content $output + } + 'types' { + Merge-Type $files | Add-Content $output + } + 'functions' { + Merge-Function $files | Add-Content $output + } + Default { + Merge-Class $files | Add-Content $output + } + } + } + catch { + throw $_ + } + finally { + Pop-Location + } +} + +function Merge-Format { + [CmdletBinding()] + param( + [Parameter(Mandatory = $True)] + [string[]] + $files + ) + + process { + $finalXml = '' + + ForEach ($file in $files) { + Write-Verbose -Message "Merging from $file" + $fileContents = Get-Content $file + $newFileContents = ($fileContents -replace '', '') + [xml]$xml = $newFileContents + + $finalXml += $xml.Configuration.ViewDefinitions.InnerXml + } + + $finalXml += '' + + Write-Output ([xml]$finalXml).OuterXml + } +} + +function Merge-Type { + [CmdletBinding()] + param( + [Parameter(Mandatory = $True)] + [string[]] + $files + ) + + process { + $finalXml = '' + + ForEach ($file in $files) { + Write-Verbose -Message "Merging from $file" + $fileContents = Get-Content $file + $newFileContents = ($fileContents -replace '', '') + [xml]$xml = $newFileContents + + $finalXml += $xml.Types.InnerXml + } + + $finalXml += '' + + Write-Output ([xml]$finalXml).OuterXml + } +} + +function Merge-Function { + [CmdletBinding()] + param( + [Parameter(Mandatory = $True)] + [string[]] + $files + ) + + process { + $contents = New-Object System.Text.StringBuilder + + ForEach ($file in $files) { + Write-Verbose -Message "Merging from $file" + $fileContents = Get-Content $file + + foreach ($line in $fileContents) { + $contents.AppendLine($line) | Out-Null + } + } + + Write-Output $contents.ToString() + } +} + +function Merge-Class { + [CmdletBinding()] + param( + [Parameter(Mandatory = $True)] + [string[]] + $files + ) + + process { + $usingsSb = New-Object System.Text.StringBuilder + $contents = New-Object System.Text.StringBuilder + + ForEach ($file in $files) { + Write-Verbose -Message "Merging from $file" + $fileContents = Get-Content $file + + # Find all the usings and save them + $matches = $fileContents | Select-String 'using.+' + + ForEach ($m in $matches) { + Write-Verbose "Found $($m.Line)" + + # Don't add duplicate usings + if ($null -eq ($usings | Where-Object { $_ -eq $m.Line })) { + $usingsSb.AppendLine($m.Line) | Out-Null + $usings += , $m.Line + } + } + + # Remove move all the using statements and comments + $newFileContents = ($fileContents -replace 'using.+', '') + $newFileContents = ($newFileContents -replace '#.+', '') + foreach ($line in $newFileContents) { + if ($null -ne $line.Trim() -and '' -ne $line.Trim()) { + $contents.AppendLine($line) | Out-Null + } + } + } + + Write-Output "$($usingsSb.ToString()) $($contents.ToString())" + } +} \ No newline at end of file diff --git a/README.md b/README.md index bfb0df556..2b6d724b5 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,30 @@ During the release the module is installed on macOS, Linux and Window and tested ## Module Dependencies - [SHiPS module](https://www.powershellgallery.com/packages/SHiPS/) +- [Trackyon.Utils module](https://www.powershellgallery.com/packages/Trackyon.Utils) + +## Building Module + +In an effort to reduce the module size this repository contains two scripts Build-Module.ps1 and Merge-File.ps1 that merges similar files into a single file. The files in the formats folder are merged into vsteam.format.ps1xml. The files in the classes folder are merged into vsteam.classes.ps1. The functions from the Private and Public folders are merged into vsteam.functions.ps1. Finally all the files in the types folder are merged into vsteam.types.ps1xml. The order of the files being merged can be controlled by the _*.json files in the repository. + +The JSON files must be in the following format: + +```JSON +{ + "outputFile": "vsteam.functions.ps1", + "fileType": "functions", + "files": [ + "./Private/*.ps1", + "./Public/*.ps1" + ] +} +``` + +The final module is stored in a dist folder by default. You can override this folder by using the -outputDir parameter to the Build-Module.ps1 script. + +To generate the help add the -buildHelp switch parameter. + +You can also use the -installDep switch parameter to install all the module dependencies to bootstrap your development. ## Contributors diff --git a/Source/Classes/VSTeamRelease.ps1 b/Source/Classes/VSTeamRelease.ps1 index 8836040d3..cb3e17dc0 100644 --- a/Source/Classes/VSTeamRelease.ps1 +++ b/Source/Classes/VSTeamRelease.ps1 @@ -25,7 +25,10 @@ class VSTeamRelease : VSTeamDirectory { $this.DefinitionName = $obj.releaseDefinition.name $this.CreatedBy = [VSTeamUserEntitlement]::new($obj.createdBy, $ProjectName) $this.ModifiedBy = [VSTeamUserEntitlement]::new($obj.modifiedBy, $ProjectName) - $this.RequestedFor = [VSTeamUserEntitlement]::new($obj.requestedFor, $ProjectName) + + if ($obj.PSObject.Properties.Match('RequestedFor').count -gt 0) { + $this.RequestedFor = [VSTeamUserEntitlement]::new($obj.requestedFor, $ProjectName) + } $this._internalObj = $obj diff --git a/Source/Classes/_classes.json b/Source/Classes/_classes.json new file mode 100644 index 000000000..d021c1c81 --- /dev/null +++ b/Source/Classes/_classes.json @@ -0,0 +1,54 @@ +{ + "outputFile": "vsteam.classes.ps1", + "fileType": "classes", + "files": [ + "VSTeamVersions.ps1", + "VSTeamProjectCache.ps1", + "VSTeamProcessCache.ps1", + "VSTeamDirectory.ps1", + "VSTeamLeaf.ps1", + "VSTeamPools.ps1", + "VSTeamInstallState.ps1", + "VSTeamExtensions.ps1", + "VSTeamFeeds.ps1", + "VSTeamAgent.ps1", + "VSTeamTask.ps1", + "VSTeamAttempt.ps1", + "VSTeamUserEntitlement.ps1", + "VSTeamPool.ps1", + "VSTeamQueue.ps1", + "VSTeamEnvironment.ps1", + "VSTeamRelease.ps1", + "VSTeamReleases.ps1", + "VSTeamBuild.ps1", + "VSTeamBuildDefinitions.ps1", + "VSTeamBuilds.ps1", + "VSTeamQueues.ps1", + "VSTeamRepositories.ps1", + "VSTeamTeams.ps1", + "VSTeamProject.ps1", + "VSTeamGitRepository.ps1", + "VSTeamBuildDefinitionProcessPhaseStep.ps1", + "VSTeamBuildDefinitionProcessPhase.ps1", + "VSTeamBuildDefinitionProcess.ps1", + "VSTeamBuildDefinition.ps1", + "VSTeamExtension.ps1", + "VSTeamFeed.ps1", + "VSTeamProcess.ps1", + "VSTeamRef.ps1", + "VSTeamTeam.ps1", + "VSTeamAccount.ps1", + "VSTeamGitRepositoryPermissions.ps1", + "VSTeamIdentityPermissions.ps1", + "VSTeamProjectPermissions.ps1", + "VSTeamWorkItemAreaPermissions.ps1", + "VSTeamWorkItemIterationPermissions.ps1", + "VSTeamGroup.ps1", + "VSTeamDescriptor.ps1", + "VSTeamSecurityNamespace.ps1", + "VSTeamAccessControlEntry.ps1", + "VSTeamAccessControlList.ps1", + "VSTeamUser.ps1", + "VSTeamClassificationNode.ps1" + ] +} \ No newline at end of file diff --git a/Source/Classes/classes.json b/Source/Classes/classes.json deleted file mode 100644 index 1e811529b..000000000 --- a/Source/Classes/classes.json +++ /dev/null @@ -1,55 +0,0 @@ -[ - "VSTeamVersions.ps1", - "VSTeamProjectCache.ps1", - "VSTeamProcessCache.ps1", - "VSTeamDirectory.ps1", - "VSTeamLeaf.ps1", - "VSTeamPools.ps1", - "VSTeamInstallState.ps1", - "VSTeamExtensions.ps1", - "VSTeamFeeds.ps1", - "VSTeamAgent.ps1", - "VSTeamTask.ps1", - "VSTeamAttempt.ps1", - "VSTeamUserEntitlement.ps1", - "VSTeamPool.ps1", - "VSTeamQueue.ps1", - "VSTeamEnvironment.ps1", - "VSTeamRelease.ps1", - "VSTeamReleases.ps1", - "VSTeamBuild.ps1", - "VSTeamBuildDefinitions.ps1", - "VSTeamBuilds.ps1", - "VSTeamQueues.ps1", - "VSTeamRepositories.ps1", - "VSTeamTeams.ps1", - "VSTeamProject.ps1", - "VSTeamGitRepository.ps1", - "VSTeamBuildDefinitionProcessPhaseStep.ps1", - "VSTeamBuildDefinitionProcessPhase.ps1", - "VSTeamBuildDefinitionProcess.ps1", - "VSTeamBuildDefinition.ps1", - "VSTeamExtension.ps1", - "VSTeamFeed.ps1", - "VSTeamProcess.ps1", - "VSTeamRef.ps1", - "VSTeamTeam.ps1", - "VSTeamAccount.ps1", - "VSTeamGitRepositoryPermissions.ps1", - "VSTeamIdentityPermissions.ps1", - "VSTeamProjectPermissions.ps1", - "VSTeamWorkItemAreaPermissions.ps1", - "VSTeamWorkItemIterationPermissions.ps1", - "VSTeamGroup.ps1", - "VSTeamGitRepositoryPermissions.ps1", - "VSTeamIdentityPermissions.ps1", - "VSTeamProjectPermissions.ps1", - "VSTeamWorkItemAreaPermissions.ps1", - "VSTeamWorkItemIterationPermissions.ps1", - "VSTeamDescriptor.ps1", - "VSTeamSecurityNamespace.ps1", - "VSTeamAccessControlEntry.ps1", - "VSTeamAccessControlList.ps1", - "VSTeamUser.ps1", - "VSTeamClassificationNode.ps1" -] \ No newline at end of file diff --git a/Source/Private/common.ps1 b/Source/Private/common.ps1 index 7888de419..5b1b22011 100644 --- a/Source/Private/common.ps1 +++ b/Source/Private/common.ps1 @@ -711,7 +711,8 @@ function _supportsServiceFabricEndpoint { function _getModuleVersion { # Read the version from the psd1 file. - $content = (Get-Content -Raw "$here\..\VSTeam.psd1" | Out-String) + # $content = (Get-Content -Raw "./VSTeam.psd1" | Out-String) + $content = (Get-Content -Raw "$here\VSTeam.psd1" | Out-String) $r = [regex]"ModuleVersion += +'([^']+)'" $d = $r.Match($content) diff --git a/Source/Public/Update-VSTeamBuild.ps1 b/Source/Public/Update-VSTeamBuild.ps1 index 16e0ad173..065b623cb 100644 --- a/Source/Public/Update-VSTeamBuild.ps1 +++ b/Source/Public/Update-VSTeamBuild.ps1 @@ -27,15 +27,15 @@ function Update-VSTeamBuild { $items = New-Object System.Collections.ArrayList - if ($KeepForever -ne $null) { + if ($null -ne $KeepForever) { $items.Add("`"keepForever`": $($KeepForever.ToString().ToLower())") > $null } - if ($buildNumber -ne $null -and $buildNumber.Length -gt 0) { + if ($null -ne $buildNumber -and $buildNumber.Length -gt 0) { $items.Add("`"buildNumber`": `"$BuildNumber`"") > $null } - if ($items -ne $null -and $items.count -gt 0) { + if ($null -ne $items -and $items.count -gt 0) { $body += ($items -join ", ") } diff --git a/Source/VSTeam.psd1 b/Source/VSTeam.psd1 index 456154891..2a9718c47 100644 --- a/Source/VSTeam.psd1 +++ b/Source/VSTeam.psd1 @@ -60,174 +60,17 @@ # ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module - TypesToProcess = @('types\Approvals.ps1xml', - 'types\builds.ps1xml', - 'types\cloudSubscriptions.ps1xml', - 'types\repositories.ps1xml', - 'types\policies.ps1xml', - 'types\releaseDefinitions.ps1xml', - 'types\releases.ps1xml', - 'types\serviceendpoints.ps1xml', - 'types\team.ps1xml', - 'types\teammembers.ps1xml', - 'types\teams.ps1xml', - 'types\tfvc.ps1xml', - 'types\usersentitlement.ps1xml', - 'types\workitems.ps1xml', - 'types\pullrequest.ps1xml', - 'types\group.ps1xml', - 'types\descriptor.ps1xml', - 'types\securityNamespace.ps1xml', - 'types\accessControlList.ps1xml', - 'types\accessControlEntry.ps1xml', - 'types\users.ps1xml', - 'types\classificationNode.ps1xml', - 'types\variablegroups.ps1xml') + TypesToProcess = @('.\vsteam.types.ps1xml') # Format files (.ps1xml) to be loaded when importing this module - FormatsToProcess = @('formats\Approvals.format.ps1xml', - 'formats\builds.format.ps1xml', - 'formats\policyTypes.format.ps1xml', - 'formats\profile.format.ps1xml', - 'formats\serviceendpoints.format.ps1xml', - 'formats\serviceendpointTypes.format.ps1xml', - 'formats\team.format.ps1xml', - 'formats\usersentitlement.format.ps1xml', - 'formats\workitemTypes.format.ps1xml', - 'formats\workitems.format.ps1xml', - 'formats\vsteamPSDrive.format.ps1xml', - 'formats\group.format.ps1xml', - 'formats\descriptor.format.ps1xml', - 'formats\securityNamespace.format.ps1xml', - 'formats\accessControlList.format.ps1xml', - 'formats\accessControlEntry.format.ps1xml', - 'formats\users.format.ps1xml', - 'formats\classificationNode.format.ps1xml', - 'formats\variablegroups.format.ps1xml') + FormatsToProcess = @('.\vsteam.format.ps1xml') # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess # NestedModules = @() # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. - FunctionsToExport = @('Add-VSTeamAzureRMServiceEndpoint', - 'Add-VSTeamSonarQubeEndpoint', - 'Add-VSTeamKubernetesEndpoint', - 'Add-VSTeamServiceFabricEndpoint', - 'Add-VSTeamServiceEndpoint', - 'Update-VSTeamServiceEndpoint', - 'Add-VSTeamBuild', - 'Add-VSTeamBuildDefinition', - 'Add-VSTeamProject', - 'Add-VSTeamRelease', - 'Add-VSTeamReleaseDefinition', - 'Set-VSTeamAccount', - 'Add-VSTeam', - 'Add-VSTeamPolicy', - 'Clear-VSTeamDefaultProject', - 'Get-VSTeamApproval', - 'Get-VSTeamBuild', - 'Get-VSTeamBuildDefinition', - 'Get-VSTeamCloudSubscription', - 'Get-VSTeamPolicy', - 'Get-VSTeamPolicyType', - 'Get-VSTeamPool', - 'Get-VSTeamProcess', - 'Get-VSTeamProject', - 'Get-VSTeamQueue', - 'Get-VSTeamRelease', - 'Get-VSTeamReleaseDefinition', - 'Get-VSTeamServiceEndpoint', - 'Get-VSTeamInfo', - 'Get-VSTeam', - 'Get-VSTeamMember', - 'Update-VSTeamPolicy', - 'Remove-VSTeamBuild', - 'Remove-VSTeamBuildDefinition', - 'Remove-VSTeamProject', - 'Remove-VSTeamRelease', - 'Remove-VSTeamReleaseDefinition', - 'Remove-VSTeamServiceEndpoint', - 'Remove-VSTeamAccount', - 'Remove-VSTeam', - 'Remove-VSTeamPolicy', - 'Set-VSTeamApproval', - 'Set-VSTeamDefaultProject', - 'Set-VSTeamReleaseStatus', - 'Update-VSTeamProject', - 'Update-VSTeam', - 'Get-VSTeamGitRepository', - 'Add-VSTeamGitRepository', - 'Remove-VSTeamGitRepository', - 'Get-VSTeamBuildLog', - 'Add-VSTeamBuildTag', - 'Get-VSTeamBuildTag', - 'Remove-VSTeamBuildTag', - 'Get-VSTeamBuildArtifact', - 'Update-VSTeamBuild', - 'Get-VSTeamOption', - 'Get-VSTeamResourceArea', - 'Show-VSTeamProject', - 'Show-VSTeamBuildDefinition', - 'Show-VSTeamApproval', - 'Show-VSTeamBuild', - 'Show-VSTeamGitRepository', - 'Show-VSTeamReleaseDefinition', - 'Show-VSTeamRelease', - 'Show-VSTeam', - 'Add-VSTeamProfile', - 'Remove-VSTeamProfile', - 'Get-VSTeamProfile', - 'Set-VSTeamAPIVersion', - 'Invoke-VSTeamRequest', - 'Get-VSTeamUserEntitlement', - 'Remove-VSTeamUserEntitlement', - 'Add-VSTeamUserEntitlement', - 'Update-VSTeamUserEntitlement', - 'Set-VSTeamEnvironmentStatus', - 'Get-VSTeamServiceEndpointType', - 'Update-VSTeamBuildDefinition', - 'Get-VSTeamTfvcRootBranch', - 'Get-VSTeamTfvcBranch', - 'Get-VSTeamWorkItemType', - 'Add-VSTeamWorkItem', - 'Get-VSTeamWorkItem', - 'Show-VSTeamWorkItem', - 'Get-VSTeamGitRef', - 'Get-VSTeamAgent', - 'Remove-VSTeamAgent', - 'Enable-VSTeamAgent', - 'Disable-VSTeamAgent', - 'Update-VSTeamProfile', - 'Get-VSTeamAPIVersion', - 'Add-VSTeamNuGetEndpoint', - 'Get-VSTeamFeed', - 'Add-VSTeamFeed', - 'Show-VSTeamFeed', - 'Remove-VSTeamFeed', - 'Get-VSTeamPullRequest', - 'Show-VSTeamPullRequest', - 'Add-VSTeamExtension', - 'Get-VSTeamExtension', - 'Update-VSTeamExtension', - 'Remove-VSTeamExtension', - 'Update-VSTeamWorkItem', - 'Set-VSTeamAlias', - 'Get-VSTeamGroup', - 'Get-VSTeamDescriptor', - 'Get-VSTeamSecurityNamespace', - 'Get-VSTeamAccessControlList', - 'Add-VSTeamAccessControlEntry', - 'Get-VSTeamUser', - 'Add-VSTeamProjectPermission', - 'Add-VSTeamGitRepositoryPermission', - 'Add-VSTeamWorkItemAreaPermission', - 'Add-VSTeamWorkItemIterationPermission', - 'Get-VSTeamClassificationNode', - 'Update-VSTeamRelease', - 'Add-VSTeamVariableGroup', - 'Get-VSTeamVariableGroup', - 'Remove-VSTeamVariableGroup', - 'Update-VSTeamVariableGroup') + # This wildcard will be replaced during the build process in AzD + FunctionsToExport = @('*') # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. # CmdletsToExport = @() @@ -253,7 +96,7 @@ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. - Tags = @('VSTS', 'TFS', 'DevOps', 'VisualStudio', 'TeamServices', 'Team', 'AzureDevOps', 'Pipelines', 'Boards', 'Artifacts', 'TestPlans', 'Repos') + Tags = @('VSTS', 'TFS', 'DevOps', 'VisualStudio', 'TeamServices', 'Team', 'AzureDevOps', 'Pipelines', 'Boards', 'Artifacts', 'TestPlans', 'Repos', 'AzD', 'ADO', 'AzDO') # If you use this you don't need SHiPS in your private repository but the user # has to install SHiPS manually. If you don't add this SHiPS will be installed @@ -261,10 +104,10 @@ # ExternalModuleDependencies = @('SHiPS') # A URL to the license for this module. - LicenseUri = 'https://github.com/DarqueWarrior/vsteam/blob/master/LICENSE' + LicenseUri = 'https://github.com/DarqueWarrior/vsteam/blob/master/LICENSE' # A URL to the main website for this project. - ProjectUri = 'https://github.com/DarqueWarrior/vsteam' + ProjectUri = 'https://github.com/DarqueWarrior/vsteam' # A URL to an icon representing this module. # IconUri = '' diff --git a/Source/VSTeam.psm1 b/Source/VSTeam.psm1 index a554236bf..d722c188b 100644 --- a/Source/VSTeam.psm1 +++ b/Source/VSTeam.psm1 @@ -6,31 +6,9 @@ # The module manifest is using wildcard exports for functions # and alias so you only have to name the files correctly. -# The order that the classes files are loaded is important. Instead -# of an awkward naming convention I added a file that has the load -# order in it. -$classOrder = Get-Content "$PSScriptRoot\Classes\classes.json" -Raw | ConvertFrom-Json - -ForEach ($classFile in $classOrder) { - Write-Verbose -Message "Importing from $classFile" - . "$PSScriptRoot\Classes\$classFile" -} - -$functionFolders = @('Private', 'Public') -ForEach ($folder in $functionFolders) { - $folderPath = Join-Path -Path $PSScriptRoot -ChildPath $folder - If (Test-Path -Path $folderPath) { - Write-Verbose -Message "Importing from $folder" - $functions = Get-ChildItem -Path $folderPath -Filter '*.ps1' - ForEach ($function in $functions) { - Write-Verbose -Message " Importing $($function.BaseName)" - . $($function.FullName) - } - } -} - -$publicFunctions = (Get-ChildItem -Path "$PSScriptRoot\Public" -Filter '*.ps1').BaseName -Export-ModuleMember -Function $publicFunctions +# Files are built using a script in the root folder +. "$PSScriptRoot\vsteam.classes.ps1" +. "$PSScriptRoot\vsteam.functions.ps1" # Check to see if the user stored the default project in an environment variable if ($null -ne $env:TEAM_PROJECT) { diff --git a/Source/_functions.json b/Source/_functions.json new file mode 100644 index 000000000..1f3802b4c --- /dev/null +++ b/Source/_functions.json @@ -0,0 +1,8 @@ +{ + "outputFile": "vsteam.functions.ps1", + "fileType": "functions", + "files": [ + "./Private/*.ps1", + "./Public/*.ps1" + ] +} \ No newline at end of file diff --git a/Source/formats/Approvals.format.ps1xml b/Source/formats/Approvals.format.ps1xml deleted file mode 100644 index 9296b8b23..000000000 --- a/Source/formats/Approvals.format.ps1xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - Pending - - Team.Approval - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - id - - - status - - - releaseName - - - releaseEnvironmentName - - - shortApprovalType - - - approverName - - - releaseDefinitionName - - - - - - - - - Approved - - Team.Approval - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - releaseName - - - releaseEnvironmentName - - - isAutomated - - - shortApprovalType - - - approverName - - - releaseDefinitionName - - - comments - - - - - - - - - Rejected - - Team.Approval - - - - - - - - - - - - - - - - - - - - - - - - - - - releaseName - - - releaseEnvironmentName - - - shortApprovalType - - - approverName - - - releaseDefinitionName - - - comments - - - - - - - - \ No newline at end of file diff --git a/Source/formats/Team.AccessControlEntry.ListView.ps1xml b/Source/formats/Team.AccessControlEntry.ListView.ps1xml new file mode 100644 index 000000000..2d045ec2e --- /dev/null +++ b/Source/formats/Team.AccessControlEntry.ListView.ps1xml @@ -0,0 +1,31 @@ + + + + + Team.AccessControlEntry.ListView + + Team.AccessControlEntry + + + + + + + Descriptor + + + Allow + + + Deny + + + ExtendedInfo + + + + + + + + \ No newline at end of file diff --git a/Source/formats/accessControlEntry.format.ps1xml b/Source/formats/Team.AccessControlEntry.TableView.ps1xml similarity index 57% rename from Source/formats/accessControlEntry.format.ps1xml rename to Source/formats/Team.AccessControlEntry.TableView.ps1xml index 87e9810e8..2024786f7 100644 --- a/Source/formats/accessControlEntry.format.ps1xml +++ b/Source/formats/Team.AccessControlEntry.TableView.ps1xml @@ -1,7 +1,6 @@ - Team.AccessControlEntry.TableView @@ -36,32 +35,5 @@ - - - Team.AccessControlEntry.ListView - - Team.AccessControlEntry - - - - - - - Descriptor - - - Allow - - - Deny - - - ExtendedInfo - - - - - - \ No newline at end of file diff --git a/Source/formats/Team.AccessControlList.ListView.ps1xml b/Source/formats/Team.AccessControlList.ListView.ps1xml new file mode 100644 index 000000000..b0752be3e --- /dev/null +++ b/Source/formats/Team.AccessControlList.ListView.ps1xml @@ -0,0 +1,28 @@ + + + + + Team.AccessControlList.ListView + + Team.AccessControlList + + + + + + + Token + + + InheritPermissions + + + Aces + + + + + + + + \ No newline at end of file diff --git a/Source/formats/accessControlList.format.ps1xml b/Source/formats/Team.AccessControlList.TableView.ps1xml similarity index 62% rename from Source/formats/accessControlList.format.ps1xml rename to Source/formats/Team.AccessControlList.TableView.ps1xml index ee6b4c1f6..7a4fdafce 100644 --- a/Source/formats/accessControlList.format.ps1xml +++ b/Source/formats/Team.AccessControlList.TableView.ps1xml @@ -1,7 +1,6 @@ - Team.AccessControlList.TableView @@ -36,30 +35,6 @@ - - - - Team.AccessControlList.ListView - - Team.AccessControlList - - - - - - - Token - - - InheritPermissions - - - Aces - - - - - - + \ No newline at end of file diff --git a/Source/formats/Team.Agent.TableView.ps1xml b/Source/formats/Team.Agent.TableView.ps1xml new file mode 100644 index 000000000..0e8f6dafe --- /dev/null +++ b/Source/formats/Team.Agent.TableView.ps1xml @@ -0,0 +1 @@ +Team.Agent.TableViewTeam.Agentnameenabledversionosid diff --git a/Source/formats/Team.Approval.Approved.TableView.ps1xml b/Source/formats/Team.Approval.Approved.TableView.ps1xml new file mode 100644 index 000000000..22f863bcf --- /dev/null +++ b/Source/formats/Team.Approval.Approved.TableView.ps1xml @@ -0,0 +1,63 @@ + + + + + Team.Approval.Approved.TableView + + Team.Approval + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + releaseName + + + releaseEnvironmentName + + + isAutomated + + + shortApprovalType + + + approverName + + + releaseDefinitionName + + + comments + + + + + + + + \ No newline at end of file diff --git a/Source/formats/Team.Approval.Pending.TableView.ps1xml b/Source/formats/Team.Approval.Pending.TableView.ps1xml new file mode 100644 index 000000000..048db0906 --- /dev/null +++ b/Source/formats/Team.Approval.Pending.TableView.ps1xml @@ -0,0 +1,63 @@ + + + + + Team.Approval.Pending.TableView + + Team.Approval + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + id + + + status + + + releaseName + + + releaseEnvironmentName + + + shortApprovalType + + + approverName + + + releaseDefinitionName + + + + + + + + \ No newline at end of file diff --git a/Source/formats/profile.format.ps1xml b/Source/formats/Team.Approval.Rejected.TableView.ps1xml similarity index 50% rename from Source/formats/profile.format.ps1xml rename to Source/formats/Team.Approval.Rejected.TableView.ps1xml index 40a95c403..00f2e03dd 100644 --- a/Source/formats/profile.format.ps1xml +++ b/Source/formats/Team.Approval.Rejected.TableView.ps1xml @@ -1,41 +1,52 @@ - - Default + Team.Approval.Rejected.TableView - Team.Profile + Team.Approval - + - + - + - + + + + + + + - Name + releaseName + + + releaseEnvironmentName + + + shortApprovalType - URL + approverName - Version + releaseDefinitionName - Type + comments diff --git a/Source/formats/Team.Build.Artifact.ListView.ps1xml b/Source/formats/Team.Build.Artifact.ListView.ps1xml new file mode 100644 index 000000000..396cca3c1 --- /dev/null +++ b/Source/formats/Team.Build.Artifact.ListView.ps1xml @@ -0,0 +1 @@ +Team.Build.Artifact.ListViewTeam.Build.ArtifactidnametypedatadownloadUrl diff --git a/Source/formats/Team.Build.Artifact.Resource.ListView.ps1xml b/Source/formats/Team.Build.Artifact.Resource.ListView.ps1xml new file mode 100644 index 000000000..0bbc58c95 --- /dev/null +++ b/Source/formats/Team.Build.Artifact.Resource.ListView.ps1xml @@ -0,0 +1 @@ +Team.Build.Artifact.Resource.ListViewTeam.Build.Artifact.ResourcetypedataurldownloadUrlproperties diff --git a/Source/formats/Team.Build.Artifact.Resource.TableView.ps1xml b/Source/formats/Team.Build.Artifact.Resource.TableView.ps1xml new file mode 100644 index 000000000..59fc1ae65 --- /dev/null +++ b/Source/formats/Team.Build.Artifact.Resource.TableView.ps1xml @@ -0,0 +1 @@ +Team.Build.Artifact.Resource.TableViewTeam.Build.Artifact.ResourcetypedataurldownloadUrlproperties diff --git a/Source/formats/Team.Build.Artifact.Resource.WideView.ps1xml b/Source/formats/Team.Build.Artifact.Resource.WideView.ps1xml new file mode 100644 index 000000000..5eb088c56 --- /dev/null +++ b/Source/formats/Team.Build.Artifact.Resource.WideView.ps1xml @@ -0,0 +1 @@ +Team.Build.Artifact.Resource.WideViewTeam.Build.Artifact.Resourceproperties diff --git a/Source/formats/Team.Build.Artifact.TableView.ps1xml b/Source/formats/Team.Build.Artifact.TableView.ps1xml new file mode 100644 index 000000000..0dce8341b --- /dev/null +++ b/Source/formats/Team.Build.Artifact.TableView.ps1xml @@ -0,0 +1 @@ +Team.Build.Artifact.TableViewTeam.Build.ArtifactnametypedownloadUrl diff --git a/Source/formats/Team.Build.Artifact.WideView.ps1xml b/Source/formats/Team.Build.Artifact.WideView.ps1xml new file mode 100644 index 000000000..4a0f88fc7 --- /dev/null +++ b/Source/formats/Team.Build.Artifact.WideView.ps1xml @@ -0,0 +1 @@ +Team.Build.Artifact.WideViewTeam.Build.ArtifactdownloadUrl diff --git a/Source/formats/Team.Build.ListView.ps1xml b/Source/formats/Team.Build.ListView.ps1xml new file mode 100644 index 000000000..59822699b --- /dev/null +++ b/Source/formats/Team.Build.ListView.ps1xml @@ -0,0 +1 @@ +Team.Build.ListViewTeam.Provider.BuildVSTeamBuildIDNameStatusResultStartTimeRequestedByBuildDefinitionProjectName diff --git a/Source/formats/Team.Build.TableView.ps1xml b/Source/formats/Team.Build.TableView.ps1xml new file mode 100644 index 000000000..628c730ad --- /dev/null +++ b/Source/formats/Team.Build.TableView.ps1xml @@ -0,0 +1 @@ +Team.Build.TableViewTeam.Provider.BuildVSTeamBuildDisplayModenamestatusresultBuildDefinition diff --git a/Source/formats/Team.Build.WideView.ps1xml b/Source/formats/Team.Build.WideView.ps1xml new file mode 100644 index 000000000..a9b7b9fbe --- /dev/null +++ b/Source/formats/Team.Build.WideView.ps1xml @@ -0,0 +1 @@ +Team.Build.WideViewTeam.Buildbuildnumber diff --git a/Source/formats/Team.BuildDefinition.ListView.ps1xml b/Source/formats/Team.BuildDefinition.ListView.ps1xml new file mode 100644 index 000000000..0fc72e81e --- /dev/null +++ b/Source/formats/Team.BuildDefinition.ListView.ps1xml @@ -0,0 +1 @@ +Team.BuildDefinition.ListViewTeam.BuildDefinitionIDNameAuthoredBy diff --git a/Source/formats/Team.BuildDefinition.TableView.ps1xml b/Source/formats/Team.BuildDefinition.TableView.ps1xml new file mode 100644 index 000000000..627754fda --- /dev/null +++ b/Source/formats/Team.BuildDefinition.TableView.ps1xml @@ -0,0 +1 @@ +Team.BuildDefinition.TableViewTeam.BuildDefinitionNameID diff --git a/Source/formats/Team.BuildDefinitionPhasedProcess.TableView.ps1xml b/Source/formats/Team.BuildDefinitionPhasedProcess.TableView.ps1xml new file mode 100644 index 000000000..f9ad1eb68 --- /dev/null +++ b/Source/formats/Team.BuildDefinitionPhasedProcess.TableView.ps1xml @@ -0,0 +1 @@ +Team.BuildDefinitionPhasedProcess.TableViewTeam.BuildDefinitionPhasedProcessNamePhases diff --git a/Source/formats/Team.BuildDefinitionProcess.ListView.ps1xml b/Source/formats/Team.BuildDefinitionProcess.ListView.ps1xml new file mode 100644 index 000000000..de4a9e011 --- /dev/null +++ b/Source/formats/Team.BuildDefinitionProcess.ListView.ps1xml @@ -0,0 +1 @@ +Team.BuildDefinitionProcess.ListViewTeam.BuildDefinitionProcessNamePhases diff --git a/Source/formats/Team.BuildDefinitionProcessPhase.ListView.ps1xml b/Source/formats/Team.BuildDefinitionProcessPhase.ListView.ps1xml new file mode 100644 index 000000000..6b47be326 --- /dev/null +++ b/Source/formats/Team.BuildDefinitionProcessPhase.ListView.ps1xml @@ -0,0 +1 @@ +Team.BuildDefinitionProcessPhase.ListViewTeam.BuildDefinitionProcessPhaseNameSteps diff --git a/Source/formats/Team.BuildDefinitionProcessPhase.TableView.ps1xml b/Source/formats/Team.BuildDefinitionProcessPhase.TableView.ps1xml new file mode 100644 index 000000000..49e1906df --- /dev/null +++ b/Source/formats/Team.BuildDefinitionProcessPhase.TableView.ps1xml @@ -0,0 +1 @@ +Team.BuildDefinitionProcessPhase.TableViewTeam.BuildDefinitionProcessPhaseNameStepCount diff --git a/Source/formats/Team.BuildDefinitionProcessPhaseStep.ListView.ps1xml b/Source/formats/Team.BuildDefinitionProcessPhaseStep.ListView.ps1xml new file mode 100644 index 000000000..adf942c4c --- /dev/null +++ b/Source/formats/Team.BuildDefinitionProcessPhaseStep.ListView.ps1xml @@ -0,0 +1 @@ +Team.BuildDefinitionProcessPhaseStep.ListViewTeam.BuildDefinitionProcessPhaseStepIDNameEnabled diff --git a/Source/formats/Team.BuildDefinitionProcessPhaseStep.TableView.ps1xml b/Source/formats/Team.BuildDefinitionProcessPhaseStep.TableView.ps1xml new file mode 100644 index 000000000..c73583e75 --- /dev/null +++ b/Source/formats/Team.BuildDefinitionProcessPhaseStep.TableView.ps1xml @@ -0,0 +1 @@ +Team.BuildDefinitionProcessPhaseStep.TableViewTeam.BuildDefinitionProcessPhaseStepIDNameEnabled diff --git a/Source/formats/Team.BuildDefinitionYamlProcess.TableView.ps1xml b/Source/formats/Team.BuildDefinitionYamlProcess.TableView.ps1xml new file mode 100644 index 000000000..ca5773be9 --- /dev/null +++ b/Source/formats/Team.BuildDefinitionYamlProcess.TableView.ps1xml @@ -0,0 +1 @@ +Team.BuildDefinitionYamlProcess.TableViewTeam.BuildDefinitionYamlProcessyamlFilename diff --git a/Source/formats/Team.ClassificationNode.ListView.ps1xml b/Source/formats/Team.ClassificationNode.ListView.ps1xml new file mode 100644 index 000000000..c5506079c --- /dev/null +++ b/Source/formats/Team.ClassificationNode.ListView.ps1xml @@ -0,0 +1 @@ +Team.ClassificationNode.ListViewTeam.ClassificationNodeIDIdentifierNamePathStructureTypeProjectNameUrlHasChildrenChildren diff --git a/Source/formats/Team.ClassificationNode.TableView.ps1xml b/Source/formats/Team.ClassificationNode.TableView.ps1xml new file mode 100644 index 000000000..615af6470 --- /dev/null +++ b/Source/formats/Team.ClassificationNode.TableView.ps1xml @@ -0,0 +1 @@ +Team.ClassificationNode.TableViewTeam.ClassificationNodeIDIdentifierNamePathStructureTypeHasChildren diff --git a/Source/formats/Team.Descriptor.ListView.ps1xml b/Source/formats/Team.Descriptor.ListView.ps1xml new file mode 100644 index 000000000..05a984e84 --- /dev/null +++ b/Source/formats/Team.Descriptor.ListView.ps1xml @@ -0,0 +1 @@ +Team.Descriptor.ListViewTeam.DescriptorDescriptorLinks diff --git a/Source/formats/Team.Descriptor.TableView.ps1xml b/Source/formats/Team.Descriptor.TableView.ps1xml new file mode 100644 index 000000000..066a10746 --- /dev/null +++ b/Source/formats/Team.Descriptor.TableView.ps1xml @@ -0,0 +1 @@ +Team.Descriptor.TableViewTeam.DescriptorDescriptorLinks diff --git a/Source/formats/Team.Environment.Status.TableView.ps1xml b/Source/formats/Team.Environment.Status.TableView.ps1xml new file mode 100644 index 000000000..581a523ba --- /dev/null +++ b/Source/formats/Team.Environment.Status.TableView.ps1xml @@ -0,0 +1 @@ +Team.Environment.Status.TableViewVSTeamEnvironmentVSTeamAttemptVSTeamTaskDisplayModeNamestatus diff --git a/Source/formats/Team.Extension.TableView.ps1xml b/Source/formats/Team.Extension.TableView.ps1xml new file mode 100644 index 000000000..45f402898 --- /dev/null +++ b/Source/formats/Team.Extension.TableView.ps1xml @@ -0,0 +1 @@ +Team.Extension.TableViewTeam.ExtensionNameIDpublisherId diff --git a/Source/formats/Team.Feed.TableView.ps1xml b/Source/formats/Team.Feed.TableView.ps1xml new file mode 100644 index 000000000..f49ec5e03 --- /dev/null +++ b/Source/formats/Team.Feed.TableView.ps1xml @@ -0,0 +1 @@ +Team.Feed.TableViewTeam.FeedNameDescriptionID diff --git a/Source/formats/Team.GitRef.TableView.ps1xml b/Source/formats/Team.GitRef.TableView.ps1xml new file mode 100644 index 000000000..d80d59310 --- /dev/null +++ b/Source/formats/Team.GitRef.TableView.ps1xml @@ -0,0 +1 @@ +Team.GitRef.TableViewTeam.GitRefRefNameCreator diff --git a/Source/formats/Team.Group.ListView.ps1xml b/Source/formats/Team.Group.ListView.ps1xml new file mode 100644 index 000000000..0e77b30ce --- /dev/null +++ b/Source/formats/Team.Group.ListView.ps1xml @@ -0,0 +1 @@ +Team.Group.ListViewTeam.GroupIDPrincipalNameDisplayNameProjectNameOriginOriginIDURLDescriptorLinks diff --git a/Source/formats/Team.Group.TableView.ps1xml b/Source/formats/Team.Group.TableView.ps1xml new file mode 100644 index 000000000..5da2c1f49 --- /dev/null +++ b/Source/formats/Team.Group.TableView.ps1xml @@ -0,0 +1 @@ +Team.Group.TableViewTeam.GroupPrincipalNameDisplayNameProjectNameOrigin diff --git a/Source/formats/Team.Option.TableView.ps1xml b/Source/formats/Team.Option.TableView.ps1xml new file mode 100644 index 000000000..0bfa01661 --- /dev/null +++ b/Source/formats/Team.Option.TableView.ps1xml @@ -0,0 +1 @@ +Team.Option.TableViewTeam.OptionresourceNameareamaxVersionrouteTemplate diff --git a/Source/formats/Team.Option.Versions.TableView.ps1xml b/Source/formats/Team.Option.Versions.TableView.ps1xml new file mode 100644 index 000000000..2422856f3 --- /dev/null +++ b/Source/formats/Team.Option.Versions.TableView.ps1xml @@ -0,0 +1 @@ +Team.Option.Versions.TableViewTeam.OptionresourceNameareaminVersionmaxVersionreleasedVersionresourceVersion diff --git a/Source/formats/Team.PSDrive.Default.ListView.ps1xml b/Source/formats/Team.PSDrive.Default.ListView.ps1xml new file mode 100644 index 000000000..50feec87a --- /dev/null +++ b/Source/formats/Team.PSDrive.Default.ListView.ps1xml @@ -0,0 +1 @@ +Team.PSDrive.Default.ListViewMicrosoft.PowerShell.SHiPS.SHiPSDirectoryTeam.AccountTeam.PoolTeam.QueuesTeam.PoolsTeam.BuildsTeam.BuildDefinitionsTeam.ReleasesTeam.RepositoriesTeam.TeamsNameprojectName diff --git a/Source/formats/Team.PSDrive.Default.TableView.ps1xml b/Source/formats/Team.PSDrive.Default.TableView.ps1xml new file mode 100644 index 000000000..487aa7255 --- /dev/null +++ b/Source/formats/Team.PSDrive.Default.TableView.ps1xml @@ -0,0 +1 @@ +Team.PSDrive.Default.TableViewMicrosoft.PowerShell.SHiPS.SHiPSDirectoryTeam.AccountTeam.PoolTeam.QueuesTeam.PoolsTeam.Provider.PoolsTeam.BuildsTeam.BuildDefinitionsTeam.ReleasesTeam.RepositoriesTeam.TeamsDisplayModeName diff --git a/Source/formats/Team.PSDrive.Leaf.Default.TableView.ps1xml b/Source/formats/Team.PSDrive.Leaf.Default.TableView.ps1xml new file mode 100644 index 000000000..2fc882b6a --- /dev/null +++ b/Source/formats/Team.PSDrive.Leaf.Default.TableView.ps1xml @@ -0,0 +1 @@ +Team.PSDrive.Leaf.Default.TableViewMicrosoft.PowerShell.SHiPS.SHiPSLeafDisplayModeName diff --git a/Source/formats/Team.PolicyType.TableView.ps1xml b/Source/formats/Team.PolicyType.TableView.ps1xml new file mode 100644 index 000000000..109e73809 --- /dev/null +++ b/Source/formats/Team.PolicyType.TableView.ps1xml @@ -0,0 +1 @@ +Team.PolicyType.TableViewTeam.PolicyTypedisplayNamedescriptionid diff --git a/Source/formats/Team.Pool.TableView.ps1xml b/Source/formats/Team.Pool.TableView.ps1xml new file mode 100644 index 000000000..ffd503cbc --- /dev/null +++ b/Source/formats/Team.Pool.TableView.ps1xml @@ -0,0 +1 @@ +Team.Pool.TableViewTeam.PoolNameCountID diff --git a/Source/formats/Team.Process.ListView.ps1xml b/Source/formats/Team.Process.ListView.ps1xml new file mode 100644 index 000000000..2ce043a8d --- /dev/null +++ b/Source/formats/Team.Process.ListView.ps1xml @@ -0,0 +1 @@ +Team.Process.ListViewTeam.ProcessTeam.Provider.ProcessVSTeamProcessNameIDDescription diff --git a/Source/formats/Team.Process.TableView.ps1xml b/Source/formats/Team.Process.TableView.ps1xml new file mode 100644 index 000000000..ee4e064fd --- /dev/null +++ b/Source/formats/Team.Process.TableView.ps1xml @@ -0,0 +1 @@ +Team.Process.TableViewTeam.ProcessNameDescription diff --git a/Source/formats/Team.Profile.TableView.ps1xml b/Source/formats/Team.Profile.TableView.ps1xml new file mode 100644 index 000000000..121b29b29 --- /dev/null +++ b/Source/formats/Team.Profile.TableView.ps1xml @@ -0,0 +1 @@ +Team.Profile.TableViewTeam.ProfileNameURLVersionType diff --git a/Source/formats/Team.Project.ListView.ps1xml b/Source/formats/Team.Project.ListView.ps1xml new file mode 100644 index 000000000..fbb7f0ff1 --- /dev/null +++ b/Source/formats/Team.Project.ListView.ps1xml @@ -0,0 +1 @@ +Team.Project.ListViewTeam.ProjectTeam.Provider.ProjectVSTeamProjectNameIDDescription diff --git a/Source/formats/Team.Project.TableView.ps1xml b/Source/formats/Team.Project.TableView.ps1xml new file mode 100644 index 000000000..cf5070a8c --- /dev/null +++ b/Source/formats/Team.Project.TableView.ps1xml @@ -0,0 +1 @@ +Team.Project.TableViewTeam.ProjectNameDescription diff --git a/Source/formats/Team.Provider.Agent.TableView.ps1xml b/Source/formats/Team.Provider.Agent.TableView.ps1xml new file mode 100644 index 000000000..3e0a0a43e --- /dev/null +++ b/Source/formats/Team.Provider.Agent.TableView.ps1xml @@ -0,0 +1 @@ +Team.Provider.Agent.TableViewTeam.Provider.AgentDisplayModenameenabledversionos diff --git a/Source/formats/Team.Provider.BuildDefinition.TableView.ps1xml b/Source/formats/Team.Provider.BuildDefinition.TableView.ps1xml new file mode 100644 index 000000000..99588ac72 --- /dev/null +++ b/Source/formats/Team.Provider.BuildDefinition.TableView.ps1xml @@ -0,0 +1 @@ +Team.Provider.BuildDefinition.TableViewTeam.Provider.BuildDefinitionDisplayModeNameID diff --git a/Source/formats/Team.Provider.BuildDefinitionProcessPhase.TableView.ps1xml b/Source/formats/Team.Provider.BuildDefinitionProcessPhase.TableView.ps1xml new file mode 100644 index 000000000..fec63f639 --- /dev/null +++ b/Source/formats/Team.Provider.BuildDefinitionProcessPhase.TableView.ps1xml @@ -0,0 +1 @@ +Team.Provider.BuildDefinitionProcessPhase.TableViewTeam.Provider.BuildDefinitionProcessPhaseDisplayModeNameStepCount diff --git a/Source/formats/Team.Provider.BuildDefinitionProcessPhaseStep.TableView.ps1xml b/Source/formats/Team.Provider.BuildDefinitionProcessPhaseStep.TableView.ps1xml new file mode 100644 index 000000000..ff2eabfe3 --- /dev/null +++ b/Source/formats/Team.Provider.BuildDefinitionProcessPhaseStep.TableView.ps1xml @@ -0,0 +1 @@ +Team.Provider.BuildDefinitionProcessPhaseStep.TableViewTeam.Provider.BuildDefinitionProcessPhaseStepDisplayModeNameEnabled diff --git a/Source/formats/Team.Provider.BuildDefinitionYamlProcess.TableView.ps1xml b/Source/formats/Team.Provider.BuildDefinitionYamlProcess.TableView.ps1xml new file mode 100644 index 000000000..9d458e68b --- /dev/null +++ b/Source/formats/Team.Provider.BuildDefinitionYamlProcess.TableView.ps1xml @@ -0,0 +1 @@ +Team.Provider.BuildDefinitionYamlProcess.TableViewTeam.Provider.BuildDefinitionYamlProcessDisplayModeyamlFilename diff --git a/Source/formats/Team.Provider.Extension.TableView.ps1xml b/Source/formats/Team.Provider.Extension.TableView.ps1xml new file mode 100644 index 000000000..36dd8bba1 --- /dev/null +++ b/Source/formats/Team.Provider.Extension.TableView.ps1xml @@ -0,0 +1 @@ +Team.Provider.Extension.TableViewTeam.Provider.ExtensionDisplayModeNameIDpublisherId diff --git a/Source/formats/Team.Provider.Feed.TableView.ps1xml b/Source/formats/Team.Provider.Feed.TableView.ps1xml new file mode 100644 index 000000000..353fddace --- /dev/null +++ b/Source/formats/Team.Provider.Feed.TableView.ps1xml @@ -0,0 +1 @@ +Team.Provider.Feed.TableViewTeam.Provider.FeedDisplayModeNameDescription diff --git a/Source/formats/Team.Provider.GitRef.TableView.ps1xml b/Source/formats/Team.Provider.GitRef.TableView.ps1xml new file mode 100644 index 000000000..16d2b2809 --- /dev/null +++ b/Source/formats/Team.Provider.GitRef.TableView.ps1xml @@ -0,0 +1 @@ +Team.Provider.GitRef.TableViewTeam.Provider.GitRefDisplayModeRefNameCreator diff --git a/Source/formats/Team.Provider.Pool.TableView.ps1xml b/Source/formats/Team.Provider.Pool.TableView.ps1xml new file mode 100644 index 000000000..71dcae181 --- /dev/null +++ b/Source/formats/Team.Provider.Pool.TableView.ps1xml @@ -0,0 +1 @@ +Team.Provider.Pool.TableViewTeam.Provider.PoolDisplayModeNameCount diff --git a/Source/formats/Team.Provider.Project.TableView.ps1xml b/Source/formats/Team.Provider.Project.TableView.ps1xml new file mode 100644 index 000000000..0b17a78e5 --- /dev/null +++ b/Source/formats/Team.Provider.Project.TableView.ps1xml @@ -0,0 +1 @@ +Team.Provider.Project.TableViewTeam.Provider.ProjectDisplayModeNameDescription diff --git a/Source/formats/Team.Provider.Queue.TableView.ps1xml b/Source/formats/Team.Provider.Queue.TableView.ps1xml new file mode 100644 index 000000000..48d24baa6 --- /dev/null +++ b/Source/formats/Team.Provider.Queue.TableView.ps1xml @@ -0,0 +1 @@ +Team.Provider.Queue.TableViewTeam.Provider.QueueDisplayModeName diff --git a/Source/formats/Team.Provider.Release.TableView.ps1xml b/Source/formats/Team.Provider.Release.TableView.ps1xml new file mode 100644 index 000000000..4dc2b3cc8 --- /dev/null +++ b/Source/formats/Team.Provider.Release.TableView.ps1xml @@ -0,0 +1 @@ +Team.Provider.Release.TableViewTeam.Provider.ReleaseDisplayModeNamestatusdefinitionname diff --git a/Source/formats/Team.Provider.Repository.TableView.ps1xml b/Source/formats/Team.Provider.Repository.TableView.ps1xml new file mode 100644 index 000000000..88bbe5ae9 --- /dev/null +++ b/Source/formats/Team.Provider.Repository.TableView.ps1xml @@ -0,0 +1 @@ +Team.Provider.Repository.TableViewTeam.Provider.RepositoryVSTeamGitRepositoryDisplayModeNameremoteUrldefaultBranchprojectName diff --git a/Source/formats/Team.Provider.Team.TableView.ps1xml b/Source/formats/Team.Provider.Team.TableView.ps1xml new file mode 100644 index 000000000..e5d4eccf7 --- /dev/null +++ b/Source/formats/Team.Provider.Team.TableView.ps1xml @@ -0,0 +1 @@ +Team.Provider.Team.TableViewTeam.Provider.TeamDisplayModeNameDescription diff --git a/Source/formats/Team.Release.TableView.ps1xml b/Source/formats/Team.Release.TableView.ps1xml new file mode 100644 index 000000000..3db2efeb3 --- /dev/null +++ b/Source/formats/Team.Release.TableView.ps1xml @@ -0,0 +1 @@ +Team.Release.TableViewVSTeamReleaseDisplayModeNamestatus diff --git a/Source/formats/Team.Repository.ListView.ps1xml b/Source/formats/Team.Repository.ListView.ps1xml new file mode 100644 index 000000000..0189aaed2 --- /dev/null +++ b/Source/formats/Team.Repository.ListView.ps1xml @@ -0,0 +1 @@ +Team.Repository.ListViewTeam.RepositoryTeam.Provider.RepositoryVSTeamGitRepositoryNameremoteUrldefaultBranchprojectName diff --git a/Source/formats/Team.Repository.TableView.ps1xml b/Source/formats/Team.Repository.TableView.ps1xml new file mode 100644 index 000000000..4f1857a19 --- /dev/null +++ b/Source/formats/Team.Repository.TableView.ps1xml @@ -0,0 +1 @@ +Team.Repository.TableViewTeam.RepositoryVSTeamGitRepositoryNameremoteUrldefaultBranchprojectName diff --git a/Source/formats/Team.SecurityNamespace.ListView.ps1xml b/Source/formats/Team.SecurityNamespace.ListView.ps1xml new file mode 100644 index 000000000..5d04688c9 --- /dev/null +++ b/Source/formats/Team.SecurityNamespace.ListView.ps1xml @@ -0,0 +1 @@ +Team.SecurityNamespace.ListViewTeam.SecurityNamespaceIDNameDisplayNameElementLengthWritePermissionReadPermissionDataspaceCategoryStructureValueExtensionTypeIsRemotableUseTokenTranslatorSystemBitMaskActions diff --git a/Source/formats/Team.SecurityNamespace.TableView.ps1xml b/Source/formats/Team.SecurityNamespace.TableView.ps1xml new file mode 100644 index 000000000..a889ab159 --- /dev/null +++ b/Source/formats/Team.SecurityNamespace.TableView.ps1xml @@ -0,0 +1 @@ +Team.SecurityNamespace.TableViewTeam.SecurityNamespaceIDNameIsRemotable diff --git a/Source/formats/Team.ServiceEndpoint.ListView.ps1xml b/Source/formats/Team.ServiceEndpoint.ListView.ps1xml new file mode 100644 index 000000000..69edc6668 --- /dev/null +++ b/Source/formats/Team.ServiceEndpoint.ListView.ps1xml @@ -0,0 +1 @@ +Team.ServiceEndpoint.ListViewTeam.ServiceEndpointnametypecreatedByUserid diff --git a/Source/formats/Team.ServiceEndpoint.TableView.ps1xml b/Source/formats/Team.ServiceEndpoint.TableView.ps1xml new file mode 100644 index 000000000..2ea9ed12d --- /dev/null +++ b/Source/formats/Team.ServiceEndpoint.TableView.ps1xml @@ -0,0 +1 @@ +Team.ServiceEndpoint.TableViewTeam.ServiceEndpointnametypeidcreatedByUser diff --git a/Source/formats/Team.ServiceEndpointType.ListView.ps1xml b/Source/formats/Team.ServiceEndpointType.ListView.ps1xml new file mode 100644 index 000000000..677cc96c8 --- /dev/null +++ b/Source/formats/Team.ServiceEndpointType.ListView.ps1xml @@ -0,0 +1 @@ +Team.ServiceEndpointType.ListViewTeam.ServiceEndpointTypenamedisplayNamedescriptionhelpMarkDown diff --git a/Source/formats/Team.ServiceEndpointType.TableView.ps1xml b/Source/formats/Team.ServiceEndpointType.TableView.ps1xml new file mode 100644 index 000000000..2687fd6f3 --- /dev/null +++ b/Source/formats/Team.ServiceEndpointType.TableView.ps1xml @@ -0,0 +1 @@ +Team.ServiceEndpointType.TableViewTeam.ServiceEndpointTypedisplayNamedescription diff --git a/Source/formats/Team.Team.ListView.ps1xml b/Source/formats/Team.Team.ListView.ps1xml new file mode 100644 index 000000000..6421f744a --- /dev/null +++ b/Source/formats/Team.Team.ListView.ps1xml @@ -0,0 +1 @@ +Team.Team.ListViewTeam.TeamTeam.Provider.TeamNameDescriptionIDProjectName diff --git a/Source/formats/Team.Team.TableView.ps1xml b/Source/formats/Team.Team.TableView.ps1xml new file mode 100644 index 000000000..7ca6de4db --- /dev/null +++ b/Source/formats/Team.Team.TableView.ps1xml @@ -0,0 +1 @@ +Team.Team.TableViewTeam.TeamNameDescription diff --git a/Source/formats/Team.User2.ListView.ps1xml b/Source/formats/Team.User2.ListView.ps1xml new file mode 100644 index 000000000..e4380d056 --- /dev/null +++ b/Source/formats/Team.User2.ListView.ps1xml @@ -0,0 +1 @@ +Team.User2.ListViewTeam.User2IDPrincipalNameMailAddressDisplayNameOriginOriginIDURLDescriptorLinks diff --git a/Source/formats/Team.User2.TableView.ps1xml b/Source/formats/Team.User2.TableView.ps1xml new file mode 100644 index 000000000..7dfd0f53a --- /dev/null +++ b/Source/formats/Team.User2.TableView.ps1xml @@ -0,0 +1 @@ +Team.User2.TableViewTeam.User2PrincipalNameDisplayNameOrigin diff --git a/Source/formats/Team.UserEntitlement.ListView.ps1xml b/Source/formats/Team.UserEntitlement.ListView.ps1xml new file mode 100644 index 000000000..ed385f554 --- /dev/null +++ b/Source/formats/Team.UserEntitlement.ListView.ps1xml @@ -0,0 +1 @@ +Team.UserEntitlement.ListViewTeam.UserEntitlementiduserNameemailaccessLevelNameprojects diff --git a/Source/formats/Team.UserEntitlement.TableView.ps1xml b/Source/formats/Team.UserEntitlement.TableView.ps1xml new file mode 100644 index 000000000..b71b35836 --- /dev/null +++ b/Source/formats/Team.UserEntitlement.TableView.ps1xml @@ -0,0 +1 @@ +Team.UserEntitlement.TableViewTeam.UserEntitlementuserNameemailaccessLevelNamelastAccessedDate diff --git a/Source/formats/Team.UserEntitlement.WideView.ps1xml b/Source/formats/Team.UserEntitlement.WideView.ps1xml new file mode 100644 index 000000000..5ec5fc04d --- /dev/null +++ b/Source/formats/Team.UserEntitlement.WideView.ps1xml @@ -0,0 +1 @@ +Team.UserEntitlement.WideViewTeam.UserEntitlementuserName diff --git a/Source/formats/Team.VariableGroup.ListView.ps1xml b/Source/formats/Team.VariableGroup.ListView.ps1xml new file mode 100644 index 000000000..748bf26e7 --- /dev/null +++ b/Source/formats/Team.VariableGroup.ListView.ps1xml @@ -0,0 +1 @@ +Team.VariableGroup.ListViewTeam.VariableGroupidnamecreatedByUsermodifiedByUser diff --git a/Source/formats/Team.VariableGroup.TableView.ps1xml b/Source/formats/Team.VariableGroup.TableView.ps1xml new file mode 100644 index 000000000..4b1576d5c --- /dev/null +++ b/Source/formats/Team.VariableGroup.TableView.ps1xml @@ -0,0 +1 @@ +Team.VariableGroup.TableViewTeam.VariableGroupidnamecreatedByUsermodifiedByUser diff --git a/Source/formats/Team.WorkItem.ListView.ps1xml b/Source/formats/Team.WorkItem.ListView.ps1xml new file mode 100644 index 000000000..ca9db652d --- /dev/null +++ b/Source/formats/Team.WorkItem.ListView.ps1xml @@ -0,0 +1,28 @@ + + + + + Team.WorkItem.ListView + + Team.WorkItem + + + + + + + id + + + title + + + state + + + + + + + + \ No newline at end of file diff --git a/Source/formats/workitems.format.ps1xml b/Source/formats/Team.WorkItem.TableView.ps1xml similarity index 61% rename from Source/formats/workitems.format.ps1xml rename to Source/formats/Team.WorkItem.TableView.ps1xml index 582233bd2..2c1f2b120 100644 --- a/Source/formats/workitems.format.ps1xml +++ b/Source/formats/Team.WorkItem.TableView.ps1xml @@ -1,7 +1,6 @@ - Team.WorkItem.TableView @@ -36,29 +35,5 @@ - - - Team.WorkItem.ListView - - Team.WorkItem - - - - - - - id - - - title - - - state - - - - - - \ No newline at end of file diff --git a/Source/formats/Team.WorkItemType.ListView.ps1xml b/Source/formats/Team.WorkItemType.ListView.ps1xml new file mode 100644 index 000000000..31e3100e6 --- /dev/null +++ b/Source/formats/Team.WorkItemType.ListView.ps1xml @@ -0,0 +1,25 @@ + + + + + Team.WorkItemType.ListView + + Team.WorkItemType + + + + + + + name + + + description + + + + + + + + \ No newline at end of file diff --git a/Source/formats/policyTypes.format.ps1xml b/Source/formats/Team.WorkItemType.TableView.ps1xml similarity index 65% rename from Source/formats/policyTypes.format.ps1xml rename to Source/formats/Team.WorkItemType.TableView.ps1xml index 745c471d0..9ce94d5da 100644 --- a/Source/formats/policyTypes.format.ps1xml +++ b/Source/formats/Team.WorkItemType.TableView.ps1xml @@ -1,35 +1,28 @@ - - Default + Team.WorkItemType.TableView - Team.PolicyType + Team.WorkItemType - - - - - + + - displayName - - - description + name - id + description diff --git a/Source/formats/_formats.json b/Source/formats/_formats.json new file mode 100644 index 000000000..99e50d771 --- /dev/null +++ b/Source/formats/_formats.json @@ -0,0 +1,92 @@ +{ + "outputFile": "vsteam.format.ps1xml", + "fileType": "formats", + "files": [ + "Team.Approval.Pending.TableView.ps1xml", + "Team.Approval.Approved.TableView.ps1xml", + "Team.Approval.Rejected.TableView.ps1xml", + "Team.AccessControlEntry.TableView.ps1xml", + "Team.AccessControlEntry.ListView.ps1xml", + "Team.AccessControlList.TableView.ps1xml", + "Team.AccessControlList.ListView.ps1xml", + "Team.Build.TableView.ps1xml", + "Team.Build.WideView.ps1xml", + "Team.Build.ListView.ps1xml", + "Team.Build.Artifact.TableView.ps1xml", + "Team.Build.Artifact.WideView.ps1xml", + "Team.Build.Artifact.ListView.ps1xml", + "Team.Build.Artifact.Resource.TableView.ps1xml", + "Team.Build.Artifact.Resource.WideView.ps1xml", + "Team.Build.Artifact.Resource.ListView.ps1xml", + "Team.ClassificationNode.TableView.ps1xml", + "Team.ClassificationNode.ListView.ps1xml", + "Team.Descriptor.TableView.ps1xml", + "Team.Descriptor.ListView.ps1xml", + "Team.Group.TableView.ps1xml", + "Team.Group.ListView.ps1xml", + "Team.PolicyType.TableView.ps1xml", + "Team.Profile.TableView.ps1xml", + "Team.SecurityNamespace.TableView.ps1xml", + "Team.SecurityNamespace.ListView.ps1xml", + "Team.ServiceEndpointType.TableView.ps1xml", + "Team.ServiceEndpointType.ListView.ps1xml", + "Team.ServiceEndpoint.TableView.ps1xml", + "Team.ServiceEndpoint.ListView.ps1xml", + "Team.Option.TableView.ps1xml", + "Team.Option.Versions.TableView.ps1xml", + "Team.User2.TableView.ps1xml", + "Team.User2.ListView.ps1xml", + "Team.UserEntitlement.TableView.ps1xml", + "Team.UserEntitlement.WideView.ps1xml", + "Team.UserEntitlement.ListView.ps1xml", + "Team.VariableGroup.TableView.ps1xml", + "Team.VariableGroup.ListView.ps1xml", + "Team.Provider.Feed.TableView.ps1xml", + "Team.Feed.TableView.ps1xml", + "Team.Provider.GitRef.TableView.ps1xml", + "Team.GitRef.TableView.ps1xml", + "Team.Agent.TableView.ps1xml", + "Team.Provider.Agent.TableView.ps1xml", + "Team.Provider.Team.TableView.ps1xml", + "Team.Team.TableView.ps1xml", + "Team.Team.ListView.ps1xml", + "Team.Provider.Release.TableView.ps1xml", + "Team.Environment.Status.TableView.ps1xml", + "Team.Build.TableView.ps1xml", + "Team.Build.ListView.ps1xml", + "Team.BuildDefinition.TableView.ps1xml", + "Team.Provider.BuildDefinition.TableView.ps1xml", + "Team.BuildDefinition.ListView.ps1xml", + "Team.BuildDefinitionYamlProcess.TableView.ps1xml", + "Team.Provider.BuildDefinitionYamlProcess.TableView.ps1xml", + "Team.BuildDefinitionPhasedProcess.TableView.ps1xml", + "Team.BuildDefinitionProcess.ListView.ps1xml", + "Team.BuildDefinitionProcessPhase.TableView.ps1xml", + "Team.Provider.BuildDefinitionProcessPhase.TableView.ps1xml", + "Team.BuildDefinitionProcessPhase.ListView.ps1xml", + "Team.BuildDefinitionProcessPhaseStep.TableView.ps1xml", + "Team.Provider.BuildDefinitionProcessPhaseStep.TableView.ps1xml", + "Team.BuildDefinitionProcessPhaseStep.ListView.ps1xml", + "Team.Release.TableView.ps1xml", + "Team.Repository.TableView.ps1xml", + "Team.Provider.Repository.TableView.ps1xml", + "Team.Repository.ListView.ps1xml", + "Team.Provider.Project.TableView.ps1xml", + "Team.Project.TableView.ps1xml", + "Team.Project.ListView.ps1xml", + "Team.Process.TableView.ps1xml", + "Team.Process.ListView.ps1xml", + "Team.Pool.TableView.ps1xml", + "Team.Provider.Queue.TableView.ps1xml", + "Team.Provider.Pool.TableView.ps1xml", + "Team.Extension.TableView.ps1xml", + "Team.Provider.Extension.TableView.ps1xml", + "Team.PSDrive.Default.TableView.ps1xml", + "Team.PSDrive.Default.ListView.ps1xml", + "Team.PSDrive.Leaf.Default.TableView.ps1xml", + "Team.WorkItemType.TableView.ps1xml", + "Team.WorkItemType.ListView.ps1xml", + "Team.WorkItem.TableView.ps1xml", + "Team.WorkItem.ListView.ps1xml" + ] +} \ No newline at end of file diff --git a/Source/formats/builds.format.ps1xml b/Source/formats/builds.format.ps1xml deleted file mode 100644 index 4b991f595..000000000 --- a/Source/formats/builds.format.ps1xml +++ /dev/null @@ -1,263 +0,0 @@ - - - - - - Team.Build.TableView - - Team.Build - - - - - - - - - - - - - - - - - - - - - buildnumber - - - status - - - result - - - definitionName - - - - - - - - - Team.Build.WideView - - Team.Build - - - - - - buildnumber - - - - - - - - Team.Build.ListView - - Team.Build - - - - - - - buildnumber - - - queuename - - - definitionName - - - projectname - - - - - - - - - Team.Build.Artifact.TableView - - Team.Build.Artifact - - - - - - - - - - - - - - - - - - name - - - type - - - downloadUrl - - - - - - - - - Team.Build.Artifact.WideView - - Team.Build.Artifact - - - - - - downloadUrl - - - - - - - - Team.Build.Artifact.ListView - - Team.Build.Artifact - - - - - - - id - - - name - - - type - - - data - - - downloadUrl - - - - - - - - - Team.Build.Artifact.Resource.TableView - - Team.Build.Artifact.Resource - - - - - - - - - - - - - - - - - - - - - - - - type - - - data - - - url - - - downloadUrl - - - properties - - - - - - - - - Team.Build.Artifact.Resource.WideView - - Team.Build.Artifact.Resource - - - - - - properties - - - - - - - - Team.Build.Artifact.Resource.ListView - - Team.Build.Artifact.Resource - - - - - - - type - - - data - - - url - - - downloadUrl - - - properties - - - - - - - - \ No newline at end of file diff --git a/Source/formats/classificationNode.format.ps1xml b/Source/formats/classificationNode.format.ps1xml deleted file mode 100644 index ae9acb199..000000000 --- a/Source/formats/classificationNode.format.ps1xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Team.ClassificationNode.TableView - - Team.ClassificationNode - - - - - - - - - - - - - - - - - - - - - - - - - - - ID - - - Identifier - - - Name - - - Path - - - StructureType - - - HasChildren - - - - - - - - - Team.ClassificationNode.ListView - - Team.ClassificationNode - - - - - - - ID - - - Identifier - - - Name - - - Path - - - StructureType - - - ProjectName - - - Url - - - HasChildren - - - Children - - - - - - - - \ No newline at end of file diff --git a/Source/formats/descriptor.format.ps1xml b/Source/formats/descriptor.format.ps1xml deleted file mode 100644 index ddf3c85c7..000000000 --- a/Source/formats/descriptor.format.ps1xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Team.Descriptor.TableView - - Team.Descriptor - - - - - - - - - - - - - - - Descriptor - - - Links - - - - - - - - - Team.Descriptor.ListView - - Team.Descriptor - - - - - - - Descriptor - - - Links - - - - - - - - \ No newline at end of file diff --git a/Source/formats/group.format.ps1xml b/Source/formats/group.format.ps1xml deleted file mode 100644 index 532cacfe1..000000000 --- a/Source/formats/group.format.ps1xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Team.Group.TableView - - Team.Group - - - - - - - - - - - - - - - - - - - - - PrincipalName - - - DisplayName - - - ProjectName - - - Origin - - - - - - - - - Team.Group.ListView - - Team.Group - - - - - - - ID - - - PrincipalName - - - DisplayName - - - ProjectName - - - Origin - - - OriginID - - - URL - - - Descriptor - - - Links - - - - - - - - \ No newline at end of file diff --git a/Source/formats/readme.md b/Source/formats/readme.md new file mode 100644 index 000000000..9eda40a25 --- /dev/null +++ b/Source/formats/readme.md @@ -0,0 +1,5 @@ +# Format + +Make sure the table views are listed before the list views. If not when Get-ChildItem is called the list format will be used instead of the table. You can control the order the files are merged using the _formats.json file. + +There are also needs to be a different format for the types returned from the provider which are PowerShell classes vs the types added to the objects returned by the other functions. diff --git a/Source/formats/securityNamespace.format.ps1xml b/Source/formats/securityNamespace.format.ps1xml deleted file mode 100644 index ed940701f..000000000 --- a/Source/formats/securityNamespace.format.ps1xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Team.SecurityNamespace.TableView - - Team.SecurityNamespace - - - - - - - - - - - - - - - - - - ID - - - Name - - - IsRemotable - - - - - - - - - Team.SecurityNamespace.ListView - - Team.SecurityNamespace - - - - - - - ID - - - Name - - - DisplayName - - - ElementLength - - - WritePermission - - - ReadPermission - - - DataspaceCategory - - - StructureValue - - - ExtensionType - - - IsRemotable - - - UseTokenTranslator - - - SystemBitMask - - - Actions - - - - - - - - \ No newline at end of file diff --git a/Source/formats/serviceendpointTypes.format.ps1xml b/Source/formats/serviceendpointTypes.format.ps1xml deleted file mode 100644 index 13e065a7c..000000000 --- a/Source/formats/serviceendpointTypes.format.ps1xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - Team.ServiceEndpointType.TableView - - Team.ServiceEndpointType - - - - - - - - - - - - - - - displayName - - - description - - - - - - - - - Team.ServiceEndpointType.ListView - - Team.ServiceEndpointType - - - - - - - name - - - displayName - - - description - - - helpMarkDown - - - - - - - - \ No newline at end of file diff --git a/Source/formats/serviceendpoints.format.ps1xml b/Source/formats/serviceendpoints.format.ps1xml deleted file mode 100644 index fbce272c5..000000000 --- a/Source/formats/serviceendpoints.format.ps1xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Team.ServiceEndpoint.TableView - - Team.ServiceEndpoint - - - - - - - - - - - - - - - - - - - - - name - - - type - - - id - - - createdByUser - - - - - - - - - Team.ServiceEndpoint.ListView - - Team.ServiceEndpoint - - - - - - - name - - - type - - - createdByUser - - - id - - - - - - - - \ No newline at end of file diff --git a/Source/formats/team.format.ps1xml b/Source/formats/team.format.ps1xml deleted file mode 100644 index f5a5e109a..000000000 --- a/Source/formats/team.format.ps1xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Default - - Team.Option - - - - - - - - - - - - - - - - - - - - - resourceName - - - area - - - maxVersion - - - routeTemplate - - - - - - - - - Versions - - Team.Option - - - - - - - - - - - - - - - - - - - - - - - - - - - resourceName - - - area - - - minVersion - - - maxVersion - - - releasedVersion - - - resourceVersion - - - - - - - - \ No newline at end of file diff --git a/Source/formats/users.format.ps1xml b/Source/formats/users.format.ps1xml deleted file mode 100644 index 1e802ed98..000000000 --- a/Source/formats/users.format.ps1xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - Team.User2.TableView - - Team.User2 - - - - - - - - - - - - - - - - - - PrincipalName - - - DisplayName - - - Origin - - - - - - - - - Team.User2.ListView - - Team.User2 - - - - - - - ID - - - PrincipalName - - - MailAddress - - - DisplayName - - - Origin - - - OriginID - - - URL - - - Descriptor - - - Links - - - - - - - - \ No newline at end of file diff --git a/Source/formats/usersentitlement.format.ps1xml b/Source/formats/usersentitlement.format.ps1xml deleted file mode 100644 index 56878216e..000000000 --- a/Source/formats/usersentitlement.format.ps1xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - Team.UserEntitlement.TableView - - Team.UserEntitlement - - - - - - - - - - - - - - - - - - - - - userName - - - email - - - accessLevelName - - - lastAccessedDate - - - - - - - - - Team.UserEntitlement.WideView - - Team.UserEntitlement - - - - - - userName - - - - - - - - Team.UserEntitlement.ListView - - Team.UserEntitlement - - - - - - - id - - - userName - - - email - - - accessLevelName - - - projects - - - - - - - - \ No newline at end of file diff --git a/Source/formats/variablegroups.format.ps1xml b/Source/formats/variablegroups.format.ps1xml deleted file mode 100644 index c3a6fbf72..000000000 --- a/Source/formats/variablegroups.format.ps1xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - Team.VariableGroup.TableView - - Team.VariableGroup - - - - - - - - - - - - - - - - - - - - - id - - - name - - - createdByUser - - - modifiedByUser - - - - - - - - - Team.VariableGroup.ListView - - Team.VariableGroup - - - - - - - id - - - name - - - createdByUser - - - modifiedByUser - - - - - - - - diff --git a/Source/formats/vsteamPSDrive.format.ps1xml b/Source/formats/vsteamPSDrive.format.ps1xml deleted file mode 100644 index 445869dee..000000000 --- a/Source/formats/vsteamPSDrive.format.ps1xml +++ /dev/null @@ -1,1539 +0,0 @@ - - - - - - - - Team.Provider.Feed - - Team.Provider.Feed - - - - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - Description - - - - - - - - - - Team.Feed - - Team.Feed - - - - - - - - - - - - - - - - - - - - Name - - - Description - - - ID - - - - - - - - - - - - RefTable - - Team.Provider.GitRef - - - - - - - - - - - - - - - - - - - - DisplayMode - - - RefName - - - Creator - - - - - - - - - - - RefTable - - Team.GitRef - - - - - - - - - - - - - - - - - RefName - - - Creator - - - - - - - - - - - Team.Agent.Table - - Team.Agent - - - - - - - - - - - - - - - - - - - - - - - - - - name - - - enabled - - - version - - - os - - - id - - - - - - - - - - Team.Provider.Agent.Table - - Team.Provider.Agent - - - - - - - - - - - - - - - - - - - - - - - - - - DisplayMode - - - name - - - enabled - - - version - - - os - - - - - - - - - - Team.Provider.Team - - Team.Provider.Team - - - - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - Description - - - - - - - - - - Team.Team - - Team.Team - - - - - - - - - - - - - - - - - Name - - - Description - - - - - - - - - - BuildList - - Team.Team - Team.Provider.Team - - - - - - - Name - - - Description - - - ID - - - ProjectName - - - - - - - - - StatusTable - - Team.Provider.Release - - - - - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - status - - - definitionname - - - - - - - - - - StatusTable - - VSTeamEnvironment - VSTeamAttempt - VSTeamTask - - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - status - - - - - - - - - - BuildTable - - Team.Provider.Build - VSTeamBuild - - - - - - - - - - - - - - - - - - - - - - - - DisplayMode - - - name - - - status - - - result - - - BuildDefinition - - - - - - - - - - BuildList - - Team.Provider.Build - VSTeamBuild - - - - - - - ID - - - Name - - - Status - - - Result - - - StartTime - - - RequestedBy - - - BuildDefinition - - - ProjectName - - - - - - - - - - Team.BuildDefinition.Table - - Team.BuildDefinition - - - - - - - - - - - - - - - - - Name - - - ID - - - - - - - - - - Team.BuildDefinition.Table - - Team.Provider.BuildDefinition - - - - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - ID - - - - - - - - - - Team.BuildDefinition.List - - Team.BuildDefinition - - - - - - - ID - - - Name - - - AuthoredBy - - - - - - - - - - Team.BuildDefinitionYamlProcess.Table - - Team.BuildDefinitionYamlProcess - - - - - - - - - - - - - - yamlFilename - - - - - - - - - - Team.Provider.BuildDefinitionYamlProcess.Table - - Team.Provider.BuildDefinitionYamlProcess - - - - - - - - - - - - - - - - - DisplayMode - - - yamlFilename - - - - - - - - - - Team.BuildDefinitionPhasedProcess.Table - - Team.BuildDefinitionPhasedProcess - - - - - - - - - - - - - - - - - Name - - - Phases - - - - - - - - - - Team.BuildDefinitionProcess.List - - Team.BuildDefinitionProcess - - - - - - - Name - - - Phases - - - - - - - - - - Team.BuildDefinitionProcessPhase.Table - - Team.BuildDefinitionProcessPhase - - - - - - - - - - - - - - - - - Name - - - StepCount - - - - - - - - - - Team.Provider.BuildDefinitionProcessPhase.Table - - Team.Provider.BuildDefinitionProcessPhase - - - - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - StepCount - - - - - - - - - - Team.BuildDefinitionProcessPhase.List - - Team.BuildDefinitionProcessPhase - - - - - - - Name - - - Steps - - - - - - - - - - Team.BuildDefinitionProcessPhaseStep.Table - - Team.BuildDefinitionProcessPhaseStep - - - - - - - - - - - - - - - - - - - - ID - - - Name - - - Enabled - - - - - - - - - - Team.Provider.BuildDefinitionProcessPhaseStep.Table - - Team.Provider.BuildDefinitionProcessPhaseStep - - - - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - Enabled - - - - - - - - - - Team.BuildDefinitionProcessPhaseStep.List - - Team.BuildDefinitionProcessPhaseStep - - - - - - - ID - - - Name - - - Enabled - - - - - - - - - - ReleaseTable - - VSTeamRelease - - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - status - - - - - - - - - - Team.RepositoryTable - - Team.Repository - VSTeamGitRepository - - - - - - - - - - - - - - - - - - - - - Name - - - remoteUrl - - - defaultBranch - - - projectName - - - - - - - - - - Team.Provider.RepositoryTable - - Team.Provider.Repository - VSTeamGitRepository - - - - - - - - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - remoteUrl - - - defaultBranch - - - projectName - - - - - - - - - - RepositoryListView - - Team.Repository - Team.Provider.Repository - VSTeamGitRepository - - - - - - - Name - - - remoteUrl - - - defaultBranch - - - projectName - - - - - - - - - - Team.Provider.ProjectTable - - Team.Provider.Project - - - - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - Description - - - - - - - - - - Team.ProjectTable - - Team.Project - - - - - - - - - - - - - - - - - Name - - - Description - - - - - - - - - - ProjectListView - - Team.Project - Team.Provider.Project - VSTeamProject - - - - - - - Name - - - ID - - - Description - - - - - - - - - - Team.ProcessTable - - Team.Process - - - - - - - - - - - - - - - - - Name - - - Description - - - - - - - - - - ProessListView - - Team.Process - Team.Provider.Process - VSTeamProcess - - - - - - - Name - - - ID - - - Description - - - - - - - - - - - - Team.Pool.Table - - Team.Pool - - - - - - - - - - - - - - - - - - - - Name - - - Count - - - ID - - - - - - - - - - Team.Provider.Queue.Table - - Team.Provider.Queue - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - - - - - - - - Team.Provider.Pool.Table - - Team.Provider.Pool - - - - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - Count - - - - - - - - - - Team.Extension.Table - - Team.Extension - - - - - - - - - - - - - - - - - - - - Name - - - ID - - - publisherId - - - - - - - - - - Team.Provider.Extension.Table - - Team.Provider.Extension - - - - - - - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - ID - - - publisherId - - - - - - - - - - VSTeamPSDriveDefaultTable - - Microsoft.PowerShell.SHiPS.SHiPSDirectory - Team.Account - Team.Pool - Team.Queues - Team.Pools - Team.Provider.Pools - Team.Builds - Team.BuildDefinitions - Team.Releases - Team.Repositories - Team.Teams - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - - - - - - - - VSTeamPSDriveDefaultList - - Microsoft.PowerShell.SHiPS.SHiPSDirectory - Team.Account - Team.Pool - Team.Queues - Team.Pools - Team.Builds - Team.BuildDefinitions - Team.Releases - Team.Repositories - Team.Teams - - - - - - - Name - - - projectName - - - - - - - - - - VSTeamPSDriveDefaultTable - - Microsoft.PowerShell.SHiPS.SHiPSLeaf - - - - - - - - - - - - - - - - - DisplayMode - - - Name - - - - - - - - \ No newline at end of file diff --git a/Source/formats/workitemTypes.format.ps1xml b/Source/formats/workitemTypes.format.ps1xml deleted file mode 100644 index 2a9a648e5..000000000 --- a/Source/formats/workitemTypes.format.ps1xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Team.WorkItemType.TableView - - Team.WorkItemType - - - - - - - - - - - - - - - name - - - description - - - - - - - - - Team.WorkItemType.ListView - - Team.WorkItemType - - - - - - - name - - - description - - - - - - - - \ No newline at end of file diff --git a/Source/types/accessControlEntry.ps1xml b/Source/types/Team.AccessControlEntry.ps1xml similarity index 94% rename from Source/types/accessControlEntry.ps1xml rename to Source/types/Team.AccessControlEntry.ps1xml index f4e2e7d5a..7361c876a 100644 --- a/Source/types/accessControlEntry.ps1xml +++ b/Source/types/Team.AccessControlEntry.ps1xml @@ -1,6 +1,5 @@ - Team.AccessControlEntry diff --git a/Source/types/accessControlList.ps1xml b/Source/types/Team.AccessControlList.ps1xml similarity index 94% rename from Source/types/accessControlList.ps1xml rename to Source/types/Team.AccessControlList.ps1xml index 527511ff8..bbd8cf9f4 100644 --- a/Source/types/accessControlList.ps1xml +++ b/Source/types/Team.AccessControlList.ps1xml @@ -1,6 +1,5 @@ - Team.AccessControlList diff --git a/Source/types/Team.AccessLevel.ps1xml b/Source/types/Team.AccessLevel.ps1xml new file mode 100644 index 000000000..bedcca87c --- /dev/null +++ b/Source/types/Team.AccessLevel.ps1xml @@ -0,0 +1,25 @@ + + + + Team.AccessLevel + + + PSStandardMembers + + + DefaultDisplayPropertySet + + accountLicenseType + assignmentSource + licenseDisplayName + licensingSource + msdnLicenseType + status + statusMessage + + + + + + + \ No newline at end of file diff --git a/Source/types/Approvals.ps1xml b/Source/types/Team.Approval.ps1xml similarity index 98% rename from Source/types/Approvals.ps1xml rename to Source/types/Team.Approval.ps1xml index 11aee64f5..239276320 100644 --- a/Source/types/Approvals.ps1xml +++ b/Source/types/Team.Approval.ps1xml @@ -1,6 +1,5 @@ - Team.Approval diff --git a/Source/types/cloudSubscriptions.ps1xml b/Source/types/Team.AzureSubscription.ps1xml similarity index 95% rename from Source/types/cloudSubscriptions.ps1xml rename to Source/types/Team.AzureSubscription.ps1xml index 49cef2d20..eb007f8b1 100644 --- a/Source/types/cloudSubscriptions.ps1xml +++ b/Source/types/Team.AzureSubscription.ps1xml @@ -1,6 +1,5 @@ - Team.AzureSubscription diff --git a/Source/types/Team.Build.Artifact.ps1xml b/Source/types/Team.Build.Artifact.ps1xml new file mode 100644 index 000000000..4e336b9a1 --- /dev/null +++ b/Source/types/Team.Build.Artifact.ps1xml @@ -0,0 +1,36 @@ + + + + Team.Build.Artifact + + + type + $this.resource.type + + + data + $this.resource.data + + + url + $this.resource.url + + + downloadUrl + $this.resource.downloadUrl + + + PSStandardMembers + + + DefaultDisplayPropertySet + + id + name + + + + + + + \ No newline at end of file diff --git a/Source/types/builds.ps1xml b/Source/types/Team.Build.ps1xml similarity index 57% rename from Source/types/builds.ps1xml rename to Source/types/Team.Build.ps1xml index 2cd3dc571..5a0446465 100644 --- a/Source/types/builds.ps1xml +++ b/Source/types/Team.Build.ps1xml @@ -1,6 +1,5 @@ - Team.Build @@ -42,39 +41,4 @@ - - - - Team.Build.Artifact - - - type - $this.resource.type - - - data - $this.resource.data - - - url - $this.resource.url - - - downloadUrl - $this.resource.downloadUrl - - - PSStandardMembers - - - DefaultDisplayPropertySet - - id - name - - - - - - \ No newline at end of file diff --git a/Source/types/classificationNode.ps1xml b/Source/types/Team.ClassificationNode.ps1xml similarity index 96% rename from Source/types/classificationNode.ps1xml rename to Source/types/Team.ClassificationNode.ps1xml index 835d80722..df9820693 100644 --- a/Source/types/classificationNode.ps1xml +++ b/Source/types/Team.ClassificationNode.ps1xml @@ -1,6 +1,5 @@ - Team.ClassificationNode diff --git a/Source/types/descriptor.ps1xml b/Source/types/Team.Descriptor.ps1xml similarity index 95% rename from Source/types/descriptor.ps1xml rename to Source/types/Team.Descriptor.ps1xml index dead904d6..d967d443c 100644 --- a/Source/types/descriptor.ps1xml +++ b/Source/types/Team.Descriptor.ps1xml @@ -1,6 +1,5 @@ - Team.Descriptor diff --git a/Source/types/Team.Environment.ps1xml b/Source/types/Team.Environment.ps1xml new file mode 100644 index 000000000..0b1b4041e --- /dev/null +++ b/Source/types/Team.Environment.ps1xml @@ -0,0 +1,21 @@ + + + + Team.Environment + + + PSStandardMembers + + + DefaultDisplayPropertySet + + id + name + status + + + + + + + \ No newline at end of file diff --git a/Source/types/repositories.ps1xml b/Source/types/Team.GitRepository.ps1xml similarity index 96% rename from Source/types/repositories.ps1xml rename to Source/types/Team.GitRepository.ps1xml index fd9df590f..e60f1b407 100644 --- a/Source/types/repositories.ps1xml +++ b/Source/types/Team.GitRepository.ps1xml @@ -1,6 +1,5 @@ - Team.GitRepository diff --git a/Source/types/group.ps1xml b/Source/types/Team.Group.ps1xml similarity index 97% rename from Source/types/group.ps1xml rename to Source/types/Team.Group.ps1xml index 7ff9faa59..24bcde4b7 100644 --- a/Source/types/group.ps1xml +++ b/Source/types/Team.Group.ps1xml @@ -1,6 +1,5 @@ - Team.Group diff --git a/Source/types/team.ps1xml b/Source/types/Team.Option.ps1xml similarity index 96% rename from Source/types/team.ps1xml rename to Source/types/Team.Option.ps1xml index 5cf12ff79..2716135e3 100644 --- a/Source/types/team.ps1xml +++ b/Source/types/Team.Option.ps1xml @@ -1,6 +1,5 @@ - Team.Option diff --git a/Source/types/policies.ps1xml b/Source/types/Team.Policy.ps1xml similarity index 97% rename from Source/types/policies.ps1xml rename to Source/types/Team.Policy.ps1xml index db86cc03a..fda648936 100644 --- a/Source/types/policies.ps1xml +++ b/Source/types/Team.Policy.ps1xml @@ -1,6 +1,5 @@ - Team.Policy diff --git a/Source/types/pullrequest.ps1xml b/Source/types/Team.PullRequest.ps1xml similarity index 89% rename from Source/types/pullrequest.ps1xml rename to Source/types/Team.PullRequest.ps1xml index 02f387f99..883d7fcb2 100644 --- a/Source/types/pullrequest.ps1xml +++ b/Source/types/Team.PullRequest.ps1xml @@ -15,7 +15,6 @@ OR RESULTS IN CONNECTION WITH THE USE OF THIS CODE AND INFORMATION REMAINS WITH THE USER. ******************************************************************** --> - Team.PullRequest @@ -35,18 +34,7 @@ REMAINS WITH THE USER. reviewStatus $votes = $this.reviewers.vote - if (!$this.reviewers -or $votes -contains 0) - { - "Pending" - } - elseif ($votes -contains -10) - { - "Rejected" - } - else - { - "Approved" - } + if (!$this.reviewers -or $votes -contains 0) { "Pending" } elseif ($votes -contains -10) { "Rejected" } else { "Approved" } diff --git a/Source/types/releases.ps1xml b/Source/types/Team.Release.ps1xml similarity index 76% rename from Source/types/releases.ps1xml rename to Source/types/Team.Release.ps1xml index a3d99d324..71614afc6 100644 --- a/Source/types/releases.ps1xml +++ b/Source/types/Team.Release.ps1xml @@ -1,26 +1,5 @@ - - - Team.Environment - - - PSStandardMembers - - - DefaultDisplayPropertySet - - id - name - status - - - - - - - - Team.Release diff --git a/Source/types/releaseDefinitions.ps1xml b/Source/types/Team.ReleaseDefinition.ps1xml similarity index 95% rename from Source/types/releaseDefinitions.ps1xml rename to Source/types/Team.ReleaseDefinition.ps1xml index 41b1aedf6..5aa64bb08 100644 --- a/Source/types/releaseDefinitions.ps1xml +++ b/Source/types/Team.ReleaseDefinition.ps1xml @@ -1,6 +1,5 @@ - Team.ReleaseDefinition diff --git a/Source/types/securityNamespace.ps1xml b/Source/types/Team.SecurityNamespace.ps1xml similarity index 96% rename from Source/types/securityNamespace.ps1xml rename to Source/types/Team.SecurityNamespace.ps1xml index 75f7f3459..d3ff95a6e 100644 --- a/Source/types/securityNamespace.ps1xml +++ b/Source/types/Team.SecurityNamespace.ps1xml @@ -1,6 +1,5 @@ - Team.SecurityNamespace diff --git a/Source/types/serviceendpoints.ps1xml b/Source/types/Team.ServiceEndpoint.ps1xml similarity index 91% rename from Source/types/serviceendpoints.ps1xml rename to Source/types/Team.ServiceEndpoint.ps1xml index fb0d7f3e9..0253e57c9 100644 --- a/Source/types/serviceendpoints.ps1xml +++ b/Source/types/Team.ServiceEndpoint.ps1xml @@ -1,6 +1,5 @@ - Team.ServiceEndpoint diff --git a/Source/types/teams.ps1xml b/Source/types/Team.Team.ps1xml similarity index 96% rename from Source/types/teams.ps1xml rename to Source/types/Team.Team.ps1xml index 22f13c860..ac00b6a9b 100644 --- a/Source/types/teams.ps1xml +++ b/Source/types/Team.Team.ps1xml @@ -1,6 +1,5 @@ - Team.Team diff --git a/Source/types/teammembers.ps1xml b/Source/types/Team.TeamMember.ps1xml similarity index 95% rename from Source/types/teammembers.ps1xml rename to Source/types/Team.TeamMember.ps1xml index 595140548..49cc80818 100644 --- a/Source/types/teammembers.ps1xml +++ b/Source/types/Team.TeamMember.ps1xml @@ -1,6 +1,5 @@ - Team.TeamMember diff --git a/Source/types/tfvc.ps1xml b/Source/types/Team.TfvcBranch.ps1xml similarity index 95% rename from Source/types/tfvc.ps1xml rename to Source/types/Team.TfvcBranch.ps1xml index 02fcf5489..74931e11a 100644 --- a/Source/types/tfvc.ps1xml +++ b/Source/types/Team.TfvcBranch.ps1xml @@ -1,6 +1,5 @@ - Team.TfvcBranch diff --git a/Source/types/users.ps1xml b/Source/types/Team.User2.ps1xml similarity index 97% rename from Source/types/users.ps1xml rename to Source/types/Team.User2.ps1xml index 55ff049ac..69ad50887 100644 --- a/Source/types/users.ps1xml +++ b/Source/types/Team.User2.ps1xml @@ -1,6 +1,5 @@ - Team.User2 diff --git a/Source/types/usersentitlement.ps1xml b/Source/types/Team.UserEntitlement.ps1xml similarity index 60% rename from Source/types/usersentitlement.ps1xml rename to Source/types/Team.UserEntitlement.ps1xml index 1f66d8570..f4e823c75 100644 --- a/Source/types/usersentitlement.ps1xml +++ b/Source/types/Team.UserEntitlement.ps1xml @@ -1,6 +1,5 @@ - Team.UserEntitlement @@ -19,7 +18,6 @@ projects [string]::Join(", ", $this.projectEntitlements.projectRef.name) - PSStandardMembers @@ -40,28 +38,4 @@ - - - - Team.AccessLevel - - - PSStandardMembers - - - DefaultDisplayPropertySet - - accountLicenseType - assignmentSource - licenseDisplayName - licensingSource - msdnLicenseType - status - statusMessage - - - - - - \ No newline at end of file diff --git a/Source/types/variablegroups.ps1xml b/Source/types/Team.VariableGroup.ps1xml similarity index 94% rename from Source/types/variablegroups.ps1xml rename to Source/types/Team.VariableGroup.ps1xml index a8adea87f..4ffbaeb5b 100644 --- a/Source/types/variablegroups.ps1xml +++ b/Source/types/Team.VariableGroup.ps1xml @@ -1,6 +1,5 @@ - Team.VariableGroup diff --git a/Source/types/workitems.ps1xml b/Source/types/Team.WorkItem.ps1xml similarity index 98% rename from Source/types/workitems.ps1xml rename to Source/types/Team.WorkItem.ps1xml index 84682064e..6f2cd8eaf 100644 --- a/Source/types/workitems.ps1xml +++ b/Source/types/Team.WorkItem.ps1xml @@ -1,6 +1,5 @@ - Team.WorkItem diff --git a/Source/types/_types.json b/Source/types/_types.json new file mode 100644 index 000000000..9b95ec383 --- /dev/null +++ b/Source/types/_types.json @@ -0,0 +1,7 @@ +{ + "outputFile": "vsteam.types.ps1xml", + "fileType": "types", + "files": [ + "*.ps1xml" + ] +} \ No newline at end of file diff --git a/Split-File.ps1 b/Split-File.ps1 new file mode 100644 index 000000000..d70da93b1 --- /dev/null +++ b/Split-File.ps1 @@ -0,0 +1,39 @@ +function Split-File { + <# +.SYNOPSIS +Takes an formats or types file and splits it into separate files. + +.DESCRIPTION +The input file must be a ps1xml file of formats. A file will be created +from the Name node. + +.PARAMETER InputFile +The ps1xml file to process. + +.EXAMPLE +PS C:\> Split-File -InputFile .\Source\formats\builds.format.ps1xml + +#> + [CmdletBinding()] + param( + [Parameter(Mandatory = $True)] + [string] + $inputFile + ) + + [xml]$xml = Get-Content $inputFile + + foreach ($view in $xml.Configuration.ViewDefinitions.View) { + $finalXml = '' + $finalXml += $view.OuterXml + $finalXml += '' + + $output = Join-Path . "$($view.Name).ps1xml" + # This makes sure the file is there and empty. + # If the file already exisit it will be overwritten. + $null = New-Item -ItemType file -Path $output -Force + + Write-Verbose $output + $finalXml | Add-Content $output + } +} \ No newline at end of file diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 336e6e646..548ccbac2 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -10,9 +10,15 @@ phases: name: Hosted Ubuntu 1604 steps: + - powershell: | + # Build the module and help + .\Build-Module.ps1 + + displayName: 'Build Module' + - powershell: | # Load the psd1 file so you can read the required modules and install them - $manifest = Import-PowerShellDataFile .\Source\*.psd1 + $manifest = Import-PowerShellDataFile .\dist\*.psd1 # Install each module $manifest.RequiredModules | ForEach-Object { Install-Module -Name $_ -Repository PSGallery -F -Scope CurrentUser } @@ -24,7 +30,7 @@ phases: displayName: 'Install Pester' - powershell: | - Import-Module .\Source\*.psd1 + Import-Module .\dist\*.psd1 Invoke-Pester -Script .\unit -EnableExit -Strict -OutputFile test-results.xml -OutputFormat NUnitXml -passthru workingDirectory: '$(System.DefaultWorkingDirectory)' @@ -45,9 +51,15 @@ phases: name: Hosted macOS High Sierra steps: + - powershell: | + # Build the module and help + .\Build-Module.ps1 + + displayName: 'Build Module' + - powershell: | # Load the psd1 file so you can read the required modules and install them - $manifest = Import-PowerShellDataFile .\Source\*.psd1 + $manifest = Import-PowerShellDataFile .\dist\*.psd1 # Install each module $manifest.RequiredModules | ForEach-Object { Install-Module -Name $_ -Repository PSGallery -F -Scope CurrentUser } @@ -59,7 +71,7 @@ phases: displayName: 'Install Pester' - powershell: | - Import-Module .\Source\*.psd1 + Import-Module .\dist\*.psd1 Invoke-Pester -Script .\unit -EnableExit -Strict -OutputFile test-results.xml -OutputFormat NUnitXml -passthru workingDirectory: '$(System.DefaultWorkingDirectory)' @@ -77,12 +89,18 @@ phases: displayName: Windows condition: succeeded() queue: - name: Hosted VS2017 + name: Hosted Windows 2019 with VS2019 steps: + - powershell: | + # Build the module and help + .\Build-Module.ps1 -buildHelp + + displayName: 'Build Module' + - powershell: | # Load the psd1 file so you can read the required modules and install them - $manifest = Import-PowerShellDataFile .\Source\*.psd1 + $manifest = Import-PowerShellDataFile .\dist\*.psd1 # Install each module $manifest.RequiredModules | ForEach-Object { Install-Module -Name $_ -Repository PSGallery -F -Scope CurrentUser } @@ -95,26 +113,22 @@ phases: - powershell: | # Has to happen in this task for it to take effect # Load the psd1 file so you can read the required modules and import them - $manifest = Import-PowerShellDataFile .\Source\*.psd1 + $manifest = Import-PowerShellDataFile .\dist\*.psd1 # Import each module $manifest.RequiredModules | ForEach-Object { Import-Module -Name $_ } - $r = Invoke-ScriptAnalyzer –Path ./Source –Recurse | Where-Object severity -ne "Information" + $r = Invoke-ScriptAnalyzer –Path ./dist –Recurse | Where-Object severity -ne "Information" $r | ForEach-Object {Write-Host "##vso[task.logissue type=$($_.Severity);sourcepath=$($_.ScriptPath);linenumber=$($_.Line);columnnumber=$($_.Column);]$($_.Message)"} displayName: 'Run Static Code Analysis' - - powershell: './gen-help.ps1' - displayName: 'Generate Help' - workingDirectory: .docs - - powershell: 'Install-Module -Name Pester -Repository PSGallery -Force -Scope CurrentUser -AllowClobber -SkipPublisherCheck -Verbose' displayName: 'Install Pester' - powershell: | - Import-Module .\Source\*.psd1 - Invoke-Pester -Script .\unit -CodeCoverage .\Source\*.ps*1 -CodeCoverageOutputFile coverage.xml -CodeCoverageOutputFileFormat JaCoCo -EnableExit -Strict -OutputFile test-results.xml -OutputFormat NUnitXml + Import-Module .\dist\*.psd1 + Invoke-Pester -Script .\unit -CodeCoverage .\dist\*.ps*1 -CodeCoverageOutputFile coverage.xml -CodeCoverageOutputFileFormat JaCoCo -EnableExit -Strict -OutputFile test-results.xml -OutputFormat NUnitXml displayName: 'Run Unit Tests' - task: PublishTestResults@2 @@ -138,7 +152,7 @@ phases: Contents: | README.md .gitignore - Source\** + dist\** TargetFolder: '$(build.artifactstagingdirectory)/VSTeam' condition: and(succeeded(), eq(variables['System.PullRequest.IsFork'], false)) @@ -154,7 +168,7 @@ phases: displayName: 'Copy Integration Tests Artifacts Folder' inputs: Contents: | - Source\*.psd1 + dist\*.psd1 integration\** TargetFolder: '$(build.artifactstagingdirectory)/Tests' @@ -165,4 +179,4 @@ phases: inputs: PathtoPublish: '$(build.artifactstagingdirectory)/Tests' ArtifactName: Test - condition: and(succeeded(), eq(variables['System.PullRequest.IsFork'], false)) \ No newline at end of file + condition: and(succeeded(), eq(variables['System.PullRequest.IsFork'], false)) diff --git a/docs/Add-VSTeam.md b/docs/Add-VSTeam.md index 26c5ee456..ba0104488 100644 --- a/docs/Add-VSTeam.md +++ b/docs/Add-VSTeam.md @@ -17,20 +17,20 @@ Adds a team to a team project. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -Description diff --git a/docs/Add-VSTeamAccessControlEntry.md b/docs/Add-VSTeamAccessControlEntry.md index c33c26b0c..0205fe0de 100644 --- a/docs/Add-VSTeamAccessControlEntry.md +++ b/docs/Add-VSTeamAccessControlEntry.md @@ -5,129 +5,129 @@ ## SYNOPSIS -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. - +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. ## SYNTAX ## DESCRIPTION -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. - +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. ## EXAMPLES ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` -### -SecurityNamespaceName - -Security Namespace Name. Valid names are: - -AzD: -- Analytics (58450c49-b02d-465a-ab12-59ae512d6531) -- AnalyticsViews (d34d3680-dfe5-4cc6-a949-7d9c68f73cba) -- ReleaseManagement (7c7d32f7-0e86-4cd6-892e-b35dbba870bd) -- ReleaseManagement2 (c788c23e-1b46-4162-8f5e-d7585343b5de) -- Identity (5a27515b-ccd7-42c9-84f1-54c998f03866) -- WorkItemTrackingAdministration (445d2788-c5fb-4132-bbef-09c4045ad93f) -- DistributedTask (101eae8c-1709-47f9-b228-0e476c35b3ba) -- WorkItemQueryFolders (71356614-aad7-4757-8f2c-0fb3bff6f680) -- GitRepositories (2e9eb7ed-3c0a-47d4-87c1-0ffdd275fd87) -- VersionControlItems2 (3c15a8b7-af1a-45c2-aa97-2cb97078332e) -- EventSubscriber (2bf24a2b-70ba-43d3-ad97-3d9e1f75622f) -- WorkItemTrackingProvision (5a6cd233-6615-414d-9393-48dbb252bd23) -- ServiceEndpoints (49b48001-ca20-4adc-8111-5b60c903a50c) -- ServiceHooks (cb594ebe-87dd-4fc9-ac2c-6a10a4c92046) -- Chat (bc295513-b1a2-4663-8d1a-7017fd760d18) -- Collection (3e65f728-f8bc-4ecd-8764-7e378b19bfa7) -- Proxy (cb4d56d2-e84b-457e-8845-81320a133fbb) -- Plan (bed337f8-e5f3-4fb9-80da-81e17d06e7a8) -- Process (2dab47f9-bd70-49ed-9bd5-8eb051e59c02) -- AccountAdminSecurity (11238e09-49f2-40c7-94d0-8f0307204ce4) -- Library (b7e84409-6553-448a-bbb2-af228e07cbeb) -- Environment (83d4c2e6-e57d-4d6e-892b-b87222b7ad20) -- Project (52d39943-cb85-4d7f-8fa8-c6baac873819) -- EventSubscription (58b176e7-3411-457a-89d0-c6d0ccb3c52b) -- CSS (83e28ad4-2d72-4ceb-97b0-c7726d5502c3) -- TeamLabSecurity (9e4894c3-ff9a-4eac-8a85-ce11cafdc6f1) -- ProjectAnalysisLanguageMetrics (fc5b7b85-5d6b-41eb-8534-e128cb10eb67) -- Tagging (bb50f182-8e5e-40b8-bc21-e8752a1e7ae2) -- MetaTask (f6a4de49-dbe2-4704-86dc-f8ec1a294436) -- Iteration (bf7bfa03-b2b7-47db-8113-fa2e002cc5b1) -- Favorites (fa557b48-b5bf-458a-bb2b-1b680426fe8b) -- Registry (4ae0db5d-8437-4ee8-a18b-1f6fb38bd34c) -- Graph (c2ee56c9-e8fa-4cdd-9d48-2c44f697a58e) -- ViewActivityPaneSecurity (dc02bf3d-cd48-46c3-8a41-345094ecc94b) -- Job (2a887f97-db68-4b7c-9ae3-5cebd7add999) -- WorkItemTracking (73e71c45-d483-40d5-bdba-62fd076f7f87) -- StrongBox (4a9e8381-289a-4dfd-8460-69028eaa93b3) -- Server (1f4179b3-6bac-4d01-b421-71ea09171400) -- TestManagement (e06e1c24-e93d-4e4a-908a-7d951187b483) -- SettingEntries (6ec4592e-048c-434e-8e6c-8671753a8418) -- BuildAdministration (302acaca-b667-436d-a946-87133492041c) -- Location (2725d2bc-7520-4af4-b0e3-8d876494731f) -- Boards (251e12d9-bea3-43a8-bfdb-901b98c0125e) -- UtilizationPermissions (83abde3a-4593-424e-b45f-9898af99034d) -- WorkItemsHub (c0e7a722-1cad-4ae6-b340-a8467501e7ce) -- WebPlatform (0582eb05-c896-449a-b933-aa3d99e121d6) -- VersionControlPrivileges (66312704-deb5-43f9-b51c-ab4ff5e351c3) -- Workspaces (93bafc04-9075-403a-9367-b7164eac6b5c) -- CrossProjectWidgetView (093cbb02-722b-4ad6-9f88-bc452043fa63) -- WorkItemTrackingConfiguration (35e35e8e-686d-4b01-aff6-c369d6e36ce0) -- Discussion Threads (0d140cae-8ac1-4f48-b6d1-c93ce0301a12) -- BoardsExternalIntegration (5ab15bc8-4ea1-d0f3-8344-cab8fe976877) -- DataProvider (7ffa7cf4-317c-4fea-8f1d-cfda50cfa956) -- Social (81c27cc8-7a9f-48ee-b63f-df1e1d0412dd) -- Security (9a82c708-bfbe-4f31-984c-e860c2196781) -- IdentityPicker (a60e0d84-c2f8-48e4-9c0c-f32da48d5fd1) -- ServicingOrchestration (84cc1aa4-15bc-423d-90d9-f97c450fc729) -- Build (33344d9c-fc72-4d6f-aba5-fa317101a7e9) -- DashboardsPrivileges (8adf73b7-389a-4276-b638-fe1653f7efc7) -- VersionControlItems (a39371cf-0841-4c16-bbd3-276e341bc052) - -VSSPS: -- EventSubscriber (2bf24a2b-70ba-43d3-ad97-3d9e1f75622f) (VSSPS) -- EventSubscription (58b176e7-3411-457a-89d0-c6d0ccb3c52b) (VSSPS) -- Registry (4ae0db5d-8437-4ee8-a18b-1f6fb38bd34c) (VSSPS) -- Graph (c2ee56c9-e8fa-4cdd-9d48-2c44f697a58e) (VSSPS) -- Invitation (ea0b4d1e-577a-4797-97b5-2f5755e548d5) (VSSPS) -- SystemGraph (b24dfdf1-285a-4ea6-a55b-32549a68121d) (VSSPS) -- Job (2a887f97-db68-4b7c-9ae3-5cebd7add999) (VSSPS) -- CommerceCollectionSecurity (307be2d3-12ed-45c2-aacf-6598760efca7) (VSSPS) -- StrongBox (4a9e8381-289a-4dfd-8460-69028eaa93b3) (VSSPS) -- GroupLicensing (c6a4fd35-b508-49eb-8ea7-7189df5f3698) (VSSPS) -- Server (1f4179b3-6bac-4d01-b421-71ea09171400) (VSSPS) -- SettingEntries (6ec4592e-048c-434e-8e6c-8671753a8418) (VSSPS) -- RemotableTemplateTest (ccdcb71c-4780-4a42-9bb4-8bce07a7628f) (VSSPS) -- Location (2725d2bc-7520-4af4-b0e3-8d876494731f) (VSSPS) -- WebPlatform (0582eb05-c896-449a-b933-aa3d99e121d6) (VSSPS) -- DataProvider (7ffa7cf4-317c-4fea-8f1d-cfda50cfa956) (VSSPS) -- Security (9a82c708-bfbe-4f31-984c-e860c2196781) (VSSPS) -- IdentityPicker (a60e0d84-c2f8-48e4-9c0c-f32da48d5fd1) (VSSPS) -- ServicingOrchestration (84cc1aa4-15bc-423d-90d9-f97c450fc729) (VSSPS) - - -```yaml -Type: String -Required: True +### -SecurityNamespaceName + +Security Namespace Name. Valid names are: + +AzD: +- Analytics (58450c49-b02d-465a-ab12-59ae512d6531) +- AnalyticsViews (d34d3680-dfe5-4cc6-a949-7d9c68f73cba) +- ReleaseManagement (7c7d32f7-0e86-4cd6-892e-b35dbba870bd) +- ReleaseManagement2 (c788c23e-1b46-4162-8f5e-d7585343b5de) +- Identity (5a27515b-ccd7-42c9-84f1-54c998f03866) +- WorkItemTrackingAdministration (445d2788-c5fb-4132-bbef-09c4045ad93f) +- DistributedTask (101eae8c-1709-47f9-b228-0e476c35b3ba) +- WorkItemQueryFolders (71356614-aad7-4757-8f2c-0fb3bff6f680) +- GitRepositories (2e9eb7ed-3c0a-47d4-87c1-0ffdd275fd87) +- VersionControlItems2 (3c15a8b7-af1a-45c2-aa97-2cb97078332e) +- EventSubscriber (2bf24a2b-70ba-43d3-ad97-3d9e1f75622f) +- WorkItemTrackingProvision (5a6cd233-6615-414d-9393-48dbb252bd23) +- ServiceEndpoints (49b48001-ca20-4adc-8111-5b60c903a50c) +- ServiceHooks (cb594ebe-87dd-4fc9-ac2c-6a10a4c92046) +- Chat (bc295513-b1a2-4663-8d1a-7017fd760d18) +- Collection (3e65f728-f8bc-4ecd-8764-7e378b19bfa7) +- Proxy (cb4d56d2-e84b-457e-8845-81320a133fbb) +- Plan (bed337f8-e5f3-4fb9-80da-81e17d06e7a8) +- Process (2dab47f9-bd70-49ed-9bd5-8eb051e59c02) +- AccountAdminSecurity (11238e09-49f2-40c7-94d0-8f0307204ce4) +- Library (b7e84409-6553-448a-bbb2-af228e07cbeb) +- Environment (83d4c2e6-e57d-4d6e-892b-b87222b7ad20) +- Project (52d39943-cb85-4d7f-8fa8-c6baac873819) +- EventSubscription (58b176e7-3411-457a-89d0-c6d0ccb3c52b) +- CSS (83e28ad4-2d72-4ceb-97b0-c7726d5502c3) +- TeamLabSecurity (9e4894c3-ff9a-4eac-8a85-ce11cafdc6f1) +- ProjectAnalysisLanguageMetrics (fc5b7b85-5d6b-41eb-8534-e128cb10eb67) +- Tagging (bb50f182-8e5e-40b8-bc21-e8752a1e7ae2) +- MetaTask (f6a4de49-dbe2-4704-86dc-f8ec1a294436) +- Iteration (bf7bfa03-b2b7-47db-8113-fa2e002cc5b1) +- Favorites (fa557b48-b5bf-458a-bb2b-1b680426fe8b) +- Registry (4ae0db5d-8437-4ee8-a18b-1f6fb38bd34c) +- Graph (c2ee56c9-e8fa-4cdd-9d48-2c44f697a58e) +- ViewActivityPaneSecurity (dc02bf3d-cd48-46c3-8a41-345094ecc94b) +- Job (2a887f97-db68-4b7c-9ae3-5cebd7add999) +- WorkItemTracking (73e71c45-d483-40d5-bdba-62fd076f7f87) +- StrongBox (4a9e8381-289a-4dfd-8460-69028eaa93b3) +- Server (1f4179b3-6bac-4d01-b421-71ea09171400) +- TestManagement (e06e1c24-e93d-4e4a-908a-7d951187b483) +- SettingEntries (6ec4592e-048c-434e-8e6c-8671753a8418) +- BuildAdministration (302acaca-b667-436d-a946-87133492041c) +- Location (2725d2bc-7520-4af4-b0e3-8d876494731f) +- Boards (251e12d9-bea3-43a8-bfdb-901b98c0125e) +- UtilizationPermissions (83abde3a-4593-424e-b45f-9898af99034d) +- WorkItemsHub (c0e7a722-1cad-4ae6-b340-a8467501e7ce) +- WebPlatform (0582eb05-c896-449a-b933-aa3d99e121d6) +- VersionControlPrivileges (66312704-deb5-43f9-b51c-ab4ff5e351c3) +- Workspaces (93bafc04-9075-403a-9367-b7164eac6b5c) +- CrossProjectWidgetView (093cbb02-722b-4ad6-9f88-bc452043fa63) +- WorkItemTrackingConfiguration (35e35e8e-686d-4b01-aff6-c369d6e36ce0) +- Discussion Threads (0d140cae-8ac1-4f48-b6d1-c93ce0301a12) +- BoardsExternalIntegration (5ab15bc8-4ea1-d0f3-8344-cab8fe976877) +- DataProvider (7ffa7cf4-317c-4fea-8f1d-cfda50cfa956) +- Social (81c27cc8-7a9f-48ee-b63f-df1e1d0412dd) +- Security (9a82c708-bfbe-4f31-984c-e860c2196781) +- IdentityPicker (a60e0d84-c2f8-48e4-9c0c-f32da48d5fd1) +- ServicingOrchestration (84cc1aa4-15bc-423d-90d9-f97c450fc729) +- Build (33344d9c-fc72-4d6f-aba5-fa317101a7e9) +- DashboardsPrivileges (8adf73b7-389a-4276-b638-fe1653f7efc7) +- VersionControlItems (a39371cf-0841-4c16-bbd3-276e341bc052) + +VSSPS: +- EventSubscriber (2bf24a2b-70ba-43d3-ad97-3d9e1f75622f) (VSSPS) +- EventSubscription (58b176e7-3411-457a-89d0-c6d0ccb3c52b) (VSSPS) +- Registry (4ae0db5d-8437-4ee8-a18b-1f6fb38bd34c) (VSSPS) +- Graph (c2ee56c9-e8fa-4cdd-9d48-2c44f697a58e) (VSSPS) +- Invitation (ea0b4d1e-577a-4797-97b5-2f5755e548d5) (VSSPS) +- SystemGraph (b24dfdf1-285a-4ea6-a55b-32549a68121d) (VSSPS) +- Job (2a887f97-db68-4b7c-9ae3-5cebd7add999) (VSSPS) +- CommerceCollectionSecurity (307be2d3-12ed-45c2-aacf-6598760efca7) (VSSPS) +- StrongBox (4a9e8381-289a-4dfd-8460-69028eaa93b3) (VSSPS) +- GroupLicensing (c6a4fd35-b508-49eb-8ea7-7189df5f3698) (VSSPS) +- Server (1f4179b3-6bac-4d01-b421-71ea09171400) (VSSPS) +- SettingEntries (6ec4592e-048c-434e-8e6c-8671753a8418) (VSSPS) +- RemotableTemplateTest (ccdcb71c-4780-4a42-9bb4-8bce07a7628f) (VSSPS) +- Location (2725d2bc-7520-4af4-b0e3-8d876494731f) (VSSPS) +- WebPlatform (0582eb05-c896-449a-b933-aa3d99e121d6) (VSSPS) +- DataProvider (7ffa7cf4-317c-4fea-8f1d-cfda50cfa956) (VSSPS) +- Security (9a82c708-bfbe-4f31-984c-e860c2196781) (VSSPS) +- IdentityPicker (a60e0d84-c2f8-48e4-9c0c-f32da48d5fd1) (VSSPS) +- ServicingOrchestration (84cc1aa4-15bc-423d-90d9-f97c450fc729) (VSSPS) + + +```yaml +Type: String +Required: True ``` ### -SecurityNamespace diff --git a/docs/Add-VSTeamAzureRMServiceEndpoint.md b/docs/Add-VSTeamAzureRMServiceEndpoint.md index f5d66429e..61d6757cb 100644 --- a/docs/Add-VSTeamAzureRMServiceEndpoint.md +++ b/docs/Add-VSTeamAzureRMServiceEndpoint.md @@ -17,20 +17,20 @@ The cmdlet adds a new connection between TFS/VSTS and Azure using the Azure Reso ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -SubscriptionName diff --git a/docs/Add-VSTeamBuild.md b/docs/Add-VSTeamBuild.md index 46779a22b..300f07b00 100644 --- a/docs/Add-VSTeamBuild.md +++ b/docs/Add-VSTeamBuild.md @@ -60,20 +60,20 @@ This example queues the build and sets the system.debug variable to true and msg ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -BuildDefinitionName diff --git a/docs/Add-VSTeamBuildDefinition.md b/docs/Add-VSTeamBuildDefinition.md index e2946141f..9e6cc2d11 100644 --- a/docs/Add-VSTeamBuildDefinition.md +++ b/docs/Add-VSTeamBuildDefinition.md @@ -28,20 +28,20 @@ on the demo team project. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -InFile diff --git a/docs/Add-VSTeamBuildTag.md b/docs/Add-VSTeamBuildTag.md index 0fb018014..0e2b0b3ba 100644 --- a/docs/Add-VSTeamBuildTag.md +++ b/docs/Add-VSTeamBuildTag.md @@ -17,72 +17,72 @@ Adds a tag to a build. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` -### -Id - -Specifies one or more builds by ID. - -To specify multiple IDs, use commas to separate the IDs. - -To find the ID of a build, type Get-VSTeamBuild. - -```yaml -Type: Int32[] -Aliases: BuildID -Accept pipeline input: true (ByPropertyName, ByValue) +### -Id + +Specifies one or more builds by ID. + +To specify multiple IDs, use commas to separate the IDs. + +To find the ID of a build, type Get-VSTeamBuild. + +```yaml +Type: Int32[] +Aliases: BuildID +Accept pipeline input: true (ByPropertyName, ByValue) ``` -### -Tags - -One or more tags. To specify multiple, use commas to separate. - -```yaml -Type: String[] -Required: True -Position: 1 -Accept pipeline input: true (ByPropertyName, ByValue) +### -Tags + +One or more tags. To specify multiple, use commas to separate. + +```yaml +Type: String[] +Required: True +Position: 1 +Accept pipeline input: true (ByPropertyName, ByValue) ``` -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Aliases: cf +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Aliases: cf ``` -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter ``` -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Aliases: wi +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Aliases: wi ``` ## INPUTS diff --git a/docs/Add-VSTeamGitRepository.md b/docs/Add-VSTeamGitRepository.md index a4dfd4d4d..3e6705ec4 100644 --- a/docs/Add-VSTeamGitRepository.md +++ b/docs/Add-VSTeamGitRepository.md @@ -25,20 +25,20 @@ This command adds a new repository named Temp to the Demo project. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -Name diff --git a/docs/Add-VSTeamGitRepositoryPermission.md b/docs/Add-VSTeamGitRepositoryPermission.md index cf0eb7dfa..515f1c935 100644 --- a/docs/Add-VSTeamGitRepositoryPermission.md +++ b/docs/Add-VSTeamGitRepositoryPermission.md @@ -17,20 +17,20 @@ Add permissions to a git repository, all repositories in a project, or a specifi ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -RepositoryId diff --git a/docs/Add-VSTeamKubernetesEndpoint.md b/docs/Add-VSTeamKubernetesEndpoint.md index 15c47c30e..08fd641ca 100644 --- a/docs/Add-VSTeamKubernetesEndpoint.md +++ b/docs/Add-VSTeamKubernetesEndpoint.md @@ -19,20 +19,20 @@ This is only used when using the Kubernetes tasks. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -Kubeconfig diff --git a/docs/Add-VSTeamNuGetEndpoint.md b/docs/Add-VSTeamNuGetEndpoint.md index 60912547d..dc63a4e0b 100644 --- a/docs/Add-VSTeamNuGetEndpoint.md +++ b/docs/Add-VSTeamNuGetEndpoint.md @@ -30,20 +30,20 @@ template and Git source control. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -NuGetUrl diff --git a/docs/Add-VSTeamPolicy.md b/docs/Add-VSTeamPolicy.md index 92a25c196..3237e1b66 100644 --- a/docs/Add-VSTeamPolicy.md +++ b/docs/Add-VSTeamPolicy.md @@ -25,20 +25,20 @@ This command adds a new policy to the Demo project's repository specified. The p ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -type diff --git a/docs/Add-VSTeamProfile.md b/docs/Add-VSTeamProfile.md index 53d31773c..dd3d778c3 100644 --- a/docs/Add-VSTeamProfile.md +++ b/docs/Add-VSTeamProfile.md @@ -5,7 +5,7 @@ ## SYNOPSIS -Stores your account name and personal access token as a profile for use with +Stores your account name and personal access token as a profile for use with the Add-TeamAccount function in this module. ## SYNTAX @@ -113,23 +113,23 @@ Required: True Position: 3 ``` -### -Version - -Specifies the version to use. The acceptable values for this parameter are: - -- TFS2017 -- TFS2018 -- VSTS -- AzD - -If you are on AzD it will default to Azd otherwise it will default to TFS2017 - -```yaml -Type: String -Parameter Sets: Secure, Plain, Windows -Required: True -Position: 3 -Default value: TFS2017 for TFS and AzD for AzD +### -Version + +Specifies the version to use. The acceptable values for this parameter are: + +- TFS2017 +- TFS2018 +- VSTS +- AzD + +If you are on AzD it will default to Azd otherwise it will default to TFS2017 + +```yaml +Type: String +Parameter Sets: Secure, Plain, Windows +Required: True +Position: 3 +Default value: TFS2017 for TFS and AzD for AzD ``` ## INPUTS diff --git a/docs/Add-VSTeamProjectPermission.md b/docs/Add-VSTeamProjectPermission.md index eb8db39ce..5118180da 100644 --- a/docs/Add-VSTeamProjectPermission.md +++ b/docs/Add-VSTeamProjectPermission.md @@ -17,20 +17,20 @@ Add Permissions on Project Level ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -Descriptor diff --git a/docs/Add-VSTeamRelease.md b/docs/Add-VSTeamRelease.md index 59a22820b..d2030c313 100644 --- a/docs/Add-VSTeamRelease.md +++ b/docs/Add-VSTeamRelease.md @@ -51,20 +51,20 @@ You must set a default project to tab complete DefinitionName and BuildNumber. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -DefinitionId @@ -142,12 +142,12 @@ Parameter Sets: ByName Accept pipeline input: true (ByPropertyName) ``` -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter ``` ## INPUTS diff --git a/docs/Add-VSTeamReleaseDefinition.md b/docs/Add-VSTeamReleaseDefinition.md index 22f282804..3219ada5c 100644 --- a/docs/Add-VSTeamReleaseDefinition.md +++ b/docs/Add-VSTeamReleaseDefinition.md @@ -27,20 +27,20 @@ This command reads release.json and creates a new release definition from it on ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -InFile diff --git a/docs/Add-VSTeamServiceEndpoint.md b/docs/Add-VSTeamServiceEndpoint.md index 63abb37c0..44ff0902b 100644 --- a/docs/Add-VSTeamServiceEndpoint.md +++ b/docs/Add-VSTeamServiceEndpoint.md @@ -17,20 +17,20 @@ The cmdlet adds a new generic connection between TFS/VSTS and a third party serv ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -Object diff --git a/docs/Add-VSTeamServiceFabricEndpoint.md b/docs/Add-VSTeamServiceFabricEndpoint.md index 373d58da7..2a6b34f43 100644 --- a/docs/Add-VSTeamServiceFabricEndpoint.md +++ b/docs/Add-VSTeamServiceFabricEndpoint.md @@ -45,20 +45,20 @@ Adds a Service Fabric Endpoint for a certificate secured cluster. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -url diff --git a/docs/Add-VSTeamSonarQubeEndpoint.md b/docs/Add-VSTeamSonarQubeEndpoint.md index 214f8287f..3af6fb704 100644 --- a/docs/Add-VSTeamSonarQubeEndpoint.md +++ b/docs/Add-VSTeamSonarQubeEndpoint.md @@ -21,20 +21,20 @@ Using SonarQube with the Maven tasks uses a Generic Connection type. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -SonarQubeUrl diff --git a/docs/Add-VSTeamUserEntitlement.md b/docs/Add-VSTeamUserEntitlement.md index 5b1bf8126..542f88add 100644 --- a/docs/Add-VSTeamUserEntitlement.md +++ b/docs/Add-VSTeamUserEntitlement.md @@ -17,20 +17,20 @@ Add a user, assign license and extensions and make them a member of a project gr ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -License diff --git a/docs/Add-VSTeamWorkItem.md b/docs/Add-VSTeamWorkItem.md index 092e536d8..4cfb2a934 100644 --- a/docs/Add-VSTeamWorkItem.md +++ b/docs/Add-VSTeamWorkItem.md @@ -39,20 +39,20 @@ ID Title Status ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -Title diff --git a/docs/Add-VSTeamWorkItemAreaPermission.md b/docs/Add-VSTeamWorkItemAreaPermission.md index d4513c639..6f72f75f9 100644 --- a/docs/Add-VSTeamWorkItemAreaPermission.md +++ b/docs/Add-VSTeamWorkItemAreaPermission.md @@ -17,20 +17,20 @@ Add Permissions to a Work Item Area ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -AreaID diff --git a/docs/Add-VSTeamWorkItemIterationPermission.md b/docs/Add-VSTeamWorkItemIterationPermission.md index ccfd3ad95..2cf53e853 100644 --- a/docs/Add-VSTeamWorkItemIterationPermission.md +++ b/docs/Add-VSTeamWorkItemIterationPermission.md @@ -17,20 +17,20 @@ Add Permissions to an Iteration ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -IterationID diff --git a/docs/Get-VSTeam.md b/docs/Get-VSTeam.md index dc8335611..254f20b77 100644 --- a/docs/Get-VSTeam.md +++ b/docs/Get-VSTeam.md @@ -17,20 +17,20 @@ Returns a team. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -Skip diff --git a/docs/Get-VSTeamApproval.md b/docs/Get-VSTeamApproval.md index 7505418e7..f501179e2 100644 --- a/docs/Get-VSTeamApproval.md +++ b/docs/Get-VSTeamApproval.md @@ -53,20 +53,20 @@ This command gets a list of all approvals rejected by Administrator using a cust ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -StatusFilter diff --git a/docs/Get-VSTeamBuild.md b/docs/Get-VSTeamBuild.md index b37c2bebb..fa01de31b 100644 --- a/docs/Get-VSTeamBuild.md +++ b/docs/Get-VSTeamBuild.md @@ -64,20 +64,20 @@ This command returns the raw object returned from the server. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -Top @@ -177,18 +177,18 @@ Type: String[] Parameter Sets: List ``` -### -Id - -Specifies one or more builds by ID. - -To specify multiple IDs, use commas to separate the IDs. - -To find the ID of a build, type Get-VSTeamBuild. - -```yaml -Type: Int32[] -Aliases: BuildID -Accept pipeline input: true (ByPropertyName, ByValue) +### -Id + +Specifies one or more builds by ID. + +To specify multiple IDs, use commas to separate the IDs. + +To find the ID of a build, type Get-VSTeamBuild. + +```yaml +Type: Int32[] +Aliases: BuildID +Accept pipeline input: true (ByPropertyName, ByValue) ``` ### -JSON diff --git a/docs/Get-VSTeamBuildArtifact.md b/docs/Get-VSTeamBuildArtifact.md index a0fd44e11..19e6b2d20 100644 --- a/docs/Get-VSTeamBuildArtifact.md +++ b/docs/Get-VSTeamBuildArtifact.md @@ -17,31 +17,31 @@ Returns the artifacts of a build. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` -### -Id - -The id of the build. - -```yaml -Type: Int32 -Aliases: BuildID -Required: True -Accept pipeline input: true (ByPropertyName, ByValue) +### -Id + +The id of the build. + +```yaml +Type: Int32 +Aliases: BuildID +Required: True +Accept pipeline input: true (ByPropertyName, ByValue) ``` ## INPUTS diff --git a/docs/Get-VSTeamBuildDefinition.md b/docs/Get-VSTeamBuildDefinition.md index d974e5b44..c05a42f17 100644 --- a/docs/Get-VSTeamBuildDefinition.md +++ b/docs/Get-VSTeamBuildDefinition.md @@ -49,20 +49,20 @@ This command returns the raw object returned from the server. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -Filter diff --git a/docs/Get-VSTeamBuildLog.md b/docs/Get-VSTeamBuildLog.md index 00bcc9547..12803d43b 100644 --- a/docs/Get-VSTeamBuildLog.md +++ b/docs/Get-VSTeamBuildLog.md @@ -28,34 +28,34 @@ displays the logs. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` -### -Id - -Specifies one or more builds by ID. - -To specify multiple IDs, use commas to separate the IDs. - -To find the ID of a build, type Get-VSTeamBuild. - -```yaml -Type: Int32[] -Aliases: BuildID -Accept pipeline input: true (ByPropertyName, ByValue) +### -Id + +Specifies one or more builds by ID. + +To specify multiple IDs, use commas to separate the IDs. + +To find the ID of a build, type Get-VSTeamBuild. + +```yaml +Type: Int32[] +Aliases: BuildID +Accept pipeline input: true (ByPropertyName, ByValue) ``` ### -Index diff --git a/docs/Get-VSTeamBuildTag.md b/docs/Get-VSTeamBuildTag.md index acd4b4d21..eba4df34b 100644 --- a/docs/Get-VSTeamBuildTag.md +++ b/docs/Get-VSTeamBuildTag.md @@ -17,31 +17,31 @@ Returns all the tags of a build. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` -### -Id - -The id of the build. - -```yaml -Type: Int32 -Aliases: BuildID -Required: True -Accept pipeline input: true (ByPropertyName, ByValue) +### -Id + +The id of the build. + +```yaml +Type: Int32 +Aliases: BuildID +Required: True +Accept pipeline input: true (ByPropertyName, ByValue) ``` ## INPUTS diff --git a/docs/Get-VSTeamClassificationNode.md b/docs/Get-VSTeamClassificationNode.md index cd23ebe33..1d33e649e 100644 --- a/docs/Get-VSTeamClassificationNode.md +++ b/docs/Get-VSTeamClassificationNode.md @@ -15,20 +15,20 @@ Gets the classification node for a given node path. ## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) +### -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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) ``` ### -StructureGroup diff --git a/docs/Get-VSTeamGitRef.md b/docs/Get-VSTeamGitRef.md index ed537570f..0cd004977 100644 --- a/docs/Get-VSTeamGitRef.md +++ b/docs/Get-VSTeamGitRef.md @@ -1,61 +1,61 @@ - - -# Get-VSTeamGitRef - -## SYNOPSIS - -Queries the provided repository for its refs and returns them. - -## SYNTAX - -## DESCRIPTION - -Get-VSTeamGitRef gets all the refs for the provided repository. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamGitRef -ProjectName Demo -``` - -This command returns all the Git refs for the Demo team project. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -RepositoryId - -Specifies the ID of the repository. - -```yaml -Type: Guid -Aliases: ID -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Get-VSTeamGitRef + +## SYNOPSIS + +Queries the provided repository for its refs and returns them. + +## SYNTAX + +## DESCRIPTION + +Get-VSTeamGitRef gets all the refs for the provided repository. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamGitRef -ProjectName Demo +``` + +This command returns all the Git refs for the Demo team project. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -RepositoryId + +Specifies the ID of the repository. + +```yaml +Type: Guid +Aliases: ID +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-VSTeamGitRepository.md b/docs/Get-VSTeamGitRepository.md index 6a324b287..7d273d9ad 100644 --- a/docs/Get-VSTeamGitRepository.md +++ b/docs/Get-VSTeamGitRepository.md @@ -1,96 +1,96 @@ - - -# Get-VSTeamGitRepository - -## SYNOPSIS - -Get all the repositories in your Visual Studio Team Services or Team Foundation Server account, or a specific project. - -## SYNTAX - -## DESCRIPTION - -Get-VSTeamGitRepository gets all the repositories in your Visual Studio Team Services or Team Foundation Server account, or a specific project. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamGitRepository -``` - -This command returns all the Git repositories for your TFS or Team Services account. - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamGitRepository -ProjectName Demo -``` - -This command returns all the Git repositories for the Demo team project. - -### -------------------------- EXAMPLE 3 -------------------------- - -```PowerShell -PS C:\> git clone (Get-VSTeamGitRepository | select -ExpandProperty remoteUrl) -``` - -This command gets the remote URL and passes it to git clone command. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies one or more repositories by ID. - -To specify multiple IDs, use commas to separate the IDs. - -To find the ID of a repository, type Get-VSTeamGitRepository. - -```yaml -Type: Guid[] -Parameter Sets: ByID -Aliases: RepositoryID -Accept pipeline input: true (ByPropertyName) -``` - -### -Name - -Specifies one or more repositories by name. - -To specify multiple names, use commas to separate the names. - -To find the name of a repository, type Get-VSTeamGitRepository. - -```yaml -Type: String[] -Parameter Sets: ByName -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Get-VSTeamGitRepository + +## SYNOPSIS + +Get all the repositories in your Visual Studio Team Services or Team Foundation Server account, or a specific project. + +## SYNTAX + +## DESCRIPTION + +Get-VSTeamGitRepository gets all the repositories in your Visual Studio Team Services or Team Foundation Server account, or a specific project. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamGitRepository +``` + +This command returns all the Git repositories for your TFS or Team Services account. + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamGitRepository -ProjectName Demo +``` + +This command returns all the Git repositories for the Demo team project. + +### -------------------------- EXAMPLE 3 -------------------------- + +```PowerShell +PS C:\> git clone (Get-VSTeamGitRepository | select -ExpandProperty remoteUrl) +``` + +This command gets the remote URL and passes it to git clone command. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies one or more repositories by ID. + +To specify multiple IDs, use commas to separate the IDs. + +To find the ID of a repository, type Get-VSTeamGitRepository. + +```yaml +Type: Guid[] +Parameter Sets: ByID +Aliases: RepositoryID +Accept pipeline input: true (ByPropertyName) +``` + +### -Name + +Specifies one or more repositories by name. + +To specify multiple names, use commas to separate the names. + +To find the name of a repository, type Get-VSTeamGitRepository. + +```yaml +Type: String[] +Parameter Sets: ByName +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-VSTeamGroup.md b/docs/Get-VSTeamGroup.md index 7d8e5104b..70d193c26 100644 --- a/docs/Get-VSTeamGroup.md +++ b/docs/Get-VSTeamGroup.md @@ -1,77 +1,77 @@ - - -# Get-VSTeamGroup - -## SYNOPSIS - -Returns a Group or List of Groups. - -## SYNTAX - -## DESCRIPTION - -Returns a Group or List of Groups. - -## EXAMPLES - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -SubjectTypes - -A comma separated list of user subject subtypes to reduce the retrieved results. -Valid subject types: - -- vssgp (Azure DevOps Group) -- aadgp (Azure Active Directory Group) - -```yaml -Type: String[] -Required: False -Parameter Sets: List, ListByProjectName -``` - -### -ScopeDescriptor - -Specify a non-default scope (collection, project) to search for groups. - -```yaml -Type: String -Required: False -Parameter Sets: List -``` - -### -Descriptor - -The descriptor of the desired graph group. - -```yaml -Type: String -Required: False -Parameter Sets: ByGroupDescriptor -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Get-VSTeamGroup + +## SYNOPSIS + +Returns a Group or List of Groups. + +## SYNTAX + +## DESCRIPTION + +Returns a Group or List of Groups. + +## EXAMPLES + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -SubjectTypes + +A comma separated list of user subject subtypes to reduce the retrieved results. +Valid subject types: + +- vssgp (Azure DevOps Group) +- aadgp (Azure Active Directory Group) + +```yaml +Type: String[] +Required: False +Parameter Sets: List, ListByProjectName +``` + +### -ScopeDescriptor + +Specify a non-default scope (collection, project) to search for groups. + +```yaml +Type: String +Required: False +Parameter Sets: List +``` + +### -Descriptor + +The descriptor of the desired graph group. + +```yaml +Type: String +Required: False +Parameter Sets: ByGroupDescriptor +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-VSTeamInfo.md b/docs/Get-VSTeamInfo.md index f13da9aa8..8ca5b9b91 100644 --- a/docs/Get-VSTeamInfo.md +++ b/docs/Get-VSTeamInfo.md @@ -1,37 +1,37 @@ - - -# Get-VSTeamInfo - -## SYNOPSIS - -Displays your current account and default project. - -## SYNTAX - -## DESCRIPTION - -Displays your current account and default project. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamInfo -``` - -This will display your current account and default project - -## PARAMETERS - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) + + +# Get-VSTeamInfo + +## SYNOPSIS + +Displays your current account and default project. + +## SYNTAX + +## DESCRIPTION + +Displays your current account and default project. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamInfo +``` + +This will display your current account and default project + +## PARAMETERS + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) diff --git a/docs/Get-VSTeamMember.md b/docs/Get-VSTeamMember.md index 9b7398777..ba726863a 100644 --- a/docs/Get-VSTeamMember.md +++ b/docs/Get-VSTeamMember.md @@ -1,73 +1,73 @@ - - -# Get-VSTeamMember - -## SYNOPSIS - -Returns a team member. - -## SYNTAX - -## DESCRIPTION - -Returns a team member. - -## EXAMPLES - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Skip - -The number of items to skip. - -```yaml -Type: Int32 -``` - -### -TeamId - -The id of the team to search. - -```yaml -Type: String -Aliases: name -Required: True -Position: 2 -Accept pipeline input: true (ByPropertyName) -``` - -### -Top - -Specifies the maximum number to return. - -```yaml -Type: Int32 -``` - -## INPUTS - -## OUTPUTS - -### Team.Team - -## NOTES - -## RELATED LINKS + + +# Get-VSTeamMember + +## SYNOPSIS + +Returns a team member. + +## SYNTAX + +## DESCRIPTION + +Returns a team member. + +## EXAMPLES + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Skip + +The number of items to skip. + +```yaml +Type: Int32 +``` + +### -TeamId + +The id of the team to search. + +```yaml +Type: String +Aliases: name +Required: True +Position: 2 +Accept pipeline input: true (ByPropertyName) +``` + +### -Top + +Specifies the maximum number to return. + +```yaml +Type: Int32 +``` + +## INPUTS + +## OUTPUTS + +### Team.Team + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-VSTeamOption.md b/docs/Get-VSTeamOption.md index 8d8357cb1..fe7c0e1a2 100644 --- a/docs/Get-VSTeamOption.md +++ b/docs/Get-VSTeamOption.md @@ -1,74 +1,74 @@ - - -# Get-VSTeamOption - -## SYNOPSIS - -Returns all the versions of supported APIs of your TFS or VSTS. - -## SYNTAX - -## DESCRIPTION - -Returns all the versions of supported APIs of your TFS or VSTS. - -There are two table formats defined for the Team.Option type, Default and Versions. - -Default view contains Name, Area, Max Version and URI Template. - -Version view contains Name, Area, Min Version, Max Version, Released Version and Resource Version. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamOption -``` - -This will display all the versions of supported APIs for your account using the 'Default' table format. - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamOption | Format-Table -View Versions -``` - -This will display all the versions of supported APIs for your account using the 'Versions' custom table format. - -### -------------------------- EXAMPLE 3 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamOption -SubDomain vsrm -``` - -This will display all the versions of supported APIs for the release management service. - -## PARAMETERS - -### -SubDomain - -Returns options for that sub domain APIs. Some examples include: - -- vsaex = Member Entitlement Management -- feeds = Artifacts -- vsrm = Release Management -- vssps = Graph -- extmgmt = Extensions - -```yaml -Type: String -Required: false -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) + + +# Get-VSTeamOption + +## SYNOPSIS + +Returns all the versions of supported APIs of your TFS or VSTS. + +## SYNTAX + +## DESCRIPTION + +Returns all the versions of supported APIs of your TFS or VSTS. + +There are two table formats defined for the Team.Option type, Default and Versions. + +Default view contains Name, Area, Max Version and URI Template. + +Version view contains Name, Area, Min Version, Max Version, Released Version and Resource Version. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamOption +``` + +This will display all the versions of supported APIs for your account using the 'Default' table format. + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamOption | Format-Table -View Versions +``` + +This will display all the versions of supported APIs for your account using the 'Versions' custom table format. + +### -------------------------- EXAMPLE 3 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamOption -SubDomain vsrm +``` + +This will display all the versions of supported APIs for the release management service. + +## PARAMETERS + +### -SubDomain + +Returns options for that sub domain APIs. Some examples include: + +- vsaex = Member Entitlement Management +- feeds = Artifacts +- vsrm = Release Management +- vssps = Graph +- extmgmt = Extensions + +```yaml +Type: String +Required: false +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) diff --git a/docs/Get-VSTeamPolicy.md b/docs/Get-VSTeamPolicy.md index 73f536d1e..7f488b44d 100644 --- a/docs/Get-VSTeamPolicy.md +++ b/docs/Get-VSTeamPolicy.md @@ -1,77 +1,77 @@ - - -# Get-VSTeamPolicy - -## SYNOPSIS - -Get the code policies in the specified Visual Studio Team Services or Team Foundation Server project. - -## SYNTAX - -## DESCRIPTION - -Get the code policies in the specified Visual Studio Team Services or Team Foundation Server project. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamPolicy -ProjectName Demo -``` - -This command returns all the policies for the Demo project in your TFS or Team Services account. - -### -------------------------- EXAMPLE 3 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamPolicy -ProjectName Demo -Id 1 -``` - -This command gets the policy with an id of 1 within the Demo project. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies one code policy by id. - -The id is an integer. Unique within each project. - -```yaml -Type: Int -Parameter Sets: ByID -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-VSTeamPolicy](Add-VSTeamPolicy.md) - -[Remove-VSTeamPolicy](Remove-VSTeamPolicy.md) - -[Get-VSTeamPolicyType](Get-VSTeamPolicyType.md) + + +# Get-VSTeamPolicy + +## SYNOPSIS + +Get the code policies in the specified Visual Studio Team Services or Team Foundation Server project. + +## SYNTAX + +## DESCRIPTION + +Get the code policies in the specified Visual Studio Team Services or Team Foundation Server project. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamPolicy -ProjectName Demo +``` + +This command returns all the policies for the Demo project in your TFS or Team Services account. + +### -------------------------- EXAMPLE 3 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamPolicy -ProjectName Demo -Id 1 +``` + +This command gets the policy with an id of 1 within the Demo project. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies one code policy by id. + +The id is an integer. Unique within each project. + +```yaml +Type: Int +Parameter Sets: ByID +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Add-VSTeamPolicy](Add-VSTeamPolicy.md) + +[Remove-VSTeamPolicy](Remove-VSTeamPolicy.md) + +[Get-VSTeamPolicyType](Get-VSTeamPolicyType.md) diff --git a/docs/Get-VSTeamPolicyType.md b/docs/Get-VSTeamPolicyType.md index 2b77532a4..a895f24b8 100644 --- a/docs/Get-VSTeamPolicyType.md +++ b/docs/Get-VSTeamPolicyType.md @@ -1,74 +1,74 @@ - - -# Get-VSTeamPolicyType - -## SYNOPSIS - -Get the policy types in the specified Visual Studio Team Services or Team Foundation Server project. - -## SYNTAX - -## DESCRIPTION - -Get the policy types in the specified Visual Studio Team Services or Team Foundation Server project. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamPolicyType -ProjectName Demo -``` - -This command returns all the policy types for the Demo project. - -### -------------------------- EXAMPLE 3 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamPolicyType -ProjectName Demo -Id 73da726a-8ff9-44d7-8caa-cbb581eac991 -``` - -This command gets the policy type by the specified id within the Demo project. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies one policy type by id. - -```yaml -Type: Guid[] -Parameter Sets: ByID -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-VSTeamPolicy](Add-VSTeamPolicy.md) - -[Remove-VSTeamPolicy](Remove-VSTeamPolicy.md) - -[Get-VSTeamPolicy](Get-VSTeamPolicy.md) + + +# Get-VSTeamPolicyType + +## SYNOPSIS + +Get the policy types in the specified Visual Studio Team Services or Team Foundation Server project. + +## SYNTAX + +## DESCRIPTION + +Get the policy types in the specified Visual Studio Team Services or Team Foundation Server project. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamPolicyType -ProjectName Demo +``` + +This command returns all the policy types for the Demo project. + +### -------------------------- EXAMPLE 3 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamPolicyType -ProjectName Demo -Id 73da726a-8ff9-44d7-8caa-cbb581eac991 +``` + +This command gets the policy type by the specified id within the Demo project. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies one policy type by id. + +```yaml +Type: Guid[] +Parameter Sets: ByID +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Add-VSTeamPolicy](Add-VSTeamPolicy.md) + +[Remove-VSTeamPolicy](Remove-VSTeamPolicy.md) + +[Get-VSTeamPolicy](Get-VSTeamPolicy.md) diff --git a/docs/Get-VSTeamPool.md b/docs/Get-VSTeamPool.md index dd3bd9ac8..2929aea46 100644 --- a/docs/Get-VSTeamPool.md +++ b/docs/Get-VSTeamPool.md @@ -1,43 +1,43 @@ - - -# Get-VSTeamPool - -## SYNOPSIS - -Returns the agent pools. - -## SYNTAX - -## DESCRIPTION - -Returns the agent pools. - -## EXAMPLES - -## PARAMETERS - -### -Id - -Id of the pool to return. - -```yaml -Type: int -Parameter Sets: ByID -Aliases: PoolID -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS + + +# Get-VSTeamPool + +## SYNOPSIS + +Returns the agent pools. + +## SYNTAX + +## DESCRIPTION + +Returns the agent pools. + +## EXAMPLES + +## PARAMETERS + +### -Id + +Id of the pool to return. + +```yaml +Type: int +Parameter Sets: ByID +Aliases: PoolID +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-VSTeamProcess.md b/docs/Get-VSTeamProcess.md index 526a7397d..e99a8d483 100644 --- a/docs/Get-VSTeamProcess.md +++ b/docs/Get-VSTeamProcess.md @@ -1,94 +1,94 @@ - - -# Get-VSTeamProcess - -## SYNOPSIS - -Returns a list of process templates in the Team Services or Team Foundation Server account. - -## SYNTAX - -## DESCRIPTION - -The list of Process Templates returned can be controlled by using the top and skip parameters. - -You can also get a single Process Template by name or id. - -You must call Set-VSTeamAccount before calling this function. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamProcess -``` - -This will return all the Process Templates - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamProcess -top 5 | Format-Wide -``` - -This will return the top five Process Templates only showing their name - -## PARAMETERS - -### -Name - -Specifies the process template name for which this function operates. - -You can tab complete from a list of available process templates. - -```yaml -Type: String -Required: true -Position: 0 -Accept pipeline input: true (ByPropertyName) -``` - -### -Top - -Specifies the maximum number to return. - -```yaml -Type: Int32 -Parameter Sets: List -Default value: 100 -``` - -### -Skip - -Defines the number of Process Templates to skip. The default value is 0 - -```yaml -Type: Int32 -Parameter Sets: List -Default value: 0 -``` - -### -Id - -The id of the Process Template to return. - -```yaml -Type: String -Parameter Sets: ByID -Aliases: ProcessID -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Add-VSTeamProject](Add-VSTeamProject.md) + + +# Get-VSTeamProcess + +## SYNOPSIS + +Returns a list of process templates in the Team Services or Team Foundation Server account. + +## SYNTAX + +## DESCRIPTION + +The list of Process Templates returned can be controlled by using the top and skip parameters. + +You can also get a single Process Template by name or id. + +You must call Set-VSTeamAccount before calling this function. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamProcess +``` + +This will return all the Process Templates + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamProcess -top 5 | Format-Wide +``` + +This will return the top five Process Templates only showing their name + +## PARAMETERS + +### -Name + +Specifies the process template name for which this function operates. + +You can tab complete from a list of available process templates. + +```yaml +Type: String +Required: true +Position: 0 +Accept pipeline input: true (ByPropertyName) +``` + +### -Top + +Specifies the maximum number to return. + +```yaml +Type: Int32 +Parameter Sets: List +Default value: 100 +``` + +### -Skip + +Defines the number of Process Templates to skip. The default value is 0 + +```yaml +Type: Int32 +Parameter Sets: List +Default value: 0 +``` + +### -Id + +The id of the Process Template to return. + +```yaml +Type: String +Parameter Sets: ByID +Aliases: ProcessID +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Add-VSTeamProject](Add-VSTeamProject.md) diff --git a/docs/Get-VSTeamProfile.md b/docs/Get-VSTeamProfile.md index c922d090f..50b532ff7 100644 --- a/docs/Get-VSTeamProfile.md +++ b/docs/Get-VSTeamProfile.md @@ -1,57 +1,57 @@ - - -# Get-VSTeamProfile - -## SYNOPSIS - -Returns the saved profiles. - -## SYNTAX - -## DESCRIPTION - -Returns the saved profiles. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamProfile -``` - -Return the list of saved profiles - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamProfile -Name mydemos -``` - -Will return details of the profile provided - -## PARAMETERS - -### -Name - -Optional name for the profile. - -```yaml -Type: String -Parameter Sets: All -Required: True -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Add-VSTeamProfile](Add-VSTeamProfile.md) + + +# Get-VSTeamProfile + +## SYNOPSIS + +Returns the saved profiles. + +## SYNTAX + +## DESCRIPTION + +Returns the saved profiles. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamProfile +``` + +Return the list of saved profiles + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamProfile -Name mydemos +``` + +Will return details of the profile provided + +## PARAMETERS + +### -Name + +Optional name for the profile. + +```yaml +Type: String +Parameter Sets: All +Required: True +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Add-VSTeamProfile](Add-VSTeamProfile.md) diff --git a/docs/Get-VSTeamProject.md b/docs/Get-VSTeamProject.md index 2aacec741..871c33f10 100644 --- a/docs/Get-VSTeamProject.md +++ b/docs/Get-VSTeamProject.md @@ -1,124 +1,124 @@ - - -# Get-VSTeamProject - -## SYNOPSIS - -Returns a list of projects in the Team Services or Team Foundation Server account. - -## SYNTAX - -## DESCRIPTION - -The list of projects returned can be controlled by using the stateFilter, top and skip parameters. - -You can also get a single project by name or id. - -You must call Set-VSTeamAccount before calling this function. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamProject -``` - -This will return all the WellFormed team projects. - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamProject -top 5 | Format-Wide -``` - -This will return the top five WellFormed team projects only showing their name - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -StateFilter - -Returns team projects in a specific team project state. The acceptable values for this parameter are: - -- WellFormed -- CreatePending -- Deleting -- New -- All - -```yaml -Type: String -Parameter Sets: List -Default value: WellFormed -``` - -### -Top - -Specifies the maximum number to return. - -```yaml -Type: Int32 -Parameter Sets: List -Default value: 100 -``` - -### -Skip - -Defines the number of team projects to skip. The default value is 0 - -```yaml -Type: Int32 -Parameter Sets: List -Default value: 0 -``` - -### -Id - -The id of the project to return. - -```yaml -Type: String -Parameter Sets: ByID -Aliases: ProjectID -``` - -### -IncludeCapabilities - -Will return additional information about the project. - -```yaml -Type: SwitchParameter -Parameter Sets: ByID -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Add-VSTeamProject](Add-VSTeamProject.md) - -[Remove-VSTeamProject](Remove-VSTeamProject.md) + + +# Get-VSTeamProject + +## SYNOPSIS + +Returns a list of projects in the Team Services or Team Foundation Server account. + +## SYNTAX + +## DESCRIPTION + +The list of projects returned can be controlled by using the stateFilter, top and skip parameters. + +You can also get a single project by name or id. + +You must call Set-VSTeamAccount before calling this function. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamProject +``` + +This will return all the WellFormed team projects. + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamProject -top 5 | Format-Wide +``` + +This will return the top five WellFormed team projects only showing their name + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -StateFilter + +Returns team projects in a specific team project state. The acceptable values for this parameter are: + +- WellFormed +- CreatePending +- Deleting +- New +- All + +```yaml +Type: String +Parameter Sets: List +Default value: WellFormed +``` + +### -Top + +Specifies the maximum number to return. + +```yaml +Type: Int32 +Parameter Sets: List +Default value: 100 +``` + +### -Skip + +Defines the number of team projects to skip. The default value is 0 + +```yaml +Type: Int32 +Parameter Sets: List +Default value: 0 +``` + +### -Id + +The id of the project to return. + +```yaml +Type: String +Parameter Sets: ByID +Aliases: ProjectID +``` + +### -IncludeCapabilities + +Will return additional information about the project. + +```yaml +Type: SwitchParameter +Parameter Sets: ByID +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Add-VSTeamProject](Add-VSTeamProject.md) + +[Remove-VSTeamProject](Remove-VSTeamProject.md) diff --git a/docs/Get-VSTeamPullRequest.md b/docs/Get-VSTeamPullRequest.md index e2b34948c..dafd5c518 100644 --- a/docs/Get-VSTeamPullRequest.md +++ b/docs/Get-VSTeamPullRequest.md @@ -1,79 +1,79 @@ - - -# Get-VSTeamPullRequest - -## SYNOPSIS - -Returns one or more a work items from your project. - -## SYNTAX - -## DESCRIPTION - -Returns one or more a work items from your project. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamPullRequest -``` - -This command returns all the open pull requests for your TFS or Team Services account. - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamPullRequest -ProjectName Demo -``` - -This command returns all the open pull requests for the Demo team project. - -### -------------------------- EXAMPLE 3 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamPullRequest -Id 123 -``` - -This command gets the pull request with an Id of 123. - -## 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. - -```yaml -Type: String -Required: false -Position: 0 -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies the pull request by ID. - -```yaml -Type: String -Aliases: PullRequestId -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Show-VSTeamPullRequest](Show-VSTeamPullRequest.md) + + +# Get-VSTeamPullRequest + +## SYNOPSIS + +Returns one or more a work items from your project. + +## SYNTAX + +## DESCRIPTION + +Returns one or more a work items from your project. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamPullRequest +``` + +This command returns all the open pull requests for your TFS or Team Services account. + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamPullRequest -ProjectName Demo +``` + +This command returns all the open pull requests for the Demo team project. + +### -------------------------- EXAMPLE 3 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamPullRequest -Id 123 +``` + +This command gets the pull request with an Id of 123. + +## 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. + +```yaml +Type: String +Required: false +Position: 0 +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies the pull request by ID. + +```yaml +Type: String +Aliases: PullRequestId +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Show-VSTeamPullRequest](Show-VSTeamPullRequest.md) diff --git a/docs/Get-VSTeamQueue.md b/docs/Get-VSTeamQueue.md index 603908b10..f4eee4816 100644 --- a/docs/Get-VSTeamQueue.md +++ b/docs/Get-VSTeamQueue.md @@ -1,73 +1,73 @@ - - -# Get-VSTeamQueue - -## SYNOPSIS - -Gets a agent queue. - -## SYNTAX - -## DESCRIPTION - -Gets a agent queue. - -## EXAMPLES - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -QueueName - -Name of the queue to return. - -```yaml -Type: String -Parameter Sets: List -``` - -### -ActionFilter - -None, Manage or Use. - -```yaml -Type: String -Parameter Sets: List -``` - -### -Id - -Id of the queue to return. - -```yaml -Type: String -Parameter Sets: ByID -Aliases: QueueID -``` - -## INPUTS - -## OUTPUTS - -### Team.Queue - -## NOTES - -## RELATED LINKS + + +# Get-VSTeamQueue + +## SYNOPSIS + +Gets a agent queue. + +## SYNTAX + +## DESCRIPTION + +Gets a agent queue. + +## EXAMPLES + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -QueueName + +Name of the queue to return. + +```yaml +Type: String +Parameter Sets: List +``` + +### -ActionFilter + +None, Manage or Use. + +```yaml +Type: String +Parameter Sets: List +``` + +### -Id + +Id of the queue to return. + +```yaml +Type: String +Parameter Sets: ByID +Aliases: QueueID +``` + +## INPUTS + +## OUTPUTS + +### Team.Queue + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-VSTeamRelease.md b/docs/Get-VSTeamRelease.md index e1abe2f16..02f6b7e73 100644 --- a/docs/Get-VSTeamRelease.md +++ b/docs/Get-VSTeamRelease.md @@ -1,202 +1,202 @@ - - -# Get-VSTeamRelease - -## SYNOPSIS - -Gets the releases for a team project. - -## SYNTAX - -## DESCRIPTION - -The Get-VSTeamRelease function gets the releases for a team project. - -The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory. - -With just a project name, this function gets all of the releases for that team project. - -You can also specify a particular release definition by ID. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamRelease -ProjectName demo | Format-List * -``` - -This command gets a list of all releases in the demo project. - -The pipeline operator (|) passes the data to the Format-List cmdlet, which displays all available properties (*) of the release definition objects. - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamRelease -ProjectName demo -Id 10 -Raw -``` - -This command returns the raw object returned from the server. - -### -------------------------- EXAMPLE 3 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamRelease -ProjectName demo -Id 10 -Json -``` - -This command returns the raw object returned from the server formated as JSON. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Expand - -Specifies which property should be expanded in the list of Release (environments, artifacts, none). - -```yaml -Type: String -Parameter Sets: List -``` - -### -StatusFilter - -Draft, Active or Abandoned. - -```yaml -Type: String -Parameter Sets: List -``` - -### -DefinitionId - -Id of the release definition - -```yaml -Type: Int32 -Parameter Sets: List -Default value: 0 -``` - -### -Top - -Specifies the maximum number to return. - -```yaml -Type: Int32 -Parameter Sets: List -Default value: 0 -``` - -### -CreatedBy - -```yaml -Type: String -Parameter Sets: List -``` - -### -MinCreatedTime - -```yaml -Type: DateTime -Parameter Sets: List -``` - -### -MaxCreatedTime - -```yaml -Type: DateTime -Parameter Sets: List -``` - -### -QueryOrder - -```yaml -Type: String -Parameter Sets: List -``` - -### -ContinuationToken - -```yaml -Type: String -Parameter Sets: List -``` - -### -Id - -Specifies one or more releases by ID. - -To specify multiple IDs, use commas to separate the IDs. - -To find the ID of a release definition, type Get-VSTeamRelease. - -```yaml -Type: Int32[] -Parameter Sets: ByID, ByIDJson, ByIDRaw -Aliases: ReleaseID -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -JSON - -Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server. - -```yaml -Type: Switch -Required: True -Parameter Sets: ByIDJson -``` - -### -Raw - -Returns the raw response. This is required when you need to use the object to send back. Without this switch the object produced from the returned object will not match the expected shape of the JSON for sending back to server. - -```yaml -Type: Switch -Required: True -Parameter Sets: ByIDRaw -``` - -## INPUTS - -## OUTPUTS - -### Team.Release - -## NOTES - -This function has a Dynamic Parameter for ProjectName that specifies the project for which this function gets releases. - -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. - -You can pipe release definition IDs to this function. - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) - -[Add-VSTeamRelease](Add-VSTeamRelease.md) - -[Remove-VSTeamRelease](Remove-VSTeamRelease.md) + + +# Get-VSTeamRelease + +## SYNOPSIS + +Gets the releases for a team project. + +## SYNTAX + +## DESCRIPTION + +The Get-VSTeamRelease function gets the releases for a team project. + +The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory. + +With just a project name, this function gets all of the releases for that team project. + +You can also specify a particular release definition by ID. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamRelease -ProjectName demo | Format-List * +``` + +This command gets a list of all releases in the demo project. + +The pipeline operator (|) passes the data to the Format-List cmdlet, which displays all available properties (*) of the release definition objects. + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamRelease -ProjectName demo -Id 10 -Raw +``` + +This command returns the raw object returned from the server. + +### -------------------------- EXAMPLE 3 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamRelease -ProjectName demo -Id 10 -Json +``` + +This command returns the raw object returned from the server formated as JSON. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Expand + +Specifies which property should be expanded in the list of Release (environments, artifacts, none). + +```yaml +Type: String +Parameter Sets: List +``` + +### -StatusFilter + +Draft, Active or Abandoned. + +```yaml +Type: String +Parameter Sets: List +``` + +### -DefinitionId + +Id of the release definition + +```yaml +Type: Int32 +Parameter Sets: List +Default value: 0 +``` + +### -Top + +Specifies the maximum number to return. + +```yaml +Type: Int32 +Parameter Sets: List +Default value: 0 +``` + +### -CreatedBy + +```yaml +Type: String +Parameter Sets: List +``` + +### -MinCreatedTime + +```yaml +Type: DateTime +Parameter Sets: List +``` + +### -MaxCreatedTime + +```yaml +Type: DateTime +Parameter Sets: List +``` + +### -QueryOrder + +```yaml +Type: String +Parameter Sets: List +``` + +### -ContinuationToken + +```yaml +Type: String +Parameter Sets: List +``` + +### -Id + +Specifies one or more releases by ID. + +To specify multiple IDs, use commas to separate the IDs. + +To find the ID of a release definition, type Get-VSTeamRelease. + +```yaml +Type: Int32[] +Parameter Sets: ByID, ByIDJson, ByIDRaw +Aliases: ReleaseID +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -JSON + +Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server. + +```yaml +Type: Switch +Required: True +Parameter Sets: ByIDJson +``` + +### -Raw + +Returns the raw response. This is required when you need to use the object to send back. Without this switch the object produced from the returned object will not match the expected shape of the JSON for sending back to server. + +```yaml +Type: Switch +Required: True +Parameter Sets: ByIDRaw +``` + +## INPUTS + +## OUTPUTS + +### Team.Release + +## NOTES + +This function has a Dynamic Parameter for ProjectName that specifies the project for which this function gets releases. + +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. + +You can pipe release definition IDs to this function. + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + +[Add-VSTeamRelease](Add-VSTeamRelease.md) + +[Remove-VSTeamRelease](Remove-VSTeamRelease.md) diff --git a/docs/Get-VSTeamReleaseDefinition.md b/docs/Get-VSTeamReleaseDefinition.md index 9b1ab66c7..93265664b 100644 --- a/docs/Get-VSTeamReleaseDefinition.md +++ b/docs/Get-VSTeamReleaseDefinition.md @@ -1,95 +1,95 @@ - - -# Get-VSTeamReleaseDefinition - -## SYNOPSIS - -Gets the release definitions for a team project. - -## SYNTAX - -## DESCRIPTION - -The Get-VSTeamReleaseDefinition function gets the release definitions for a team project. - -The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory. - -With just a project name, this function gets all of the release definitions for that team project. - -You can also specify a particular release definition by ID. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamReleaseDefinition -ProjectName demo | Format-List * -``` - -This command gets a list of all release definitions in the demo project. - -The pipeline operator (|) passes the data to the Format-List cmdlet, which displays all available properties (*) of the release definition objects. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Expand - -Specifies which property should be expanded in the list of Release Definition (environments, artifacts, none). - -```yaml -Type: String -Parameter Sets: List -``` - -### -Id - -Specifies one or more release definitions by ID. - -To specify multiple IDs, use commas to separate the IDs. - -To find the ID of a release definition, type Get-VSTeamReleaseDefinition. - -```yaml -Type: Int32[] -Parameter Sets: ByID -Aliases: ReleaseDefinitionID -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -### Int[] - -## OUTPUTS - -### Team.ReleaseDefinition - -## NOTES - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) - -[Add-VSTeamReleaseDefinition](Add-VSTeamReleaseDefinition.md) - -[Remove-VSTeamReleaseDefinition](Remove-VSTeamReleaseDefinition.md) + + +# Get-VSTeamReleaseDefinition + +## SYNOPSIS + +Gets the release definitions for a team project. + +## SYNTAX + +## DESCRIPTION + +The Get-VSTeamReleaseDefinition function gets the release definitions for a team project. + +The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory. + +With just a project name, this function gets all of the release definitions for that team project. + +You can also specify a particular release definition by ID. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamReleaseDefinition -ProjectName demo | Format-List * +``` + +This command gets a list of all release definitions in the demo project. + +The pipeline operator (|) passes the data to the Format-List cmdlet, which displays all available properties (*) of the release definition objects. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Expand + +Specifies which property should be expanded in the list of Release Definition (environments, artifacts, none). + +```yaml +Type: String +Parameter Sets: List +``` + +### -Id + +Specifies one or more release definitions by ID. + +To specify multiple IDs, use commas to separate the IDs. + +To find the ID of a release definition, type Get-VSTeamReleaseDefinition. + +```yaml +Type: Int32[] +Parameter Sets: ByID +Aliases: ReleaseDefinitionID +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +### Int[] + +## OUTPUTS + +### Team.ReleaseDefinition + +## NOTES + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + +[Add-VSTeamReleaseDefinition](Add-VSTeamReleaseDefinition.md) + +[Remove-VSTeamReleaseDefinition](Remove-VSTeamReleaseDefinition.md) diff --git a/docs/Get-VSTeamResourceArea.md b/docs/Get-VSTeamResourceArea.md index 53ef3d36d..7a0d2d149 100644 --- a/docs/Get-VSTeamResourceArea.md +++ b/docs/Get-VSTeamResourceArea.md @@ -1,39 +1,39 @@ - - -# Get-VSTeamResourceArea - -## SYNOPSIS - -List all the areas supported by this instance of TFS/VSTS. - -## SYNTAX - -## DESCRIPTION - -List all the areas supported by this instance of TFS/VSTS. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamResourceArea -``` - -This will display all the areas of supported APIs for your account. - -## PARAMETERS - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Add-VSTeamOption](Add-VSTeamOption.md) + + +# Get-VSTeamResourceArea + +## SYNOPSIS + +List all the areas supported by this instance of TFS/VSTS. + +## SYNTAX + +## DESCRIPTION + +List all the areas supported by this instance of TFS/VSTS. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamResourceArea +``` + +This will display all the areas of supported APIs for your account. + +## PARAMETERS + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Add-VSTeamOption](Add-VSTeamOption.md) diff --git a/docs/Get-VSTeamSecurityNamespace.md b/docs/Get-VSTeamSecurityNamespace.md index e43d83b58..e7cf9d280 100644 --- a/docs/Get-VSTeamSecurityNamespace.md +++ b/docs/Get-VSTeamSecurityNamespace.md @@ -1,59 +1,59 @@ - - -# Get-VSTeamSecurityNamespace - -## SYNOPSIS - -List all security namespaces or just the specified namespace. - -## SYNTAX - -## DESCRIPTION - -List all security namespaces or just the specified namespace. - -## EXAMPLES - -## PARAMETERS - -### -Id - -Security namespace identifier. - -```yaml -Type: String -Required: False -Parameter Sets: ByNamespaceId -``` - -### -Name - -Security namespace name. - -```yaml -Type: String -Required: False -Parameter Sets: ByNamespaceName -``` - -### -LocalOnly - -If true, retrieve only local security namespaces. - -```yaml -Type: Switch -Required: False -Parameter Sets: List -``` - -## INPUTS - -## OUTPUTS - -### VSTeamSecurityNamespace - -## NOTES - -## RELATED LINKS + + +# Get-VSTeamSecurityNamespace + +## SYNOPSIS + +List all security namespaces or just the specified namespace. + +## SYNTAX + +## DESCRIPTION + +List all security namespaces or just the specified namespace. + +## EXAMPLES + +## PARAMETERS + +### -Id + +Security namespace identifier. + +```yaml +Type: String +Required: False +Parameter Sets: ByNamespaceId +``` + +### -Name + +Security namespace name. + +```yaml +Type: String +Required: False +Parameter Sets: ByNamespaceName +``` + +### -LocalOnly + +If true, retrieve only local security namespaces. + +```yaml +Type: Switch +Required: False +Parameter Sets: List +``` + +## INPUTS + +## OUTPUTS + +### VSTeamSecurityNamespace + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-VSTeamServiceEndpoint.md b/docs/Get-VSTeamServiceEndpoint.md index 3dea1e172..4d5238a1c 100644 --- a/docs/Get-VSTeamServiceEndpoint.md +++ b/docs/Get-VSTeamServiceEndpoint.md @@ -1,58 +1,58 @@ - - -# Get-VSTeamServiceEndpoint - -## SYNOPSIS - -Gets a service endpoint. - -## SYNTAX - -## DESCRIPTION - -Gets a service endpoint. - -## EXAMPLES - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Id of the service endpoint - -```yaml -Type: String -Parameter Sets: ByID -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS + + +# Get-VSTeamServiceEndpoint + +## SYNOPSIS + +Gets a service endpoint. + +## SYNTAX + +## DESCRIPTION + +Gets a service endpoint. + +## EXAMPLES + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Id of the service endpoint + +```yaml +Type: String +Parameter Sets: ByID +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-VSTeamServiceEndpointType.md b/docs/Get-VSTeamServiceEndpointType.md index ed77630a9..863f34383 100644 --- a/docs/Get-VSTeamServiceEndpointType.md +++ b/docs/Get-VSTeamServiceEndpointType.md @@ -1,51 +1,51 @@ - - -# Get-VSTeamServiceEndpointType - -## SYNOPSIS - -Get service endpoint types. - -## SYNTAX - -## DESCRIPTION - -Get service endpoint types. - -## EXAMPLES - -## PARAMETERS - -### -Type - -Name of service endpoint type to return. - -```yaml -Type: String -Parameter Sets: ByType -Accept pipeline input: true (ByPropertyName) -``` - -### -Scheme - -Scheme of service endpoint - -```yaml -Type: String -Parameter Sets: ByType -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS + + +# Get-VSTeamServiceEndpointType + +## SYNOPSIS + +Get service endpoint types. + +## SYNTAX + +## DESCRIPTION + +Get service endpoint types. + +## EXAMPLES + +## PARAMETERS + +### -Type + +Name of service endpoint type to return. + +```yaml +Type: String +Parameter Sets: ByType +Accept pipeline input: true (ByPropertyName) +``` + +### -Scheme + +Scheme of service endpoint + +```yaml +Type: String +Parameter Sets: ByType +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-VSTeamTfvcBranch.md b/docs/Get-VSTeamTfvcBranch.md index 0854b2f84..503830def 100644 --- a/docs/Get-VSTeamTfvcBranch.md +++ b/docs/Get-VSTeamTfvcBranch.md @@ -1,102 +1,102 @@ - - -# Get-VSTeamTfvcBranch - -## SYNOPSIS - -Gets a branch for a given path from TFVC source control. - -## SYNTAX - -## DESCRIPTION - -Get-VSTeamTfvcBranch gets a branch for a given path from TFVC source control. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamTfvcBranch -Path $/MyProject/MyBranch -``` - -This command returns the branch object for the path $/MyProject/MyBranch - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamTfvcBranch -Path $/MyProject/MyBranch -IncludeChildren -``` - -This command returns the branch object for the path $/MyProject/MyBranch and its child branches. - -### -------------------------- EXAMPLE 3 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamTfvcBranch -Path $/MyProject/MyBranch -IncludeParent -``` - -This command returns the branch object for the path $/MyProject/MyBranch and its parent. - -### -------------------------- EXAMPLE 4 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamTfvcBranch -Path $/MyProject/MyBranch -IncludeDeleted -``` - -This command returns the branch object for the path $/MyProject/MyBranch, even if it's marked as deleted. - -### -------------------------- EXAMPLE 5 -------------------------- - -```PowerShell -PS C:\> '$/MyProject/MyBranch','$/AnotherProject/AnotherBranch' | Get-VSTeamTfvcBranch -``` - -This command returns the branch objects for the paths $/MyProject/MyBranch and $/AnotherProject/AnotherBranch by using the pipeline. - -## PARAMETERS - -### -Path - -Full path to the branch. - -```yaml -Type: String[] -Accept pipeline input: true -``` - -### -IncludeChildren - -Return child branches, if there are any. - -```yaml -Type: SwitchParameter -``` - -### -IncludeParent - -Return the parent branch, if there is one. - -```yaml -Type: SwitchParameter -``` - -### -IncludeDeleted - -Return branches marked as deleted. - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -You can pipe paths to this function. - -## RELATED LINKS + + +# Get-VSTeamTfvcBranch + +## SYNOPSIS + +Gets a branch for a given path from TFVC source control. + +## SYNTAX + +## DESCRIPTION + +Get-VSTeamTfvcBranch gets a branch for a given path from TFVC source control. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamTfvcBranch -Path $/MyProject/MyBranch +``` + +This command returns the branch object for the path $/MyProject/MyBranch + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamTfvcBranch -Path $/MyProject/MyBranch -IncludeChildren +``` + +This command returns the branch object for the path $/MyProject/MyBranch and its child branches. + +### -------------------------- EXAMPLE 3 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamTfvcBranch -Path $/MyProject/MyBranch -IncludeParent +``` + +This command returns the branch object for the path $/MyProject/MyBranch and its parent. + +### -------------------------- EXAMPLE 4 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamTfvcBranch -Path $/MyProject/MyBranch -IncludeDeleted +``` + +This command returns the branch object for the path $/MyProject/MyBranch, even if it's marked as deleted. + +### -------------------------- EXAMPLE 5 -------------------------- + +```PowerShell +PS C:\> '$/MyProject/MyBranch','$/AnotherProject/AnotherBranch' | Get-VSTeamTfvcBranch +``` + +This command returns the branch objects for the paths $/MyProject/MyBranch and $/AnotherProject/AnotherBranch by using the pipeline. + +## PARAMETERS + +### -Path + +Full path to the branch. + +```yaml +Type: String[] +Accept pipeline input: true +``` + +### -IncludeChildren + +Return child branches, if there are any. + +```yaml +Type: SwitchParameter +``` + +### -IncludeParent + +Return the parent branch, if there is one. + +```yaml +Type: SwitchParameter +``` + +### -IncludeDeleted + +Return branches marked as deleted. + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +You can pipe paths to this function. + +## RELATED LINKS diff --git a/docs/Get-VSTeamTfvcRootBranch.md b/docs/Get-VSTeamTfvcRootBranch.md index f857fe25a..ccfa156f9 100644 --- a/docs/Get-VSTeamTfvcRootBranch.md +++ b/docs/Get-VSTeamTfvcRootBranch.md @@ -1,67 +1,67 @@ - - -# Get-VSTeamTfvcRootBranch - -## SYNOPSIS - -Gets root branches for all projects with TFVC source control. - -## SYNTAX - -## DESCRIPTION - -Get-VSTeamTfvcRootBranch gets root branches for all projects with TFVC source control. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamTfvcRootBranch -``` - -This command returns root branches for all projects. - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamTfvcRootBranch -IncludeChildren -``` - -This command returns root branches for all projects and their respective child branches. - -### -------------------------- EXAMPLE 3 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamTfvcRootBranch -IncludeDeleted -``` - -This command returns root branches for all projects, also those marked as deleted. - -## PARAMETERS - -### -IncludeChildren - -Return the child branches for each root branch. - -```yaml -Type: SwitchParameter -``` - -### -IncludeDeleted - -Return deleted branches. - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Get-VSTeamTfvcRootBranch + +## SYNOPSIS + +Gets root branches for all projects with TFVC source control. + +## SYNTAX + +## DESCRIPTION + +Get-VSTeamTfvcRootBranch gets root branches for all projects with TFVC source control. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamTfvcRootBranch +``` + +This command returns root branches for all projects. + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamTfvcRootBranch -IncludeChildren +``` + +This command returns root branches for all projects and their respective child branches. + +### -------------------------- EXAMPLE 3 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamTfvcRootBranch -IncludeDeleted +``` + +This command returns root branches for all projects, also those marked as deleted. + +## PARAMETERS + +### -IncludeChildren + +Return the child branches for each root branch. + +```yaml +Type: SwitchParameter +``` + +### -IncludeDeleted + +Return deleted branches. + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-VSTeamUser.md b/docs/Get-VSTeamUser.md index 1d7045d6a..30c42bb24 100644 --- a/docs/Get-VSTeamUser.md +++ b/docs/Get-VSTeamUser.md @@ -1,54 +1,54 @@ - - -# Get-VSTeamUser - -## SYNOPSIS - -Returns a list of users for the account. - -## SYNTAX - -## DESCRIPTION - -Returns a list of users for the account. - -## EXAMPLES - -## PARAMETERS - -### -SubjectTypes - -A comma separated list of user subject subtypes to reduce the retrieved results. -Valid subject types: - -- vss (Azure DevOps User) -- aad (Azure Active Directory User) -- svc (Azure DevOps Service Identity) -- imp (Imported Identity) -- msa (Microsoft Account) - -```yaml -Type: String[] -Required: False -Parameter Sets: List -``` - -### -Descriptor - -The descriptor of the desired graph user. - -```yaml -Type: String -Required: False -Parameter Sets: ByUserDescriptor -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Get-VSTeamUser + +## SYNOPSIS + +Returns a list of users for the account. + +## SYNTAX + +## DESCRIPTION + +Returns a list of users for the account. + +## EXAMPLES + +## PARAMETERS + +### -SubjectTypes + +A comma separated list of user subject subtypes to reduce the retrieved results. +Valid subject types: + +- vss (Azure DevOps User) +- aad (Azure Active Directory User) +- svc (Azure DevOps Service Identity) +- imp (Imported Identity) +- msa (Microsoft Account) + +```yaml +Type: String[] +Required: False +Parameter Sets: List +``` + +### -Descriptor + +The descriptor of the desired graph user. + +```yaml +Type: String +Required: False +Parameter Sets: ByUserDescriptor +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-VSTeamUserEntitlement.md b/docs/Get-VSTeamUserEntitlement.md index 15a3fc62f..e90649013 100644 --- a/docs/Get-VSTeamUserEntitlement.md +++ b/docs/Get-VSTeamUserEntitlement.md @@ -1,69 +1,69 @@ - - -# Get-VSTeamUserEntitlement - -## SYNOPSIS - -Get User Entitlement for a user. - -## SYNTAX - -## DESCRIPTION - -Get User Entitlement for a user. - -## EXAMPLES - -## PARAMETERS - -### -Skip - -The number of items to skip. - -```yaml -Type: Int32 -Parameter Sets: List -``` - -### -UserId - -The id of the user to retrieve. - -```yaml -Type: String[] -Parameter Sets: ByID -``` - -### -Top - -Specifies the maximum number to return. - -```yaml -Type: Int32 -Parameter Sets: List -``` - -### -Select - -Comma (",") separated list of properties to select in the result entitlements. The acceptable values for this parameter are: - -- Projects -- Extensions -- GroupRules - -```yaml -Type: String -Parameter Sets: List -Required: True -Default value: None -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Get-VSTeamUserEntitlement + +## SYNOPSIS + +Get User Entitlement for a user. + +## SYNTAX + +## DESCRIPTION + +Get User Entitlement for a user. + +## EXAMPLES + +## PARAMETERS + +### -Skip + +The number of items to skip. + +```yaml +Type: Int32 +Parameter Sets: List +``` + +### -UserId + +The id of the user to retrieve. + +```yaml +Type: String[] +Parameter Sets: ByID +``` + +### -Top + +Specifies the maximum number to return. + +```yaml +Type: Int32 +Parameter Sets: List +``` + +### -Select + +Comma (",") separated list of properties to select in the result entitlements. The acceptable values for this parameter are: + +- Projects +- Extensions +- GroupRules + +```yaml +Type: String +Parameter Sets: List +Required: True +Default value: None +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Get-VSTeamWorkItem.md b/docs/Get-VSTeamWorkItem.md index 105071f92..fad309c10 100644 --- a/docs/Get-VSTeamWorkItem.md +++ b/docs/Get-VSTeamWorkItem.md @@ -1,109 +1,109 @@ - - -# Get-VSTeamWorkItem - -## SYNOPSIS - -Returns one or more a work items from your project. - -## SYNTAX - -## DESCRIPTION - -Returns one or more a work items from your project. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamWorkItem -Ids 47,48 -``` - -This command gets work items with IDs 47 and 48 by using the IDs parameter. - -## PARAMETERS - -### -Id - -The id of the work item. - -```yaml -Type: Int32 -Parameter Sets: ByID -Required: True -Accept pipeline input: true (ByPropertyName, ByValue) -``` - -### -Ids - -The id of the work item. - -```yaml -Type: Int32[] -Parameter Sets: List -Required: True -Accept pipeline input: true (ByPropertyName, ByValue) -``` - -### -ErrorPolicy - -The flag to control error policy in a bulk get work items request. The acceptable values for this parameter are: - -- Fail -- Omit - -```yaml -Type: String -Parameter Sets: List -Required: True -Default value: Fail -``` - -### -Fields - -Comma-separated list of requested fields. - -```yaml -Type: String[] -``` - -### -Expand - -Comma-separated list of requested fields. The acceptable values for this parameter are: - -- None -- Relations -- Fields -- Links -- All - -```yaml -Type: String -``` - -### -AsOf - -```yaml -Type: DateTime -``` - -## INPUTS - -### System.String - -ProjectName - -WorkItemType - -## OUTPUTS - -## NOTES - -WorkItemType is a dynamic parameter and use the default project value to query their validate set. - -If you do not set the default project by called Set-VSTeamDefaultProject before calling Get-VSTeamWorkItem you will have to type in the names. - -## RELATED LINKS + + +# Get-VSTeamWorkItem + +## SYNOPSIS + +Returns one or more a work items from your project. + +## SYNTAX + +## DESCRIPTION + +Returns one or more a work items from your project. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamWorkItem -Ids 47,48 +``` + +This command gets work items with IDs 47 and 48 by using the IDs parameter. + +## PARAMETERS + +### -Id + +The id of the work item. + +```yaml +Type: Int32 +Parameter Sets: ByID +Required: True +Accept pipeline input: true (ByPropertyName, ByValue) +``` + +### -Ids + +The id of the work item. + +```yaml +Type: Int32[] +Parameter Sets: List +Required: True +Accept pipeline input: true (ByPropertyName, ByValue) +``` + +### -ErrorPolicy + +The flag to control error policy in a bulk get work items request. The acceptable values for this parameter are: + +- Fail +- Omit + +```yaml +Type: String +Parameter Sets: List +Required: True +Default value: Fail +``` + +### -Fields + +Comma-separated list of requested fields. + +```yaml +Type: String[] +``` + +### -Expand + +Comma-separated list of requested fields. The acceptable values for this parameter are: + +- None +- Relations +- Fields +- Links +- All + +```yaml +Type: String +``` + +### -AsOf + +```yaml +Type: DateTime +``` + +## INPUTS + +### System.String + +ProjectName + +WorkItemType + +## OUTPUTS + +## NOTES + +WorkItemType is a dynamic parameter and use the default project value to query their validate set. + +If you do not set the default project by called Set-VSTeamDefaultProject before calling Get-VSTeamWorkItem you will have to type in the names. + +## RELATED LINKS diff --git a/docs/Get-VSTeamWorkItemType.md b/docs/Get-VSTeamWorkItemType.md index e76674313..9adc3fd62 100644 --- a/docs/Get-VSTeamWorkItemType.md +++ b/docs/Get-VSTeamWorkItemType.md @@ -1,70 +1,70 @@ - - -# Get-VSTeamWorkItemType - -## SYNOPSIS - -Gets a list of all Work Item Types or a single work item type. - -## SYNTAX - -## Description - -Gets a list of all Work Item Types or a single work item type. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS R:\repos\vsteam> Get-WorkItemType -ProjectName test -WorkItemType 'Code Review Response' -``` - -This command gets a single work item type. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -WorkItemType - -The type of work item to retrieve. - -```yaml -Type: String -Parameter Sets: ByType -``` - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -The JSON returned has empty named items i.e. -"": "To Do" -This causes issues with the ConvertFrom-Json CmdLet. Therefore, all "": are replaced with "_end": - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) + + +# Get-VSTeamWorkItemType + +## SYNOPSIS + +Gets a list of all Work Item Types or a single work item type. + +## SYNTAX + +## Description + +Gets a list of all Work Item Types or a single work item type. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS R:\repos\vsteam> Get-WorkItemType -ProjectName test -WorkItemType 'Code Review Response' +``` + +This command gets a single work item type. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -WorkItemType + +The type of work item to retrieve. + +```yaml +Type: String +Parameter Sets: ByType +``` + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +The JSON returned has empty named items i.e. +"": "To Do" +This causes issues with the ConvertFrom-Json CmdLet. Therefore, all "": are replaced with "_end": + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) diff --git a/docs/Invoke-VSTeamRequest.md b/docs/Invoke-VSTeamRequest.md index 1c75959e4..d7d732dcb 100644 --- a/docs/Invoke-VSTeamRequest.md +++ b/docs/Invoke-VSTeamRequest.md @@ -1,173 +1,173 @@ - - -# Invoke-VSTeamRequest - -## SYNOPSIS - -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. - -## SYNTAX - -## DESCRIPTION - -Invoke-VSTeamRequest allows you to call a TFS/VSTS REST API much easier than using Invoke-WebRequest directly. The shape of the URI and authentication is all handled for you. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Invoke-VSTeamRequest -resource projectHistory -version '4.1-preview' -Verbose -``` - -This command will return the project history. - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> ivr -area release -resource releases -version '4.1-preview' -subDomain vsrm -Verbose -``` - -This command will return the releases for a project. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -ContentType - -Specifies the content type of the request. - -If this parameter is omitted and the request method is POST, the content type will be set to application/json. - -Otherwise, the content type is not specified in the call. - -```yaml -Type: String -Default value: application/json -``` - -### -Method - -Specifies the method used for the request. The acceptable values for this parameter are: - -- Get -- Post -- Patch -- Delete -- Options -- Put -- Default -- Trace -- Head -- Merge - -```yaml -Type: String -Default value: Get -``` - -### -Body - -Specifies the body of the request. The body is the content of the request that follows the headers. You can also pipe a body value to Invoke-VSTeamRequest. - -The Body parameter can be used to specify a list of query parameters or specify the content of the response. - -When the input is a GET request and the body is an IDictionary (typically, a hash table), the body is added to the URI as query parameters. For other GET requests, the body is set as the value of the request body in the standard name=value format. - -```yaml -Type: Object -Accept pipeline input: true (ByValue) -``` - -### -InFile - -Path and file name to the file that contains the contents of the request. If the path is omitted, the default is the current location. - -```yaml -Type: String -``` - -### -OutFile - -Specifies the output file for which this function saves the response body. Enter a path and file name. If you omit the path, the default is the current location. - -```yaml -Type: String -``` - -### -Area - -The area to find the resource. - -```yaml -Type: String -``` - -### -Resource - -The name of the feature you want to manipulate. - -```yaml -Type: String -``` - -### -Id - -The unique value of the item you want to work with. - -```yaml -Type: String -``` - -### -Version - -The version of the API you wish to target. - -```yaml -Type: String -``` - -### -SubDomain - -The SubDomain before .dev.azure.com. For example, to target Release Management you must use the SubDomain vsrm. - -```yaml -Type: String -``` - -### -JSON - -Converts the PowerShell object into JSON and displays in the console. - -```yaml -Type: Switch -``` - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS + + +# Invoke-VSTeamRequest + +## SYNOPSIS + +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. + +## SYNTAX + +## DESCRIPTION + +Invoke-VSTeamRequest allows you to call a TFS/VSTS REST API much easier than using Invoke-WebRequest directly. The shape of the URI and authentication is all handled for you. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Invoke-VSTeamRequest -resource projectHistory -version '4.1-preview' -Verbose +``` + +This command will return the project history. + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> ivr -area release -resource releases -version '4.1-preview' -subDomain vsrm -Verbose +``` + +This command will return the releases for a project. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -ContentType + +Specifies the content type of the request. + +If this parameter is omitted and the request method is POST, the content type will be set to application/json. + +Otherwise, the content type is not specified in the call. + +```yaml +Type: String +Default value: application/json +``` + +### -Method + +Specifies the method used for the request. The acceptable values for this parameter are: + +- Get +- Post +- Patch +- Delete +- Options +- Put +- Default +- Trace +- Head +- Merge + +```yaml +Type: String +Default value: Get +``` + +### -Body + +Specifies the body of the request. The body is the content of the request that follows the headers. You can also pipe a body value to Invoke-VSTeamRequest. + +The Body parameter can be used to specify a list of query parameters or specify the content of the response. + +When the input is a GET request and the body is an IDictionary (typically, a hash table), the body is added to the URI as query parameters. For other GET requests, the body is set as the value of the request body in the standard name=value format. + +```yaml +Type: Object +Accept pipeline input: true (ByValue) +``` + +### -InFile + +Path and file name to the file that contains the contents of the request. If the path is omitted, the default is the current location. + +```yaml +Type: String +``` + +### -OutFile + +Specifies the output file for which this function saves the response body. Enter a path and file name. If you omit the path, the default is the current location. + +```yaml +Type: String +``` + +### -Area + +The area to find the resource. + +```yaml +Type: String +``` + +### -Resource + +The name of the feature you want to manipulate. + +```yaml +Type: String +``` + +### -Id + +The unique value of the item you want to work with. + +```yaml +Type: String +``` + +### -Version + +The version of the API you wish to target. + +```yaml +Type: String +``` + +### -SubDomain + +The SubDomain before .dev.azure.com. For example, to target Release Management you must use the SubDomain vsrm. + +```yaml +Type: String +``` + +### -JSON + +Converts the PowerShell object into JSON and displays in the console. + +```yaml +Type: Switch +``` + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/docs/Remove-VSTeam.md b/docs/Remove-VSTeam.md index 943d837d8..4f0b5789a 100644 --- a/docs/Remove-VSTeam.md +++ b/docs/Remove-VSTeam.md @@ -1,81 +1,81 @@ - - -# Remove-VSTeam - -## SYNOPSIS - -Removes a team from a project. - -## SYNTAX - -## DESCRIPTION - -Removes a team from a project. - -## EXAMPLES - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -TeamId - -The id of the team to remove. - -```yaml -Type: String -Aliases: name -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Aliases: cf -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Aliases: wi -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Remove-VSTeam + +## SYNOPSIS + +Removes a team from a project. + +## SYNTAX + +## DESCRIPTION + +Removes a team from a project. + +## EXAMPLES + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -TeamId + +The id of the team to remove. + +```yaml +Type: String +Aliases: name +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Aliases: cf +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Aliases: wi +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Remove-VSTeamAccessControlList.md b/docs/Remove-VSTeamAccessControlList.md index 5792f1c2a..618328047 100644 --- a/docs/Remove-VSTeamAccessControlList.md +++ b/docs/Remove-VSTeamAccessControlList.md @@ -1,65 +1,65 @@ - - -# Remove-VSTeamAccessControlList - -## SYNOPSIS - -Remove access control lists under the specified security namespace. - -## SYNTAX - -## DESCRIPTION - -Remove access control lists under the specified security namespace. - -## EXAMPLES - -## PARAMETERS - -### -SecurityNamespace - -Security namespace identifier. - -```yaml -Type: VSTeamSecurityNamespace -Required: True -``` - -### -SecurityNamespaceId - -Security namespace identifier. - -```yaml -Type: String -Required: True -``` - -### -Tokens - -One or more comma-separated security tokens - -```yaml -Type: String -Required: True -``` - -### -Recurse - -If true and this is a hierarchical namespace, also remove child ACLs of the specified tokens. - -```yaml -Type: Switch -Required: True -``` - -## INPUTS - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS + + +# Remove-VSTeamAccessControlList + +## SYNOPSIS + +Remove access control lists under the specified security namespace. + +## SYNTAX + +## DESCRIPTION + +Remove access control lists under the specified security namespace. + +## EXAMPLES + +## PARAMETERS + +### -SecurityNamespace + +Security namespace identifier. + +```yaml +Type: VSTeamSecurityNamespace +Required: True +``` + +### -SecurityNamespaceId + +Security namespace identifier. + +```yaml +Type: String +Required: True +``` + +### -Tokens + +One or more comma-separated security tokens + +```yaml +Type: String +Required: True +``` + +### -Recurse + +If true and this is a hierarchical namespace, also remove child ACLs of the specified tokens. + +```yaml +Type: Switch +Required: True +``` + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/docs/Remove-VSTeamAccount.md b/docs/Remove-VSTeamAccount.md index a24f05761..95b494f09 100644 --- a/docs/Remove-VSTeamAccount.md +++ b/docs/Remove-VSTeamAccount.md @@ -1,55 +1,55 @@ - - -# Remove-VSTeamAccount - -## SYNOPSIS - -Clears your default project, account name and personal access token. - -## SYNTAX - -## DESCRIPTION - -Clears the environment variables that hold your default project, account, bearer token and personal access token. You have to run Set-VSTeamAccount again before calling any other functions. - -To remove from the Machine level you must be running PowerShell as administrator. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Remove-VSTeamAccount -``` - -This will clear your account name and personal access token. - -## PARAMETERS - -### -Level - -On Windows allows you to clear your account information at the Process, User or Machine levels. - -```yaml -Type: String -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) + + +# Remove-VSTeamAccount + +## SYNOPSIS + +Clears your default project, account name and personal access token. + +## SYNTAX + +## DESCRIPTION + +Clears the environment variables that hold your default project, account, bearer token and personal access token. You have to run Set-VSTeamAccount again before calling any other functions. + +To remove from the Machine level you must be running PowerShell as administrator. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Remove-VSTeamAccount +``` + +This will clear your account name and personal access token. + +## PARAMETERS + +### -Level + +On Windows allows you to clear your account information at the Process, User or Machine levels. + +```yaml +Type: String +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) diff --git a/docs/Remove-VSTeamAgent.md b/docs/Remove-VSTeamAgent.md index e7a9f15d0..f6969dad0 100644 --- a/docs/Remove-VSTeamAgent.md +++ b/docs/Remove-VSTeamAgent.md @@ -1,58 +1,58 @@ - - -# Remove-VSTeamAgent - -## SYNOPSIS - -Removes an agent from a pool. - -## SYNTAX - -## DESCRIPTION - -Removes an agent from a pool. - -## EXAMPLES - -## PARAMETERS - -### -PoolId - -Id of the pool. - -```yaml -Type: int -Required: True -Accept pipeline input: true (ByValue) -``` - -### -Id - -Id of the agent to remove. - -```yaml -Type: int[] -Aliases: AgentID -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -### System.String - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Remove-VSTeamAgent + +## SYNOPSIS + +Removes an agent from a pool. + +## SYNTAX + +## DESCRIPTION + +Removes an agent from a pool. + +## EXAMPLES + +## PARAMETERS + +### -PoolId + +Id of the pool. + +```yaml +Type: int +Required: True +Accept pipeline input: true (ByValue) +``` + +### -Id + +Id of the agent to remove. + +```yaml +Type: int[] +Aliases: AgentID +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +### System.String + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Remove-VSTeamBuild.md b/docs/Remove-VSTeamBuild.md index bd6488d7f..4367b6962 100644 --- a/docs/Remove-VSTeamBuild.md +++ b/docs/Remove-VSTeamBuild.md @@ -1,75 +1,75 @@ - - -# Remove-VSTeamBuild - -## SYNOPSIS - -Deletes the build. - -## SYNTAX - -## DESCRIPTION - -Deletes the build. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamBuild | Remove-VSTeamBuild -Force -``` - -This command will delete all builds that are not marked retain indefinitely. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies one or more builds by ID. - -To specify multiple IDs, use commas to separate the IDs. - -To find the ID of a build, type Get-VSTeamBuild. - -```yaml -Type: Int32[] -Aliases: BuildID -Accept pipeline input: true (ByPropertyName, ByValue) -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS + + +# Remove-VSTeamBuild + +## SYNOPSIS + +Deletes the build. + +## SYNTAX + +## DESCRIPTION + +Deletes the build. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamBuild | Remove-VSTeamBuild -Force +``` + +This command will delete all builds that are not marked retain indefinitely. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies one or more builds by ID. + +To specify multiple IDs, use commas to separate the IDs. + +To find the ID of a build, type Get-VSTeamBuild. + +```yaml +Type: Int32[] +Aliases: BuildID +Accept pipeline input: true (ByPropertyName, ByValue) +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/docs/Remove-VSTeamBuildDefinition.md b/docs/Remove-VSTeamBuildDefinition.md index 3773b98e1..7f26272de 100644 --- a/docs/Remove-VSTeamBuildDefinition.md +++ b/docs/Remove-VSTeamBuildDefinition.md @@ -1,95 +1,95 @@ - - -# Remove-VSTeamBuildDefinition - -## SYNOPSIS - -Removes the build definitions for a team project. - -## SYNTAX - -## DESCRIPTION - -The Remove-VSTeamBuildDefinition function removes the build definitions for a team project. - -The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamBuildDefinition -ProjectName Demo | Remove-VSTeamBuildDefinition -``` - -This command gets a list of all build definitions in the demo project. - -The pipeline operator (|) passes the data to the Remove-VSTeamBuildDefinition function, which removes each build definition object. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies one or more build definitions by ID. - -To specify multiple IDs, use commas to separate the IDs. - -To find the ID of a build definition, type Get-VSTeamBuildDefinition. - -```yaml -Type: Int32[] -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -### None - -## NOTES - -This function has a Dynamic Parameter for ProjectName that specifies the project for which this function gets build definitions. - -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. - -You can pipe build definition IDs to this function. - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) - -[Add-VSTeamBuildDefinition](Add-VSTeamBuildDefinition.md) - -[Get-VSTeamBuildDefinition](Get-VSTeamBuildDefinition.md) + + +# Remove-VSTeamBuildDefinition + +## SYNOPSIS + +Removes the build definitions for a team project. + +## SYNTAX + +## DESCRIPTION + +The Remove-VSTeamBuildDefinition function removes the build definitions for a team project. + +The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamBuildDefinition -ProjectName Demo | Remove-VSTeamBuildDefinition +``` + +This command gets a list of all build definitions in the demo project. + +The pipeline operator (|) passes the data to the Remove-VSTeamBuildDefinition function, which removes each build definition object. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies one or more build definitions by ID. + +To specify multiple IDs, use commas to separate the IDs. + +To find the ID of a build definition, type Get-VSTeamBuildDefinition. + +```yaml +Type: Int32[] +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +### None + +## NOTES + +This function has a Dynamic Parameter for ProjectName that specifies the project for which this function gets build definitions. + +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. + +You can pipe build definition IDs to this function. + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + +[Add-VSTeamBuildDefinition](Add-VSTeamBuildDefinition.md) + +[Get-VSTeamBuildDefinition](Get-VSTeamBuildDefinition.md) diff --git a/docs/Remove-VSTeamBuildTag.md b/docs/Remove-VSTeamBuildTag.md index 9f604838f..b1d0ae0c4 100644 --- a/docs/Remove-VSTeamBuildTag.md +++ b/docs/Remove-VSTeamBuildTag.md @@ -1,95 +1,95 @@ - - -# Remove-VSTeamBuildTag - -## SYNOPSIS - -Removes the tag from a build. - -## SYNTAX - -## DESCRIPTION - -Removes the tag from a build. - -## EXAMPLES - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies one or more builds by ID. - -To specify multiple IDs, use commas to separate the IDs. - -To find the ID of a build, type Get-VSTeamBuild. - -```yaml -Type: Int32[] -Aliases: BuildID -Accept pipeline input: true (ByPropertyName, ByValue) -``` - -### -Tags - -One or more tags. To specify multiple, use commas to separate. - -```yaml -Type: String[] -Required: True -Position: 1 -Accept pipeline input: true (ByPropertyName, ByValue) -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Aliases: cf -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Aliases: wi -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Remove-VSTeamBuildTag + +## SYNOPSIS + +Removes the tag from a build. + +## SYNTAX + +## DESCRIPTION + +Removes the tag from a build. + +## EXAMPLES + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies one or more builds by ID. + +To specify multiple IDs, use commas to separate the IDs. + +To find the ID of a build, type Get-VSTeamBuild. + +```yaml +Type: Int32[] +Aliases: BuildID +Accept pipeline input: true (ByPropertyName, ByValue) +``` + +### -Tags + +One or more tags. To specify multiple, use commas to separate. + +```yaml +Type: String[] +Required: True +Position: 1 +Accept pipeline input: true (ByPropertyName, ByValue) +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Aliases: cf +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Aliases: wi +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Remove-VSTeamExtension.md b/docs/Remove-VSTeamExtension.md index de434b61c..e154aac68 100644 --- a/docs/Remove-VSTeamExtension.md +++ b/docs/Remove-VSTeamExtension.md @@ -1,61 +1,61 @@ - - -# Remove-VSTeamExtension - -## SYNOPSIS - -Uninstall the specified extension from the account / project collection. - -## SYNTAX - -## DESCRIPTION - -Uninstall the specified extension from the account / project collection. - -## EXAMPLES - -## PARAMETERS - -### -PublisherId - -The id of the publisher. - -```yaml -Type: String -Required: True -``` - -### -ExtensionId - -The id of the extension. - -```yaml -Type: String -Required: True -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-VSTeamExtension](Add-VSTeamExtension.md) - -[Get-VSTeamExtension](Get-VSTeamExtension.md) - -[Remove-VSTeamExtension](Remove-VSTeamExtension.md) - -[Update-VSTeamExtension](Update-VSTeamExtension.md) + + +# Remove-VSTeamExtension + +## SYNOPSIS + +Uninstall the specified extension from the account / project collection. + +## SYNTAX + +## DESCRIPTION + +Uninstall the specified extension from the account / project collection. + +## EXAMPLES + +## PARAMETERS + +### -PublisherId + +The id of the publisher. + +```yaml +Type: String +Required: True +``` + +### -ExtensionId + +The id of the extension. + +```yaml +Type: String +Required: True +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Add-VSTeamExtension](Add-VSTeamExtension.md) + +[Get-VSTeamExtension](Get-VSTeamExtension.md) + +[Remove-VSTeamExtension](Remove-VSTeamExtension.md) + +[Update-VSTeamExtension](Update-VSTeamExtension.md) diff --git a/docs/Remove-VSTeamFeed.md b/docs/Remove-VSTeamFeed.md index 692d6f458..086dd8bfd 100644 --- a/docs/Remove-VSTeamFeed.md +++ b/docs/Remove-VSTeamFeed.md @@ -1,45 +1,45 @@ - - -# Remove-VSTeamFeed - -## SYNOPSIS - -Removes a package feed from the account. - -## SYNTAX - -## DESCRIPTION - -Removes a package feed from the account. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Remove-VSTeamFeed -id '00000000-0000-0000-0000-000000000000' -``` - -This command remove the package feed from the account. - -## PARAMETERS - -### -FeedId - -Specifies the ID of the feed. - -```yaml -Type: Guid -Aliases: ID -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Remove-VSTeamFeed + +## SYNOPSIS + +Removes a package feed from the account. + +## SYNTAX + +## DESCRIPTION + +Removes a package feed from the account. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Remove-VSTeamFeed -id '00000000-0000-0000-0000-000000000000' +``` + +This command remove the package feed from the account. + +## PARAMETERS + +### -FeedId + +Specifies the ID of the feed. + +```yaml +Type: Guid +Aliases: ID +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Remove-VSTeamGitRepository.md b/docs/Remove-VSTeamGitRepository.md index 904b0e240..64bf889f9 100644 --- a/docs/Remove-VSTeamGitRepository.md +++ b/docs/Remove-VSTeamGitRepository.md @@ -1,57 +1,57 @@ - - -# Remove-VSTeamGitRepository - -## SYNOPSIS - -Removes the Git repository from your Visual Studio Team Services or Team Foundation Server account. - -## SYNTAX - -## DESCRIPTION - -Remove-VSTeamGitRepository removes the Git repository from your Visual Studio Team Services or Team Foundation Server account. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Remove-VSTeamGitRepository -Id 687c53f8-1a82-4e89-9a86-13d51bc4a8d5 -``` - -This command removes all the Git repositories for your TFS or Team Services account. - -## PARAMETERS - -### -Id - -Specifies one or more repositories by ID. - -To specify multiple IDs, use commas to separate the IDs. - -To find the ID of a repository, type Get-Repository. - -```yaml -Type: Guid[] -Aliases: RepositoryID -Accept pipeline input: true (ByPropertyName) -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Remove-VSTeamGitRepository + +## SYNOPSIS + +Removes the Git repository from your Visual Studio Team Services or Team Foundation Server account. + +## SYNTAX + +## DESCRIPTION + +Remove-VSTeamGitRepository removes the Git repository from your Visual Studio Team Services or Team Foundation Server account. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Remove-VSTeamGitRepository -Id 687c53f8-1a82-4e89-9a86-13d51bc4a8d5 +``` + +This command removes all the Git repositories for your TFS or Team Services account. + +## PARAMETERS + +### -Id + +Specifies one or more repositories by ID. + +To specify multiple IDs, use commas to separate the IDs. + +To find the ID of a repository, type Get-Repository. + +```yaml +Type: Guid[] +Aliases: RepositoryID +Accept pipeline input: true (ByPropertyName) +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Remove-VSTeamPolicy.md b/docs/Remove-VSTeamPolicy.md index 31090631a..b327c2889 100644 --- a/docs/Remove-VSTeamPolicy.md +++ b/docs/Remove-VSTeamPolicy.md @@ -1,77 +1,77 @@ - - -# Remove-VSTeamPolicy - -## SYNOPSIS - -Removes the specified policy from the specified project. - -## SYNTAX - -## DESCRIPTION - -Remove-VSTeamPolicy removes the policy from the specified project. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Remove-VSTeamPolicy -ProjectName Demo -Id 1 -``` - -This command removes the policy with ID of 1 from the Demo project. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies one or more policies by ID. - -To find the ID of a policy see [Get-VSTeamPolicy](Get-VSTeamPolicy.md) - -```yaml -Type: Int[] -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-VSTeamPolicy](Add-VSTeamPolicy.md) - -[Get-VSTeamPolicy](Get-VSTeamPolicy.md) - -[Get-VSTeamPolicyType](Get-VSTeamPolicyType.md) + + +# Remove-VSTeamPolicy + +## SYNOPSIS + +Removes the specified policy from the specified project. + +## SYNTAX + +## DESCRIPTION + +Remove-VSTeamPolicy removes the policy from the specified project. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Remove-VSTeamPolicy -ProjectName Demo -Id 1 +``` + +This command removes the policy with ID of 1 from the Demo project. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies one or more policies by ID. + +To find the ID of a policy see [Get-VSTeamPolicy](Get-VSTeamPolicy.md) + +```yaml +Type: Int[] +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Add-VSTeamPolicy](Add-VSTeamPolicy.md) + +[Get-VSTeamPolicy](Get-VSTeamPolicy.md) + +[Get-VSTeamPolicyType](Get-VSTeamPolicyType.md) diff --git a/docs/Remove-VSTeamProfile.md b/docs/Remove-VSTeamProfile.md index c3ecf456f..5217f98a0 100644 --- a/docs/Remove-VSTeamProfile.md +++ b/docs/Remove-VSTeamProfile.md @@ -1,54 +1,54 @@ - - -# Remove-VSTeamProfile - -## SYNOPSIS - -Removes the profile. - -## SYNTAX - -## DESCRIPTION - -Removes the profile. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamProfile | Remove-VSTeamProfile -Force -``` - -This will remove all the profiles on your system. - -## PARAMETERS - -### -Name - -Name of profile to remove. - -```yaml -Type: String -Required: True -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-VSTeamProfile](Add-VSTeamProfile.md) + + +# Remove-VSTeamProfile + +## SYNOPSIS + +Removes the profile. + +## SYNTAX + +## DESCRIPTION + +Removes the profile. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamProfile | Remove-VSTeamProfile -Force +``` + +This will remove all the profiles on your system. + +## PARAMETERS + +### -Name + +Name of profile to remove. + +```yaml +Type: String +Required: True +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Add-VSTeamProfile](Add-VSTeamProfile.md) diff --git a/docs/Remove-VSTeamProject.md b/docs/Remove-VSTeamProject.md index ae34a5093..6680cd10b 100644 --- a/docs/Remove-VSTeamProject.md +++ b/docs/Remove-VSTeamProject.md @@ -1,81 +1,81 @@ - - -# Remove-VSTeamProject - -## SYNOPSIS - -Deletes the Team Project from your Team Services account. - -## SYNTAX - -## DESCRIPTION - -This will permanently delete your Team Project from your Team Services account. - -This function takes a DynamicParam for ProjectName that can be read from the Pipeline by Property Name - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Remove-VSTeamProject 'MyProject' -``` - -You will be prompted for confirmation and the project will be deleted. - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Remove-VSTeamProject 'MyProject' -Force -``` - -You will NOT be prompted for confirmation and the project will be deleted. - -### -------------------------- EXAMPLE 3 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamProject | Remove-VSTeamProject -Force -``` - -This will remove all projects - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Add-VSTeamProject](Add-VSTeamProject.md) + + +# Remove-VSTeamProject + +## SYNOPSIS + +Deletes the Team Project from your Team Services account. + +## SYNTAX + +## DESCRIPTION + +This will permanently delete your Team Project from your Team Services account. + +This function takes a DynamicParam for ProjectName that can be read from the Pipeline by Property Name + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Remove-VSTeamProject 'MyProject' +``` + +You will be prompted for confirmation and the project will be deleted. + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Remove-VSTeamProject 'MyProject' -Force +``` + +You will NOT be prompted for confirmation and the project will be deleted. + +### -------------------------- EXAMPLE 3 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamProject | Remove-VSTeamProject -Force +``` + +This will remove all projects + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Add-VSTeamProject](Add-VSTeamProject.md) diff --git a/docs/Remove-VSTeamRelease.md b/docs/Remove-VSTeamRelease.md index 4490c0123..f71101fdf 100644 --- a/docs/Remove-VSTeamRelease.md +++ b/docs/Remove-VSTeamRelease.md @@ -1,95 +1,95 @@ - - -# Remove-VSTeamRelease - -## SYNOPSIS - -Removes the releases for a team project. - -## SYNTAX - -## DESCRIPTION - -The Remove-VSTeamRelease function removes the releases for a team project. - -The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamRelease -ProjectName demo | Remove-VSTeamRelease -``` - -This command gets a list of all releases in the demo project. - -The pipeline operator (|) passes the data to the Remove-VSTeamRelease function, which removes each release definition object. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies one or more releases by ID. - -To specify multiple IDs, use commas to separate the IDs. - -To find the ID of a release definition, type Get-VSTeamRelease. - -```yaml -Type: Int32[] -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -### None - -## NOTES - -This function has a Dynamic Parameter for ProjectName that specifies the project for which this function gets releases. - -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. - -You can pipe release definition IDs to this function. - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) - -[Add-VSTeamRelease](Add-VSTeamRelease.md) - -[Get-VSTeamRelease](Get-VSTeamRelease.md) + + +# Remove-VSTeamRelease + +## SYNOPSIS + +Removes the releases for a team project. + +## SYNTAX + +## DESCRIPTION + +The Remove-VSTeamRelease function removes the releases for a team project. + +The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamRelease -ProjectName demo | Remove-VSTeamRelease +``` + +This command gets a list of all releases in the demo project. + +The pipeline operator (|) passes the data to the Remove-VSTeamRelease function, which removes each release definition object. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies one or more releases by ID. + +To specify multiple IDs, use commas to separate the IDs. + +To find the ID of a release definition, type Get-VSTeamRelease. + +```yaml +Type: Int32[] +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +### None + +## NOTES + +This function has a Dynamic Parameter for ProjectName that specifies the project for which this function gets releases. + +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. + +You can pipe release definition IDs to this function. + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + +[Add-VSTeamRelease](Add-VSTeamRelease.md) + +[Get-VSTeamRelease](Get-VSTeamRelease.md) diff --git a/docs/Remove-VSTeamReleaseDefinition.md b/docs/Remove-VSTeamReleaseDefinition.md index 35cc2a234..1d8d98b08 100644 --- a/docs/Remove-VSTeamReleaseDefinition.md +++ b/docs/Remove-VSTeamReleaseDefinition.md @@ -1,95 +1,95 @@ - - -# Remove-VSTeamReleaseDefinition - -## SYNOPSIS - -Removes the release definitions for a team project. - -## SYNTAX - -## DESCRIPTION - -The Remove-VSTeamReleaseDefinition function removes the release definitions for a team project. - -The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamReleaseDefinition -ProjectName demo | Remove-VSTeamReleaseDefinition -``` - -This command gets a list of all release definitions in the demo project. - -The pipeline operator (|) passes the data to the Remove-VSTeamReleaseDefinition function, which removes each release definition object. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies one or more release definitions by ID. - -To specify multiple IDs, use commas to separate the IDs. - -To find the ID of a release definition, type Get-VSTeamReleaseDefinition. - -```yaml -Type: Int32[] -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -### None - -## NOTES - -This function has a Dynamic Parameter for ProjectName that specifies the project for which this function gets release definitions. - -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. - -You can pipe release definition IDs to this function. - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) - -[Add-VSTeamReleaseDefinition](Add-VSTeamReleaseDefinition.md) - -[Get-VSTeamReleaseDefinition](Get-VSTeamReleaseDefinition.md) + + +# Remove-VSTeamReleaseDefinition + +## SYNOPSIS + +Removes the release definitions for a team project. + +## SYNTAX + +## DESCRIPTION + +The Remove-VSTeamReleaseDefinition function removes the release definitions for a team project. + +The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamReleaseDefinition -ProjectName demo | Remove-VSTeamReleaseDefinition +``` + +This command gets a list of all release definitions in the demo project. + +The pipeline operator (|) passes the data to the Remove-VSTeamReleaseDefinition function, which removes each release definition object. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies one or more release definitions by ID. + +To specify multiple IDs, use commas to separate the IDs. + +To find the ID of a release definition, type Get-VSTeamReleaseDefinition. + +```yaml +Type: Int32[] +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +### None + +## NOTES + +This function has a Dynamic Parameter for ProjectName that specifies the project for which this function gets release definitions. + +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. + +You can pipe release definition IDs to this function. + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + +[Add-VSTeamReleaseDefinition](Add-VSTeamReleaseDefinition.md) + +[Get-VSTeamReleaseDefinition](Get-VSTeamReleaseDefinition.md) diff --git a/docs/Remove-VSTeamServiceEndpoint.md b/docs/Remove-VSTeamServiceEndpoint.md index 38a658e61..e38a10223 100644 --- a/docs/Remove-VSTeamServiceEndpoint.md +++ b/docs/Remove-VSTeamServiceEndpoint.md @@ -1,61 +1,61 @@ - - -# Remove-VSTeamServiceEndpoint - -## SYNOPSIS - -Removes a service endpoint. - -## SYNTAX - -## DESCRIPTION - -Removes a service endpoint. - -## EXAMPLES - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Id of the service endpoint - -```yaml -Type: String[] -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Remove-VSTeamServiceEndpoint + +## SYNOPSIS + +Removes a service endpoint. + +## SYNTAX + +## DESCRIPTION + +Removes a service endpoint. + +## EXAMPLES + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Id of the service endpoint + +```yaml +Type: String[] +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Remove-VSTeamUserEntitlement.md b/docs/Remove-VSTeamUserEntitlement.md index 189d7b14f..4d28e8093 100644 --- a/docs/Remove-VSTeamUserEntitlement.md +++ b/docs/Remove-VSTeamUserEntitlement.md @@ -1,86 +1,86 @@ - - -# Remove-VSTeamUserEntitlement - -## SYNOPSIS - -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. - -## SYNTAX - -## DESCRIPTION - -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. - -## EXAMPLES - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Aliases: cf -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -### -UserId - -The id of the user to remove. - -```yaml -Type: String -Parameter Sets: ByID -Aliases: name -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Email - -The email of the user to remove. - -```yaml -Type: String -Parameter Sets: ByEmail -Aliases: name -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Aliases: wi -``` - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS + + +# Remove-VSTeamUserEntitlement + +## SYNOPSIS + +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. + +## SYNTAX + +## DESCRIPTION + +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. + +## EXAMPLES + +## PARAMETERS + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Aliases: cf +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +### -UserId + +The id of the user to remove. + +```yaml +Type: String +Parameter Sets: ByID +Aliases: name +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Email + +The email of the user to remove. + +```yaml +Type: String +Parameter Sets: ByEmail +Aliases: name +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Aliases: wi +``` + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/docs/Set-VSTeamAPIVersion.md b/docs/Set-VSTeamAPIVersion.md index a9b7e46fe..92e204c5f 100644 --- a/docs/Set-VSTeamAPIVersion.md +++ b/docs/Set-VSTeamAPIVersion.md @@ -1,99 +1,99 @@ - - -# Set-VSTeamAPIVersion - -## SYNOPSIS - -Sets the API versions to support either TFS2017, TFS2018 or VSTS. - -## SYNTAX - -## DESCRIPTION - -Set-VSTeamAPIVersion sets the versions of APIs used. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamAPIVersion AzD -``` - -This command sets the API versions to support AzD. - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamAPIVersion -Service Release -Version '5.0' -``` - -This command sets the version of the Release calls to 5.0. - -## PARAMETERS - -### -Target - -Specifies the version to use. The acceptable values for this parameter are: - -- TFS2017 -- TFS2018 -- VSTS -- AzD - -```yaml -Type: String -Required: True -Position: 0 -Parameter Sets: Target -Default value: TFS2017 -``` - -### -Service - -Specifies the service to change. The acceptable values for this parameter are: - -- Build -- Release -- Core -- Git -- DistributedTask -- Tfvc -- Packaging -- MemberEntitlementManagement -- ExtensionsManagement -- ServiceFabricEndpoint - -```yaml -Type: String -Required: True -Parameter Sets: Service -``` - -### -Version - -Specifies the version to use. - -```yaml -Type: String -Required: True -Parameter Sets: Service -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Set-VSTeamAPIVersion + +## SYNOPSIS + +Sets the API versions to support either TFS2017, TFS2018 or VSTS. + +## SYNTAX + +## DESCRIPTION + +Set-VSTeamAPIVersion sets the versions of APIs used. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamAPIVersion AzD +``` + +This command sets the API versions to support AzD. + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamAPIVersion -Service Release -Version '5.0' +``` + +This command sets the version of the Release calls to 5.0. + +## PARAMETERS + +### -Target + +Specifies the version to use. The acceptable values for this parameter are: + +- TFS2017 +- TFS2018 +- VSTS +- AzD + +```yaml +Type: String +Required: True +Position: 0 +Parameter Sets: Target +Default value: TFS2017 +``` + +### -Service + +Specifies the service to change. The acceptable values for this parameter are: + +- Build +- Release +- Core +- Git +- DistributedTask +- Tfvc +- Packaging +- MemberEntitlementManagement +- ExtensionsManagement +- ServiceFabricEndpoint + +```yaml +Type: String +Required: True +Parameter Sets: Service +``` + +### -Version + +Specifies the version to use. + +```yaml +Type: String +Required: True +Parameter Sets: Service +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Set-VSTeamAccount.md b/docs/Set-VSTeamAccount.md index c1d4e4e3d..ebabc6fc2 100644 --- a/docs/Set-VSTeamAccount.md +++ b/docs/Set-VSTeamAccount.md @@ -1,221 +1,221 @@ - - -# Set-VSTeamAccount - -## SYNOPSIS - -Stores your account name and personal access token for use with the other -functions in this module. - -## SYNTAX - -## DESCRIPTION - -On Windows you have to option to store the information at the process, user or machine (you must be running PowerShell as administrator to store at the machine level) level. - -On Linux and Mac you can only store at the process level. - -Calling Set-VSTeamAccount will clear any default project. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamAccount -``` - -You will be prompted for the account name and personal access token. - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamAccount -Account mydemos -PersonalAccessToken 7a8ilh6db4aforlrnrthisisnotreal4uhlh5vgbmgap3mziwnga -``` - -Allows you to provide all the information on the command line. - -### -------------------------- EXAMPLE 3 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamAccount -Account http://localtfs:8080/tfs/DefaultCollection -UseWindowsAuthentication -``` - -On Windows, allows you use to use Windows authentication against a local TFS server. - -### -------------------------- EXAMPLE 4 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamAccount -Profile demonstrations -``` - -Will add the account from the profile provided. - -### -------------------------- EXAMPLE 5 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamAccount -Profile demonstrations -Drive demo | Invoke-Expression -PS C:\> Set-Location demo: -PS demo:\> Get-ChildItem -``` - -Will add the account from the profile provided and mount a drive named demo that you can navigate like a file system. If you do not pipe to Invoke-Expression you can simply copy and paste the output and execute it. - -### -------------------------- EXAMPLE 6 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamAccount -Profile demonstrations -Level Machine -``` - -Will add the account from the profile provided and store the information at the Machine level. Now any new PowerShell sessions will auto load this account. - -Note: You must run PowerShell as an Administrator to store at the Machine level. - -### -------------------------- EXAMPLE 7 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamAccount -Account mydemos -Token $(System.AccessToken) -UseBearerToken -``` - -Will add the account and use the OAuth Token provided by VSTS when you check the *Allow scripts to access OAuth token* checkbox on the phase. Using this method removes the need to create a Personal Access Token. Note -Token is just an alias for -PersonalAccessToken. The token is scoped to only allow access to the account running the build or release. To access other accounts you will have to use a personal access token. - -## PARAMETERS - -### -Account - -The Visual Studio Team Services (VSTS) account name to use. -DO NOT enter the entire URL. - -Just the portion after dev.azure.com. For example in the -following url mydemos is the account name. - -or -The full Team Foundation Server (TFS) url including the collection. - - -```yaml -Type: String -Parameter Sets: Secure, Plain, Windows -Required: True -Position: 1 -``` - -### -SecurePersonalAccessToken - -A secured string to capture your personal access token. - -This will allow you to provide your personal access token without displaying it in plain text. - -To use pat simply omit it from the Set-VSTeamAccount command. - -```yaml -Type: SecureString -Aliases: PAT -Parameter Sets: Secure -Required: True -``` - -### -Level - -On Windows allows you to store your account information at the Process, User or Machine levels. -When saved at the User or Machine level your account information will be in any future PowerShell processes. - -To store at the Machine level you must be running PowerShell as an Administrator. - -```yaml -Type: String -Parameter Sets: Secure, Plain, Windows -``` - -### -PersonalAccessToken - -The personal access token from VSTS/TFS to use to access this account. - -```yaml -Type: String -Parameter Sets: Plain -Aliases: Token -Required: True -Position: 2 -``` - -### -UseWindowsAuthentication - -Allows the use of the current user's Windows credentials to authenticate against a local Team Foundation Server or Azure DevOps Server. This cannot be used to connect to Azure DevOps Services. - -```yaml -Type: SwitchParameter -Parameter Sets: Windows -``` - -### -UseBearerToken - -Switches the authorization from Basic to Bearer. You still use the PAT for PersonalAccessToken parameters to store the token. - -```yaml -Type: SwitchParameter -Parameter Sets: Secure, Plain -``` - -### -Profile - -The profile name stored using Set-VSTeamProfile function. You can tab complete through existing profile names. - -```yaml -Type: String -Parameter Sets: Profile -Required: True -``` - -### -Version - -Specifies the version to use. The acceptable values for this parameter are: - -- TFS2017 -- TFS2018 -- VSTS -- AzD - -If you are on AzD it will default to Azd otherwise it will default to TFS2017 - -```yaml -Type: String -Parameter Sets: Secure, Plain, Windows -Required: True -Position: 3 -Default value: TFS2017 for TFS and AzD for AzD -``` - -### -Drive - -The name of the drive you want to mount to this account. The command you need to run will be presented. Simply copy and paste the command to mount the drive. To use the drive run Set-Location [driveName]: - -```yaml -Type: String -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Set-VSTeamProfile](Set-VSTeamProfile.md) - -[Clear-VSTeamDefaultProject](Clear-VSTeamDefaultProject.md) - -[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + + +# Set-VSTeamAccount + +## SYNOPSIS + +Stores your account name and personal access token for use with the other +functions in this module. + +## SYNTAX + +## DESCRIPTION + +On Windows you have to option to store the information at the process, user or machine (you must be running PowerShell as administrator to store at the machine level) level. + +On Linux and Mac you can only store at the process level. + +Calling Set-VSTeamAccount will clear any default project. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamAccount +``` + +You will be prompted for the account name and personal access token. + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamAccount -Account mydemos -PersonalAccessToken 7a8ilh6db4aforlrnrthisisnotreal4uhlh5vgbmgap3mziwnga +``` + +Allows you to provide all the information on the command line. + +### -------------------------- EXAMPLE 3 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamAccount -Account http://localtfs:8080/tfs/DefaultCollection -UseWindowsAuthentication +``` + +On Windows, allows you use to use Windows authentication against a local TFS server. + +### -------------------------- EXAMPLE 4 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamAccount -Profile demonstrations +``` + +Will add the account from the profile provided. + +### -------------------------- EXAMPLE 5 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamAccount -Profile demonstrations -Drive demo | Invoke-Expression +PS C:\> Set-Location demo: +PS demo:\> Get-ChildItem +``` + +Will add the account from the profile provided and mount a drive named demo that you can navigate like a file system. If you do not pipe to Invoke-Expression you can simply copy and paste the output and execute it. + +### -------------------------- EXAMPLE 6 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamAccount -Profile demonstrations -Level Machine +``` + +Will add the account from the profile provided and store the information at the Machine level. Now any new PowerShell sessions will auto load this account. + +Note: You must run PowerShell as an Administrator to store at the Machine level. + +### -------------------------- EXAMPLE 7 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamAccount -Account mydemos -Token $(System.AccessToken) -UseBearerToken +``` + +Will add the account and use the OAuth Token provided by VSTS when you check the *Allow scripts to access OAuth token* checkbox on the phase. Using this method removes the need to create a Personal Access Token. Note -Token is just an alias for -PersonalAccessToken. The token is scoped to only allow access to the account running the build or release. To access other accounts you will have to use a personal access token. + +## PARAMETERS + +### -Account + +The Visual Studio Team Services (VSTS) account name to use. +DO NOT enter the entire URL. + +Just the portion after dev.azure.com. For example in the +following url mydemos is the account name. + +or +The full Team Foundation Server (TFS) url including the collection. + + +```yaml +Type: String +Parameter Sets: Secure, Plain, Windows +Required: True +Position: 1 +``` + +### -SecurePersonalAccessToken + +A secured string to capture your personal access token. + +This will allow you to provide your personal access token without displaying it in plain text. + +To use pat simply omit it from the Set-VSTeamAccount command. + +```yaml +Type: SecureString +Aliases: PAT +Parameter Sets: Secure +Required: True +``` + +### -Level + +On Windows allows you to store your account information at the Process, User or Machine levels. +When saved at the User or Machine level your account information will be in any future PowerShell processes. + +To store at the Machine level you must be running PowerShell as an Administrator. + +```yaml +Type: String +Parameter Sets: Secure, Plain, Windows +``` + +### -PersonalAccessToken + +The personal access token from VSTS/TFS to use to access this account. + +```yaml +Type: String +Parameter Sets: Plain +Aliases: Token +Required: True +Position: 2 +``` + +### -UseWindowsAuthentication + +Allows the use of the current user's Windows credentials to authenticate against a local Team Foundation Server or Azure DevOps Server. This cannot be used to connect to Azure DevOps Services. + +```yaml +Type: SwitchParameter +Parameter Sets: Windows +``` + +### -UseBearerToken + +Switches the authorization from Basic to Bearer. You still use the PAT for PersonalAccessToken parameters to store the token. + +```yaml +Type: SwitchParameter +Parameter Sets: Secure, Plain +``` + +### -Profile + +The profile name stored using Set-VSTeamProfile function. You can tab complete through existing profile names. + +```yaml +Type: String +Parameter Sets: Profile +Required: True +``` + +### -Version + +Specifies the version to use. The acceptable values for this parameter are: + +- TFS2017 +- TFS2018 +- VSTS +- AzD + +If you are on AzD it will default to Azd otherwise it will default to TFS2017 + +```yaml +Type: String +Parameter Sets: Secure, Plain, Windows +Required: True +Position: 3 +Default value: TFS2017 for TFS and AzD for AzD +``` + +### -Drive + +The name of the drive you want to mount to this account. The command you need to run will be presented. Simply copy and paste the command to mount the drive. To use the drive run Set-Location [driveName]: + +```yaml +Type: String +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Set-VSTeamProfile](Set-VSTeamProfile.md) + +[Clear-VSTeamDefaultProject](Clear-VSTeamDefaultProject.md) + +[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) diff --git a/docs/Set-VSTeamAlias.md b/docs/Set-VSTeamAlias.md index 1a375350a..05e12c24f 100644 --- a/docs/Set-VSTeamAlias.md +++ b/docs/Set-VSTeamAlias.md @@ -1,39 +1,39 @@ - - -# Set-VSTeamAlias - -## SYNOPSIS - -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. - -## SYNTAX - -## DESCRIPTION - -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. - -## EXAMPLES - -## PARAMETERS - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS + + +# Set-VSTeamAlias + +## SYNOPSIS + +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. + +## SYNTAX + +## DESCRIPTION + +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. + +## EXAMPLES + +## PARAMETERS + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/docs/Set-VSTeamApproval.md b/docs/Set-VSTeamApproval.md index bec7e9b7e..9d28698bd 100644 --- a/docs/Set-VSTeamApproval.md +++ b/docs/Set-VSTeamApproval.md @@ -1,108 +1,108 @@ - - -# Set-VSTeamApproval - -## SYNOPSIS - -Sets the status of approval to Approved, Rejected, Pending, or ReAssigned. - -## SYNTAX - -## DESCRIPTION - -Set-VSTeamApproval sets the status of approval to Approved, Rejected, Pending, or ReAssigned. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamApproval | Set-VSTeamApproval -``` - -This command sets all pending approvals to approved. - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamApproval -Id 1 -Status Rejected -``` - -This command rejects approval with Id of 1. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies the approval IDs of the approvals to set. - -```yaml -Type: Int32[] -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Status - -Specifies the status to set for the approval. The acceptable values for this parameter are: - -- Approved -- Rejected -- Pending -- ReAssigned - -```yaml -Type: String -Required: True -Default value: Approved -``` - -### -Approver - -Specifies the user to whom the approval has been re-assigned to Alias of the user chuckreinhart@outlook.com, for example. - -```yaml -Type: String -``` - -### -Comment - -Specifies the comment to be stored with this approval. - -```yaml -Type: String -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Set-VSTeamApproval + +## SYNOPSIS + +Sets the status of approval to Approved, Rejected, Pending, or ReAssigned. + +## SYNTAX + +## DESCRIPTION + +Set-VSTeamApproval sets the status of approval to Approved, Rejected, Pending, or ReAssigned. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamApproval | Set-VSTeamApproval +``` + +This command sets all pending approvals to approved. + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamApproval -Id 1 -Status Rejected +``` + +This command rejects approval with Id of 1. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies the approval IDs of the approvals to set. + +```yaml +Type: Int32[] +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Status + +Specifies the status to set for the approval. The acceptable values for this parameter are: + +- Approved +- Rejected +- Pending +- ReAssigned + +```yaml +Type: String +Required: True +Default value: Approved +``` + +### -Approver + +Specifies the user to whom the approval has been re-assigned to Alias of the user chuckreinhart@outlook.com, for example. + +```yaml +Type: String +``` + +### -Comment + +Specifies the comment to be stored with this approval. + +```yaml +Type: String +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Set-VSTeamDefaultProject.md b/docs/Set-VSTeamDefaultProject.md index a5e7c5812..c7fce9467 100644 --- a/docs/Set-VSTeamDefaultProject.md +++ b/docs/Set-VSTeamDefaultProject.md @@ -1,77 +1,77 @@ - - -# Set-VSTeamDefaultProject - -## SYNOPSIS - -Sets the default project to be used with other calls in the module. - -## SYNTAX - -## DESCRIPTION - -The majority of the functions in this module require a project name. - -By setting a default project you can omit that parameter from your function calls and this default will be used instead. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamDefaultProject Demo -``` - -This command sets Demo as the default project. - -You can now call other functions that require a project name without passing the project. - -## PARAMETERS - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -### -Project - -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. - -```yaml -Type: String -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Level - -On Windows allows you to store your default project at the Process, User or Machine levels. - -When saved at the User or Machine level your default project will be in any future PowerShell processes. - -```yaml -Type: String -``` - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -Setting a default project also enables tab completion of dynamic parameters when you call Add-VSTeamBuild. - -## RELATED LINKS + + +# Set-VSTeamDefaultProject + +## SYNOPSIS + +Sets the default project to be used with other calls in the module. + +## SYNTAX + +## DESCRIPTION + +The majority of the functions in this module require a project name. + +By setting a default project you can omit that parameter from your function calls and this default will be used instead. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamDefaultProject Demo +``` + +This command sets Demo as the default project. + +You can now call other functions that require a project name without passing the project. + +## PARAMETERS + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +### -Project + +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. + +```yaml +Type: String +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Level + +On Windows allows you to store your default project at the Process, User or Machine levels. + +When saved at the User or Machine level your default project will be in any future PowerShell processes. + +```yaml +Type: String +``` + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +Setting a default project also enables tab completion of dynamic parameters when you call Add-VSTeamBuild. + +## RELATED LINKS diff --git a/docs/Set-VSTeamEnvironmentStatus.md b/docs/Set-VSTeamEnvironmentStatus.md index 6e8ac0914..eca077d75 100644 --- a/docs/Set-VSTeamEnvironmentStatus.md +++ b/docs/Set-VSTeamEnvironmentStatus.md @@ -1,116 +1,116 @@ - - -# Set-VSTeamEnvironmentStatus - -## SYNOPSIS - -Sets the status of a environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined. - -## SYNTAX - -## DESCRIPTION - -Sets the status of a environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamEnvironmentStatus -ReleaseId 54 -Id 5 -status inProgress -``` - -This command will set the status of environment with id 5 of release 54 to inProgress. You can use this call to redeploy an environment. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -EnvironmentId - -Specifies one or more environments by ID you wish to deploy. - -The Environment Ids are unique for each environment and in each release. - -To specify multiple IDs, use commas to separate the IDs. - -To find the ID of an environment type Get-VSTeamRelease -expand environments. - -```yaml -Type: Int32[] -Aliases: Id -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -ReleaseId - -Specifies the release by ID. - -```yaml -Type: Int32 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Status - -The status to set for the environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined. - -```yaml -Type: String -``` - -### -Comment - -The comment to set for the status change. - -```yaml -Type: String -``` - -### -ScheduledDeploymentTime - -The date and time to schedule when setting the status to scheduled. - -```yaml -Type: DateTime -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -This function has a Dynamic Parameter for ProjectName that specifies the project for which this function gets releases. - -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. - -## RELATED LINKS + + +# Set-VSTeamEnvironmentStatus + +## SYNOPSIS + +Sets the status of a environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined. + +## SYNTAX + +## DESCRIPTION + +Sets the status of a environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamEnvironmentStatus -ReleaseId 54 -Id 5 -status inProgress +``` + +This command will set the status of environment with id 5 of release 54 to inProgress. You can use this call to redeploy an environment. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -EnvironmentId + +Specifies one or more environments by ID you wish to deploy. + +The Environment Ids are unique for each environment and in each release. + +To specify multiple IDs, use commas to separate the IDs. + +To find the ID of an environment type Get-VSTeamRelease -expand environments. + +```yaml +Type: Int32[] +Aliases: Id +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -ReleaseId + +Specifies the release by ID. + +```yaml +Type: Int32 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Status + +The status to set for the environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined. + +```yaml +Type: String +``` + +### -Comment + +The comment to set for the status change. + +```yaml +Type: String +``` + +### -ScheduledDeploymentTime + +The date and time to schedule when setting the status to scheduled. + +```yaml +Type: DateTime +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +This function has a Dynamic Parameter for ProjectName that specifies the project for which this function gets releases. + +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. + +## RELATED LINKS diff --git a/docs/Set-VSTeamReleaseStatus.md b/docs/Set-VSTeamReleaseStatus.md index c64a961c8..e010053a1 100644 --- a/docs/Set-VSTeamReleaseStatus.md +++ b/docs/Set-VSTeamReleaseStatus.md @@ -1,81 +1,81 @@ - - -# Set-VSTeamReleaseStatus - -## SYNOPSIS - -Sets the status of a release to Active or Abandoned. - -## SYNTAX - -## DESCRIPTION - -Sets the status of a release to Active or Abandoned. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamReleaseStatus -Id 5 -status Abandoned -``` - -This command will set the status of release with id 5 to Abandoned. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies one or more releases by ID. - -To specify multiple IDs, use commas to separate the IDs. - -To find the ID of a release type Get-VSTeamRelease. - -```yaml -Type: Int32[] -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Status - -The status to set for the release Active or Abandoned. - -```yaml -Type: String -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Set-VSTeamReleaseStatus + +## SYNOPSIS + +Sets the status of a release to Active or Abandoned. + +## SYNTAX + +## DESCRIPTION + +Sets the status of a release to Active or Abandoned. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamReleaseStatus -Id 5 -status Abandoned +``` + +This command will set the status of release with id 5 to Abandoned. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies one or more releases by ID. + +To specify multiple IDs, use commas to separate the IDs. + +To find the ID of a release type Get-VSTeamRelease. + +```yaml +Type: Int32[] +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Status + +The status to set for the release Active or Abandoned. + +```yaml +Type: String +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Show-VSTeam.md b/docs/Show-VSTeam.md index 98bfc1ed9..bafcbdf70 100644 --- a/docs/Show-VSTeam.md +++ b/docs/Show-VSTeam.md @@ -1,37 +1,37 @@ - - -# Show-VSTeam - -## SYNOPSIS - -Opens TFS or VSTS site in the default browser. - -## SYNTAX - -## DESCRIPTION - -Opens TFS or VSTS site in the default browser. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Show-VSTeam -``` - -This will open a browser to the TFS or VSTS site - -## PARAMETERS - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) + + +# Show-VSTeam + +## SYNOPSIS + +Opens TFS or VSTS site in the default browser. + +## SYNTAX + +## DESCRIPTION + +Opens TFS or VSTS site in the default browser. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Show-VSTeam +``` + +This will open a browser to the TFS or VSTS site + +## PARAMETERS + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) diff --git a/docs/Show-VSTeamApproval.md b/docs/Show-VSTeamApproval.md index 5d58556d7..a71308711 100644 --- a/docs/Show-VSTeamApproval.md +++ b/docs/Show-VSTeamApproval.md @@ -1,81 +1,81 @@ - - -# Show-VSTeamApproval - -## SYNOPSIS - -Opens the release associated with the waiting approval in the default browser. - -## SYNTAX - -## DESCRIPTION - -Opens the release associated with the waiting approval in the default browser. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamApproval -ProjectName Demo | Show-VSTeamApproval -``` - -This command opens a web browser showing the release requiring approval. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -ReleaseDefinitionId - -Only approvals for the release id provided will be returned. - -```yaml -Type: Int32 -Aliases: Id -Required: True -Position: 1 -Accept pipeline input: true (ByPropertyName, ByValue) -``` - -## INPUTS - -## OUTPUTS - -### Team.BuildDefinition - -## NOTES - -This function has a Dynamic Parameter for ProjectName that specifies the project for which this function gets build definitions. - -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. - -You can pipe build definition IDs to this function. - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) - -[Add-VSTeamBuildDefinition](Add-VSTeamBuildDefinition.md) - -[Remove-VSTeamBuildDefinition](Remove-VSTeamBuildDefinition.md) + + +# Show-VSTeamApproval + +## SYNOPSIS + +Opens the release associated with the waiting approval in the default browser. + +## SYNTAX + +## DESCRIPTION + +Opens the release associated with the waiting approval in the default browser. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamApproval -ProjectName Demo | Show-VSTeamApproval +``` + +This command opens a web browser showing the release requiring approval. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -ReleaseDefinitionId + +Only approvals for the release id provided will be returned. + +```yaml +Type: Int32 +Aliases: Id +Required: True +Position: 1 +Accept pipeline input: true (ByPropertyName, ByValue) +``` + +## INPUTS + +## OUTPUTS + +### Team.BuildDefinition + +## NOTES + +This function has a Dynamic Parameter for ProjectName that specifies the project for which this function gets build definitions. + +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. + +You can pipe build definition IDs to this function. + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + +[Add-VSTeamBuildDefinition](Add-VSTeamBuildDefinition.md) + +[Remove-VSTeamBuildDefinition](Remove-VSTeamBuildDefinition.md) diff --git a/docs/Show-VSTeamBuild.md b/docs/Show-VSTeamBuild.md index 08e4c8cff..e797f54a3 100644 --- a/docs/Show-VSTeamBuild.md +++ b/docs/Show-VSTeamBuild.md @@ -1,59 +1,59 @@ - - -# Show-VSTeamBuild - -## SYNOPSIS - -Opens the build summary in the default browser. - -## SYNTAX - -## DESCRIPTION - -Opens the build summary in the default browser. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Show-VSTeamBuild -ProjectName Demo -Id 3 -``` - -This command will open a web browser with the summary of build 3. - -## PARAMETERS - -### -Id - -Specifies build by ID. - -```yaml -Type: Int32 -Parameter Sets: ByID -Aliases: BuildID -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -## OUTPUTS - -### Team.Build - -## NOTES - -You can pipe the build ID to this function. - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) - -[Add-VSTeamBuild](Add-VSTeamBuild.md) - -[Remove-VSTeamBuild](Remove-VSTeamBuild.md) + + +# Show-VSTeamBuild + +## SYNOPSIS + +Opens the build summary in the default browser. + +## SYNTAX + +## DESCRIPTION + +Opens the build summary in the default browser. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Show-VSTeamBuild -ProjectName Demo -Id 3 +``` + +This command will open a web browser with the summary of build 3. + +## PARAMETERS + +### -Id + +Specifies build by ID. + +```yaml +Type: Int32 +Parameter Sets: ByID +Aliases: BuildID +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +## OUTPUTS + +### Team.Build + +## NOTES + +You can pipe the build ID to this function. + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + +[Add-VSTeamBuild](Add-VSTeamBuild.md) + +[Remove-VSTeamBuild](Remove-VSTeamBuild.md) diff --git a/docs/Show-VSTeamBuildDefinition.md b/docs/Show-VSTeamBuildDefinition.md index 97db1452a..236f76e4a 100644 --- a/docs/Show-VSTeamBuildDefinition.md +++ b/docs/Show-VSTeamBuildDefinition.md @@ -1,108 +1,108 @@ - - -# Show-VSTeamBuildDefinition - -## SYNOPSIS - -Opens the build definition in the default browser. - -## SYNTAX - -## DESCRIPTION - -Opens the build definition in the default browser. - -The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory. - -With just a project name, this function shows all of the build definitions for that team project. - -You can also specify a particular build definition by ID. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Show-VSTeamBuildDefinition -ProjectName Demo -``` - -This command will open a web browser with All Definitions for this project showing. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Type - -The type of the build definitions to retrieve. The acceptable values for this parameter are: - -- Mine -- All -- Queued -- XAML - -If not specified, all types will be returned. - -```yaml -Type: String -Parameter Sets: List -Default value: All -``` - -### -Path - -The folder of the build definitions to retrieve. - -```yaml -Type: String -Parameter Sets: List -Default value: \ -``` - -### -Id - -Specifies build definition by ID. - -```yaml -Type: Int32 -Parameter Sets: ByID -Aliases: BuildDefinitionID -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -## OUTPUTS - -### Team.BuildDefinition - -## NOTES - -You can pipe build definition IDs to this function. - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) - -[Add-VSTeamBuildDefinition](Add-VSTeamBuildDefinition.md) - -[Remove-VSTeamBuildDefinition](Remove-VSTeamBuildDefinition.md) + + +# Show-VSTeamBuildDefinition + +## SYNOPSIS + +Opens the build definition in the default browser. + +## SYNTAX + +## DESCRIPTION + +Opens the build definition in the default browser. + +The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory. + +With just a project name, this function shows all of the build definitions for that team project. + +You can also specify a particular build definition by ID. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Show-VSTeamBuildDefinition -ProjectName Demo +``` + +This command will open a web browser with All Definitions for this project showing. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Type + +The type of the build definitions to retrieve. The acceptable values for this parameter are: + +- Mine +- All +- Queued +- XAML + +If not specified, all types will be returned. + +```yaml +Type: String +Parameter Sets: List +Default value: All +``` + +### -Path + +The folder of the build definitions to retrieve. + +```yaml +Type: String +Parameter Sets: List +Default value: \ +``` + +### -Id + +Specifies build definition by ID. + +```yaml +Type: Int32 +Parameter Sets: ByID +Aliases: BuildDefinitionID +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +## OUTPUTS + +### Team.BuildDefinition + +## NOTES + +You can pipe build definition IDs to this function. + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + +[Add-VSTeamBuildDefinition](Add-VSTeamBuildDefinition.md) + +[Remove-VSTeamBuildDefinition](Remove-VSTeamBuildDefinition.md) diff --git a/docs/Show-VSTeamFeed.md b/docs/Show-VSTeamFeed.md index ce1e03f2b..f0ada0c09 100644 --- a/docs/Show-VSTeamFeed.md +++ b/docs/Show-VSTeamFeed.md @@ -1,53 +1,53 @@ - - -# Show-VSTeamFeed - -## SYNOPSIS - -Opens the feed in the default browser. - -## SYNTAX - -## DESCRIPTION - -Opens the feed in the default browser. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Show-VSTeamFeed -Name Demo -``` - -This command will open a web browser with this feed showing. - -## PARAMETERS - -### -Id - -Specifies feed by ID or Name. - -```yaml -Type: Int32 -Parameter Sets: -Aliases: Name -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -## OUTPUTS - -### Team.Feed - -## NOTES - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Add-VSTeamFeed](Add-VSTeamFeed.md) + + +# Show-VSTeamFeed + +## SYNOPSIS + +Opens the feed in the default browser. + +## SYNTAX + +## DESCRIPTION + +Opens the feed in the default browser. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Show-VSTeamFeed -Name Demo +``` + +This command will open a web browser with this feed showing. + +## PARAMETERS + +### -Id + +Specifies feed by ID or Name. + +```yaml +Type: Int32 +Parameter Sets: +Aliases: Name +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +## OUTPUTS + +### Team.Feed + +## NOTES + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Add-VSTeamFeed](Add-VSTeamFeed.md) diff --git a/docs/Show-VSTeamGitRepository.md b/docs/Show-VSTeamGitRepository.md index 73ecb887b..534e3ae0a 100644 --- a/docs/Show-VSTeamGitRepository.md +++ b/docs/Show-VSTeamGitRepository.md @@ -1,61 +1,61 @@ - - -# Show-VSTeamGitRepository - -## SYNOPSIS - -Opens the Git repository in the default browser. - -## SYNTAX - -## DESCRIPTION - -Opens the Git repository in the default browser. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Show-VSTeamGitRepository -ProjectName Demo -``` - -This command opens the Git repository in a browser. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -RemoteUrl - -The RemoteUrl of the Git repository to open. - -```yaml -Type: String -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS + + +# Show-VSTeamGitRepository + +## SYNOPSIS + +Opens the Git repository in the default browser. + +## SYNTAX + +## DESCRIPTION + +Opens the Git repository in the default browser. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Show-VSTeamGitRepository -ProjectName Demo +``` + +This command opens the Git repository in a browser. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -RemoteUrl + +The RemoteUrl of the Git repository to open. + +```yaml +Type: String +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Show-VSTeamProject.md b/docs/Show-VSTeamProject.md index 8a114e342..5d890ef8a 100644 --- a/docs/Show-VSTeamProject.md +++ b/docs/Show-VSTeamProject.md @@ -1,69 +1,69 @@ - - -# Show-VSTeamProject - -## SYNOPSIS - -Opens the project in the default browser. - -## SYNTAX - -## DESCRIPTION - -Opens the project in default browser. - -You must call Set-VSTeamAccount before calling this function. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Show-VSTeamProject TestProject -``` - -This will open a browser to the TestProject site - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -The id of the project to return. - -```yaml -Type: String -Parameter Sets: ByID -Aliases: ProjectID -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Add-VSTeamProject](Add-VSTeamProject.md) - -[Remove-VSTeamProject](Remove-VSTeamProject.md) + + +# Show-VSTeamProject + +## SYNOPSIS + +Opens the project in the default browser. + +## SYNTAX + +## DESCRIPTION + +Opens the project in default browser. + +You must call Set-VSTeamAccount before calling this function. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Show-VSTeamProject TestProject +``` + +This will open a browser to the TestProject site + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +The id of the project to return. + +```yaml +Type: String +Parameter Sets: ByID +Aliases: ProjectID +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Add-VSTeamProject](Add-VSTeamProject.md) + +[Remove-VSTeamProject](Remove-VSTeamProject.md) diff --git a/docs/Show-VSTeamPullRequest.md b/docs/Show-VSTeamPullRequest.md index b1d6a3f25..7f21f8bf8 100644 --- a/docs/Show-VSTeamPullRequest.md +++ b/docs/Show-VSTeamPullRequest.md @@ -1,60 +1,60 @@ - - -# Show-VSTeamPullRequest - -## SYNOPSIS - -Opens the pull request in the default browser. - -## SYNTAX - -## DESCRIPTION - -Opens the pull request in the default browser. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Show-VSTeamPullRequest 3 -``` - -This command will open a web browser with the pull request id of 3. - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Show-VSTeamPullRequest -Id 3 -``` - -This command will open a web browser with the pull request id of 3. - -## PARAMETERS - -### -PullRequestId - -Specifies pull request by ID. - -```yaml -Type: Int32 -Aliases: PullRequestId -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -## OUTPUTS - -### Team.Release - -## NOTES - -You can pipe the pull request ID to this function. - -## RELATED LINKS - -[Get-VSTeamPullRequest](Get-VSTeamPullRequest.md) + + +# Show-VSTeamPullRequest + +## SYNOPSIS + +Opens the pull request in the default browser. + +## SYNTAX + +## DESCRIPTION + +Opens the pull request in the default browser. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Show-VSTeamPullRequest 3 +``` + +This command will open a web browser with the pull request id of 3. + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Show-VSTeamPullRequest -Id 3 +``` + +This command will open a web browser with the pull request id of 3. + +## PARAMETERS + +### -PullRequestId + +Specifies pull request by ID. + +```yaml +Type: Int32 +Aliases: PullRequestId +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +## OUTPUTS + +### Team.Release + +## NOTES + +You can pipe the pull request ID to this function. + +## RELATED LINKS + +[Get-VSTeamPullRequest](Get-VSTeamPullRequest.md) diff --git a/docs/Show-VSTeamRelease.md b/docs/Show-VSTeamRelease.md index ae311b634..28ed507fa 100644 --- a/docs/Show-VSTeamRelease.md +++ b/docs/Show-VSTeamRelease.md @@ -1,59 +1,59 @@ - - -# Show-VSTeamRelease - -## SYNOPSIS - -Opens the release summary in the default browser. - -## SYNTAX - -## DESCRIPTION - -Opens the release summary in the default browser. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Show-VSTeamRelease -ProjectName Demo -Id 3 -``` - -This command will open a web browser with the summary of release 3. - -## PARAMETERS - -### -Id - -Specifies release by ID. - -```yaml -Type: Int32 -Parameter Sets: ByID -Aliases: ReleaseID -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -## OUTPUTS - -### Team.Release - -## NOTES - -You can pipe the release ID to this function. - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) - -[Add-VSTeamRelease](Add-VSTeamRelease.md) - -[Remove-VSTeamRelease](Remove-VSTeamRelease.md) + + +# Show-VSTeamRelease + +## SYNOPSIS + +Opens the release summary in the default browser. + +## SYNTAX + +## DESCRIPTION + +Opens the release summary in the default browser. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Show-VSTeamRelease -ProjectName Demo -Id 3 +``` + +This command will open a web browser with the summary of release 3. + +## PARAMETERS + +### -Id + +Specifies release by ID. + +```yaml +Type: Int32 +Parameter Sets: ByID +Aliases: ReleaseID +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +## OUTPUTS + +### Team.Release + +## NOTES + +You can pipe the release ID to this function. + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + +[Add-VSTeamRelease](Add-VSTeamRelease.md) + +[Remove-VSTeamRelease](Remove-VSTeamRelease.md) diff --git a/docs/Show-VSTeamReleaseDefinition.md b/docs/Show-VSTeamReleaseDefinition.md index b756157c6..ace66c307 100644 --- a/docs/Show-VSTeamReleaseDefinition.md +++ b/docs/Show-VSTeamReleaseDefinition.md @@ -1,75 +1,75 @@ - - -# Show-VSTeamReleaseDefinition - -## SYNOPSIS - -Opens the release definitions for a team project in the default browser. - -## SYNTAX - -## DESCRIPTION - -Opens the release definitions for a team project in the default browser. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Show-VSTeamReleaseDefinition -ProjectName Demo -``` - -This command will open a web browser with All Release Definitions for this project showing. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies release definition by ID. - -```yaml -Type: Int32 -Parameter Sets: ByID -Aliases: ReleaseDefinitionID -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -## OUTPUTS - -### Team.ReleaseDefinition - -## NOTES - -You can pipe the release definition ID to this function. - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) - -[Add-VSTeamReleaseDefinition](Add-VSTeamReleaseDefinition.md) - -[Remove-VSTeamReleaseDefinition](Remove-VSTeamReleaseDefinition.md) + + +# Show-VSTeamReleaseDefinition + +## SYNOPSIS + +Opens the release definitions for a team project in the default browser. + +## SYNTAX + +## DESCRIPTION + +Opens the release definitions for a team project in the default browser. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Show-VSTeamReleaseDefinition -ProjectName Demo +``` + +This command will open a web browser with All Release Definitions for this project showing. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies release definition by ID. + +```yaml +Type: Int32 +Parameter Sets: ByID +Aliases: ReleaseDefinitionID +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +## OUTPUTS + +### Team.ReleaseDefinition + +## NOTES + +You can pipe the release definition ID to this function. + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + +[Add-VSTeamReleaseDefinition](Add-VSTeamReleaseDefinition.md) + +[Remove-VSTeamReleaseDefinition](Remove-VSTeamReleaseDefinition.md) diff --git a/docs/Show-VSTeamWorkItem.md b/docs/Show-VSTeamWorkItem.md index 1680128aa..c6a067fb4 100644 --- a/docs/Show-VSTeamWorkItem.md +++ b/docs/Show-VSTeamWorkItem.md @@ -1,59 +1,59 @@ - - -# Show-VSTeamWorkItem - -## SYNOPSIS - -Opens the work item in the default browser. - -## SYNTAX - -## DESCRIPTION - -Opens the work item in the default browser. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Show-VSTeamWorkItem -ProjectName Demo -Id 3 -``` - -This command will open a web browser with the summary of work item 3. - -## PARAMETERS - -### -Id - -Specifies work item by ID. - -```yaml -Type: Int32 -Parameter Sets: ByID -Aliases: WorkItemID -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -## OUTPUTS - -### Team.WorkItem - -## NOTES - -You can pipe the WorkItem ID to this function. - -## RELATED LINKS - -[Set-VSTeamAccount](Set-VSTeamAccount.md) - -[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) - -[Add-VSTeamWorkItem](Add-VSTeamWorkItem.md) - -[Get-VSTeamWorkItem](Get-VSTeamWorkItem.md) + + +# Show-VSTeamWorkItem + +## SYNOPSIS + +Opens the work item in the default browser. + +## SYNTAX + +## DESCRIPTION + +Opens the work item in the default browser. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Show-VSTeamWorkItem -ProjectName Demo -Id 3 +``` + +This command will open a web browser with the summary of work item 3. + +## PARAMETERS + +### -Id + +Specifies work item by ID. + +```yaml +Type: Int32 +Parameter Sets: ByID +Aliases: WorkItemID +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +## OUTPUTS + +### Team.WorkItem + +## NOTES + +You can pipe the WorkItem ID to this function. + +## RELATED LINKS + +[Set-VSTeamAccount](Set-VSTeamAccount.md) + +[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + +[Add-VSTeamWorkItem](Add-VSTeamWorkItem.md) + +[Get-VSTeamWorkItem](Get-VSTeamWorkItem.md) diff --git a/docs/Team.md b/docs/Team.md index 5e1cbe6bb..e883be423 100644 --- a/docs/Team.md +++ b/docs/Team.md @@ -1,26 +1,26 @@ ---- -Module Name: Team -Module Guid: 22fe5207-1749-4832-9648-e939fe074b7f -Help Version: 1.0.0.0 -Locale: en-US ---- - -# VSTeam Module - -## Description - -Welcome to VSTeam. VSTeam is a [PowerShell module](https://www.powershellgallery.com/packages/VSTeam/) that wraps the [REST API provided by Team Foundation Server and Visual Studio Team Services](https://cda.ms/ys). This allows you to access the power of TFS and VSTS from [PowerShell on Windows, MacOS and Linux](https://github.com/PowerShell/PowerShell). - -## VSTeam Functions - +--- +Module Name: Team +Module Guid: 22fe5207-1749-4832-9648-e939fe074b7f +Help Version: 1.0.0.0 +Locale: en-US +--- + +# VSTeam Module + +## Description + +Welcome to VSTeam. VSTeam is a [PowerShell module](https://www.powershellgallery.com/packages/VSTeam/) that wraps the [REST API provided by Team Foundation Server and Visual Studio Team Services](https://cda.ms/ys). This allows you to access the power of TFS and VSTS from [PowerShell on Windows, MacOS and Linux](https://github.com/PowerShell/PowerShell). + +## VSTeam Functions + ### [Add-VSTeam](Add-VSTeam.md) Adds a team to a team project. ### [Add-VSTeamAccessControlEntry](Add-VSTeamAccessControlEntry.md) -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. - +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-VSTeamAzureRMServiceEndpoint](Add-VSTeamAzureRMServiceEndpoint.md) @@ -69,7 +69,7 @@ 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 +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) @@ -366,8 +366,8 @@ Removes a service endpoint. ### [Remove-VSTeamUserEntitlement](Remove-VSTeamUserEntitlement.md) -Delete a user from the account. - +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](Remove-VSTeamVariableGroup.md) @@ -376,7 +376,7 @@ Removes a variable group ### [Set-VSTeamAccount](Set-VSTeamAccount.md) -Stores your account name and personal access token for use with the other +Stores your account name and personal access token for use with the other functions in this module. ### [Set-VSTeamAlias](Set-VSTeamAlias.md) @@ -496,5 +496,5 @@ Updates an existing variable group Update a work item in your project. - + diff --git a/docs/Update-VSTeam.md b/docs/Update-VSTeam.md index 8d8a28ba9..d61e0695c 100644 --- a/docs/Update-VSTeam.md +++ b/docs/Update-VSTeam.md @@ -1,108 +1,108 @@ - - -# Update-VSTeam - -## SYNOPSIS - -Updates the team name, description or both. - -## SYNTAX - -## DESCRIPTION - -Updates the team name, description or both. - -## EXAMPLES - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Description - -The new description of the team - -```yaml -Type: String -Position: 2 -``` - -### -Name - -The name of the team to update - -```yaml -Type: String -Aliases: Id, TeamToUpdate, TeamId, TeamName -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -NewTeamName - -The new name of the team - -```yaml -Type: String -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Aliases: cf -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Aliases: wi -``` - -## INPUTS - -### System.String - -Description - -Name - -NewTeamName - -## OUTPUTS - -### Team.Team - -## NOTES - -## RELATED LINKS + + +# Update-VSTeam + +## SYNOPSIS + +Updates the team name, description or both. + +## SYNTAX + +## DESCRIPTION + +Updates the team name, description or both. + +## EXAMPLES + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Description + +The new description of the team + +```yaml +Type: String +Position: 2 +``` + +### -Name + +The name of the team to update + +```yaml +Type: String +Aliases: Id, TeamToUpdate, TeamId, TeamName +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -NewTeamName + +The new name of the team + +```yaml +Type: String +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Aliases: cf +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Aliases: wi +``` + +## INPUTS + +### System.String + +Description + +Name + +NewTeamName + +## OUTPUTS + +### Team.Team + +## NOTES + +## RELATED LINKS diff --git a/docs/Update-VSTeamBuild.md b/docs/Update-VSTeamBuild.md index 176a7953a..54d3a500a 100644 --- a/docs/Update-VSTeamBuild.md +++ b/docs/Update-VSTeamBuild.md @@ -1,109 +1,109 @@ - - -# Update-VSTeamBuild - -## SYNOPSIS - -Allows you to set the keep forever flag and build number. - -## SYNTAX - -## DESCRIPTION - -Allows you to set the keep forever flag and build number. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamBuild | Update-VSTeamBuild -KeepForever $false -``` - -Sets the keep forever property of every build to false. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -BuildNumber - -The value you want to set as the build number. - -```yaml -Type: String -Accept pipeline input: true (ByPropertyName, ByValue) -``` - -### -Id - -The id of the build. - -```yaml -Type: Int32 -Aliases: BuildID -Required: True -Accept pipeline input: true (ByPropertyName, ByValue) -``` - -### -KeepForever - -$True or $False to set the keep forever property of the build. - -```yaml -Type: Boolean -Accept pipeline input: true (ByPropertyName, ByValue) -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Aliases: cf -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Aliases: wi -``` - -## INPUTS - -## OUTPUTS - -### Team.Build - -## NOTES - -## RELATED LINKS + + +# Update-VSTeamBuild + +## SYNOPSIS + +Allows you to set the keep forever flag and build number. + +## SYNTAX + +## DESCRIPTION + +Allows you to set the keep forever flag and build number. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamBuild | Update-VSTeamBuild -KeepForever $false +``` + +Sets the keep forever property of every build to false. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -BuildNumber + +The value you want to set as the build number. + +```yaml +Type: String +Accept pipeline input: true (ByPropertyName, ByValue) +``` + +### -Id + +The id of the build. + +```yaml +Type: Int32 +Aliases: BuildID +Required: True +Accept pipeline input: true (ByPropertyName, ByValue) +``` + +### -KeepForever + +$True or $False to set the keep forever property of the build. + +```yaml +Type: Boolean +Accept pipeline input: true (ByPropertyName, ByValue) +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Aliases: cf +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Aliases: wi +``` + +## INPUTS + +## OUTPUTS + +### Team.Build + +## NOTES + +## RELATED LINKS diff --git a/docs/Update-VSTeamBuildDefinition.md b/docs/Update-VSTeamBuildDefinition.md index 8657b9ba2..16695551e 100644 --- a/docs/Update-VSTeamBuildDefinition.md +++ b/docs/Update-VSTeamBuildDefinition.md @@ -1,85 +1,85 @@ - - -# Update-VSTeamBuildDefinition - -## SYNOPSIS - -Updates a build definition for a team project. - -## SYNTAX - -## DESCRIPTION - -Reads a JSON file off disk and uses that file to update an existing build definition in the provided project. - -You must call Set-VSTeamAccount before calling this function. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Update-VSTeamBuildDefinition -ProjectName Demo -Id 123 -InFile build.json -``` - -This command reads build.json and updates existing build definition with -id 123 from it on the demo team project. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies the build definition to update by ID. - -To find the ID of a build definition, type Get-VSTeamBuildDefinition. - -```yaml -Type: Int32 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -InFile - -Path and file name to the JSON file that contains the definition to be updated. If the path is omitted, the default is the current location. - -```yaml -Type: String -Required: True -Position: 1 -Accept pipeline input: true (ByPropertyName) -``` - -## INPUTS - -## OUTPUTS - -### None - -## NOTES - -This function has a Dynamic Parameter for ProjectName that specifies the project for which this function gets build definitions. - -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. - -## RELATED LINKS + + +# Update-VSTeamBuildDefinition + +## SYNOPSIS + +Updates a build definition for a team project. + +## SYNTAX + +## DESCRIPTION + +Reads a JSON file off disk and uses that file to update an existing build definition in the provided project. + +You must call Set-VSTeamAccount before calling this function. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Update-VSTeamBuildDefinition -ProjectName Demo -Id 123 -InFile build.json +``` + +This command reads build.json and updates existing build definition with +id 123 from it on the demo team project. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies the build definition to update by ID. + +To find the ID of a build definition, type Get-VSTeamBuildDefinition. + +```yaml +Type: Int32 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -InFile + +Path and file name to the JSON file that contains the definition to be updated. If the path is omitted, the default is the current location. + +```yaml +Type: String +Required: True +Position: 1 +Accept pipeline input: true (ByPropertyName) +``` + +## INPUTS + +## OUTPUTS + +### None + +## NOTES + +This function has a Dynamic Parameter for ProjectName that specifies the project for which this function gets build definitions. + +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. + +## RELATED LINKS diff --git a/docs/Update-VSTeamExtension.md b/docs/Update-VSTeamExtension.md index 49b0b5f8c..53e951c0a 100644 --- a/docs/Update-VSTeamExtension.md +++ b/docs/Update-VSTeamExtension.md @@ -1,73 +1,73 @@ - - -# Update-VSTeamExtension - -## SYNOPSIS - -Update an installed extension. Typically this API is used to enable or disable an extension. - -## SYNTAX - -## DESCRIPTION - -Update an installed extension. Typically this API is used to enable or disable an extension. - -## EXAMPLES - -## PARAMETERS - -### -PublisherId - -The id of the publisher. - -```yaml -Type: String -Required: True -``` - -### -ExtensionId - -The id of the extension. - -```yaml -Type: String -Required: True -``` - -### -ExtensionState - -The state of an installed extension. Example: "disabled". The acceptable values for this parameter are: - -- none -- disabled - -```yaml -Type: String -Required: True -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-VSTeamExtension](Add-VSTeamExtension.md) - -[Get-VSTeamExtension](Get-VSTeamExtension.md) - -[Remove-VSTeamExtension](Remove-VSTeamExtension.md) - -[Update-VSTeamExtension](Update-VSTeamExtension.md) + + +# Update-VSTeamExtension + +## SYNOPSIS + +Update an installed extension. Typically this API is used to enable or disable an extension. + +## SYNTAX + +## DESCRIPTION + +Update an installed extension. Typically this API is used to enable or disable an extension. + +## EXAMPLES + +## PARAMETERS + +### -PublisherId + +The id of the publisher. + +```yaml +Type: String +Required: True +``` + +### -ExtensionId + +The id of the extension. + +```yaml +Type: String +Required: True +``` + +### -ExtensionState + +The state of an installed extension. Example: "disabled". The acceptable values for this parameter are: + +- none +- disabled + +```yaml +Type: String +Required: True +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Add-VSTeamExtension](Add-VSTeamExtension.md) + +[Get-VSTeamExtension](Get-VSTeamExtension.md) + +[Remove-VSTeamExtension](Remove-VSTeamExtension.md) + +[Update-VSTeamExtension](Update-VSTeamExtension.md) diff --git a/docs/Update-VSTeamPolicy.md b/docs/Update-VSTeamPolicy.md index 3aca54380..9b1f5fc90 100644 --- a/docs/Update-VSTeamPolicy.md +++ b/docs/Update-VSTeamPolicy.md @@ -1,101 +1,101 @@ - - -# Update-VSTeamPolicy - -## SYNOPSIS - -Updates an existing policy in the specified project. - -## SYNTAX - -## DESCRIPTION - -Updates an existing policy in the specified project. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Update-VSTeamPolicy -ProjectName Demo -id 1 -type 687c53f8-1a82-4e89-9a86-13d51bc4a8d5 -enabled -blocking -settings @{MinimumApproverCount = 1;Scope=@(@{repositoryId=b87c5af8-1a82-4e59-9a86-13d5cbc4a8d5; matchKind="Exact"; refName="refs/heads/master"})} -``` - -This command updates an existing policy in the Demo project. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -Specifies the policy to update. - -```yaml -Type: Int -``` - -### -type - -Specifies the id of the type of policy to be update. This must match the original policy, it cannot be changed via this call. - -```yaml -Type: Guid -Required: True -``` - -### -enabled - -Enables the policy - -```yaml -Type: Switch -``` - -### -blocking - -Determines if the policy will block pushes to the branch if the policy is not adhered to. - -```yaml -Type: Switch -``` - -### -settings - -The settings for the policy. - -Each policy type has it's own settings that will need to be set. - -```yaml -Type: Hashtable -Required: True -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-VSTeamPolicy](Get-VSTeamPolicy.md) - -[Remove-VSTeamPolicy](Remove-VSTeamPolicy.md) - -[Get-VSTeamPolicyType](Get-VSTeamPolicyType.md) + + +# Update-VSTeamPolicy + +## SYNOPSIS + +Updates an existing policy in the specified project. + +## SYNTAX + +## DESCRIPTION + +Updates an existing policy in the specified project. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Update-VSTeamPolicy -ProjectName Demo -id 1 -type 687c53f8-1a82-4e89-9a86-13d51bc4a8d5 -enabled -blocking -settings @{MinimumApproverCount = 1;Scope=@(@{repositoryId=b87c5af8-1a82-4e59-9a86-13d5cbc4a8d5; matchKind="Exact"; refName="refs/heads/master"})} +``` + +This command updates an existing policy in the Demo project. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +Specifies the policy to update. + +```yaml +Type: Int +``` + +### -type + +Specifies the id of the type of policy to be update. This must match the original policy, it cannot be changed via this call. + +```yaml +Type: Guid +Required: True +``` + +### -enabled + +Enables the policy + +```yaml +Type: Switch +``` + +### -blocking + +Determines if the policy will block pushes to the branch if the policy is not adhered to. + +```yaml +Type: Switch +``` + +### -settings + +The settings for the policy. + +Each policy type has it's own settings that will need to be set. + +```yaml +Type: Hashtable +Required: True +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-VSTeamPolicy](Get-VSTeamPolicy.md) + +[Remove-VSTeamPolicy](Remove-VSTeamPolicy.md) + +[Get-VSTeamPolicyType](Get-VSTeamPolicyType.md) diff --git a/docs/Update-VSTeamProfile.md b/docs/Update-VSTeamProfile.md index 3fd51d041..710540f4b 100644 --- a/docs/Update-VSTeamProfile.md +++ b/docs/Update-VSTeamProfile.md @@ -1,97 +1,97 @@ - - -# Update-VSTeamProfile - -## SYNOPSIS - -Allows you to update the Personal Access Token for your profile. - -## SYNTAX - -## DESCRIPTION - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Update-VSTeamProfile -Name ProfileName -``` - -You will be prompted for the account name and personal access token. - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Update-VSTeamProfile -Name mydemos -PersonalAccessToken 7a8ilh6db4aforlrnrqmdrxdztkjvcc4uhlh5vgbteserp3mziwnga -``` - -Allows you to provide all the information on the command line. - -### -------------------------- EXAMPLE 3 -------------------------- - -```PowerShell -PS C:\> Get-VSTeamProfile | Where-Object version -eq vsts | Select-Object -skip 1 | Update-VSTeamProfile -PersonalAccessToken 7a8ilh6db4aforlrnrqmdrxdztkjvcc4uhlh5vgbteserp3mziwnga -Force -``` - -This will update all but the first VSTS profile - -## PARAMETERS - -### -PAT - -A secured string to capture your personal access token. - -This will allow you to provide your personal access token -without displaying it in plain text. - -To use pat simply omit it from the Update-VSTeamProfile command. - -```yaml -Type: SecureString -Parameter Sets: Secure -Required: True -``` - -### -PersonalAccessToken - -The personal access token from VSTS/TFS to use to access this account. - -```yaml -Type: String -Parameter Sets: Plain -Required: True -Position: 2 -``` - -### -Name - -Name of the profile to be updated - -```yaml -Type: String -Required: True -Position: 3 -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Update-VSTeamAccount](Set-VSTeamAccount.md) - -[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) + + +# Update-VSTeamProfile + +## SYNOPSIS + +Allows you to update the Personal Access Token for your profile. + +## SYNTAX + +## DESCRIPTION + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Update-VSTeamProfile -Name ProfileName +``` + +You will be prompted for the account name and personal access token. + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Update-VSTeamProfile -Name mydemos -PersonalAccessToken 7a8ilh6db4aforlrnrqmdrxdztkjvcc4uhlh5vgbteserp3mziwnga +``` + +Allows you to provide all the information on the command line. + +### -------------------------- EXAMPLE 3 -------------------------- + +```PowerShell +PS C:\> Get-VSTeamProfile | Where-Object version -eq vsts | Select-Object -skip 1 | Update-VSTeamProfile -PersonalAccessToken 7a8ilh6db4aforlrnrqmdrxdztkjvcc4uhlh5vgbteserp3mziwnga -Force +``` + +This will update all but the first VSTS profile + +## PARAMETERS + +### -PAT + +A secured string to capture your personal access token. + +This will allow you to provide your personal access token +without displaying it in plain text. + +To use pat simply omit it from the Update-VSTeamProfile command. + +```yaml +Type: SecureString +Parameter Sets: Secure +Required: True +``` + +### -PersonalAccessToken + +The personal access token from VSTS/TFS to use to access this account. + +```yaml +Type: String +Parameter Sets: Plain +Required: True +Position: 2 +``` + +### -Name + +Name of the profile to be updated + +```yaml +Type: String +Required: True +Position: 3 +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Update-VSTeamAccount](Set-VSTeamAccount.md) + +[Set-VSTeamDefaultProject](Set-VSTeamDefaultProject.md) diff --git a/docs/Update-VSTeamProject.md b/docs/Update-VSTeamProject.md index 085b8dcfa..24325197d 100644 --- a/docs/Update-VSTeamProject.md +++ b/docs/Update-VSTeamProject.md @@ -1,90 +1,90 @@ - - -# Update-VSTeamProject - -## SYNOPSIS - -Updates the project name, description or both. - -## SYNTAX - -## DESCRIPTION - -Updates the project name, description or both. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Update-VSTeamProject -Name Demo -NewName aspDemo -``` - -This command changes the name of your project from Demo to aspDemo. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -NewName - -The new name for the project. - -```yaml -Type: String -``` - -### -NewDescription - -The new description for the project. - -```yaml -Type: String -``` - -### -Id - -The id of the project to update. - -```yaml -Type: String -Parameter Sets: (ByID) -Aliases: ProjectId -Accept pipeline input: true (ByPropertyName) -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -### System.String - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS + + +# Update-VSTeamProject + +## SYNOPSIS + +Updates the project name, description or both. + +## SYNTAX + +## DESCRIPTION + +Updates the project name, description or both. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Update-VSTeamProject -Name Demo -NewName aspDemo +``` + +This command changes the name of your project from Demo to aspDemo. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -NewName + +The new name for the project. + +```yaml +Type: String +``` + +### -NewDescription + +The new description for the project. + +```yaml +Type: String +``` + +### -Id + +The id of the project to update. + +```yaml +Type: String +Parameter Sets: (ByID) +Aliases: ProjectId +Accept pipeline input: true (ByPropertyName) +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/docs/Update-VSTeamRelease.md b/docs/Update-VSTeamRelease.md index e2aab0941..dff1fa12e 100644 --- a/docs/Update-VSTeamRelease.md +++ b/docs/Update-VSTeamRelease.md @@ -1,113 +1,113 @@ - - -# Update-VSTeamRelease - -## SYNOPSIS - -Allows you to update release variables for future stages to read. - -## SYNTAX - -## DESCRIPTION - -Allows you to update release variables for future stages to read. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamAccount -Account mydemos -Token $(System.AccessToken) -UseBearerToken -PS C:\> $r = Get-VSTeamRelease -ProjectName project -Id 76 -Raw -PS C:\> $r.variables.temp.value='temp' -PS C:\> Update-VSTeamRelease -ProjectName project -Id 76 -release $r -``` - -Changes the variable temp on the release. This can be done in one stage and read in another stage. - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamAccount -Account mydemos -Token $(System.AccessToken) -UseBearerToken -PS C:\> $r = Get-VSTeamRelease -ProjectName project -Id 76 -Raw -PS C:\> $r.variables | Add-Member NoteProperty temp([PSCustomObject]@{value='test'}) -PS C:\> Update-VSTeamRelease -ProjectName project -Id 76 -release $r -``` - -Adds a variable temp to the release with a value of test. - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -The id of the release to update - -```yaml -Type: Int32 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Release - -The updated release to save in AzD - -```yaml -Type: PSCustomObject -Required: True -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Aliases: cf -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Aliases: wi -``` - -## INPUTS - -## OUTPUTS - -### Team.Release - -## NOTES - -## RELATED LINKS + + +# Update-VSTeamRelease + +## SYNOPSIS + +Allows you to update release variables for future stages to read. + +## SYNTAX + +## DESCRIPTION + +Allows you to update release variables for future stages to read. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamAccount -Account mydemos -Token $(System.AccessToken) -UseBearerToken +PS C:\> $r = Get-VSTeamRelease -ProjectName project -Id 76 -Raw +PS C:\> $r.variables.temp.value='temp' +PS C:\> Update-VSTeamRelease -ProjectName project -Id 76 -release $r +``` + +Changes the variable temp on the release. This can be done in one stage and read in another stage. + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamAccount -Account mydemos -Token $(System.AccessToken) -UseBearerToken +PS C:\> $r = Get-VSTeamRelease -ProjectName project -Id 76 -Raw +PS C:\> $r.variables | Add-Member NoteProperty temp([PSCustomObject]@{value='test'}) +PS C:\> Update-VSTeamRelease -ProjectName project -Id 76 -release $r +``` + +Adds a variable temp to the release with a value of test. + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +The id of the release to update + +```yaml +Type: Int32 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Release + +The updated release to save in AzD + +```yaml +Type: PSCustomObject +Required: True +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Aliases: cf +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Aliases: wi +``` + +## INPUTS + +## OUTPUTS + +### Team.Release + +## NOTES + +## RELATED LINKS diff --git a/docs/Update-VSTeamServiceEndpoint.md b/docs/Update-VSTeamServiceEndpoint.md index 81203e0ad..9587c77ed 100644 --- a/docs/Update-VSTeamServiceEndpoint.md +++ b/docs/Update-VSTeamServiceEndpoint.md @@ -1,88 +1,88 @@ - - -# Update-VSTeamServiceEndpoint - -## SYNOPSIS - -Updates an existing service connection - -## SYNTAX - -## DESCRIPTION - -Updates an existing service connection - -## EXAMPLES - -## 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. - -```yaml -Type: String -Position: 0 -Required: True -Accept pipeline input: true (ByPropertyName) -``` - -### -Id - -UUID of existing services endpoint from VSTS - -```yaml -Type: String -Position: 1 -``` - -### -Object - -Hashtable of payload for REST call - -```yaml -Type: Hashtable -Required: true -Accept pipeline input: true (ByPropertyName) -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -### Team.ServiceEndpoint - -## NOTES - -## RELATED LINKS - -[Add-VSTeamServiceEndpoint](Add-VSTeamServiceEndpoint.md) - -[Add-VSTeamServiceFabricEndpoint](Add-VSTeamServiceFabricEndpoint.md) - -[Add-VSTeamSonarQubeEndpoint](Add-VSTeamSonarQubeEndpoint.md) - -[Add-VSTeamKubernetesEndpoint](Add-VSTeamKubernetesEndpoint.md) - -[Add-VSTeamAzureRMServiceEndpoint](Add-VSTeamAzureRMServiceEndpoint.md) - -[Get-VSTeamServiceEndpoint](Get-VSTeamServiceEndpoint.md) - -[Get-VSTeamServiceEndpointType](Get-VSTeamServiceEndpointType.md) - -[Remove-VSTeamServiceEndpoint](Remove-VSTeamServiceEndpoint.md) + + +# Update-VSTeamServiceEndpoint + +## SYNOPSIS + +Updates an existing service connection + +## SYNTAX + +## DESCRIPTION + +Updates an existing service connection + +## EXAMPLES + +## 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. + +```yaml +Type: String +Position: 0 +Required: True +Accept pipeline input: true (ByPropertyName) +``` + +### -Id + +UUID of existing services endpoint from VSTS + +```yaml +Type: String +Position: 1 +``` + +### -Object + +Hashtable of payload for REST call + +```yaml +Type: Hashtable +Required: true +Accept pipeline input: true (ByPropertyName) +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +### Team.ServiceEndpoint + +## NOTES + +## RELATED LINKS + +[Add-VSTeamServiceEndpoint](Add-VSTeamServiceEndpoint.md) + +[Add-VSTeamServiceFabricEndpoint](Add-VSTeamServiceFabricEndpoint.md) + +[Add-VSTeamSonarQubeEndpoint](Add-VSTeamSonarQubeEndpoint.md) + +[Add-VSTeamKubernetesEndpoint](Add-VSTeamKubernetesEndpoint.md) + +[Add-VSTeamAzureRMServiceEndpoint](Add-VSTeamAzureRMServiceEndpoint.md) + +[Get-VSTeamServiceEndpoint](Get-VSTeamServiceEndpoint.md) + +[Get-VSTeamServiceEndpointType](Get-VSTeamServiceEndpointType.md) + +[Remove-VSTeamServiceEndpoint](Remove-VSTeamServiceEndpoint.md) diff --git a/docs/Update-VSTeamUserEntitlement.md b/docs/Update-VSTeamUserEntitlement.md index 6e1f453fc..ac8692779 100644 --- a/docs/Update-VSTeamUserEntitlement.md +++ b/docs/Update-VSTeamUserEntitlement.md @@ -1,73 +1,73 @@ - - -# Update-VSTeamUserEntitlement - -## SYNOPSIS - -Edit the entitlements (License, Extensions, Projects, Teams etc) for a user. - -## SYNTAX - -## DESCRIPTION - -Edit the entitlements (License, Extensions, Projects, Teams etc) for a user. - -## EXAMPLES - -## PARAMETERS - -### -Id - -The id of the user to be updated. - -```yaml -Type: String -Parameter Sets: ById -Required: True -``` - -### -Email - -The email address of the user to update. For organizations with over 100 users this can be very slow and resource intensive. - -```yaml -Type: String -Parameter Sets: ByEmail -Required: True -``` - -### -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 -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-VSTeamUserEntitlement](Get-VSTeamUserEntitlement.md) + + +# Update-VSTeamUserEntitlement + +## SYNOPSIS + +Edit the entitlements (License, Extensions, Projects, Teams etc) for a user. + +## SYNTAX + +## DESCRIPTION + +Edit the entitlements (License, Extensions, Projects, Teams etc) for a user. + +## EXAMPLES + +## PARAMETERS + +### -Id + +The id of the user to be updated. + +```yaml +Type: String +Parameter Sets: ById +Required: True +``` + +### -Email + +The email address of the user to update. For organizations with over 100 users this can be very slow and resource intensive. + +```yaml +Type: String +Parameter Sets: ByEmail +Required: True +``` + +### -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 +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Get-VSTeamUserEntitlement](Get-VSTeamUserEntitlement.md) diff --git a/docs/Update-VSTeamWorkItem.md b/docs/Update-VSTeamWorkItem.md index 94a7d2360..905a9a25c 100644 --- a/docs/Update-VSTeamWorkItem.md +++ b/docs/Update-VSTeamWorkItem.md @@ -1,116 +1,116 @@ - - -# Update-VSTeamWorkItem - -## SYNOPSIS - -Update a work item in your project. - -## SYNTAX - -## DESCRIPTION - -Update-VSTeamWorkItem will update a new work item in your project. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamDefaultProject Demo -PS C:\> Update-VSTeamWorkItem -WorkItemId 1 -Title "Updated Work Item" - -ID Title Status --- ----- ------ -6 Updated Work Item To Do -``` - -### -------------------------- EXAMPLE 2 -------------------------- - -```PowerShell -PS C:\> Set-VSTeamDefaultProject Demo -PS C:\> Update-VSTeamWorkItem -Title "Updated Work Item" -WorkItemType Task -Description "This is a description" - -ID Title Status --- ----- ------ -6 Updated Work Item To Do -``` - -## PARAMETERS - -### -Id - -The id of the work item. - -```yaml -Type: Int32 -Parameter Sets: ByID -Required: True -Accept pipeline input: true (ByPropertyName, ByValue) -``` - -### -Title - -The title of the work item - -```yaml -Type: String -Required: False -``` - -### -Description - -The Description of the work item - -```yaml -Type: String -Required: False -``` - -### -IterationPath - -The IterationPath of the work item - -```yaml -Type: String -Required: False -``` - -### -AssignedTo - -The email address of the user this work item will be assigned to. - -```yaml -Type: String -Required: False -``` - -### -Force - -Forces the command without confirmation - -```yaml -Type: SwitchParameter -``` - -## INPUTS - -### System.String - -ProjectName - -WorkItemType - -## OUTPUTS - -## NOTES - -WorkItemType is a dynamic parameter and use the default -project value to query their validate set. - -If you do not set the default project by called Set-VSTeamDefaultProject before -calling Update-VSTeamWorkItem you will have to type in the names. - -## RELATED LINKS + + +# Update-VSTeamWorkItem + +## SYNOPSIS + +Update a work item in your project. + +## SYNTAX + +## DESCRIPTION + +Update-VSTeamWorkItem will update a new work item in your project. + +## EXAMPLES + +### -------------------------- EXAMPLE 1 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamDefaultProject Demo +PS C:\> Update-VSTeamWorkItem -WorkItemId 1 -Title "Updated Work Item" + +ID Title Status +-- ----- ------ +6 Updated Work Item To Do +``` + +### -------------------------- EXAMPLE 2 -------------------------- + +```PowerShell +PS C:\> Set-VSTeamDefaultProject Demo +PS C:\> Update-VSTeamWorkItem -Title "Updated Work Item" -WorkItemType Task -Description "This is a description" + +ID Title Status +-- ----- ------ +6 Updated Work Item To Do +``` + +## PARAMETERS + +### -Id + +The id of the work item. + +```yaml +Type: Int32 +Parameter Sets: ByID +Required: True +Accept pipeline input: true (ByPropertyName, ByValue) +``` + +### -Title + +The title of the work item + +```yaml +Type: String +Required: False +``` + +### -Description + +The Description of the work item + +```yaml +Type: String +Required: False +``` + +### -IterationPath + +The IterationPath of the work item + +```yaml +Type: String +Required: False +``` + +### -AssignedTo + +The email address of the user this work item will be assigned to. + +```yaml +Type: String +Required: False +``` + +### -Force + +Forces the command without confirmation + +```yaml +Type: SwitchParameter +``` + +## INPUTS + +### System.String + +ProjectName + +WorkItemType + +## OUTPUTS + +## NOTES + +WorkItemType is a dynamic parameter and use the default +project value to query their validate set. + +If you do not set the default project by called Set-VSTeamDefaultProject before +calling Update-VSTeamWorkItem you will have to type in the names. + +## RELATED LINKS diff --git a/docs/readme.md b/docs/readme.md index 892426236..7ac308334 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,31 +1,31 @@ -# VSTeam Help - -Welcome to VSTeam. VSTeam is a [PowerShell module](https://www.powershellgallery.com/packages/VSTeam/) that wraps the [REST API provided by Team Foundation Server and Visual Studio Team Services](https://cda.ms/ys). This allows you to access the power of TFS and VSTS from [PowerShell on Windows, MacOS and Linux](https://github.com/PowerShell/PowerShell). - -## About files - -[VSTeam](../en-US/about_vsteam.help.txt) - -Learn about the goals of VSTeam. - -[Profiles](../en-US/about_vsteam_profiles.help.txt) - -Profiles allow you to store your account information for easy switching of accounts. - -[Provider](../en-US/about_vsteam_provider.help.txt) - -The provider allows you to navigate your TFS or VSTS as a file system. - -## VSTeam Functions - +# VSTeam Help + +Welcome to VSTeam. VSTeam is a [PowerShell module](https://www.powershellgallery.com/packages/VSTeam/) that wraps the [REST API provided by Team Foundation Server and Visual Studio Team Services](https://cda.ms/ys). This allows you to access the power of TFS and VSTS from [PowerShell on Windows, MacOS and Linux](https://github.com/PowerShell/PowerShell). + +## About files + +[VSTeam](../en-US/about_vsteam.help.txt) + +Learn about the goals of VSTeam. + +[Profiles](../en-US/about_vsteam_profiles.help.txt) + +Profiles allow you to store your account information for easy switching of accounts. + +[Provider](../en-US/about_vsteam_provider.help.txt) + +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-VSTeamAccessControlEntry](Add-VSTeamAccessControlEntry.md) -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. - +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-VSTeamAzureRMServiceEndpoint](Add-VSTeamAzureRMServiceEndpoint.md) @@ -74,7 +74,7 @@ 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 +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) @@ -371,8 +371,8 @@ Removes a service endpoint. ### [Remove-VSTeamUserEntitlement](Remove-VSTeamUserEntitlement.md) -Delete a user from the account. - +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](Remove-VSTeamVariableGroup.md) @@ -381,7 +381,7 @@ Removes a variable group ### [Set-VSTeamAccount](Set-VSTeamAccount.md) -Stores your account name and personal access token for use with the other +Stores your account name and personal access token for use with the other functions in this module. ### [Set-VSTeamAlias](Set-VSTeamAlias.md) @@ -501,5 +501,5 @@ Updates an existing variable group Update a work item in your project. - +