Merge pull request #54 from WeAreInSpark/docs/add-docs

docs: fixing docs
WeAreInSpark · Feb 9, 2024 · 0ee2de3 · 0ee2de3
2 parents f982a64 + 30878bf
commit 0ee2de3
Show file tree

Hide file tree

Showing 54 changed files with 58 additions and 5,494 deletions.
diff --git a/AzureDevOpsPowerShell/Public/Api/Build/GeneralSettings/Set-AzDOProjectSetting.ps1 b/AzureDevOpsPowerShell/Public/Api/Build/GeneralSettings/Set-AzDOProjectSetting.ps1
@@ -7,7 +7,6 @@ function Set-AzDoProjectSetting {
     .EXAMPLE
         $params = @{
             CollectionUri = "https://dev.azure.com/contoso"
-            PAT = "***"
             ProjectName = "Project01"
             EnforceJobAuthScope = $true
             EnforceJobAuthScopeForReleases = $true

diff --git a/AzureDevOpsPowerShell/Public/Api/Core/Projects/Get-AzDoProject.ps1 b/AzureDevOpsPowerShell/Public/Api/Core/Projects/Get-AzDoProject.ps1
@@ -7,7 +7,6 @@ function Get-AzDoProject {
 .EXAMPLE
     $Params = @{
         CollectionUri = "https://dev.azure.com/contoso"
-        PAT = "***"
     }
     Get-AzDoProject @params
 
@@ -16,7 +15,6 @@ function Get-AzDoProject {
 .EXAMPLE
     $Params = @{
         CollectionUri = "https://dev.azure.com/contoso"
-        PAT = "***"
         ProjectName = 'Project1'
     }
     Get-AzDoProject @params
@@ -26,7 +24,6 @@ function Get-AzDoProject {
 .EXAMPLE
     $params = @{
         collectionuri = "https://dev.azure.com/contoso"
-        PAT = "***"
     }
     $somedifferentobject = [PSCustomObject]@{
         ProjectName = 'Project1'
@@ -38,7 +35,6 @@ function Get-AzDoProject {
 .EXAMPLE
     $params = @{
         collectionuri = "https://dev.azure.com/contoso"
-        PAT = "***"
     }
     @(
         'Project1',

diff --git a/AzureDevOpsPowerShell/Public/Api/Core/Projects/Remove-AzDoProject.ps1 b/AzureDevOpsPowerShell/Public/Api/Core/Projects/Remove-AzDoProject.ps1
@@ -5,15 +5,15 @@ function Remove-AzDoProject {
     .DESCRIPTION
         Function to create an Azure DevOps project
     .EXAMPLE
-        New-AzDoProject -CollectionUri "https://dev.azure.com/contoso" -PAT "***" -ProjectName "Project 1"
+        New-AzDoProject -CollectionUri "https://dev.azure.com/contoso" -ProjectName "Project 1"
 
         This example creates a new private Azure DevOps project
     .EXAMPLE
-        New-AzDoProject -CollectionUri "https://dev.azure.com/contoso" -PAT "***" -ProjectName "Project 1" -Visibility 'public'
+        New-AzDoProject -CollectionUri "https://dev.azure.com/contoso" -ProjectName "Project 1" -Visibility 'public'
 
         This example creates a new public Azure DevOps project
     .EXAMPLE
-        @("MyProject1","Myproject2") | New-AzDoProject -CollectionUri "https://dev.azure.com/contoso" -PAT "***"
+        @("MyProject1","Myproject2") | New-AzDoProject -CollectionUri "https://dev.azure.com/contoso"
 
         This example creates two new Azure DevOps projects using the pipeline.
 

diff --git a/...OpsPowerShell/Public/Api/DistributedTask/VariableGroups/Add-AzDoVariableGroupVariable.ps1 b/...OpsPowerShell/Public/Api/DistributedTask/VariableGroups/Add-AzDoVariableGroupVariable.ps1
@@ -9,7 +9,6 @@ function Add-AzDoVariableGroupVariable {
         $splat = @{
             CollectionUri     = 'https://dev.azure.com/ChristianPiet0452/'
             ProjectName       = 'Ditproject'
-            PAT = '*******************'
             VariableGroupName = @('Group1', 'Group2')
             Variables         = @{
                 test = @{

diff --git a/AzureDevOpsPowerShell/Public/Api/DistributedTask/VariableGroups/Get-AzDoVariableGroup.ps1 b/AzureDevOpsPowerShell/Public/Api/DistributedTask/VariableGroups/Get-AzDoVariableGroup.ps1
@@ -8,7 +8,6 @@ function Get-AzDoVariableGroup {
     .EXAMPLE
         $params = @{
             Collectionuri = 'https://dev.azure.com/weareinspark/'
-            PAT = '*******************'
             ProjectName = 'Project 1'
             VariableGroupName = 'VariableGroup1','VariableGroup2'
         }

diff --git a/AzureDevOpsPowerShell/Public/Api/DistributedTask/VariableGroups/New-AzDoVariableGroup.ps1 b/AzureDevOpsPowerShell/Public/Api/DistributedTask/VariableGroups/New-AzDoVariableGroup.ps1
@@ -8,7 +8,6 @@ function New-AzDoVariableGroup {
     .EXAMPLE
         $params = @{
             Collectionuri = 'https://dev.azure.com/weareinspark/'
-            PAT = '*******************'
             ProjectName = 'Project 1'
             VariableGroupName = 'VariableGroup1'
             Variables = @{ test = @{ value = 'test' } }

diff --git a/AzureDevOpsPowerShell/Public/Api/Environments/Environments/Get-AzDoEnvironment.ps1 b/AzureDevOpsPowerShell/Public/Api/Environments/Environments/Get-AzDoEnvironment.ps1
@@ -7,7 +7,6 @@ function Get-AzDoEnvironment {
 .EXAMPLE
     $params = @{
         CollectionUri = "https://dev.azure.com/contoso"
-        PAT = "***"
         Name = "Policy 1"
         RepoName = "Repo 1"
         ProjectName = "Project 1"

diff --git a/AzureDevOpsPowerShell/Public/Api/Environments/Environments/New-AzDoEnvironment.ps1 b/AzureDevOpsPowerShell/Public/Api/Environments/Environments/New-AzDoEnvironment.ps1
@@ -7,7 +7,6 @@ function New-AzDoEnvironment {
 .EXAMPLE
     $params = @{
         CollectionUri = "https://dev.azure.com/contoso"
-        PAT = "***"
         Name = "Policy 1"
         RepoName = "Repo 1"
         ProjectName = "Project 1"

diff --git a/AzureDevOpsPowerShell/Public/Api/Git/Pushes/Add-FilesToRepo.ps1 b/AzureDevOpsPowerShell/Public/Api/Git/Pushes/Add-FilesToRepo.ps1
@@ -7,7 +7,6 @@ function Add-FilesToRepo {
 .EXAMPLE
     $params = @{
         CollectionUri = "https://dev.azure.com/contoso"
-        PAT           = "***"
         Name          = "Repo 1"
         ProjectName   = "Project 1"
     }

diff --git a/AzureDevOpsPowerShell/Public/Api/Git/Repositories/Get-AzDoRepo.ps1 b/AzureDevOpsPowerShell/Public/Api/Git/Repositories/Get-AzDoRepo.ps1
@@ -7,7 +7,6 @@ function Get-AzDoRepo {
 .EXAMPLE
     $Params = @{
         CollectionUri = "https://dev.azure.com/contoso"
-        PAT = "***"
         ProjectName = "Project 1"
         Name "Repo 1"
     }
@@ -17,7 +16,6 @@ function Get-AzDoRepo {
 .EXAMPLE
     $Params = @{
         CollectionUri = "https://dev.azure.com/contoso"
-        PAT = "***"
         ProjectName = "Project 1"
         Name "Repo 1"
     }
@@ -27,7 +25,6 @@ function Get-AzDoRepo {
 .EXAMPLE
     $Params = @{
         CollectionUri = "https://dev.azure.com/contoso"
-        PAT = "***"
         Name "Repo 1"
     }
     get-AzDoProject -pat $pat -CollectionUri $collectionuri | Get-AzDoRepo -PAT $PAT

diff --git a/AzureDevOpsPowerShell/Public/Api/Git/Repositories/New-AzDoRepo.ps1 b/AzureDevOpsPowerShell/Public/Api/Git/Repositories/New-AzDoRepo.ps1
@@ -7,15 +7,13 @@ function New-AzDoRepo {
 .EXAMPLE
     $params = @{
         CollectionUri = "https://dev.azure.com/contoso"
-        PAT           = "***"
         Name          = "Repo 1"
         ProjectName   = "Project 1"
     }
     New-AzDoRepo @params
 
     This example creates a new Azure DevOps repo with splatting parameters
 .EXAMPLE
-    $env:SYSTEM_ACCESSTOKEN = '***'
     'test', 'test2' | New-AzDoRepo -CollectionUri "https://dev.azure.com/contoso" -ProjectName "Project 1"
 
     This example creates a new Azure DevOps repo for each in pipeline

diff --git a/AzureDevOpsPowerShell/Public/Api/Pipelines/Pipelines/Get-AzDoPipeline.ps1 b/AzureDevOpsPowerShell/Public/Api/Pipelines/Pipelines/Get-AzDoPipeline.ps1
@@ -7,7 +7,6 @@ function Get-AzDoPipeline {
 .EXAMPLE
     $params = @{
         CollectionUri = "https://dev.azure.com/contoso"
-        PAT = "***"
         Name = "Policy 1"
         RepoName = "Repo 1"
         ProjectName = "Project 1"

diff --git a/AzureDevOpsPowerShell/Public/Api/Pipelines/Pipelines/New-AzDoPipeline.ps1 b/AzureDevOpsPowerShell/Public/Api/Pipelines/Pipelines/New-AzDoPipeline.ps1
@@ -7,7 +7,6 @@ function New-AzDoPipeline {
 .EXAMPLE
   $newAzDoPipelineSplat = @{
       CollectionUri = "https://dev.azure.com/contoso"
-      PAT = "***"
       PipelineName = "Pipeline 1"
       RepoName = "Repo 1"
       ProjectName = "Project 1"

diff --git a/...eDevOpsPowerShell/Public/Api/Policy/Configuration/Set-AzDoBranchPolicyBuildValidation.ps1 b/...eDevOpsPowerShell/Public/Api/Policy/Configuration/Set-AzDoBranchPolicyBuildValidation.ps1
@@ -7,7 +7,6 @@ function Set-AzDoBranchPolicyBuildValidation {
 .EXAMPLE
     $params = @{
         CollectionUri = "https://dev.azure.com/contoso"
-        PAT = "***"
         Name = "Policy 1"
         RepoName = "Repo 1"
         ProjectName = "Project 1"

diff --git a/...evOpsPowerShell/Public/Api/Policy/Configuration/Set-AzDoBranchPolicyCommentResolution.ps1 b/...evOpsPowerShell/Public/Api/Policy/Configuration/Set-AzDoBranchPolicyCommentResolution.ps1
@@ -7,7 +7,6 @@ function Set-AzDoBranchPolicyCommentResolution {
 .EXAMPLE
     $params = @{
         CollectionUri = "https://dev.azure.com/contoso"
-        PAT = "***"
         RepoName = "Repo 1"
         ProjectName = "Project 1"
     }

diff --git a/AzureDevOpsPowerShell/Public/Api/Policy/Configuration/Set-AzDoBranchPolicyMergeStrategy.ps1 b/AzureDevOpsPowerShell/Public/Api/Policy/Configuration/Set-AzDoBranchPolicyMergeStrategy.ps1
@@ -7,7 +7,6 @@ function Set-AzDoBranchPolicyMergeStrategy {
 .EXAMPLE
     $params = @{
         CollectionUri = "https://dev.azure.com/contoso"
-        PAT = "***"
         RepoName = "Repo 1"
         ProjectName = "Project 1"
     }

diff --git a/...eDevOpsPowerShell/Public/Api/Policy/Configuration/Set-AzDoBranchPolicyMinimalApproval.ps1 b/...eDevOpsPowerShell/Public/Api/Policy/Configuration/Set-AzDoBranchPolicyMinimalApproval.ps1
@@ -7,7 +7,6 @@ function Set-AzDoBranchPolicyMinimalApproval {
 .EXAMPLE
     $params = @{
         CollectionUri = "https://dev.azure.com/contoso"
-        PAT = "***"
         RepoName = "Repo 1"
         ProjectName = "Project 1"
     }

diff --git a/...DevOpsPowerShell/Public/Api/ServiceEndpoints/Endpointproxy/Test-AzDoServiceConnection.ps1 b/...DevOpsPowerShell/Public/Api/ServiceEndpoints/Endpointproxy/Test-AzDoServiceConnection.ps1
@@ -7,7 +7,6 @@ function Test-AzDoServiceConnection {
     .EXAMPLE
         $params = @{
             CollectionUri               = "https://dev.azure.com/contoso"
-            PAT                         = "***"
             ProjectName                 = "Project 1"
             SubscriptionId              = "00000-00000-00000-00000-00000"
             SubscriptionName            = "Subscription 1"

diff --git a/AzureDevOpsPowerShell/Public/Api/ServiceEndpoints/Endpoints/New-AzDoServiceConnection.ps1 b/AzureDevOpsPowerShell/Public/Api/ServiceEndpoints/Endpoints/New-AzDoServiceConnection.ps1
@@ -7,7 +7,6 @@ function New-AzDoServiceConnection {
   .EXAMPLE
       $params = @{
           CollectionUri               = "https://dev.azure.com/contoso"
-          PAT                         = "***"
           ProjectName                 = "Project 1"
           SubscriptionId              = "00000-00000-00000-00000-00000"
           SubscriptionName            = "Subscription 1"

diff --git a/README.md b/README.md
@@ -18,34 +18,34 @@
 
 ## Overview
 
-Automate tasks in Azure DevOps and Azure AD. Works on Windows Linux and MacOS.
+Automate tasks in Azure DevOps. Works on Windows, Linux and MacOS. There are a few good open-source projects already going on this topic (Like VS-Team),
+but we believe that this project in more user-friendly.
 
 ## Installation
 
 ```powershell
+# PowerShell 7.3 and below
+Install-Module -Name AzureDevOpsPowerShellAPI -Scope CurrentUser
 
-Install-Module -Name AzureDevOpsPowerShellAPI -Scope CurrentUser -Repository InSpark -Credential $InSparkAzureDevopsArtifacts
-
+# PowerShell 7.4 and up
+Install-PSresource -Name AzureDevOpsPowerShellAPI -Scope CurrentUser
 ```
 
-For more information on how to setup access to our repository, please checkout [our guide](https://weareinspark.github.io/AzureDevOpsPowerShellAPI/about_InstallingModule/). The [source documentation on installation can also be found here](https://github.com/WeAreInSpark/AzureDevOpsPowerShellAPI/blob/main/docs/en-US/about_InstallingModule.md).
-
 ## Basic Usage
 
 ### List all Azure DevOps projects
 
 ```powershell
 $Params = @{
     CollectionUri = "https://dev.azure.com/contoso"
-    PAT = "***"
 }
 Get-AzDoProject @params
 ```
 
 ### Create an Azure DevOps Project
 
 ```powershell
-New-AzDoProject -CollectionUri "https://dev.azure.com/contoso" -PAT "***" -ProjectName "Project 1"
+New-AzDoProject -CollectionUri "https://dev.azure.com/contoso" -ProjectName "Project 1"
 ```
 
 ## Contributing

diff --git a/docs/en-US/.pages b/docs/en-US/.pages
@@ -1,7 +1,7 @@
 nav:
   - Home:
     - index.md
-    - ...| about*.md
+    - ...| About*.md
   - Modules:
     - Approvals And Checks:
       - Check Configurations:
@@ -23,9 +23,6 @@ nav:
         - Add-FilesToRepo.md
       - Repositories:
         - ... | *AzDoRepo.md
-    - Graph:
-      - Groups:
-        - Set-AzDoTeamMember.md
     - Pipelines:
       - Pipelines:
         - ... | *AzDoPipeline.md

diff --git a/docs/en-US/About_Authentication.md b/docs/en-US/About_Authentication.md
@@ -0,0 +1,37 @@
+# Authentication
+
+## Users
+
+When you use the module locally you only have to log in to your Azure tenant with 'Azure PowerShell'.
+The module will then fetch a Access token with `Get-AzAccessToken`.
+
+```powershell
+Connect-AzAccount
+
+Get-AzDoProject -CollectionUri = "https://dev.azure.com/contoso"
+```
+
+## Azure resources
+
+When using the module in for example an Automation Account or an Azure Function you can use the Managed Identity to
+give access to the azure DevOps resources. The module can again use the access token to access the resources.
+
+```powershell
+Connect-AzAccount -Identity
+
+Get-AzDoProject -CollectionUri = "https://dev.azure.com/contoso"
+```
+
+## Azure DevOps
+
+When you use Azure DevOps you can use of the Azure DevOps token to authenticate to Azure. Do not forget to disable the protection setting. You can find the docmentation [here](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/access-tokens?view=azure-devops&tabs=yaml#protect-access-to-repositories-in-yaml-pipelines)
+
+```yaml
+steps:
+  - powershell: |
+      Set-AzdoPat -Pat "$env:SYSTEM_ACCESSTOKEN"
+
+      Get-AzDoProject -CollectionUri = "https://dev.azure.com/contoso"
+    env:
+      SYSTEM_ACCESSTOKEN: $(System.AccessToken)
+```