How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure TestRun API

The TestRun API from Microsoft Azure — 16 operation(s) for testrun.

Microsoft Azure TestRun API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include TestRun. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 22 operations across 16 paths, and defines 72 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

22 operations 16 paths 72 schemas 2 DELETE13 GET4 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 22

Across 16 paths, the API surfaces 22 operations — 2 DELETE, 13 GET, 4 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

TestRun 22
GET
/test-runs
Microsoft Azure Get All Test Runs For The Given Filters
microsoftAzureLoadtestrunListtestruns 8 params → 200default
GET
/test-runs/{testRunId}
Microsoft Azure Get Test Run Details By Test Run Id
microsoftAzureLoadtestrunGettestrun 2 params → 200default
PATCH
/test-runs/{testRunId}
Microsoft Azure Create And Start A New Test Run With The Given Test Run Id
microsoftAzureLoadtestrunCreateorupdatetestrun 3 params body → 200201default
DELETE
/test-runs/{testRunId}
Microsoft Azure Delete An Existing Load Test Run
microsoftAzureLoadtestrunDeletetestrun 2 params → 204default
POST
/test-runs/{testRunId}:stop
Microsoft Azure Stop Test Run By Test Run Id
microsoftAzureLoadtestrunStoptestrun 2 params → 200default
GET
/test-runs/{testRunId}/app-components
Microsoft Azure Get Associated App Component Collection Of Azure Resources For The Given Test run
microsoftAzureLoadtestrunGetappcomponents 2 params → 200default
PATCH
/test-runs/{testRunId}/app-components
Microsoft Azure Add An App Component To A Test Run
microsoftAzureLoadtestrunCreateorupdateappcomponents 2 params body → 200201default
GET
/test-runs/{testRunId}/files/{fileName}
Microsoft Azure Get Test Run File By File Name
microsoftAzureLoadtestrunGettestrunfile 3 params → 200default
GET
/test-runs/{testRunId}/metric-definitions
Microsoft Azure List The Metric Definitions For A Load Test Run
microsoftAzureLoadtestrunListmetricdefinitions 3 params → 200default
GET
/test-runs/{testRunId}/metric-dimensions/{name}/values
Microsoft Azure List The Dimension Values For The Given Metric Dimension Name
microsoftAzureLoadtestrunListmetricdimensionvalues 7 params → 200default
GET
/test-runs/{testRunId}/metric-namespaces
Microsoft Azure List The Metric Namespaces For A Load Test Run
microsoftAzureLoadtestrunListmetricnamespaces 2 params → 200default
POST
/test-runs/{testRunId}/metrics
Microsoft Azure List The Metric Values For A Load Test Run
microsoftAzureLoadtestrunListmetrics 7 params body → 200default
GET
/test-runs/{testRunId}/server-metrics-config
Microsoft Azure Get Associated Server Metrics Configuration For The Given Test Run
microsoftAzureLoadtestrunGetservermetricsconfig 2 params → 200default
PATCH
/test-runs/{testRunId}/server-metrics-config
Microsoft Azure Configure Server Metrics For A Test Run
microsoftAzureLoadtestrunCreateorupdateservermetricsconfig 2 params body → 200201default
DELETE
/testruns/{testRunId}
Microsoft Azure Delete A Test Run With Given Name Test Run Name Must Be A Valid Url Character ^[a Z0 9 ]$
microsoftAzureTestrunDeletetestrun 2 params → 204default
PATCH
/testruns/{testRunId}
Microsoft Azure Create And Start New Test Run Of The Given Name, Test Run Name Must Be A Valid Url Character ^[a Z0 9 ]$
microsoftAzureTestrunCreateandupdatetest 3 params body → 200default
GET
/testruns/{testRunId}
Microsoft Azure Get Test Run Of Given Name
microsoftAzureTestrunGettestrun 2 params → 200default
GET
/testruns/{testRunId}/files/{fileId}
Microsoft Azure Get Testrun File With Given File Name
microsoftAzureTestrunGettestrunfile 3 params → 200default
GET
/testruns/sortAndFilter
Microsoft Azure Get All Test Runs With Given Filters
microsoftAzureTestrunGetapptestrunssearch 9 params → 200default
POST
/testruns/{testRunId}:stop
Microsoft Azure Stop Test Run Of Given Name
microsoftAzureTestrunStoptestrun 2 params → 200default
GET
/testruns/{testRunId}/clientMetrics
Microsoft Azure Get All Client Metrics For A Given Load Test Run
microsoftAzureTestrunGettestrunclientmetrics 4 params → 200default
GET
/testruns/{testRunId}/clientMetricsFilters
Microsoft Azure Get All Client Metrics Supported Filters List For A Given Load Test Run
microsoftAzureTestrunGettestrunclientmetricsfilters 2 params → 200default

