Merge pull request #59 from WeAreInSpark/dylan-fix

fixed documentation and collectionuri parameter

Author: Dylan-Prins

AzureDevOpsPowerShell/Private/Validate-CollectionUri.ps1

@@ -0,0 +1,15 @@
+function Validate-CollectionUri {
+  [CmdletBinding()]
+  param (
+    # Parameter help description
+    [Parameter(Mandatory)]
+    [string]
+    $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/'"
+  } else {
+    $true
+  }
+}

AzureDevOpsPowerShell/Public/Api/ApprovalsAndChecks/CheckConfigurations/Add-AzDoPipelineBranchControl.ps1

@@ -38,6 +38,7 @@ function Add-AzDoPipelineBranchControl {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Build/GeneralSettings/Set-AzDOProjectSetting.ps1

@@ -27,6 +27,7 @@ function Set-AzDoProjectSetting {
   param (
     # Collection uri of the organization. Can be set with the predefined variable from Azure DevOps.
     [Parameter(Mandatory)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Core/Projects/Get-AzDoProject.ps1

@@ -50,6 +50,7 @@ function Get-AzDoProject {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Core/Projects/New-AzDoProject.ps1

@@ -35,6 +35,7 @@ function New-AzDoProject {
     # Collection URI. e.g. https://dev.azure.com/contoso.
     # Azure Pipelines has a predefined variable for this.
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Core/Projects/Remove-AzDoProject.ps1

@@ -36,6 +36,7 @@ function Remove-AzDoProject {
     # Collection URI. e.g. https://dev.azure.com/contoso.
     # Azure Pipelines has a predefined variable for this.
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/DistributedTask/VariableGroups/Add-AzDoVariableGroupVariable.ps1

@@ -41,6 +41,7 @@ function Add-AzDoVariableGroupVariable {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/DistributedTask/VariableGroups/Get-AzDoVariableGroup.ps1

@@ -31,6 +31,7 @@ function Get-AzDoVariableGroup {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/DistributedTask/VariableGroups/New-AzDoVariableGroup.ps1

@@ -40,6 +40,7 @@ function New-AzDoVariableGroup {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Environments/Environments/Get-AzDoEnvironment.ps1

@@ -37,6 +37,7 @@ function Get-AzDoEnvironment {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName, ValueFromPipeline)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Environments/Environments/New-AzDoEnvironment.ps1

@@ -37,6 +37,7 @@ function New-AzDoEnvironment {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Git/Pushes/Add-FilesToRepo.ps1

@@ -22,6 +22,7 @@ function Add-FilesToRepo {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Git/Repositories/Get-AzDoRepo.ps1

@@ -38,6 +38,7 @@ function Get-AzDoRepo {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Git/Repositories/New-AzDoRepo.ps1

@@ -34,6 +34,7 @@ function New-AzDoRepo {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Pipelines/Pipelines/Get-AzDoPipeline.ps1

@@ -37,6 +37,7 @@ function Get-AzDoPipeline {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName, ValueFromPipeline)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Pipelines/Pipelines/New-AzDoPipeline.ps1

@@ -30,6 +30,7 @@ function New-AzDoPipeline {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Policy/Configuration/Get-AzDoBranchPolicy.ps1

@@ -20,6 +20,7 @@ function Get-AzDoBranchPolicy {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Policy/Configuration/Set-AzDoBranchPolicyBuildValidation.ps1

@@ -37,6 +37,7 @@ function Set-AzDoBranchPolicyBuildValidation {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Policy/Configuration/Set-AzDoBranchPolicyCommentResolution.ps1

@@ -33,6 +33,7 @@ function Set-AzDoBranchPolicyCommentResolution {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Policy/Configuration/Set-AzDoBranchPolicyMergeStrategy.ps1

@@ -37,6 +37,7 @@ function Set-AzDoBranchPolicyMergeStrategy {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Policy/Configuration/Set-AzDoBranchPolicyMinimalApproval.ps1

@@ -41,6 +41,7 @@ function Set-AzDoBranchPolicyMinimalApproval {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/Policy/Types/Get-AzDoBranchPolicyType.ps1

@@ -19,6 +19,7 @@ function Get-AzDoBranchPolicyType {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/ServiceEndpoints/Endpointproxy/Test-AzDoServiceConnection.ps1

@@ -32,6 +32,7 @@ function Test-AzDoServiceConnection {
 
     # Collection Uri. e.g. https://dev.azure.com/contoso.
     [Parameter(Mandatory)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/ServiceEndpoints/Endpoints/Get-AzDoServiceConnection.ps1

@@ -72,6 +72,7 @@ function Get-AzDoServiceConnection {
   param (
     # Collection Uri of the organization
     [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

AzureDevOpsPowerShell/Public/Api/ServiceEndpoints/Endpoints/New-AzDoServiceConnection.ps1

@@ -45,6 +45,7 @@ function New-AzDoServiceConnection {
   param (
     # Collection Uri. e.g. https://dev.azure.com/contoso.
     [Parameter(Mandatory)]
+    [ValidateScript({ Validate-CollectionUri -CollectionUri $_ })]
     [string]
     $CollectionUri,
 

README.md

@@ -25,10 +25,10 @@ but we believe that this project in more user-friendly.
 
 ```powershell
 # PowerShell 7.3 and below
-Install-Module -Name AzureDevOpsPowerShellAPI -Scope CurrentUser
+Install-Module -Name AzureDevOpsPowerShell -Scope CurrentUser
 
 # PowerShell 7.4 and up
-Install-PSresource -Name AzureDevOpsPowerShellAPI -Scope CurrentUser
+Install-PSresource -Name AzureDevOpsPowerShell -Scope CurrentUser
 ```
 
 ## Basic Usage