|
1 | | - |
2 | | - |
3 | 1 | # AzureDevOps |
4 | 2 |
|
5 | | -[](https://dev.azure.com/azuredevops-powershell/azuredevops-powershell/_build/latest?definitionId=1) |
6 | | -[](https://dev.azure.com/azuredevops-powershell/azuredevops-powershell/_build/latest?definitionId=1) |
7 | | -[](https://dev.azure.com/azuredevops-powershell/azuredevops-powershell/_build/latest?definitionId=1) |
8 | | -[](https://dev.azure.com/azuredevops-powershell/azuredevops-powershell/_release/) |
9 | | -[](https://www.powershellgallery.com/packages/AzureDevOps) |
10 | | -[](https://www.powershellgallery.com/packages/AzureDevOps) |
11 | | - |
12 | | -AzureDevOps is a very simple (and primitive) PowerShell module to interact with the Azure DevOps REST API. |
13 | | - |
14 | | -## Getting started |
15 | | - |
16 | | -1. Install the module |
17 | | - |
18 | | - ```powershell |
19 | | - Install-Module AzureDevOps |
20 | | - ``` |
21 | | - |
22 | | -2. Import the module |
23 | | - |
24 | | - ```powershell |
25 | | - Import-Module AzureDevOps |
26 | | - ``` |
27 | | - |
28 | | -3. Add connection details |
29 | | - |
30 | | - ```powershell |
31 | | - # Add Azure DevOps connection details |
32 | | - Add-AzureDevOpsAccount ` |
33 | | - -OrganisationName "contoso" ` |
34 | | - -ProjectName "AzureDevOps PowerShell Demo" ` |
35 | | - -UserName "user@name.com" ` |
36 | | - -Token "<azure-devops-personal-access-token>"; |
37 | | - ``` |
38 | | - |
39 | | -4. Check out the examples in the [Examples](https://github.com/mehmetseckin/azuredevops-powershell/tree/master/Examples) folder. |
40 | | - |
41 | | -5. Or, check out the list of available cmdlets |
| 3 | +AzureDevOps is a PowerShell module for interacting with the Azure DevOps REST API. |
42 | 4 |
|
43 | | - ```powershell |
44 | | - Get-Command *AzureDevOps* |
45 | | - ``` |
| 5 | +## Installation |
46 | 6 |
|
47 | | -6. Use `Get-Help` to see details for the cmdlets. |
| 7 | +Install the module from the PowerShell Gallery: |
48 | 8 |
|
49 | | - ```powershell |
50 | | - Get-Help Add-AzureDevOpsAccount -Detailed |
51 | | - ``` |
| 9 | +```powershell |
| 10 | +Install-PSResource -Name AzureDevOps |
| 11 | +Import-Module -Name AzureDevOps |
| 12 | +``` |
52 | 13 |
|
53 | 14 | ## Documentation |
54 | 15 |
|
55 | | -Documentation for the individual commands is available in the [Docs](https://github.com/mehmetseckin/azuredevops-powershell/blob/master/Docs/AzureDevOps.md) folder. |
| 16 | +Documentation is published at [psmodule.io/AzureDevOps](https://psmodule.io/AzureDevOps/). |
56 | 17 |
|
57 | | -## References |
| 18 | +Use PowerShell help and command discovery for module details: |
58 | 19 |
|
59 | | -- [Azure DevOps CLI](https://learn.microsoft.com/en-us/azure/devops/cli/?view=azure-devops) |
60 | | -- [Azure DevOps Services REST API Reference](https://learn.microsoft.com/en-us/rest/api/azure/devops/) |
61 | | -- [Azure DevOps Developer resources documentation | Microsoft Learn](https://learn.microsoft.com/en-us/azure/devops/dev-resources/?view=azure-devops) |
62 | | -- [How to use the Azure DevOps REST API with PowerShell | YouTube](https://www.youtube.com/watch?v=ylJmee-4KTo) |
| 20 | +```powershell |
| 21 | +Get-Command -Module AzureDevOps |
| 22 | +Get-Help <CommandName> -Examples |
| 23 | +``` |
63 | 24 |
|
64 | | -## Similar projects |
| 25 | +## Contributing |
65 | 26 |
|
66 | | -* [vsteam](https://github.com/DarqueWarrior/vsteam) - A comprehensive PowerShell module for accessing TFS and VSTS. |
67 | | -* [AzureDevOpsPowerShell](https://github.com/rfennell/AzureDevOpsPowershell) - A selection of PowerShell scripts that make use of the Azure DevOps (TFS/VSTS) APIs. |
68 | | -* [vststools-cli](https://github.com/AssureCare/vststools-cli) - A set of useful command-line tools and extensions for VSTS. |
69 | | -* [AzurePipelinesPS](https://github.com/Dejulia489/AzurePipelinesPS) - A PowerShell module that makes interfacing with Azure Pipelines a little easier |
70 | | -* [AZDOPS](https://github.com/AZDOPS/AZDOPS) |
| 27 | +Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. |
0 commit comments