Schemas 72

The contract defines 72 schemas that model the data the API accepts and returns. The most detailed are TestRun (28 properties), TestRunModel (23 properties), TestRunStatisticsModel (14 properties), TestRunStatistics (14 properties). Each schema is shown below with its type and property counts.

ArtifactsContainerInfo
object
Artifacts container info.
2 properties
MetricRequestPayload
object
Filters to fetch the set of metric.
1 property
Azure.Core.Foundations.Error
object
The error object.
5 properties 2 required
TestRunStatistics
object
Test run statistics.
14 properties
CertificateType
string
Types of certificates supported.
TestRunCreateOrUpdate
object
Load test run model
9 properties
MetricValue
object
Represents a metric value.
2 properties
Secret
object
Secret
2 properties
MetricDefinitionCollection
object
Represents collection of metric definitions.
1 property 1 required
Azure.Core.Foundations.InnerError
object
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Gu…
2 properties
PassFailCriteria
object
Pass fail criteria for a test.
1 property
ErrorDetails
object
Error details if there is any failure in load test run
1 property
OptionalLoadTestConfig
object
Configuration for quick load test
6 properties
OutputTestArtifacts
object
The output artifacts for the test run
2 properties 2 required
TestRunInputArtifacts
object
The input artifacts for the test run.
6 properties
TestRunStatisticsModel
object
[Readonly] Test run statistics
14 properties
PassFailCriteria_2
object
Pass fail criteria for a test
1 property
AppComponentUpdate
object
An Azure resource object (Refer azure generic resource model :https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-idgenericresource)
4 properties
PFResult
string
Pass/fail criteria result.
TestRun
object
Load test run model
28 properties 1 required
TestRunModel
object
Load test run model
23 properties
DimensionValue
object
Represents a metric dimension value.
2 properties
ErrorResponseBody
object
The error response object.
4 properties
TestRunModelResourceList
object
List of Resources
2 properties
FileUrl
object
FileUrl Model
4 properties
MetricAvailability
object
Metric availability specifies the time grain (aggregation interval or frequency)
1 property
PagedTestRun
object
Paged collection of TestRun items
2 properties 1 required
TestRunServerMetricConfig
object
Test run server metrics configuration
6 properties
TimeSeriesElement
object
The time series returned when a data query is performed.
2 properties
AggregationType
string
Aggregation type.
DefaultErrorResponseBody
object
The definition of an error object.
1 property
ResourceMetric
object
Associated metric definition for particular metrics of the azure resource ( Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/listme…
8 properties 5 required
MetricNamespace
object
Metric namespace class specifies the metadata for a metric namespace.
2 properties
TestRunAppComponentsUpdate
object
Test run app component
1 property
TimeGrain
string
Time Grain
Status
string
Test run status.
Filters
object
2 properties
FileType
string
Types of file supported.
MetricUnit
string
Metric unit.
PFTestResult
string
Test result based on pass/fail criteria.
MetricDefinition
object
Metric definition
8 properties
AutoStopCriteria
object
Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window.
3 properties
TestRunOutputArtifacts
object
The output artifacts for the test run.
3 properties
AppComponent
object
An Azure resource object (Refer azure generic resource model :https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-idgenericresource)
7 properties 3 required
DimensionFilter
object
Dimension name and values to filter
2 properties
ClientMetricsResults
object
2 properties
TestRunAppComponents
object
Test run app component
6 properties 1 required
FileStatus
string
File status.
TimeSeries
object
2 properties
TimeRange
object
2 properties
ClientMetricsFilters
object
3 properties
TestKind
string
Test kind
SecretType
string
Types of secrets supported.
PassFailMetric_2
object
7 properties
SecretMetadata
object
2 properties
DimensionValueList
object
Metrics dimension values.
3 properties
LoadTestConfig
object
The load test configuration
1 property
MetricNamespaceCollection
object
Represents collection of metric namespaces.
1 property 1 required
PassFailMetric
object
Pass fail metric
8 properties
LoadTestConfiguration
object
Configurations for the load test.
4 properties
PFAgFunc
string
Aggregation functions for pass/fail criteria.
InputTestArtifacts
object
[ReadOnly]The input artifacts for the test
4 properties
FileUrlPath
object
3 properties
Series
object
4 properties
PFMetrics
string
Metrics for pass/fail criteria.
Metrics
object
The response to a metrics query.
2 properties 1 required
TestRunFileInfo
object
Test run file info.
6 properties 1 required
Azure.Core.Foundations.ErrorResponse
object
A response containing error details.
1 property 1 required
NameAndDesc
object
The name and description
2 properties
TestArtifacts
object
2 properties 1 required
TestRunArtifacts
object
Collection of test run artifacts
2 properties
CertificateMetadata
object
Certificates metadata
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-testrun-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure TestRun API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.