Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/microsoft/azure-devops-node-api
Azure DevOps Client for Node.js
https://github.com/microsoft/azure-devops-node-api
Last synced: about 2 months ago
JSON representation
Azure DevOps Client for Node.js
- Host: GitHub
- URL: https://github.com/microsoft/azure-devops-node-api
- Owner: microsoft
- License: other
- Created: 2015-06-29T19:05:03.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-06-26T11:36:09.000Z (3 months ago)
- Last Synced: 2024-07-22T21:54:49.181Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 4.31 MB
- Stars: 456
- Watchers: 97
- Forks: 226
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://dev.azure.com/ms/azure-devops-node-api/_build/latest?definitionId=89&branchName=master)
# Azure DevOps Client for Node.js
Integrate with Azure DevOps from your Node.js apps.
### Install the library
```
npm install azure-devops-node-api --save
```
## News
vso-node-api has been renamed and released as azure-devops-node-api
## Get started
### Samples
See [samples](./samples) for complete coding examples
### Install the library
```
npm install azure-devops-node-api --save
```
### Create a connection
```javascript
import * as azdev from "azure-devops-node-api";
// your collection url
let orgUrl = "https://dev.azure.com/yourorgname";
let token: string = process.env.AZURE_PERSONAL_ACCESS_TOKEN;
let authHandler = azdev.getPersonalAccessTokenHandler(token);
let connection = new azdev.WebApi(orgUrl, authHandler);
```
> Please note that some API's (e.g. ProfileApi) can't be hit at the org level, and has to be hit at the deployment level,
so url should be structured like https://**vssps**.dev.azure.com/{yourorgname}
### Get an instance of a client
```javascript
import * as ba from "azure-devops-node-api/BuildApi";
let build: ba.IBuildApi = await connection.getBuildApi();
```
#### Available clients
These clients are available:
* Advanced Security Alert
* Advanced Security Management
* Build
* Core
* Dashboard
* ExtensionManagement
* FeatureManagement
* FileContainer
* Git
* Locations
* Notification
* Policy
* Profile
* ProjectAnalysis
* Release
* SecurityRoles
* TaskAgent
* Task
* Test
* TestPlan
* TestResults
* Tfvc
* Wiki
* Work
* WorkItemTracking
* WorkItemTrackingProcess
* WorkItemTrackingProcessDefinitions
### Use the client
Coding is easy using linear coding with async/await in TypeScript
```javascript
import * as bi from "azure-devops-node-api/interfaces/BuildInterfaces";
async function run() {
let project: string = "myProject";
let defs: bi.DefinitionReference[] = await build.getDefinitions(project);
defs.forEach((defRef: bi.DefinitionReference) => {
console.log(`${defRef.name} (${defRef.id})`);
});
}
run();
```
## APIs
To see what APIs are available, see the appropriate client interface. For example, [GitApi.ts](https://github.com/Microsoft/azure-devops-node-api/blob/master/api/GitApi.ts)
More detailed information for the endpoints of each API can be found at https://docs.microsoft.com/en-us/rest/api/vsts/?view=vsts-rest-4.1
## Running Samples
Pre-reqs: [Node >= 16](https://nodejs.org) and [typescript (tsc) >= 4](https://www.npmjs.com/package/typescript)
Run `npm install` first
Set environment variables using set or export:
```bash
API_URL=https://dev.azure.com/yourorgname
// use your token
API_TOKEN=cbdeb34vzyuk5l4gxc4qfczn3lko3avfkfqyb47etahq6axpcqha
API_PROJECT=myProject
```
Run samples:
```bash
$ npm run samples
```
Run a specific sample:
```bash
$ npm run samples -- projectAnalysis
```
## Node support
v14 and above - [current, maintained] - Supports node 16 and above
v13 and below - End Of Life, for Node < 16, contains security vulnerabilities, use at your own risk
## API and TFS Mapping
Below you'll find a quick mapping of azure-devops-node-api versions and their corresponding TFS releases. All API versions will work on the TFS version mentioned as well as later TFS versions.
|**TFS Version** | **Node API VERSION**|
|-------------------|------------------|
|Azure DevOps Server vNext | 8.0.0|
|Azure DevOps Server 2019 | 7.0.0|
|TFS 2018 Update 2 | 6.6.2|
|TFS 2017 Update 2 | 6.2.8-preview|
|TFS 2017 Update 1 | 5.1.2|
|TFS 2017 RTW | 5.0.0|
|TFS 2015 Update 2 | 0.7.0|
## Contributing
To contribute to this repository, see the [contribution guide](./CONTRIBUTING.md)
## Issues
Feel free to file an issue in this repo.
Do you think there might be a security issue? Have you been phished or identified a security vulnerability? Please don't report it here - let us know by sending an email to [email protected].
## Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.