{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector TestRun API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "TestRun", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Get All Test Runs For The Given Filters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/test-runs", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort on the supported fields in (field asc/desc) format. eg: executedDateTime\nasc. Supported fields - executedDateTime" }, { "name": "search", "value": "", "type": "query", "description": "Prefix based, case sensitive search on searchable fields - description,\nexecutedUser. For example, to search for a test run, with description 500 VUs,\nthe search parameter can be 500." }, { "name": "testId", "value": "", "type": "query", "description": "Unique name of an existing load test." }, { "name": "executionFrom", "value": "", "type": "query", "description": "Start DateTime(RFC 3339 literal format) of test-run execution time filter range." }, { "name": "executionTo", "value": "", "type": "query", "description": "End DateTime(RFC 3339 literal format) of test-run execution time filter range." }, { "name": "status", "value": "", "type": "query", "description": "Comma separated list of test run status." }, { "name": "maxpagesize", "value": "", "type": "query", "description": "Number of results in response." } ] }, "docs": "Get all test runs for the given filters." }, { "info": { "name": "Microsoft Azure Get Test Run Details By Test Run Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/test-runs/:testRunId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "testRunId", "value": "", "type": "path", "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters." } ] }, "docs": "Get test run details by test run Id." }, { "info": { "name": "Microsoft Azure Create And Start A New Test Run With The Given Test Run Id", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/test-runs/:testRunId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "testRunId", "value": "", "type": "path", "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters." }, { "name": "oldTestRunId", "value": "", "type": "query", "description": "Existing test run identifier that should be rerun, if this is provided, the\ntest will run with the JMX file, configuration and app components from the\nexisting test run. You can override the configuration values for new test run\nin the request body." } ] }, "docs": "Create and start a new test run with the given test run Id." }, { "info": { "name": "Microsoft Azure Delete An Existing Load Test Run", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/test-runs/:testRunId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "testRunId", "value": "", "type": "path", "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters." } ] }, "docs": "Delete an existing load test run by providing the testRunId." }, { "info": { "name": "Microsoft Azure Stop Test Run By Test Run Id", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/test-runs/:testRunId:stop", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "testRunId", "value": "", "type": "path", "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters." } ] }, "docs": "Stop test run by test run Id." }, { "info": { "name": "Microsoft Azure Get Associated App Component Collection Of Azure Resources For The Given Test\nrun", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/test-runs/:testRunId/app-components", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "testRunId", "value": "", "type": "path", "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters." } ] }, "docs": "Get associated app component (collection of azure resources) for the given test
run." }, { "info": { "name": "Microsoft Azure Add An App Component To A Test Run", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/test-runs/:testRunId/app-components", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "testRunId", "value": "", "type": "path", "description": "Unique Id for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters." } ] }, "docs": "Add an app component to a test run by providing the resource Id, name and type." }, { "info": { "name": "Microsoft Azure Get Test Run File By File Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/test-runs/:testRunId/files/:fileName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "testRunId", "value": "", "type": "path", "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters." }, { "name": "fileName", "value": "", "type": "path", "description": "Name of the file." } ] }, "docs": "Get test run file by file name." }, { "info": { "name": "Microsoft Azure List The Metric Definitions For A Load Test Run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/test-runs/:testRunId/metric-definitions", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "testRunId", "value": "", "type": "path", "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters." }, { "name": "metricNamespace", "value": "", "type": "query", "description": "Metric namespace to query metric definitions for." } ] }, "docs": "List the metric definitions for a load test run." }, { "info": { "name": "Microsoft Azure List The Dimension Values For The Given Metric Dimension Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/test-runs/:testRunId/metric-dimensions/:name/values", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "testRunId", "value": "", "type": "path", "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters." }, { "name": "name", "value": "", "type": "path", "description": "Dimension name" }, { "name": "metricname", "value": "", "type": "query", "description": "Metric name" }, { "name": "interval", "value": "", "type": "query", "description": "The interval (i.e. timegrain) of the query." }, { "name": "metricNamespace", "value": "", "type": "query", "description": "Metric namespace to query metric definitions for." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'." } ] }, "docs": "List the dimension values for the given metric dimension name." }, { "info": { "name": "Microsoft Azure List The Metric Namespaces For A Load Test Run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/test-runs/:testRunId/metric-namespaces", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "testRunId", "value": "", "type": "path", "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters." } ] }, "docs": "List the metric namespaces for a load test run." }, { "info": { "name": "Microsoft Azure List The Metric Values For A Load Test Run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/test-runs/:testRunId/metrics", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "testRunId", "value": "", "type": "path", "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters." }, { "name": "aggregation", "value": "", "type": "query", "description": "The aggregation" }, { "name": "metricname", "value": "", "type": "query", "description": "Metric name" }, { "name": "interval", "value": "", "type": "query", "description": "The interval (i.e. timegrain) of the query." }, { "name": "metricNamespace", "value": "", "type": "query", "description": "Metric namespace to query metric definitions for." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'." } ] }, "docs": "List the metric values for a load test run." }, { "info": { "name": "Microsoft Azure Get Associated Server Metrics Configuration For The Given Test Run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/test-runs/:testRunId/server-metrics-config", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "testRunId", "value": "", "type": "path", "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters." } ] }, "docs": "Get associated server metrics configuration for the given test run." }, { "info": { "name": "Microsoft Azure Configure Server Metrics For A Test Run", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/test-runs/:testRunId/server-metrics-config", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "testRunId", "value": "", "type": "path", "description": "Unique Id for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters." } ] }, "docs": "Configure server metrics for a test run" }, { "info": { "name": "Microsoft Azure Get Test Run Of Given Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/testruns/:testRunId", "params": [ { "name": "testRunId", "value": "", "type": "path", "description": "Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$" }, { "name": "api-version", "value": "", "type": "query", "description": "Api version" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Create And Start New Test Run Of The Given Name, Test Run Name Must Be A Valid Url Character ^[a Z0 9 ]*$", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/testruns/:testRunId", "params": [ { "name": "testRunId", "value": "", "type": "path", "description": "Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$" }, { "name": "oldTestRunId", "value": "", "type": "query", "description": "Existing testRunId to re run new test" }, { "name": "api-version", "value": "", "type": "query", "description": "Api version" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Delete A Test Run With Given Name Test Run Name Must Be A Valid Url Character ^[a Z0 9 ]*$", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/testruns/:testRunId", "params": [ { "name": "testRunId", "value": "", "type": "path", "description": "Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$" }, { "name": "api-version", "value": "", "type": "query", "description": "Api version" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get Testrun File With Given File Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/testruns/:testRunId/files/:fileId", "params": [ { "name": "testRunId", "value": "", "type": "path", "description": "Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$" }, { "name": "fileId", "value": "", "type": "path", "description": "Unique identifier for test run file, must be a valid URL character ^[a-z0-9_-]*$" }, { "name": "api-version", "value": "", "type": "query", "description": "Api version" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get All Test Runs With Given Filters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/testruns/sortAndFilter", "params": [ { "name": "orderBy", "value": "", "type": "query", "description": "Sort on one of the field - status, displayName, executedDateTime in (field asc/desc) format. eg: displayName asc" }, { "name": "nextLink", "value": "", "type": "query", "description": "NextLink Token to get next page of response" }, { "name": "search", "value": "", "type": "query", "description": "Filter search based on searchable fields - description, executedUser." }, { "name": "testId", "value": "", "type": "query", "description": "Unique identifier for load test name, must be a valid URL character ^[a-z0-9_-]*$" }, { "name": "executionFrom", "value": "", "type": "query", "description": "The end DateTime(Iso8601Literal format) of test-run execution time filter range." }, { "name": "executionTo", "value": "", "type": "query", "description": "The start DateTime(Iso8601Literal format) of test-run execution time filter range." }, { "name": "status", "value": "", "type": "query", "description": "Comma separated list of test run status, value can be - \"ACCEPTED\", \"NOTSTARTED\",\"PROVISIONING\",\"PROVISIONED\",\"CONFIGURING\",\n\"CONFIGURED\",\"EXECUTING\",\"EXECUTED\",\"DEPROVISIONING\",\"DEPROVISIONED\",\"DONE\",\"CANCELLED\",\"FAILED\"" }, { "name": "maxPageSize", "value": "", "type": "query", "description": "No of results in response" }, { "name": "api-version", "value": "", "type": "query", "description": "Api version" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Stop Test Run Of Given Name", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/testruns/:testRunId:stop", "params": [ { "name": "testRunId", "value": "", "type": "path", "description": "Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$" }, { "name": "api-version", "value": "", "type": "query", "description": "Api version" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get All Client Metrics For A Given Load Test Run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/testruns/:testRunId/clientMetrics", "params": [ { "name": "testRunId", "value": "", "type": "path", "description": "Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$" }, { "name": "filter", "value": "", "type": "query", "description": "Filter to be used in metrics queries, filters can be applied on following fields : request, error, percentile( possible values : 90, 99, 95) or time (can be between start and end time). Request and error filter values can be get from /clientMetricsFilter API. Example of filter : (request eq 'HTTP Request1' or request eq 'total-4bec6d5b-c3c3-4f5f-be09-5c4abb28aedd') and (error eq 'Non HTTP response code: org.apache.http.conn.ConnectTimeoutException' or error eq 'total-4bec6d5b-c3c3-4f5f-be09-5c4abb28aedd') and (percentile eq 90) and (time ge 1626346535054 and time le 1626346924744)" }, { "name": "groupByInterval", "value": "", "type": "query", "description": "Group by time interval, in which interval metrics needs to be retrieved, values can be 10s,20s,30s,1m,2m,5m,1h" }, { "name": "api-version", "value": "", "type": "query", "description": "Api version" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get All Client Metrics Supported Filters List For A Given Load Test Run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/testruns/:testRunId/clientMetricsFilters", "params": [ { "name": "testRunId", "value": "", "type": "path", "description": "Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$" }, { "name": "api-version", "value": "", "type": "query", "description": "Api version" } ] }, "docs": "Needs a more full description created." } ] } ], "bundled": true }