> For the complete documentation index, see [llms.txt](https://docs.cloudbeat.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cloudbeat.io/features/integrations/ci-cd-tools/azure-tfs.md).

# Azure DevOps

### Prerequisites 

In order to run a test case, we need 3 things: Cloudbeat API Key, test case id and test type.

### Cloudbeat API Key

To find your api key, go to Account > Settings > Security

or follow this link: <https://app.cloudbeat.io/#/settings/security/>

### Test Case ID

To find a case id simply open cases and open the case you want to run.

<figure><img src="/files/IbMwWhhefk6nBIMuWATt" alt=""><figcaption></figcaption></figure>

### Test Type

You can choose between a case, which is used for a singular test, or suite for multiple tests.

## Azure Pipeline

**Start by creating a new pipeline in Azure**

* **Log In and Navigate**
  * Go to [Azure DevOps](https://dev.azure.com/), log in, and open your project.
* **Go to Pipelines**
  * Click on **Pipelines** in the left-hand menu, then choose **New Pipeline**.
* **Select Source Repository**
  * Choose the repository where your code is stored (e.g., Azure Repos or GitHub).
* **Choose the Classic Editor**
  * When setting up the pipeline, select **Use the Classic Editor** instead of YAML.
* **Configure Pipeline Settings**
  * Set the pipeline name (e.g., `Cloudbeat-cli Run Test Example`).
  * Under **Agent Pool**, choose **Azure Pipelines** and select the **Agent Specification** (e.g., `ubuntu-22.04`).

<figure><img src="/files/0Gkou9zRDfyxF9BokGeX" alt=""><figcaption></figcaption></figure>

* **Select the Repository Source**:
  * In the pipeline editor, under **Get Sources**, click the edit icon.
  * Choose **GitHub** (or another repository type based on your project).
* **Authorize the Connection**:
  * If GitHub is selected, ensure it’s authorized using an access token. Click **Change** to modify or reauthorize if necessary.
* **Set Repository and Branch**:
  * Repository: Select the specific GitHub repository (e.g., `oxygenhq/docs`).
  * Default Branch: Specify the branch to build from (e.g., `refs/heads/master`).
* **Adjust Source Settings**:
  * **Clean**: Set to `false` (default) to avoid cleaning the workspace before building. Change to `true` if a fresh workspace is needed for every run.
  * **Tag Sources**: Choose whether to tag the repository:
    * **Never**: Don’t tag builds (default).
    * **On Success**: Tag only successful builds.
    * **Always**: Tag every build.
* **Report Build Status**:
  * Check the box to report the build status back to GitHub.

<figure><img src="/files/KFwYGmPXEdvzrnIRH0Ki" alt=""><figcaption></figcaption></figure>

## Define Variables

You can create variables to store data such as API keys and other data to use across the tasks.

<figure><img src="/files/jdJH2OmyGHGUvz7YesNY" alt=""><figcaption></figcaption></figure>

## Add Agent Job

First we need to add a command which will install the cloudbeat cli

### Install Cloudbeat CLI

Add a command line task, name it "Install @cloudbeat/cli"

Add the script:

`npm install -g @cloudbeat/cli`

<figure><img src="/files/5jvc9eOaVp8jZL1iFPS0" alt=""><figcaption></figcaption></figure>

### Run Test Case

To run our test, we need to add another command line and pass in the test type, id, and api key:

cloudbeat-cli start testType testId --apiKey=apiKey

But since we defined our variables, we can add this to the script:

`cloudbeat-cli start $(cbTestType) $(cbTestId) --apiKey=$(cbApiKey)`

when the test ends, it will create an JUnit XML results file

### Publish Test Results

Lastly we need to publish the results. Add another task called "Publish Test Results":

<figure><img src="/files/wzPA69Krh5WMBFj7KLGY" alt=""><figcaption></figcaption></figure>

## Run Pipeline

Press on Queue and Run

<figure><img src="/files/m3fF8n4DVGeKomv09019" alt=""><figcaption></figcaption></figure>

Inside Cloudbeat, you will see the test case starting

<figure><img src="/files/MPqbby687Z1ZLNDE0bZP" alt=""><figcaption></figcaption></figure>

After it's finished, you can see the results by following the link under Publish Test Results:

<figure><img src="/files/n8rGlF0VT2P5ghKAytJs" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/OwN8KAt28Z3p9D1o1Eby" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.cloudbeat.io/features/integrations/ci-cd-tools/azure-tfs.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.