Modules/AzureDevOpsDsc.Common/Resources/Functions/Public/Set-AzDevOpsProject.ps1
|
<#
.SYNOPSIS Updates an Azure DevOps 'Project' with the specified properties set by the parameters. .PARAMETER ApiUri The URI of the Azure DevOps API to be connected to. For example: https://dev.azure.com/someOrganizationName/_apis/ .PARAMETER Pat The 'Personal Access Token' (PAT) to be used by any subsequent requests/operations against the Azure DevOps API. This PAT must have the relevant permissions assigned for the subsequent operations being performed. .PARAMETER ProjectName The 'name' of the 'Project' being updated. .PARAMETER ProjectDescription The 'description' of the 'Project' being updated. .PARAMETER SourceControlType The 'sourceControlType' of the 'Project' being updated. Options are 'Tfvc' or 'Git'. Defaults to 'Git' if no value provided. .PARAMETER Force When this switch is used, any confirmation will be overidden/ignored. .EXAMPLE Set-AzDevOpsProject -ApiUri 'YourApiUriHere' -Pat 'YourPatHere' ` -ProjectName 'YourProjectNameHere' ` -ProjectDescription 'YourProjectDescriptionHere' -SourceControlType 'Git' Creates a 'Project' (assocated with the Organization/ApiUrl) in Azure DevOps using project-related, parameter values provided. #> function Set-AzDevOpsProject { [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'Medium')] [OutputType([System.Object])] param ( [Parameter(Mandatory = $true)] [ValidateScript( { Test-AzDevOpsApiUri -ApiUri $_ -IsValid })] [Alias('Uri')] [System.String] $ApiUri, [Parameter(Mandatory = $true)] [ValidateScript({ Test-AzDevOpsPat -Pat $_ -IsValid })] [Alias('PersonalAccessToken')] [System.String] $Pat, [Parameter(Mandatory = $true)] [ValidateScript({ Test-AzDevOpsProjectId -ProjectId $_ -IsValid })] [Alias('ResourceId','Id')] [System.String] $ProjectId, [Parameter(Mandatory = $true)] [ValidateScript({ Test-AzDevOpsProjectName -ProjectName $_ -IsValid })] [Alias('Name')] [System.String] $ProjectName, [Parameter()] [ValidateScript({ Test-AzDevOpsProjectDescription -ProjectDescription $_ -IsValid })] [AllowEmptyString()] [Alias('Description')] [System.String] $ProjectDescription = '', # $SourceControlType - Not supported for updates/set [Parameter()] [System.Management.Automation.SwitchParameter] $Force ) # [string]$resourceJson = ' # { # "id": "'+ $ProjectId +'", # "name": "' + $ProjectName + '", # "description": "' + $ProjectDescription + '", # "capabilities": { # "versioncontrol": { # "sourceControlType": "' + $SourceControlType + '" # }, # "processTemplate": { # "templateTypeId": "6b724908-ef14-45cf-84f8-768b5384da45" # } # } # } # ' [string]$resourceJson = ' { "id": "'+ $ProjectId +'", "name": "' + $ProjectName + '", "description": "' + $ProjectDescription + '" } ' [System.Object]$newResource = $null $ResourceName = 'Project' if ($Force -or $PSCmdlet.ShouldProcess($ApiUri, $ResourceName)) { Set-AzDevOpsApiResource -ApiUri $ApiUri -Pat $Pat ` -ResourceName $ResourceName ` -ResourceId $ProjectId ` -Resource $($resourceJson | ConvertFrom-Json) ` -Force:$Force -Wait | Out-Null [System.Object]$newResource = Get-AzDevOpsProject -ApiUri $ApiUri -Pat $Pat ` -ProjectId $ProjectId ` -ProjectName $ProjectName } return $newResource } |