diff --git a/AzureDevOpsPowerShell/Private/Invoke-AzDoRestMethod.ps1 b/AzureDevOpsPowerShell/Private/Invoke-AzDoRestMethod.ps1 index a2dd1750..79084cde 100644 --- a/AzureDevOpsPowerShell/Private/Invoke-AzDoRestMethod.ps1 +++ b/AzureDevOpsPowerShell/Private/Invoke-AzDoRestMethod.ps1 @@ -100,7 +100,7 @@ function Invoke-AzDoRestMethod { try { Invoke-RestMethod @params } catch { - Write-AzdoError -Message ($_ | ConvertFrom-Json).message + $PSCmdlet.ThrowTerminatingError((Write-AzDoError -Message ($_ | ConvertFrom-Json).message)) } } } diff --git a/AzureDevOpsPowerShell/Private/Validate-CollectionUri.ps1 b/AzureDevOpsPowerShell/Private/Validate-CollectionUri.ps1 index 551c2ae6..0b7e976b 100644 --- a/AzureDevOpsPowerShell/Private/Validate-CollectionUri.ps1 +++ b/AzureDevOpsPowerShell/Private/Validate-CollectionUri.ps1 @@ -8,7 +8,7 @@ function Validate-CollectionUri { ) if ($CollectionUri -notmatch '^https:\/\/dev\.azure\.com\/\w+') { - Write-AzdoError "CollectionUri must be a valid Azure DevOps collection URI starting with 'https://dev.azure.com/'" + $PSCmdlet.ThrowTerminatingError((Write-AzDoError "CollectionUri must be a valid Azure DevOps collection URI starting with 'https://dev.azure.com/'")) } else { $true } diff --git a/AzureDevOpsPowerShell/Private/Write-AzDoError.ps1 b/AzureDevOpsPowerShell/Private/Write-AzDoError.ps1 index d2d8242d..e96d459a 100644 --- a/AzureDevOpsPowerShell/Private/Write-AzDoError.ps1 +++ b/AzureDevOpsPowerShell/Private/Write-AzDoError.ps1 @@ -8,13 +8,11 @@ function Write-AzDoError { process { - $errorRec = [System.Management.Automation.ErrorRecord]::new( + [System.Management.Automation.ErrorRecord]::new( [Exception]::new($Message), 'ErrorID', [System.Management.Automation.ErrorCategory]::OperationStopped, 'TargetObject' ) - - $PScmdlet.ThrowTerminatingError($errorRec) } } diff --git a/AzureDevOpsPowerShell/Public/Api/Core/Projects/New-AzDoProject.ps1 b/AzureDevOpsPowerShell/Public/Api/Core/Projects/New-AzDoProject.ps1 index d7541011..914ec065 100644 --- a/AzureDevOpsPowerShell/Public/Api/Core/Projects/New-AzDoProject.ps1 +++ b/AzureDevOpsPowerShell/Public/Api/Core/Projects/New-AzDoProject.ps1 @@ -160,7 +160,7 @@ function New-AzDoProject { if ($_ -match 'TF200019') { Write-Warning "Project $name already exists, trying to get it" } else { - Write-AzDoError -message $_ + $PSCmdlet.ThrowTerminatingError((Write-AzDoError -message $_)) } } diff --git a/AzureDevOpsPowerShell/Public/Api/Core/Teams/Get-AzDoAllTeams.ps1 b/AzureDevOpsPowerShell/Public/Api/Core/Teams/Get-AzDoAllTeams.ps1 new file mode 100644 index 00000000..ee912873 --- /dev/null +++ b/AzureDevOpsPowerShell/Public/Api/Core/Teams/Get-AzDoAllTeams.ps1 @@ -0,0 +1,93 @@ +function Get-AzDoAllTeams { + <# + .SYNOPSIS + This script gets all teams within an organization. + .DESCRIPTION + This script retrieves all teams within an organization using the Azure DevOps REST API. + .EXAMPLE + $params = @{ + CollectionUri = 'https://dev.azure.com/contoso/' + ExpandIdentity = $true + Mine = $true + } + Get-AzDoAllTeams @params + + This example gets all teams within 'contoso' where the requesting user is a member. + .OUTPUTS + PSObject + .NOTES + #> + [CmdletBinding(SupportsShouldProcess)] + param ( + # Collection URI. e.g. https://dev.azure.com/contoso. + [Parameter(Mandatory, ValueFromPipelineByPropertyName)] + [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })] + [String] + $CollectionUri, + + # Whether or not to return detailed identity info + [Parameter(ValueFromPipelineByPropertyName)] + [Switch] + $ExpandIdentity = $false, + + # Filter only teams your identity is member of + [Parameter(ValueFromPipelineByPropertyName)] + [Switch] + $Mine = $false, + + # Skip number N of results + [Parameter(ValueFromPipelineByPropertyName)] + [Int] + $Skip = 0, + + # Show only top N results + [Parameter(ValueFromPipelineByPropertyName)] + [Int] + $Top = 0 + ) + process { + $result = @() + Write-Verbose "Starting function: Get-AzDoAllTeams" + + $queryParams = @() + if ($ExpandIdentity) { + $queryParams += "`$expandIdentity=$ExpandIdentity" + } + if ($Mine) { + $queryParams += "`$mine=$Mine" + } + if ($Skip -gt 0) { + $queryParams += "`$skip=$Skip" + } + if ($Top -gt 0) { + $queryParams += "`$top=$Top" + } + $queryParams = $queryParams -join "&" + + $uri = "$CollectionUri/_apis/teams" + $version = "7.1-preview.3" + + $params = @{ + Uri = $uri + Version = $version + QueryParameters = $queryParams + Method = 'GET' + } + + if ($PSCmdlet.ShouldProcess($CollectionUri, "Get all teams in organization")) { + (Invoke-AzDoRestMethod @params).value | ForEach-Object { + [PSCustomObject]@{ + CollectionUri = $CollectionUri + ProjectName = $_.projectName + TeamName = $_.name + TeamId = $_.id + Description = $_.description + Url = $_.url + IdentityUrl = $_.identityUrl + } + } + } else { + Write-Verbose "Calling Invoke-AzDoRestMethod with $($params | ConvertTo-Json -Depth 10)" + } + } +} diff --git a/AzureDevOpsPowerShell/Public/Api/Core/Teams/Get-AzDoProjectTeam.ps1 b/AzureDevOpsPowerShell/Public/Api/Core/Teams/Get-AzDoProjectTeam.ps1 new file mode 100644 index 00000000..be41fbfd --- /dev/null +++ b/AzureDevOpsPowerShell/Public/Api/Core/Teams/Get-AzDoProjectTeam.ps1 @@ -0,0 +1,90 @@ +function Get-AzDoProjectTeam { + <# + .SYNOPSIS + This script gets team details in a given project. + .DESCRIPTION + This script gets teams in a given project. + When used in a pipeline, you can use the pre-defined CollectionUri, ProjectName, and AccessToken (PAT) variables. + .EXAMPLE + $params = @{ + CollectionUri = 'https://dev.azure.com/contoso/' + ProjectName = 'Project 1' + TeamName = 'testteam' + } + Get-AzDoProjectTeam @params + + This example gets the team 'testteam' in 'Project 1'. + .EXAMPLE + $params = @{ + CollectionUri = 'https://dev.azure.com/contoso/' + ProjectName = 'Project 1' + } + Get-AzDoProjectTeam @params + + This example gets all teams in 'Project 1'. + .OUTPUTS + PSObject + #> + [CmdletBinding(SupportsShouldProcess)] + param ( + # Collection URI + [Parameter(Mandatory, ValueFromPipelineByPropertyName)] + [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })] + [string] + $CollectionUri, + + # Project name of the project + [Parameter(Mandatory, ValueFromPipelineByPropertyName)] + [string] + $ProjectName, + + # team name + [Parameter(ValueFromPipelineByPropertyName)] + [string] + $TeamName + ) + process { + Write-Verbose "Starting function: Get-AzDoProjectTeam" + + $params = @{ + uri = "$CollectionUri/_apis/projects/$ProjectName/teams" + version = "7.1-preview.3" + method = 'GET' + } + if ($PSCmdlet.ShouldProcess($CollectionUri, "Get teams from: $($PSStyle.Bold)$ProjectName$($PSStyle.Reset)")) { + try { + $teams = (Invoke-AzDoRestMethod @params).value + } catch { + $PSCmdlet.ThrowTerminatingError((Write-AzDoError -message "Failed to get teams for project '$ProjectName'. Error: $_")) + } + if ($TeamName) { + $teams | Where-Object { $_.name -eq $TeamName } | ForEach-Object { + [PSCustomObject]@{ + CollectionURI = $CollectionUri + ProjectName = $ProjectName + TeamName = $_.name + TeamId = $_.id + Description = $_.description + Url = $_.url + IdentityUrl = $_.identityUrl + } + } + } else { + $teams | ForEach-Object { + [PSCustomObject]@{ + CollectionURI = $CollectionUri + ProjectName = $ProjectName + TeamName = $_.name + TeamId = $_.id + Description = $_.description + Url = $_.url + IdentityUrl = $_.identityUrl + } + } + } + } else { + Write-Verbose "Calling Invoke-AzDoRestMethod with $($params | ConvertTo-Json -Depth 10)" + } + } +} + diff --git a/AzureDevOpsPowerShell/Public/Api/Core/Teams/Get-AzDoTeamMember.ps1 b/AzureDevOpsPowerShell/Public/Api/Core/Teams/Get-AzDoTeamMember.ps1 new file mode 100644 index 00000000..4a08588c --- /dev/null +++ b/AzureDevOpsPowerShell/Public/Api/Core/Teams/Get-AzDoTeamMember.ps1 @@ -0,0 +1,95 @@ +function Get-AzDoTeamMember { + <# + .SYNOPSIS + This script gets team members with extended properties in a given project and team. + .DESCRIPTION + This script gets team members with extended properties in a given project and team. + When used in a pipeline, you can use the pre-defined CollectionUri, ProjectName, and AccessToken (PAT) variables. + .EXAMPLE + $params = @{ + CollectionUri = 'https://dev.azure.com/contos0' + ProjectName = 'Project 1' + TeamName = 'testteam' + } + Get-AzDoTeamMember @params + + This example gets the team members with extended properties in 'testteam' within 'Project 1'. + .OUTPUTS + PSObject + .NOTES + #> + [CmdletBinding(SupportsShouldProcess)] + param ( + # Collection Uri of the organization + [Parameter(Mandatory, ValueFromPipelineByPropertyName)] + [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })] + [string] + $CollectionUri, + + # the projectName + [Parameter(Mandatory, ValueFromPipelineByPropertyName)] + [string] + $ProjectName, + + # Team name of the team + [Parameter(Mandatory, ValueFromPipelineByPropertyName)] + [string] + $TeamName + ) + + process { + Write-Verbose "Starting function: Get-AzDoTeamMember" + + # Get the team ID using the Get-AzDoProjectTeam function + $teamParams = @{ + CollectionUri = $CollectionUri + ProjectName = $ProjectName + TeamName = $TeamName + } + + try { + $team = Get-AzDoProjectTeam @teamParams | Where-Object { $_.TeamName -eq $TeamName } + if (-not $team) { + throw "Team '$TeamName' not found in project '$ProjectName'." + } + + $teamId = $team.TeamId + Write-Verbose "Retrieved Team ID: $teamId" + } catch { + $PSCmdlet.ThrowTerminatingError((Write-AzDoError "Team '$TeamName' not found in project '$ProjectName'. Error: $_")) + } + + $params = @{ + uri = "$CollectionUri/_apis/projects/$ProjectName/teams/$teamId/members" + version = "7.1-preview.2" + method = 'GET' + } + + Write-Verbose "Request URI: $($params.uri)" + + if ($PSCmdlet.ShouldProcess($CollectionUri, "Get team members with extended properties from: $($PSStyle.Bold)$TeamName$($PSStyle.Reset) in project: $($PSStyle.Bold)$ProjectName$($PSStyle.Reset)")) { + try { + $members = (Invoke-AzDoRestMethod @params).value + if (-not $members) { + Write-Verbose "No members found for team '$TeamName'." + } else { + $members | ForEach-Object { + [PSCustomObject]@{ + CollectionUri = $CollectionUri + TeamName = $TeamName + ProjectName = $ProjectName + MemberId = $_.identity.id + DisplayName = $_.identity.displayName + UniqueName = $_.identity.uniqueName + IsTeamAdmin = $_.isTeamAdmin ? $true : $false + } + } + } + } catch { + $PSCmdlet.ThrowTerminatingError((Write-AzDoError "Error retrieving team members for '$TeamName' Error: $_")) + } + } else { + Write-Verbose "Calling Invoke-AzDoRestMethod with $($params | ConvertTo-Json -Depth 10)" + } + } +} diff --git a/AzureDevOpsPowerShell/Public/Api/Core/Teams/New-AzDoTeam.ps1 b/AzureDevOpsPowerShell/Public/Api/Core/Teams/New-AzDoTeam.ps1 new file mode 100644 index 00000000..ce29842b --- /dev/null +++ b/AzureDevOpsPowerShell/Public/Api/Core/Teams/New-AzDoTeam.ps1 @@ -0,0 +1,100 @@ +function New-AzDoTeam { + <# + .SYNOPSIS + Function to create an Azure DevOps team. + .DESCRIPTION + Function to create an Azure DevOps team within a specified project. + .EXAMPLE + $newAzDoTeamSplat = @{ + CollectionUri = "https://dev.azure.com/contoso" + ProjectName = ProjectName + TeamName = "NewTeamName" + Description = "This is the new team" + } + New-AzDoTeam @newAzDoTeamSplat + + This example creates a new team named "NewTeamName" in the specified project ProjectName within the collectionUri "https://dev.azure.com/contoso". + + .OUTPUTS + Outputs the response from the Azure DevOps REST API, which includes details of the newly created team. + + .NOTES + This function requires the user to be authenticated with Azure using Connect-AzAccount. + Ensure that the tenant ID is correctly specified in the script. + #> + [CmdletBinding(SupportsShouldProcess)] + param ( + # Collection URI. e.g. https://dev.azure.com/contoso. + [Parameter(Mandatory, ValueFromPipelineByPropertyName)] + [string]$CollectionUri, + + # Name of the project. + [Parameter(Mandatory, ValueFromPipelineByPropertyName)] + [string]$ProjectName, + + # Name of the team. + [Parameter(Mandatory, ValueFromPipelineByPropertyName)] + [string]$TeamName, + + # Description of the team. + [Parameter()] + [string]$Description + ) + + process { + Write-Verbose "Starting function: New-AzDoTeam" + + # Get the project ID + try { + $project = (Get-AzDoProject -CollectionUri $CollectionUri -ProjectName $ProjectName) + } catch { + $PSCmdlet.ThrowTerminatingError((Write-AzDoError "Failed to get project ID for project '$ProjectName'. Error: $_")) + } + + try { + if (Get-AzDoProjectTeam -CollectionUri $CollectionUri -ProjectName $ProjectName -TeamName $TeamName) { + throw "Team '$TeamName' already exists in project '$ProjectName'." + } + } catch { + $PSCmdlet.ThrowTerminatingError((Write-AzDoError -Message $_)) + } + + $params = @{ + Uri = "$CollectionUri/_apis/projects/$($project.Projectid)/teams" + Version = "7.2-preview.3" + Method = 'POST' + } + + $body = @{ + name = $TeamName + description = $Description + visibility = $true + } + + if ($PSCmdlet.ShouldProcess($CollectionUri, "Create team named: $($PSStyle.Bold)$TeamName$($PSStyle.Reset) in project: $($PSStyle.Bold)$Project$($PSStyle.Reset)")) { + try { + $response = $body | Invoke-AzDoRestMethod @params + if ($response -is [System.Management.Automation.PSObject]) { + [PSCustomObject]@{ + CollectionUri = $CollectionUri + ProjectName = $ProjectName + projectId = $project.projectId + Name = $TeamName + Description = $Description + TeamId = $response.id + Url = $response.url + IdentityUrl = $response.IdentityUrl + Identity = $response.Identity + } + } else { + $PSCmdlet.ThrowTerminatingError((Write-AzDoError -Message "Unexpected response format: $($response | Out-String)")) + } + } catch { + $PSCmdlet.ThrowTerminatingError((Write-AzDoError -Message "Failed to create team '$TeamName'. Error: $_")) + } + } else { + Write-Verbose "Calling Invoke-AzDoRestMethod with $($params | ConvertTo-Json -Depth 10)" + } + Write-Verbose "Ending function: New-AzDoTeam" + } +} diff --git a/AzureDevOpsPowerShell/Public/Api/Core/Teams/Update-AzDoTeams.ps1 b/AzureDevOpsPowerShell/Public/Api/Core/Teams/Update-AzDoTeams.ps1 new file mode 100644 index 00000000..1155b541 --- /dev/null +++ b/AzureDevOpsPowerShell/Public/Api/Core/Teams/Update-AzDoTeams.ps1 @@ -0,0 +1,118 @@ +function Update-AzDoTeams { + <# + .SYNOPSIS + This script updates a team in Azure DevOps. + .DESCRIPTION + This script updates a team's details in a specified project in Azure DevOps. + When used in a pipeline, you can use the pre-defined CollectionUri, ProjectName, TeamName, and AccessToken (PAT) variables. + .EXAMPLE + $params = @{ + CollectionUri = 'https://dev.azure.com/contoso/' + ProjectName = 'Project 1' + TeamName = 'testteam' + NewTeamName = 'newTestTeam' + Description = 'Updated description for testteam' + } + Update-AzDoTeams @params + + This example updates the team 'testteam' in 'Project 1' with a new name and description. + .OUTPUTS + PSObject + .NOTES + #> + [CmdletBinding(SupportsShouldProcess)] + param ( + # the collectionUri + [Parameter(Mandatory, ValueFromPipelineByPropertyName)] + [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })] + [string] + $CollectionUri, + + # the name of the project + [Parameter(Mandatory, ValueFromPipelineByPropertyName)] + [string] + $ProjectName, + + # the (old) name of the team + [Parameter(Mandatory, ValueFromPipelineByPropertyName)] + [string] + $TeamName, + + # the new name of the team + [Parameter(ValueFromPipelineByPropertyName)] + [string] + $NewTeamName, + + # the (new) description + [Parameter(ValueFromPipelineByPropertyName)] + [string] + $Description + ) + + begin { + Write-Verbose "Starting function: Update-AzDoTeams" + } + + process { + # Get the team ID using the Get-AzDoProjectTeam function + $teamParams = @{ + CollectionUri = $CollectionUri + ProjectName = $ProjectName + TeamName = $TeamName + } + + try { + $team = Get-AzDoProjectTeam @teamParams | Where-Object { $_.TeamName -eq $TeamName } + if (-not $team) { + Write-Error "Team '$TeamName' not found in project '$ProjectName'." + return + } + + $teamId = $team.TeamId + } catch { + Write-Error "Error retrieving team details: $_" + return + } + + $body = @{} + if ($PSBoundParameters.ContainsKey('NewTeamName')) { + $body.name = $NewTeamName + } + if ($PSBoundParameters.ContainsKey('Description')) { + $body.description = $Description + } + + if ($body.Count -eq 0) { + Write-Error "No new data provided to update the team." + return + } + + $params = @{ + uri = "$CollectionUri/_apis/projects/$ProjectName/teams/$teamId" + version = "7.1-preview.3" + method = 'PATCH' + body = $body + } + + if ($PSCmdlet.ShouldProcess($CollectionUri, "Update team: $TeamName in project: $ProjectName")) { + try { + $response = Invoke-AzDoRestMethod @params + [PSCustomObject]@{ + CollectionUri = $CollectionUri + ProjectName = $ProjectName + TeamName = $response.name + TeamId = $response.id + Description = $response.description + Url = $response.url + IdentityUrl = $response.identityUrl + } + } catch { + Write-Error "Error updating team: $_" + } + } + } + + end { + Write-Verbose "Ending function: Update-AzDoTeams" + } +} diff --git a/AzureDevOpsPowerShell/Public/Api/Environments/Environments/New-AzDoEnvironment.ps1 b/AzureDevOpsPowerShell/Public/Api/Environments/Environments/New-AzDoEnvironment.ps1 index 40379b83..ec30f4cb 100644 --- a/AzureDevOpsPowerShell/Public/Api/Environments/Environments/New-AzDoEnvironment.ps1 +++ b/AzureDevOpsPowerShell/Public/Api/Environments/Environments/New-AzDoEnvironment.ps1 @@ -85,7 +85,7 @@ function New-AzDoEnvironment { $params.Method = 'GET' $result += (Invoke-AzDoRestMethod @params).value | Where-Object { $_.name -eq $name } } else { - Write-AzDoError -message $_ + $PSCmdlet.ThrowTerminatingError((Write-AzDoError -message $_)) } } } else { diff --git a/AzureDevOpsPowerShell/Public/Api/Git/PullRequests/New-AzDoPullRequest.ps1 b/AzureDevOpsPowerShell/Public/Api/Git/PullRequests/New-AzDoPullRequest.ps1 index 7c5eda06..d7920069 100644 --- a/AzureDevOpsPowerShell/Public/Api/Git/PullRequests/New-AzDoPullRequest.ps1 +++ b/AzureDevOpsPowerShell/Public/Api/Git/PullRequests/New-AzDoPullRequest.ps1 @@ -126,7 +126,7 @@ function New-AzDoPullRequest { } $result += (Invoke-AzDoRestMethod @getParams).value | Where-Object { $_.sourceRefName -eq $prSourceRefName -and $_.targetRefName -eq $prTargetRefName } } else { - Write-AzDoError -message $_ + $PSCmdlet.ThrowTerminatingError((Write-AzDoError -message $_)) } } } else { diff --git a/AzureDevOpsPowerShell/Public/Api/Git/Pushes/Add-FilesToRepo.ps1 b/AzureDevOpsPowerShell/Public/Api/Git/Pushes/Add-FilesToRepo.ps1 index 60b952fe..e4ebe736 100644 --- a/AzureDevOpsPowerShell/Public/Api/Git/Pushes/Add-FilesToRepo.ps1 +++ b/AzureDevOpsPowerShell/Public/Api/Git/Pushes/Add-FilesToRepo.ps1 @@ -49,7 +49,7 @@ function Add-FilesToRepo { process { $changes = @() - $files = Get-ChildItem -Path $Path -Recurse -File -Force | Where-Object {$_.FullName -notmatch ".git"} + $files = Get-ChildItem -Path $Path -Recurse -File -Force | Where-Object { $_.FullName -notmatch ".git" } foreach ($file in $files) { if (($file.Extension -in '.png', '.svg, .jpg', '.jpeg')) { @@ -107,7 +107,7 @@ function Add-FilesToRepo { if ($_ -match 'TF401028') { Write-Warning "Repo is already initialized, skip uploading files" } else { - Write-AzDoError -message $_ + $PSCmdlet.ThrowTerminatingError((Write-AzDoError -message $_)) } } } else { diff --git a/AzureDevOpsPowerShell/Public/Api/Git/Repositories/New-AzDoRepo.ps1 b/AzureDevOpsPowerShell/Public/Api/Git/Repositories/New-AzDoRepo.ps1 index 2b4732d2..ba3ea5ec 100644 --- a/AzureDevOpsPowerShell/Public/Api/Git/Repositories/New-AzDoRepo.ps1 +++ b/AzureDevOpsPowerShell/Public/Api/Git/Repositories/New-AzDoRepo.ps1 @@ -79,7 +79,7 @@ function New-AzDoRepo { $params.Method = 'GET' $result += (Invoke-AzDoRestMethod @params).value | Where-Object { $_.name -eq $name } } else { - Write-AzDoError -message $_ + $PSCmdlet.ThrowTerminatingError((Write-AzDoError -message $_)) } } } else { diff --git a/AzureDevOpsPowerShell/Public/Api/Pipelines/Pipelines/New-AzDoPipeline.ps1 b/AzureDevOpsPowerShell/Public/Api/Pipelines/Pipelines/New-AzDoPipeline.ps1 index 218ddd9b..2a64e87f 100644 --- a/AzureDevOpsPowerShell/Public/Api/Pipelines/Pipelines/New-AzDoPipeline.ps1 +++ b/AzureDevOpsPowerShell/Public/Api/Pipelines/Pipelines/New-AzDoPipeline.ps1 @@ -120,7 +120,7 @@ function New-AzDoPipeline { } } } else { - Write-AzDoError -message $_ + $PSCmdlet.ThrowTerminatingError((Write-AzDoError -message $_)) } } diff --git a/AzureDevOpsPowerShell/Public/Api/WorkItemTracking/ClassificationNodes/New-AzDoClassificationNode.ps1 b/AzureDevOpsPowerShell/Public/Api/WorkItemTracking/ClassificationNodes/New-AzDoClassificationNode.ps1 index 7fc1062d..fcefb5e4 100644 --- a/AzureDevOpsPowerShell/Public/Api/WorkItemTracking/ClassificationNodes/New-AzDoClassificationNode.ps1 +++ b/AzureDevOpsPowerShell/Public/Api/WorkItemTracking/ClassificationNodes/New-AzDoClassificationNode.ps1 @@ -177,7 +177,7 @@ function New-AzDoClassificationNode { } } } else { - Write-AzDoError -message $_ + $PSCmdlet.ThrowTerminatingError((Write-AzDoError -message $_)) } } } diff --git a/docs/en-US/Add-AzDoPipelineBranchControl.md b/docs/en-US/Add-AzDoPipelineBranchControl.md index cc61673c..e8eacdba 100644 --- a/docs/en-US/Add-AzDoPipelineBranchControl.md +++ b/docs/en-US/Add-AzDoPipelineBranchControl.md @@ -245,9 +245,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### [PSCustomObject]@{ -### CollectionUri = $CollectionUri -### ProjectName = $ProjectName -### CheckId = $_.id +### CollectionUri = $CollectionUri +### ProjectName = $ProjectName +### CheckId = $_.id ### } ## NOTES diff --git a/docs/en-US/Get-AzDoAllTeams.md b/docs/en-US/Get-AzDoAllTeams.md new file mode 100644 index 00000000..3366a5a9 --- /dev/null +++ b/docs/en-US/Get-AzDoAllTeams.md @@ -0,0 +1,172 @@ +--- +external help file: AzureDevOpsPowerShell-help.xml +Module Name: AzureDevOpsPowerShell +online version: +schema: 2.0.0 +--- + +# Get-AzDoAllTeams + +## SYNOPSIS +This script gets all teams within an organization. + +## SYNTAX + +``` +Get-AzDoAllTeams [-CollectionUri] [-ExpandIdentity] [-Mine] [[-Skip] ] [[-Top] ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This script retrieves all teams within an organization using the Azure DevOps REST API. + +## EXAMPLES + +### EXAMPLE 1 +``` +$params = @{ + CollectionUri = 'https://dev.azure.com/contoso/' + ExpandIdentity = $true + Mine = $true +} +Get-AzDoAllTeams @params +``` + +This example gets all teams within 'contoso' where the requesting user is a member. + +## PARAMETERS + +### -CollectionUri +Collection URI. +e.g. +https://dev.azure.com/contoso. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ExpandIdentity +whether or not to return detailed identity info + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Mine +filter only teams I'm member of + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Skip +skip number N of results + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Top +show only top N results + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### PSObject +## NOTES + +## RELATED LINKS diff --git a/docs/en-US/Get-AzDoClassificationNode.md b/docs/en-US/Get-AzDoClassificationNode.md new file mode 100644 index 00000000..6e098100 --- /dev/null +++ b/docs/en-US/Get-AzDoClassificationNode.md @@ -0,0 +1,236 @@ +--- +external help file: AzureDevOpsPowerShell-help.xml +Module Name: AzureDevOpsPowerShell +online version: +schema: 2.0.0 +--- + +# Get-AzDoClassificationNode + +## SYNOPSIS +Get a Classification Node in Azure DevOps. + +## SYNTAX + +``` +Get-AzDoClassificationNode [-CollectionUri] [-ProjectName] [-StructureGroup] + [[-Path] ] [-Name] [[-Depth] ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Get a Classification Node in Azure DevOps. +This could be an area or an iteration. + +## EXAMPLES + +### EXAMPLE 1 +``` +$Params = @{ + CollectionUri = "https://dev.azure.com/cantoso" + ProjectName = "Playground" + StructureGroup = "areas" + Name = "Area1" + Depth = '2' +} +``` + +Get-AzDoClassificationNode @Params + +This example removes a Classification Node of the type 'areas' within the Project. + +### EXAMPLE 2 +``` +$Params = @{ + CollectionUri = "https://dev.azure.com/cantoso" + ProjectName = "Playground" + StructureGroup = "areas" + Name = "Area1" + Path = "Path1" + Depth = '2' +} +``` + +Get-AzDoClassificationNode @Params + +This example removes a Classification Node of the type 'areas' within the specified path. + +### EXAMPLE 3 +``` +$Params = @{ + CollectionUri = "https://dev.azure.com/cantoso" + ProjectName = "Playground" + StructureGroup = "iterations" + Name = "Iteration1" + Depth = '2' +} +``` + +Get-AzDoClassificationNode @Params + +This example removes a Classification Node of the type 'iterations' within the specified path. + +### EXAMPLE 4 +``` +$Params = @{ + CollectionUri = "https://dev.azure.com/cantoso" + ProjectName = "Playground" + StructureGroup = "iterations" + Name = "Iteration1" + Path = "Path1" + Depth = '2' +} +``` + +Get-AzDoClassificationNode @Params + +This example removes a Classification Node of the type 'iterations' within the specified path. + +## PARAMETERS + +### -CollectionUri +Collection Uri of the organization + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProjectName +Name of the project where the new repository has to be created + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StructureGroup +Name of the project where the new repository has to be created + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Path of the classification node (optional) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the classification node + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Depth +Optional parameter to specify the depth of child nodes to retrieve + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: 2 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/en-US/Get-AzDoEnvironment.md b/docs/en-US/Get-AzDoEnvironment.md index 73f89815..ddbb47c5 100644 --- a/docs/en-US/Get-AzDoEnvironment.md +++ b/docs/en-US/Get-AzDoEnvironment.md @@ -147,11 +147,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### [PSCustomObject]@{ -### CollectionUri = $CollectionUri -### ProjectName = $ProjectName -### RepoName = $RepoName -### Id = $result.id -### Url = $result.url +### CollectionUri = $CollectionUri +### ProjectName = $ProjectName +### RepoName = $RepoName +### Id = $result.id +### Url = $result.url ### } ## NOTES diff --git a/docs/en-US/Get-AzDoPipeline.md b/docs/en-US/Get-AzDoPipeline.md index c893ab13..c4c336db 100644 --- a/docs/en-US/Get-AzDoPipeline.md +++ b/docs/en-US/Get-AzDoPipeline.md @@ -147,11 +147,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### [PSCustomObject]@{ -### CollectionUri = $CollectionUri -### ProjectName = $ProjectName -### RepoName = $RepoName -### Id = $result.id -### Url = $result.url +### CollectionUri = $CollectionUri +### ProjectName = $ProjectName +### RepoName = $RepoName +### Id = $result.id +### Url = $result.url ### } ## NOTES diff --git a/docs/en-US/Get-AzDoProjectTeam.md b/docs/en-US/Get-AzDoProjectTeam.md new file mode 100644 index 00000000..66374e25 --- /dev/null +++ b/docs/en-US/Get-AzDoProjectTeam.md @@ -0,0 +1,152 @@ +--- +external help file: AzureDevOpsPowerShell-help.xml +Module Name: AzureDevOpsPowerShell +online version: +schema: 2.0.0 +--- + +# Get-AzDoProjectTeam + +## SYNOPSIS +This script gets team details in a given project. + +## SYNTAX + +``` +Get-AzDoProjectTeam [-CollectionUri] [-ProjectName] [[-TeamName] ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This script gets teams in a given project. +When used in a pipeline, you can use the pre-defined CollectionUri, ProjectName, and AccessToken (PAT) variables. + +## EXAMPLES + +### EXAMPLE 1 +``` +$params = @{ + CollectionUri = 'https://dev.azure.com/contoso/' + ProjectName = 'Project 1' + TeamName = 'testteam' +} +Get-AzDoProjectTeam @params +``` + +This example gets the team 'testteam' in 'Project 1'. + +### EXAMPLE 2 +``` +$params = @{ + CollectionUri = 'https://dev.azure.com/contoso/' + ProjectName = 'Project 1' +} +Get-AzDoProjectTeam @params +``` + +This example gets all teams in 'Project 1'. + +## PARAMETERS + +### -CollectionUri +Collection URI + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProjectName +Project name of the project + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TeamName +team name + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### PSObject +## NOTES + +## RELATED LINKS diff --git a/docs/en-US/Get-AzDoProjectTeams.md b/docs/en-US/Get-AzDoProjectTeams.md new file mode 100644 index 00000000..6bcf0186 --- /dev/null +++ b/docs/en-US/Get-AzDoProjectTeams.md @@ -0,0 +1,152 @@ +--- +external help file: AzureDevOpsPowerShell-help.xml +Module Name: AzureDevOpsPowerShell +online version: +schema: 2.0.0 +--- + +# Get-AzDoProjectTeam + +## SYNOPSIS +This script gets team details in a given project. + +## SYNTAX + +``` +Get-AzDoProjectTeam [-CollectionUri] [-ProjectName] [[-TeamName] ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This script gets teams in a given project. +When used in a pipeline, you can use the pre-defined CollectionUri, ProjectName, and AccessToken (PAT) variables. + +## EXAMPLES + +### EXAMPLE 1 +``` +$params = @{ + CollectionUri = 'https://dev.azure.com/contoso/' + ProjectName = 'Project 1' + TeamName = 'testteam' +} +Get-AzDoProjectTeam @params +``` + +This example gets the team 'testteam' in 'Project 1'. + +### EXAMPLE 2 +``` +$params = @{ + CollectionUri = 'https://dev.azure.com/contoso/' + ProjectName = 'Project 1' +} +Get-AzDoProjectTeam @params +``` + +This example gets all teams in 'Project 1'. + +## PARAMETERS + +### -CollectionUri +collection URI + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProjectName +project name of the project + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TeamName +team name + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### PSObject +## NOTES + +## RELATED LINKS diff --git a/docs/en-US/Get-AzDoTeamMember.md b/docs/en-US/Get-AzDoTeamMember.md new file mode 100644 index 00000000..bf39102d --- /dev/null +++ b/docs/en-US/Get-AzDoTeamMember.md @@ -0,0 +1,141 @@ +--- +external help file: AzureDevOpsPowerShell-help.xml +Module Name: AzureDevOpsPowerShell +online version: +schema: 2.0.0 +--- + +# Get-AzDoTeamMember + +## SYNOPSIS +This script gets team members with extended properties in a given project and team. + +## SYNTAX + +``` +Get-AzDoTeamMember [-CollectionUri] [-ProjectName] [-TeamName] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This script gets team members with extended properties in a given project and team. +When used in a pipeline, you can use the pre-defined CollectionUri, ProjectName, and AccessToken (PAT) variables. + +## EXAMPLES + +### EXAMPLE 1 +``` +$params = @{ + CollectionUri = 'https://dev.azure.com/contos0' + ProjectName = 'Project 1' + TeamName = 'testteam' +} +Get-AzDoTeamMember @params +``` + +This example gets the team members with extended properties in 'testteam' within 'Project 1'. + +## PARAMETERS + +### -CollectionUri +Collection Uri of the organization + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProjectName +the projectName + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TeamName +Team name of the team + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### PSObject +## NOTES + +## RELATED LINKS diff --git a/docs/en-US/Get-AzDoTeamMembers.md b/docs/en-US/Get-AzDoTeamMembers.md new file mode 100644 index 00000000..9ecb3d07 --- /dev/null +++ b/docs/en-US/Get-AzDoTeamMembers.md @@ -0,0 +1,141 @@ +--- +external help file: AzureDevOpsPowerShell-help.xml +Module Name: AzureDevOpsPowerShell +online version: +schema: 2.0.0 +--- + +# Get-AzDoTeamMembers + +## SYNOPSIS +This script gets team members with extended properties in a given project and team. + +## SYNTAX + +``` +Get-AzDoTeamMembers [-CollectionUri] [-ProjectName] [-TeamName] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This script gets team members with extended properties in a given project and team. +When used in a pipeline, you can use the pre-defined CollectionUri, ProjectName, and AccessToken (PAT) variables. + +## EXAMPLES + +### EXAMPLE 1 +``` +$params = @{ + CollectionUri = 'https://dev.azure.com/contos0' + ProjectName = 'Project 1' + TeamName = 'testteam' +} +Get-AzDoTeamMembers @params +``` + +This example gets the team members with extended properties in 'testteam' within 'Project 1'. + +## PARAMETERS + +### -CollectionUri +Collection Uri of the organization + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProjectName +the projectName + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TeamName +Team name of the team + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### PSObject +## NOTES + +## RELATED LINKS diff --git a/docs/en-US/Get-AzDoTeamMembersExtended.md b/docs/en-US/Get-AzDoTeamMembersExtended.md new file mode 100644 index 00000000..1d025572 --- /dev/null +++ b/docs/en-US/Get-AzDoTeamMembersExtended.md @@ -0,0 +1,141 @@ +--- +external help file: AzureDevOpsPowerShell-help.xml +Module Name: AzureDevOpsPowerShell +online version: +schema: 2.0.0 +--- + +# Get-AzDoTeamMembersExtended + +## SYNOPSIS +This script gets team members with extended properties in a given project and team. + +## SYNTAX + +``` +Get-AzDoTeamMembersExtended [-CollectionUri] [-ProjectName] [-TeamName] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +This script gets team members with extended properties in a given project and team. +When used in a pipeline, you can use the pre-defined CollectionUri, ProjectName, and AccessToken (PAT) variables. + +## EXAMPLES + +### EXAMPLE 1 +``` +$params = @{ + CollectionUri = 'https://dev.azure.com/contos0' + ProjectName = 'Project 1' + TeamName = 'testteam' +} +Get-AzDoTeamMembersExtended @params +``` + +This example gets the team members with extended properties in 'testteam' within 'Project 1'. + +## PARAMETERS + +### -CollectionUri +Collection Uri of the organization + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProjectName +the projectName + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TeamName +Team name of the team + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### PSObject +## NOTES + +## RELATED LINKS diff --git a/docs/en-US/Get-PipelineRun.md b/docs/en-US/Get-PipelineRun.md new file mode 100644 index 00000000..37f44c28 --- /dev/null +++ b/docs/en-US/Get-PipelineRun.md @@ -0,0 +1,163 @@ +--- +external help file: AzureDevOpsPowerShell-help.xml +Module Name: AzureDevOpsPowerShell +online version: +schema: 2.0.0 +--- + +# Get-PipelineRun + +## SYNOPSIS +Retrieves pipeline run information from Azure DevOps for a specified pipeline within a project. + +## SYNTAX + +``` +Get-PipelineRun [-CollectionUri] [-ProjectName] [-PipelineId] [[-RunId] ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The \`Get-PipelineRun\` function fetches details about one or more pipeline runs from an Azure DevOps project. +It requires the collection URI, project name, and pipeline ID. +Optionally, specific run IDs can be provided +to filter the results. +The function uses the \`Invoke-AzDoRestMethod\` cmdlet to make the REST API call to +Azure DevOps and returns the run details. + +## EXAMPLES + +### EXAMPLE 1 +``` +Get-PipelineRun -CollectionUri "https://dev.azure.com/YourOrg" -ProjectName "YourProject" -PipelineId 123 +``` + +Retrieves all runs for the specified pipeline in the given project. + +### EXAMPLE 2 +``` +Get-PipelineRun -CollectionUri "https://dev.azure.com/YourOrg" -ProjectName "YourProject" -PipelineId 123 -RunId 456 +``` + +Retrieves the details of the specified run (with ID 456) for the given pipeline. + +## PARAMETERS + +### -CollectionUri +Collection Uri of the organization + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProjectName +The name of the project containing the pipeline + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PipelineId +The ID of the pipeline to retrieve the run for + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: 0 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RunId +The ID of the run to retrieve. +If not provided, all runs for the pipeline are returned. + +```yaml +Type: Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Returns an array of pipeline run objects. If specific run IDs are provided, only the matching runs are returned. +## NOTES + +## RELATED LINKS diff --git a/docs/en-US/New-AzDoClassificationNode.md b/docs/en-US/New-AzDoClassificationNode.md new file mode 100644 index 00000000..467fe66e --- /dev/null +++ b/docs/en-US/New-AzDoClassificationNode.md @@ -0,0 +1,261 @@ +--- +external help file: AzureDevOpsPowerShell-help.xml +Module Name: AzureDevOpsPowerShell +online version: +schema: 2.0.0 +--- + +# New-AzDoClassificationNode + +## SYNOPSIS +Creates a Classification Node in Azure DevOps. + +## SYNTAX + +``` +New-AzDoClassificationNode [-CollectionUri] [-ProjectName] [-StructureGroup] + [[-Path] ] [-Name] [[-startDate] ] [[-finishDate] ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates a Classification Node in Azure DevOps. +This could be an area or an iteration. + +## EXAMPLES + +### EXAMPLE 1 +``` +$Params = @{ + CollectionUri = "https://dev.azure.com/cantoso" + ProjectName = "Playground" + StructureGroup = "areas" + Name = "Area1" +} +``` + +New-AzDoClassificationNode @Params + +This example creates a Classification Node of the type 'areas' within the Project. + +### EXAMPLE 2 +``` +$Params = @{ + CollectionUri = "https://dev.azure.com/cantoso" + ProjectName = "Playground" + StructureGroup = "areas" + Name = "Area1" + Path = "Path1" +} +``` + +New-AzDoClassificationNode @Params + +This example creates a Classification Node of the type 'areas' within the specified path. + +### EXAMPLE 3 +``` +$Params = @{ + CollectionUri = "https://dev.azure.com/cantoso" + ProjectName = "Playground" + StructureGroup = "iterations" + Name = "Iteration1" +} +``` + +New-AzDoClassificationNode @Params + +This example creates a Classification Node of the type 'iterations' within the Project. + +### EXAMPLE 4 +``` +$Params = @{ + CollectionUri = "https://dev.azure.com/cantoso" + ProjectName = "Playground" + StructureGroup = "iterations" + Name = "Iteration1" + Path = "Path1" + startDate = "10//701001 00:00:00 + finishDate = "10//701008 00:00:00 +} +``` + +New-AzDoClassificationNode @Params + +This example creates a Classification Node of the type 'iterations' within the specified path, it is also possible to use a start and finish date of the iteration by adding the optional parameters 'startDate' and 'finishDate'. + +## PARAMETERS + +### -CollectionUri +Collection Uri of the organization + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProjectName +Name of the project where the new repository has to be created + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StructureGroup +Name of the project where the new repository has to be created + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Path of the classification node (optional) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the classification node + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -startDate +Start date of the iteration (optional) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -finishDate +Finish date of the iteration (optional) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### [PSCustomObject]@{ +### CollectionUri = $CollectionUri +### ProjectName = $ProjectName +### Id = $_.id +### Identifier = $_.identifier +### Name = $_.name +### StructureType = $_.structureType +### HasChildren = $_.hasChildren +### Path = $_.path +### Links = $_._links +### Url = $_.url +### } +## NOTES + +## RELATED LINKS diff --git a/docs/en-US/New-AzDoEnvironment.md b/docs/en-US/New-AzDoEnvironment.md index cdf90bd4..8d5df9fa 100644 --- a/docs/en-US/New-AzDoEnvironment.md +++ b/docs/en-US/New-AzDoEnvironment.md @@ -163,11 +163,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### [PSCustomObject]@{ -### CollectionUri = $CollectionUri -### ProjectName = $ProjectName -### RepoName = $RepoName -### Id = $result.id -### Url = $result.url +### CollectionUri = $CollectionUri +### ProjectName = $ProjectName +### RepoName = $RepoName +### Id = $result.id +### Url = $result.url ### } ## NOTES diff --git a/docs/en-US/New-AzDoPipeline.md b/docs/en-US/New-AzDoPipeline.md index a925e79b..0b356de3 100644 --- a/docs/en-US/New-AzDoPipeline.md +++ b/docs/en-US/New-AzDoPipeline.md @@ -14,8 +14,8 @@ Creates an Azure Pipeline ``` New-AzDoPipeline [-CollectionUri] [-ProjectName] [-PipelineName] - [-RepoName] [[-Path] ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] + [-RepoName] [[-PipelineFolderPath] ] [[-Path] ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -107,6 +107,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -PipelineFolderPath +Folder to put Azure Devops Pipeline in + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Path Path of the YAML-sourcecode in the Repository @@ -116,7 +131,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 5 +Position: 6 Default value: /main.yaml Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/docs/en-US/New-AzDoPullRequest.md b/docs/en-US/New-AzDoPullRequest.md index e1f791d8..bc5b9bab 100644 --- a/docs/en-US/New-AzDoPullRequest.md +++ b/docs/en-US/New-AzDoPullRequest.md @@ -1,225 +1,227 @@ ---- -external help file: AzureDevOpsPowerShell-help.xml -Module Name: AzureDevOpsPowerShell -online version: -schema: 2.0.0 ---- - -# New-AzDoPullRequest - -## SYNOPSIS -Creates a pull request in Azure DevOps. - -## SYNTAX - -``` -New-AzDoPullRequest [-CollectionUri] [-RepoName] [-ProjectName] [-Title] [-Description] [-SourceRefName] [-TargetRefName] - [-ProgressAction ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Creates a pull request in Azure DevOps. - -## EXAMPLES - -### EXAMPLE 1 -``` -$params = @{ - CollectionUri = "https://dev.azure.com/contoso" - RepoName = "Repo 1" - ProjectName = "Project 1" - Title = "New Pull Request" - Description = "This is a new pull request" - SourceRefName = "refs/heads/feature1" - TargetRefName = "refs/heads/main" - } - New-AzDoPullRequest @params -``` - -This example creates a new Azure DevOps Pull Request with splatting parameters - -### Example 2 -``` -$params = @{ - CollectionUri = "https://dev.azure.com/contoso" - RepoName = "Repo1" - ProjectName = "Project 1" - Title = "New Pull Request" - Description = "This is a new pull request" - SourceRefName = "refs/heads/feature1" - TargetRefName = "refs/heads/main" - } - $params | New-AzDoPullRequest - - This example creates a new Azure DevOps Pull Request with pipeline parameters -``` -## PARAMETERS - -### -CollectionUri -Collection Uri of the organization - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RepoName -Name of the repo - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ProjectName -Name of the project where the repository is hosted - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Title -The title of the new pull request - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -The description of the new pull request - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceRefName -The source branch path of the pull request - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetRefName -The target branch path of the pull request - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### [PSCustomObject]@{ -### CollectionUri = $CollectionUri -### ProjectName = $ProjectName -### RepoId = $RepoId -### PullRequestId = $res.pullRequestId -### PullRequestURL = $res.url -### } -## NOTES - -## RELATED LINKS +--- +external help file: AzureDevOpsPowerShell-help.xml +Module Name: AzureDevOpsPowerShell +online version: +schema: 2.0.0 +--- + +# New-AzDoPullRequest + +## SYNOPSIS +Creates a pull request in Azure DevOps. + +## SYNTAX + +``` +New-AzDoPullRequest [-CollectionUri] [-RepoName] [-ProjectName] [-Title] + [[-Description] ] [-SourceRefName] [-TargetRefName] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates a pull request in Azure DevOps. + +## EXAMPLES + +### EXAMPLE 1 +``` +$params = @{ + CollectionUri = "https://dev.azure.com/contoso" + RepoName = "Repo 1" + ProjectName = "Project 1" + Title = "New Pull Request" + Description = "This is a new pull request" + SourceRefName = "refs/heads/feature1" + TargetRefName = "refs/heads/main" + } + New-AzDoPullRequest @params +``` + +This example creates a new Azure DevOps Pull Request with splatting parameters + +### Example 2 +``` +$params = @{ + CollectionUri = "https://dev.azure.com/contoso" + RepoName = "Repo1" + ProjectName = "Project 1" + Title = "New Pull Request" + Description = "This is a new pull request" + SourceRefName = "refs/heads/feature1" + TargetRefName = "refs/heads/main" + } + $params | New-AzDoPullRequest + + This example creates a new Azure DevOps Pull Request with pipeline parameters +``` + +## PARAMETERS + +### -CollectionUri +Collection Uri of the organization + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RepoName +Name of the repo + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +Name of the project where the repository is hosted + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Title +The title of the new pull request + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +The description of the new pull request + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SourceRefName +The source branch path of the pull request + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TargetRefName +The target branch path of the pull request + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### [PSCustomObject]@{ +### CollectionUri = $CollectionUri +### ProjectName = $ProjectName +### RepoId = $RepoId +### PullRequestId = $res.pullRequestId +### PullRequestURL = $res.url +### } +## NOTES + +## RELATED LINKS diff --git a/docs/en-US/New-AzDoRepo.md b/docs/en-US/New-AzDoRepo.md index 4fd00491..ddf106bd 100644 --- a/docs/en-US/New-AzDoRepo.md +++ b/docs/en-US/New-AzDoRepo.md @@ -142,15 +142,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### [PSCustomObject]@{ -### CollectionUri = $CollectionUri -### ProjectName = $ProjectName -### RepoName = $res.name -### RepoId = $res.id -### RepoURL = $res.url -### WebUrl = $res.webUrl -### HttpsUrl = $res.remoteUrl -### SshUrl = $res.sshUrl -### } +### CollectionUri = $CollectionUri +### ProjectName = $ProjectName +### RepoName = $res.name +### RepoId = $res.id +### RepoURL = $res.url +### WebUrl = $res.webUrl +### HttpsUrl = $res.remoteUrl +### SshUrl = $res.sshUrl +### } ## NOTES ## RELATED LINKS diff --git a/docs/en-US/New-AzDoServiceConnection.md b/docs/en-US/New-AzDoServiceConnection.md index f07d60dc..de7b25eb 100644 --- a/docs/en-US/New-AzDoServiceConnection.md +++ b/docs/en-US/New-AzDoServiceConnection.md @@ -15,8 +15,9 @@ Function to create a service connection in Azure DevOps ### WorkloadIdentityFederation ``` New-AzDoServiceConnection -CollectionUri -ProjectName -ServiceConnectionName - [-Description ] [-Force] [-AsDraft] [-AuthenticationType ] [-TenantId ] - [-ServiceprincipalId ] [-ProgressAction ] [-WhatIf] [-Confirm] [] + [-Description ] [-Force] [-AsDraft] [-ScopeLevel ] [-AuthenticationType ] + [-SubscriptionId ] [-SubscriptionName ] [-TenantId ] [-ServiceprincipalId ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### ServiceprincipalCertificate @@ -191,6 +192,18 @@ Accept wildcard characters: False ### -ScopeLevel Scope level (Subscription or ManagementGroup). +```yaml +Type: String +Parameter Sets: WorkloadIdentityFederation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ```yaml Type: String Parameter Sets: ServiceprincipalCertificate, ServiceprincipalSecret @@ -221,6 +234,18 @@ Accept wildcard characters: False ### -SubscriptionId ID of the subscriptionn. +```yaml +Type: String +Parameter Sets: WorkloadIdentityFederation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ```yaml Type: String Parameter Sets: Subscription @@ -236,6 +261,18 @@ Accept wildcard characters: False ### -SubscriptionName Name of the subscription. +```yaml +Type: String +Parameter Sets: WorkloadIdentityFederation +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ```yaml Type: String Parameter Sets: Subscription diff --git a/docs/en-US/New-AzDoTeam.md b/docs/en-US/New-AzDoTeam.md new file mode 100644 index 00000000..29412ba3 --- /dev/null +++ b/docs/en-US/New-AzDoTeam.md @@ -0,0 +1,160 @@ +--- +external help file: AzureDevOpsPowerShell-help.xml +Module Name: AzureDevOpsPowerShell +online version: +schema: 2.0.0 +--- + +# New-AzDoTeam + +## SYNOPSIS +Function to create an Azure DevOps team. + +## SYNTAX + +``` +New-AzDoTeam [-CollectionUri] [-ProjectName] [-TeamName] [[-Description] ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Function to create an Azure DevOps team within a specified project. + +## EXAMPLES + +### EXAMPLE 1 +``` +$newAzDoTeamSplat = @{ + CollectionUri = "https://dev.azure.com/contoso" + ProjectName = ProjectName + TeamName = "NewTeamName" + Description = "This is the new team" +} +New-AzDoTeam @newAzDoTeamSplat +``` + +This example creates a new team named "NewTeamName" in the specified project ProjectName within the collectionUri "https://dev.azure.com/contoso". + +## PARAMETERS + +### -CollectionUri +Collection URI. +e.g. +https://dev.azure.com/contoso. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProjectName +Name of the project. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TeamName +Name of the team. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +Description of the team. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs the response from the Azure DevOps REST API, which includes details of the newly created team. +## NOTES +This function requires the user to be authenticated with Azure using Connect-AzAccount. +Ensure that the tenant ID is correctly specified in the script. + +## RELATED LINKS diff --git a/docs/en-US/New-AzDoTeams.md b/docs/en-US/New-AzDoTeams.md new file mode 100644 index 00000000..b52238ea --- /dev/null +++ b/docs/en-US/New-AzDoTeams.md @@ -0,0 +1,160 @@ +--- +external help file: AzureDevOpsPowerShell-help.xml +Module Name: AzureDevOpsPowerShell +online version: +schema: 2.0.0 +--- + +# New-AzDoTeams + +## SYNOPSIS +Function to create an Azure DevOps team. + +## SYNTAX + +``` +New-AzDoTeams [-CollectionUri] [-ProjectName] [-TeamName] [[-Description] ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Function to create an Azure DevOps team within a specified project. + +## EXAMPLES + +### EXAMPLE 1 +``` +$newAzDoTeamSplat = @{ + CollectionUri = "https://dev.azure.com/contoso" + ProjectName = ProjectName + TeamName = "NewTeamName" + Description = "This is the new team" +} +New-AzDoTeam @newAzDoTeamSplat +``` + +This example creates a new team named "NewTeamName" in the specified project ProjectName within the collectionUri "https://dev.azure.com/contoso". + +## PARAMETERS + +### -CollectionUri +Collection URI. +e.g. +https://dev.azure.com/contoso. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProjectName +Name of the project. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TeamName +Name of the team. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +Description of the team. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: "Team for $TeamName" +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs the response from the Azure DevOps REST API, which includes details of the newly created team. +## NOTES +This function requires the user to be authenticated with Azure using Connect-AzAccount. +Ensure that the tenant ID is correctly specified in the script. + +## RELATED LINKS diff --git a/docs/en-US/Remove-AzDoClassificationNode.md b/docs/en-US/Remove-AzDoClassificationNode.md new file mode 100644 index 00000000..56cc59a7 --- /dev/null +++ b/docs/en-US/Remove-AzDoClassificationNode.md @@ -0,0 +1,217 @@ +--- +external help file: AzureDevOpsPowerShell-help.xml +Module Name: AzureDevOpsPowerShell +online version: +schema: 2.0.0 +--- + +# Remove-AzDoClassificationNode + +## SYNOPSIS +Delete a Classification Node in Azure DevOps. + +## SYNTAX + +``` +Remove-AzDoClassificationNode [-CollectionUri] [-ProjectName] [-StructureGroup] + [[-Path] ] [-Name] [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Delete a Classification Node in Azure DevOps. +This could be an area or an iteration. + +## EXAMPLES + +### EXAMPLE 1 +``` +$Params = @{ + CollectionUri = "https://dev.azure.com/cantoso" + ProjectName = "Playground" + StructureGroup = "areas" + Name = "Area1" +} +``` + +Remove-AzDoClassificationNode @Params + +This example removes a Classification Node of the type 'areas' within the Project. + +### EXAMPLE 2 +``` +$Params = @{ + CollectionUri = "https://dev.azure.com/cantoso" + ProjectName = "Playground" + StructureGroup = "areas" + Name = "Area1" + Path = "Path1" +} +``` + +Remove-AzDoClassificationNode @Params + +This example removes a Classification Node of the type 'areas' within the specified path. + +### EXAMPLE 3 +``` +$Params = @{ + CollectionUri = "https://dev.azure.com/cantoso" + ProjectName = "Playground" + StructureGroup = "iterations" + Name = "Iteration1" +} +``` + +Remove-AzDoClassificationNode @Params + +This example removes a Classification Node of the type 'iterations' within the specified path. + +### EXAMPLE 4 +``` +$Params = @{ + CollectionUri = "https://dev.azure.com/cantoso" + ProjectName = "Playground" + StructureGroup = "iterations" + Name = "Iteration1" + Path = "Path1" +} +``` + +Remove-AzDoClassificationNode @Params + +This example removes a Classification Node of the type 'iterations' within the specified path. + +## PARAMETERS + +### -CollectionUri +Collection Uri of the organization + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProjectName +Name of the project where the new repository has to be created + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StructureGroup +Name of the project where the new repository has to be created + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Path +Path of the classification node (optional) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name +Name of the classification node + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/en-US/Set-AzDoBranchPolicyBuildValidation.md b/docs/en-US/Set-AzDoBranchPolicyBuildValidation.md index 34b7f8e3..01c8931b 100644 --- a/docs/en-US/Set-AzDoBranchPolicyBuildValidation.md +++ b/docs/en-US/Set-AzDoBranchPolicyBuildValidation.md @@ -240,11 +240,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### [PSCustomObject]@{ -### CollectionUri = $CollectionUri -### ProjectName = $ProjectName -### RepoName = $RepoName -### Id = $result.id -### Url = $result.url +### CollectionUri = $CollectionUri +### ProjectName = $ProjectName +### RepoName = $RepoName +### Id = $result.id +### Url = $result.url ### } ## NOTES diff --git a/docs/en-US/Set-AzDoBranchPolicyCommentResolution.md b/docs/en-US/Set-AzDoBranchPolicyCommentResolution.md index 261e29d5..50f1a15f 100644 --- a/docs/en-US/Set-AzDoBranchPolicyCommentResolution.md +++ b/docs/en-US/Set-AzDoBranchPolicyCommentResolution.md @@ -174,10 +174,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### [PSCustomObject]@{ -### CollectionUri = $CollectionUri -### ProjectName = $ProjectName -### RepoName = $RepoName -### id = $res.id +### CollectionUri = $CollectionUri +### ProjectName = $ProjectName +### RepoName = $RepoName +### id = $res.id ### } ## NOTES diff --git a/docs/en-US/Set-AzDoBranchPolicyMergeStrategy.md b/docs/en-US/Set-AzDoBranchPolicyMergeStrategy.md index c99a0555..40545783 100644 --- a/docs/en-US/Set-AzDoBranchPolicyMergeStrategy.md +++ b/docs/en-US/Set-AzDoBranchPolicyMergeStrategy.md @@ -219,14 +219,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### [PSCustomObject]@{ -### CollectionUri = $CollectionUri -### ProjectName = $ProjectName -### RepoName = $RepoName -### id = $res.id -### allowSquash = $res.settings.allowSquash -### allowNoFastForward = $res.settings.allowNoFastForward -### allowRebase = $res.settings.allowRebase -### allowRebaseMerge = $res.settings.allowRebaseMerge +### CollectionUri = $CollectionUri +### ProjectName = $ProjectName +### RepoName = $RepoName +### id = $res.id +### allowSquash = $res.settings.allowSquash +### allowNoFastForward = $res.settings.allowNoFastForward +### allowRebase = $res.settings.allowRebase +### allowRebaseMerge = $res.settings.allowRebaseMerge ### } ## NOTES diff --git a/docs/en-US/Set-AzDoBranchPolicyMinimalApproval.md b/docs/en-US/Set-AzDoBranchPolicyMinimalApproval.md index 6d2fbc06..be8ef4d9 100644 --- a/docs/en-US/Set-AzDoBranchPolicyMinimalApproval.md +++ b/docs/en-US/Set-AzDoBranchPolicyMinimalApproval.md @@ -189,18 +189,18 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### [PSCustomObject]@{ -### CollectionUri = $CollectionUri -### ProjectName = $ProjectName -### RepoName = $RepoName -### id = $res.id -### minimumApproverCount = $res.settings.minimumApproverCount -### creatorVoteCounts = $res.settings.creatorVoteCounts -### allowDownvotes = $res.settings.allowDownvotes -### resetOnSourcePush = $res.settings.resetOnSourcePush -### requireVoteOnLastIteration = $res.settings.requireVoteOnLastIteration -### resetRejectionsOnSourcePush = $res.settings.resetRejectionsOnSourcePush -### blockLastPusherVote = $res.settings.blockLastPusherVote -### requireVoteOnEachIteration = $res.settings.requireVoteOnEachIteration +### CollectionUri = $CollectionUri +### ProjectName = $ProjectName +### RepoName = $RepoName +### id = $res.id +### minimumApproverCount = $res.settings.minimumApproverCount +### creatorVoteCounts = $res.settings.creatorVoteCounts +### allowDownvotes = $res.settings.allowDownvotes +### resetOnSourcePush = $res.settings.resetOnSourcePush +### requireVoteOnLastIteration = $res.settings.requireVoteOnLastIteration +### resetRejectionsOnSourcePush = $res.settings.resetRejectionsOnSourcePush +### blockLastPusherVote = $res.settings.blockLastPusherVote +### requireVoteOnEachIteration = $res.settings.requireVoteOnEachIteration ### } ## NOTES diff --git a/docs/en-US/Update-AzDoTeams.md b/docs/en-US/Update-AzDoTeams.md new file mode 100644 index 00000000..dc49df11 --- /dev/null +++ b/docs/en-US/Update-AzDoTeams.md @@ -0,0 +1,174 @@ +--- +external help file: AzureDevOpsPowerShell-help.xml +Module Name: AzureDevOpsPowerShell +online version: +schema: 2.0.0 +--- + +# Update-AzDoTeams + +## SYNOPSIS +This script updates a team in Azure DevOps. + +## SYNTAX + +``` +Update-AzDoTeams [-CollectionUri] [-ProjectName] [-TeamName] + [[-NewTeamName] ] [[-Description] ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +This script updates a team's details in a specified project in Azure DevOps. +When used in a pipeline, you can use the pre-defined CollectionUri, ProjectName, TeamName, and AccessToken (PAT) variables. + +## EXAMPLES + +### EXAMPLE 1 +``` +$params = @{ + CollectionUri = 'https://dev.azure.com/contoso/' + ProjectName = 'Project 1' + TeamName = 'testteam' + NewTeamName = 'newTestTeam' + Description = 'Updated description for testteam' +} +Update-AzDoTeams @params +``` + +This example updates the team 'testteam' in 'Project 1' with a new name and description. + +## PARAMETERS + +### -CollectionUri +the collectionUri + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProjectName +the name of the project + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -TeamName +the (old) name of the team + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -NewTeamName +the new name of the team + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Description +the (new) description + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### PSObject +## NOTES + +## RELATED LINKS