Microsoft Azure Test Run API

The Test Run API from Microsoft Azure — 16 operation(s) for test run.

Documentation GitHub OpenAPI

Operations 22

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /test-runs List load test runs with filters · Microsoft Azure Get All Test Runs For The Given Filters #

Ask an LLM

“Which load test runs have I executed for a particular test?”

“Can I filter my load test runs by status and an execution date range?”

Tell an agent

List the load test runs for test {testId}.

Show test runs with status {status} executed between {executionFrom} and {executionTo}.

GET /test-runs/{testRunId} Get a load test run's details · Microsoft Azure Get Test Run Details By Test Run Id #

Ask an LLM

“What were the results and status of a specific load test run?”

“Can I pull up the full details of one test run by its id?”

Tell an agent

Show the details of load test run {testRunId}.

Get test run {testRunId} and tell me its current status.

PATCH /test-runs/{testRunId} Start a new load test run · Microsoft Azure Create And Start A New Test Run With The Given Test Run Id #

Ask an LLM

“How do I kick off a new run of an existing load test?”

“Can I rerun a load test using the settings from a previous run?”

Tell an agent

Start test run {testRunId} for load test {testId}.

Rerun test run {oldTestRunId} as new run {testRunId}.

DELETE /test-runs/{testRunId} Delete a load test run · Microsoft Azure Delete An Existing Load Test Run #

Ask an LLM

“How do I get rid of an old load test run I no longer need?”

“Can a finished test run be deleted from Azure Load Testing?”

Tell an agent destructive · confirm first

Delete load test run {testRunId}.

Remove the test run {testRunId} and its results permanently.

POST /test-runs/{testRunId}:stop Stop a running load test · Microsoft Azure Stop Test Run By Test Run Id #

Ask an LLM

“How can I halt a load test run that's currently executing?”

“Can I abort a test run early if it's hammering my app too hard?”

Tell an agent destructive · confirm first

Stop load test run {testRunId} now.

Abort the in-progress test run {testRunId}.

GET /test-runs/{testRunId}/app-components Get the app components tied to a test run · Microsoft Azure Get Associated App Component Collection Of Azure Resources For… #

Ask an LLM

“Which Azure resources are being monitored as app components for a test run?”

“What app components are associated with a given load test run?”

Tell an agent

Show the app components linked to test run {testRunId}.

List the Azure resources monitored during load test run {testRunId}.

PATCH /test-runs/{testRunId}/app-components Add app components to a test run · Microsoft Azure Add An App Component To A Test Run #

Ask an LLM

“How do I attach an Azure resource as an app component to a load test run?”

“Can I add monitored app components to a run by resource id, name and type?”

Tell an agent

Add app components {components} to test run {testRunId}.

Attach these Azure resources {components} for monitoring on load test run {testRunId}.

GET /test-runs/{testRunId}/files/{fileName} Download a file from a load test run · Microsoft Azure Get Test Run File By File Name #

Ask an LLM

“How do I retrieve a results or log file from a load test run by name?”

“Can I fetch a specific file produced by a test run?”

Tell an agent

Get file {fileName} from load test run {testRunId}.

Download the run artifact named {fileName} for test run {testRunId}.

GET /test-runs/{testRunId}/metric-definitions List metric definitions for a test run · Microsoft Azure List The Metric Definitions For A Load Test Run #

Ask an LLM

“Which metrics can I query for a load test run within a namespace?”

“What metric definitions are available for a given run and metric namespace?”

Tell an agent

List metric definitions for test run {testRunId} in namespace {metricNamespace}.

Show which metrics I can chart for run {testRunId} under {metricNamespace}.

GET /test-runs/{testRunId}/metric-dimensions/{name}/values List values of a metric dimension for a test run · Microsoft Azure List The Dimension Values For The Given Metric Dimension Name #

Ask an LLM

“What values does a metric dimension take during a load test run?”

“Can I see the distinct dimension values for a metric over a time span?”

Tell an agent

List values of dimension {name} for metric {metricname} in namespace {metricNamespace} on run {testRunId} over {timespan}.

Show the dimension values for {name} on test run {testRunId}.

GET /test-runs/{testRunId}/metric-namespaces List metric namespaces for a test run · Microsoft Azure List The Metric Namespaces For A Load Test Run #

Ask an LLM

“Which metric namespaces does a load test run expose?”

“What groups of metrics were collected for one test run?”

Tell an agent

List the metric namespaces for test run {testRunId}.

Show which metric namespaces are available on load test run {testRunId}.

POST /test-runs/{testRunId}/metrics Get metric values for a load test run · Microsoft Azure List The Metric Values For A Load Test Run #

Ask an LLM

