AzureDevOps.RestAPI.NetSDK.Helper
1.1.0-preview-9
dotnet add package AzureDevOps.RestAPI.NetSDK.Helper --version 1.1.0-preview-9
NuGet\Install-Package AzureDevOps.RestAPI.NetSDK.Helper -Version 1.1.0-preview-9
<PackageReference Include="AzureDevOps.RestAPI.NetSDK.Helper" Version="1.1.0-preview-9" />
paket add AzureDevOps.RestAPI.NetSDK.Helper --version 1.1.0-preview-9
#r "nuget: AzureDevOps.RestAPI.NetSDK.Helper, 1.1.0-preview-9"
// Install AzureDevOps.RestAPI.NetSDK.Helper as a Cake Addin #addin nuget:?package=AzureDevOps.RestAPI.NetSDK.Helper&version=1.1.0-preview-9&prerelease // Install AzureDevOps.RestAPI.NetSDK.Helper as a Cake Tool #tool nuget:?package=AzureDevOps.RestAPI.NetSDK.Helper&version=1.1.0-preview-9&prerelease
AzureDevOps.RestAPI.NetSDK.Helper
Helper tools for the Azure DevOps rest api .net SDK
==========
Onboarding Instructions
Installation
- Add nuget package:
Install-Package AzureDevOps.RestAPI.NetSDK.Helper
- In your application, you must initialize the helper with your Azure DevOps credentials. Open your program.cs or Startup.cs and add the following code:
builder.Services.RegisterVssConnection("https://dev.azure.com/{organization}", "{PAT}");
A VssConnection object is now registered in the dependency injection container. You can now inject it in your services or controllers.
public class MyService
{
private readonly VssConnection _vssConnection;
public MyService(VssConnection vssConnection)
{
_vssConnection = vssConnection;
}
}
Azure DevOps helpers
Here is the list of helpers available in the package:
Domain | Function | Description | Status |
---|---|---|---|
Projects | GetProjectList(...) | Get all projects | ✅ |
Backlog | GetQueries(...) | Returns all queries available in a project | ✅ |
Backlog | GetQueryResults(...) | Execute a query and retrive results | ✅ |
Backlog | DownloadAttachment(...) | Download an attachment for a specific work item | 📆 |
Wiki | GetWikis() | Retreive all available wikis | ✅ |
Wiki | GetWiki(...) | Get a Wiki description by identifier | ✅ |
Wiki | GetWikiPages(...) | Retreive all pages for a dedicated Wiki | ✅ |
Wiki | GetWikiPageText(...) | Retreive string content for a wiki page | ✅ |
✅ : Available
📆 : Planned in the roadmap
You can find more details and samples in the Wiki.
IC
Documentation : I want more
Do not hesitate to check unit tests on the solution. It's a good way to check how transformations are tested.
Also, to get more samples, go to the Wiki.
Do not hesitate to contribute.
Support / Contribute
If you have any questions, problems or suggestions, create an issue or fork the project and create a Pull Request.
You want more ? Feel free to create an issue or contribute by adding new functionnalities by forking the project and create a pull request.
And if you like this project, don't forget to star it !
You can also support me with a coffee :
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net7.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.TeamFoundationServer.Client (>= 16.205.1)
- Microsoft.VisualStudio.Services.Client (>= 16.205.1)
- Microsoft.VisualStudio.Services.Release.Client (>= 16.205.1)
- Microsoft.VisualStudio.Services.Search.Client (>= 16.205.1)
- Microsoft.VisualStudio.Services.ServiceHooks.WebApi (>= 16.205.1)
-
net8.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Microsoft.TeamFoundationServer.Client (>= 16.205.1)
- Microsoft.VisualStudio.Services.Client (>= 16.205.1)
- Microsoft.VisualStudio.Services.Release.Client (>= 16.205.1)
- Microsoft.VisualStudio.Services.Search.Client (>= 16.205.1)
- Microsoft.VisualStudio.Services.ServiceHooks.WebApi (>= 16.205.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.1.0-preview-9 | 463 | 1/22/2024 |
1.1.0-preview-8 | 194 | 12/4/2023 |
1.1.0-preview-7 | 110 | 11/29/2023 |
1.1.0-preview-5 | 153 | 10/6/2023 |
1.0.0 | 845 | 7/4/2023 |