“What were the response time values for a load test run over time?”

“Can I aggregate a test run metric by interval and filter by dimension?”

Tell an agent

Get values of metric {metricname} in namespace {metricNamespace} for run {testRunId} over {timespan}.

Chart metric {metricname} for test run {testRunId} with {aggregation} aggregation at {interval} intervals.

GET /test-runs/{testRunId}/server-metrics-config Get server metrics configuration for a test run · Microsoft Azure Get Associated Server Metrics Configuration For The Given Test… #

Ask an LLM

“Which server-side metrics are configured for a load test run?”

“What resource metrics will be captured from my app during a run?”

Tell an agent

Show the server metrics configuration for test run {testRunId}.

Get the server-side metrics set up on load test run {testRunId}.

PATCH /test-runs/{testRunId}/server-metrics-config Configure server metrics for a test run · Microsoft Azure Configure Server Metrics For A Test Run #

Ask an LLM

“How do I choose which server metrics to collect during a load test run?”

“Can I change the server-side metrics captured for a specific run?”

Tell an agent

Configure server metrics {metrics} for test run {testRunId}.

Set the server-side metrics collected on load test run {testRunId} to {metrics}.

DELETE /testruns/{testRunId} Delete a test run via the legacy endpoint · Microsoft Azure Delete A Test Run With Given Name Test Run Name Must Be A Valid… #

Ask an LLM

“How do I delete a test run with the older /testruns API?”

“What characters are allowed in a test run name when deleting through the legacy endpoint?”

Tell an agent destructive · confirm first

Delete test run {testRunId} using the legacy testruns endpoint.

Remove run {testRunId} through the older load testing API version.

PATCH /testruns/{testRunId} Start a test run via the legacy endpoint · Microsoft Azure Create And Start New Test Run Of The Given Name, Test Run Name… #

Ask an LLM

“How do I start a new test run with the older /testruns API?”

“Can the legacy endpoint rerun a test from an earlier run's settings?”

Tell an agent

Start test run {testRunId} for test {testId} using the legacy testruns endpoint.

Through the older API, rerun {oldTestRunId} as new run {testRunId}.

GET /testruns/{testRunId} Get a test run via the legacy testruns endpoint · Microsoft Azure Get Test Run Of Given Name #

Ask an LLM

“How do I read a test run through the older /testruns endpoint?”

“Can the legacy load testing API still return a test run by name?”

Tell an agent

Get test run {testRunId} using the legacy testruns endpoint.

Fetch run {testRunId} from the older load testing API version.

GET /testruns/{testRunId}/files/{fileId} Get a test run file via the legacy endpoint · Microsoft Azure Get Testrun File With Given File Name #

Ask an LLM

“How do I fetch a test run file by file id with the older /testruns API?”

“Can the legacy endpoint return a run's files?”

Tell an agent

Get file {fileId} from test run {testRunId} using the legacy testruns endpoint.

Download legacy run file {fileId} for {testRunId}.

GET /testruns/sortAndFilter Search test runs via the legacy sortAndFilter endpoint · Microsoft Azure Get All Test Runs With Given Filters #

Ask an LLM

“How do I sort and filter test runs with the older sortAndFilter API?”

“Can the legacy endpoint page through test runs with a next link?”

Tell an agent

Using the legacy sortAndFilter endpoint, list test runs for test {testId}.

Through the older API, find runs matching {search} ordered by {orderBy}.

POST /testruns/{testRunId}:stop Stop a test run via the legacy endpoint · Microsoft Azure Stop Test Run Of Given Name #

Ask an LLM

“How do I stop a running test with the older /testruns API?”

“Does the legacy load testing endpoint support stopping a run?”

Tell an agent destructive · confirm first

Stop test run {testRunId} using the legacy testruns endpoint.

Halt run {testRunId} through the older load testing API version.

GET /testruns/{testRunId}/clientMetrics Get client-side metrics for a load test run · Microsoft Azure Get All Client Metrics For A Given Load Test Run #

Ask an LLM

“What client-side metrics did a load test run record?”

“Can I group a run's client metrics by time interval?”

Tell an agent

Get client metrics for test run {testRunId}.

Show client metrics for run {testRunId} grouped by {groupByInterval}.

GET /testruns/{testRunId}/clientMetricsFilters List supported client metric filters for a run · Microsoft Azure Get All Client Metrics Supported Filters List For A Given Load… #

Ask an LLM

“Which filters can I apply to a test run's client metrics?”

“What values can I use to narrow down a load test run's client metrics?”

Tell an agent

List the supported client metric filters for test run {testRunId}.

Show what I can filter client metrics by on run {testRunId}.

Microsoft Azure Test Run API

Operations 22

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification