@azure-rest/load-testing 1.0.1 → 1.1.0-alpha.20250324.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +4 -4
- package/README.md +91 -107
- package/dist/browser/azureLoadTesting.d.ts +10 -4
- package/dist/browser/azureLoadTesting.d.ts.map +1 -1
- package/dist/browser/azureLoadTesting.js +28 -11
- package/dist/browser/azureLoadTesting.js.map +1 -1
- package/dist/browser/clientDefinitions.d.ts +164 -84
- package/dist/browser/clientDefinitions.d.ts.map +1 -1
- package/dist/browser/clientDefinitions.js.map +1 -1
- package/dist/browser/getFileValidationPoller.d.ts +2 -2
- package/dist/browser/getFileValidationPoller.d.ts.map +1 -1
- package/dist/browser/getFileValidationPoller.js.map +1 -1
- package/dist/browser/getTestProfileRunCompletionPoller.d.ts +11 -0
- package/dist/browser/getTestProfileRunCompletionPoller.d.ts.map +1 -0
- package/dist/browser/getTestProfileRunCompletionPoller.js +127 -0
- package/dist/browser/getTestProfileRunCompletionPoller.js.map +1 -0
- package/dist/browser/getTestRunCompletionPoller.d.ts +2 -2
- package/dist/browser/getTestRunCompletionPoller.d.ts.map +1 -1
- package/dist/browser/getTestRunCompletionPoller.js.map +1 -1
- package/dist/browser/index.d.ts.map +1 -1
- package/dist/browser/index.js.map +1 -1
- package/dist/browser/isUnexpected.d.ts +44 -27
- package/dist/browser/isUnexpected.d.ts.map +1 -1
- package/dist/browser/isUnexpected.js +52 -32
- package/dist/browser/isUnexpected.js.map +1 -1
- package/dist/browser/logger.d.ts +2 -0
- package/dist/browser/logger.d.ts.map +1 -0
- package/dist/browser/logger.js +5 -0
- package/dist/browser/logger.js.map +1 -0
- package/dist/browser/models.d.ts +545 -220
- package/dist/browser/models.d.ts.map +1 -1
- package/dist/browser/models.js.map +1 -1
- package/dist/browser/outputModels.d.ts +844 -207
- package/dist/browser/outputModels.d.ts.map +1 -1
- package/dist/browser/outputModels.js.map +1 -1
- package/dist/browser/paginateHelper.d.ts +27 -2
- package/dist/browser/paginateHelper.d.ts.map +1 -1
- package/dist/browser/paginateHelper.js +98 -1
- package/dist/browser/paginateHelper.js.map +1 -1
- package/dist/browser/parameters.d.ts +327 -123
- package/dist/browser/parameters.d.ts.map +1 -1
- package/dist/browser/parameters.js.map +1 -1
- package/dist/browser/pollingHelper.d.ts +2 -1
- package/dist/browser/pollingHelper.d.ts.map +1 -1
- package/dist/browser/pollingHelper.js +7 -0
- package/dist/browser/pollingHelper.js.map +1 -1
- package/dist/browser/responses.d.ts +464 -239
- package/dist/browser/responses.d.ts.map +1 -1
- package/dist/browser/responses.js.map +1 -1
- package/dist/browser/util/LROUtil.d.ts +2 -1
- package/dist/browser/util/LROUtil.d.ts.map +1 -1
- package/dist/browser/util/LROUtil.js +13 -0
- package/dist/browser/util/LROUtil.js.map +1 -1
- package/dist/commonjs/azureLoadTesting.d.ts +10 -4
- package/dist/commonjs/azureLoadTesting.d.ts.map +1 -1
- package/dist/commonjs/azureLoadTesting.js +28 -11
- package/dist/commonjs/azureLoadTesting.js.map +1 -1
- package/dist/commonjs/clientDefinitions.d.ts +164 -84
- package/dist/commonjs/clientDefinitions.d.ts.map +1 -1
- package/dist/commonjs/clientDefinitions.js.map +1 -1
- package/dist/commonjs/getFileValidationPoller.d.ts +2 -2
- package/dist/commonjs/getFileValidationPoller.d.ts.map +1 -1
- package/dist/commonjs/getFileValidationPoller.js.map +1 -1
- package/dist/commonjs/getTestProfileRunCompletionPoller.d.ts +11 -0
- package/dist/commonjs/getTestProfileRunCompletionPoller.d.ts.map +1 -0
- package/dist/commonjs/getTestProfileRunCompletionPoller.js +130 -0
- package/dist/commonjs/getTestProfileRunCompletionPoller.js.map +1 -0
- package/dist/commonjs/getTestRunCompletionPoller.d.ts +2 -2
- package/dist/commonjs/getTestRunCompletionPoller.d.ts.map +1 -1
- package/dist/commonjs/getTestRunCompletionPoller.js.map +1 -1
- package/dist/commonjs/index.d.ts.map +1 -1
- package/dist/commonjs/index.js.map +1 -1
- package/dist/commonjs/isUnexpected.d.ts +44 -27
- package/dist/commonjs/isUnexpected.d.ts.map +1 -1
- package/dist/commonjs/isUnexpected.js +52 -32
- package/dist/commonjs/isUnexpected.js.map +1 -1
- package/dist/commonjs/logger.d.ts +2 -0
- package/dist/commonjs/logger.d.ts.map +1 -0
- package/dist/commonjs/logger.js +8 -0
- package/dist/commonjs/logger.js.map +1 -0
- package/dist/commonjs/models.d.ts +545 -220
- package/dist/commonjs/models.d.ts.map +1 -1
- package/dist/commonjs/models.js.map +1 -1
- package/dist/commonjs/outputModels.d.ts +844 -207
- package/dist/commonjs/outputModels.d.ts.map +1 -1
- package/dist/commonjs/outputModels.js.map +1 -1
- package/dist/commonjs/paginateHelper.d.ts +27 -2
- package/dist/commonjs/paginateHelper.d.ts.map +1 -1
- package/dist/commonjs/paginateHelper.js +99 -2
- package/dist/commonjs/paginateHelper.js.map +1 -1
- package/dist/commonjs/parameters.d.ts +327 -123
- package/dist/commonjs/parameters.d.ts.map +1 -1
- package/dist/commonjs/parameters.js.map +1 -1
- package/dist/commonjs/pollingHelper.d.ts +2 -1
- package/dist/commonjs/pollingHelper.d.ts.map +1 -1
- package/dist/commonjs/pollingHelper.js +7 -0
- package/dist/commonjs/pollingHelper.js.map +1 -1
- package/dist/commonjs/responses.d.ts +464 -239
- package/dist/commonjs/responses.d.ts.map +1 -1
- package/dist/commonjs/responses.js.map +1 -1
- package/dist/commonjs/tsdoc-metadata.json +1 -1
- package/dist/commonjs/util/LROUtil.d.ts +2 -1
- package/dist/commonjs/util/LROUtil.d.ts.map +1 -1
- package/dist/commonjs/util/LROUtil.js +14 -0
- package/dist/commonjs/util/LROUtil.js.map +1 -1
- package/dist/esm/azureLoadTesting.d.ts +10 -4
- package/dist/esm/azureLoadTesting.d.ts.map +1 -1
- package/dist/esm/azureLoadTesting.js +28 -11
- package/dist/esm/azureLoadTesting.js.map +1 -1
- package/dist/esm/clientDefinitions.d.ts +164 -84
- package/dist/esm/clientDefinitions.d.ts.map +1 -1
- package/dist/esm/clientDefinitions.js.map +1 -1
- package/dist/esm/getFileValidationPoller.d.ts +2 -2
- package/dist/esm/getFileValidationPoller.d.ts.map +1 -1
- package/dist/esm/getFileValidationPoller.js.map +1 -1
- package/dist/esm/getTestProfileRunCompletionPoller.d.ts +11 -0
- package/dist/esm/getTestProfileRunCompletionPoller.d.ts.map +1 -0
- package/dist/esm/getTestProfileRunCompletionPoller.js +127 -0
- package/dist/esm/getTestProfileRunCompletionPoller.js.map +1 -0
- package/dist/esm/getTestRunCompletionPoller.d.ts +2 -2
- package/dist/esm/getTestRunCompletionPoller.d.ts.map +1 -1
- package/dist/esm/getTestRunCompletionPoller.js.map +1 -1
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/isUnexpected.d.ts +44 -27
- package/dist/esm/isUnexpected.d.ts.map +1 -1
- package/dist/esm/isUnexpected.js +52 -32
- package/dist/esm/isUnexpected.js.map +1 -1
- package/dist/esm/logger.d.ts +2 -0
- package/dist/esm/logger.d.ts.map +1 -0
- package/dist/esm/logger.js +5 -0
- package/dist/esm/logger.js.map +1 -0
- package/dist/esm/models.d.ts +545 -220
- package/dist/esm/models.d.ts.map +1 -1
- package/dist/esm/models.js.map +1 -1
- package/dist/esm/outputModels.d.ts +844 -207
- package/dist/esm/outputModels.d.ts.map +1 -1
- package/dist/esm/outputModels.js.map +1 -1
- package/dist/esm/paginateHelper.d.ts +27 -2
- package/dist/esm/paginateHelper.d.ts.map +1 -1
- package/dist/esm/paginateHelper.js +98 -1
- package/dist/esm/paginateHelper.js.map +1 -1
- package/dist/esm/parameters.d.ts +327 -123
- package/dist/esm/parameters.d.ts.map +1 -1
- package/dist/esm/parameters.js.map +1 -1
- package/dist/esm/pollingHelper.d.ts +2 -1
- package/dist/esm/pollingHelper.d.ts.map +1 -1
- package/dist/esm/pollingHelper.js +7 -0
- package/dist/esm/pollingHelper.js.map +1 -1
- package/dist/esm/responses.d.ts +464 -239
- package/dist/esm/responses.d.ts.map +1 -1
- package/dist/esm/responses.js.map +1 -1
- package/dist/esm/util/LROUtil.d.ts +2 -1
- package/dist/esm/util/LROUtil.d.ts.map +1 -1
- package/dist/esm/util/LROUtil.js +13 -0
- package/dist/esm/util/LROUtil.js.map +1 -1
- package/dist/react-native/azureLoadTesting.d.ts +10 -4
- package/dist/react-native/azureLoadTesting.d.ts.map +1 -1
- package/dist/react-native/azureLoadTesting.js +28 -11
- package/dist/react-native/azureLoadTesting.js.map +1 -1
- package/dist/react-native/clientDefinitions.d.ts +164 -84
- package/dist/react-native/clientDefinitions.d.ts.map +1 -1
- package/dist/react-native/clientDefinitions.js.map +1 -1
- package/dist/react-native/getFileValidationPoller.d.ts +2 -2
- package/dist/react-native/getFileValidationPoller.d.ts.map +1 -1
- package/dist/react-native/getFileValidationPoller.js.map +1 -1
- package/dist/react-native/getTestProfileRunCompletionPoller.d.ts +11 -0
- package/dist/react-native/getTestProfileRunCompletionPoller.d.ts.map +1 -0
- package/dist/react-native/getTestProfileRunCompletionPoller.js +127 -0
- package/dist/react-native/getTestProfileRunCompletionPoller.js.map +1 -0
- package/dist/react-native/getTestRunCompletionPoller.d.ts +2 -2
- package/dist/react-native/getTestRunCompletionPoller.d.ts.map +1 -1
- package/dist/react-native/getTestRunCompletionPoller.js.map +1 -1
- package/dist/react-native/index.d.ts.map +1 -1
- package/dist/react-native/index.js.map +1 -1
- package/dist/react-native/isUnexpected.d.ts +44 -27
- package/dist/react-native/isUnexpected.d.ts.map +1 -1
- package/dist/react-native/isUnexpected.js +52 -32
- package/dist/react-native/isUnexpected.js.map +1 -1
- package/dist/react-native/logger.d.ts +2 -0
- package/dist/react-native/logger.d.ts.map +1 -0
- package/dist/react-native/logger.js +5 -0
- package/dist/react-native/logger.js.map +1 -0
- package/dist/react-native/models.d.ts +545 -220
- package/dist/react-native/models.d.ts.map +1 -1
- package/dist/react-native/models.js.map +1 -1
- package/dist/react-native/outputModels.d.ts +844 -207
- package/dist/react-native/outputModels.d.ts.map +1 -1
- package/dist/react-native/outputModels.js.map +1 -1
- package/dist/react-native/paginateHelper.d.ts +27 -2
- package/dist/react-native/paginateHelper.d.ts.map +1 -1
- package/dist/react-native/paginateHelper.js +98 -1
- package/dist/react-native/paginateHelper.js.map +1 -1
- package/dist/react-native/parameters.d.ts +327 -123
- package/dist/react-native/parameters.d.ts.map +1 -1
- package/dist/react-native/parameters.js.map +1 -1
- package/dist/react-native/pollingHelper.d.ts +2 -1
- package/dist/react-native/pollingHelper.d.ts.map +1 -1
- package/dist/react-native/pollingHelper.js +7 -0
- package/dist/react-native/pollingHelper.js.map +1 -1
- package/dist/react-native/responses.d.ts +464 -239
- package/dist/react-native/responses.d.ts.map +1 -1
- package/dist/react-native/responses.js.map +1 -1
- package/dist/react-native/util/LROUtil.d.ts +2 -1
- package/dist/react-native/util/LROUtil.d.ts.map +1 -1
- package/dist/react-native/util/LROUtil.js +13 -0
- package/dist/react-native/util/LROUtil.js.map +1 -1
- package/package.json +23 -21
|
@@ -1,209 +1,344 @@
|
|
|
1
|
-
/** Load test model */
|
|
1
|
+
/** Load test model. */
|
|
2
2
|
export interface TestOutput {
|
|
3
3
|
/** Pass fail criteria for a test. */
|
|
4
4
|
passFailCriteria?: PassFailCriteriaOutput;
|
|
5
|
-
/**
|
|
5
|
+
/** Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. */
|
|
6
|
+
autoStopCriteria?: AutoStopCriteriaOutput;
|
|
7
|
+
/**
|
|
8
|
+
* Secrets can be stored in an Azure Key Vault or any other secret store. If the
|
|
9
|
+
* secret is stored in an Azure Key Vault, the value should be the secret
|
|
10
|
+
* identifier and the type should be AKV_SECRET_URI. If the secret is stored
|
|
11
|
+
* elsewhere, the secret value should be provided directly and the type should be
|
|
12
|
+
* SECRET_VALUE.
|
|
13
|
+
*/
|
|
6
14
|
secrets?: Record<string, SecretOutput>;
|
|
7
|
-
/** Certificates metadata */
|
|
15
|
+
/** Certificates metadata. */
|
|
8
16
|
certificate?: CertificateMetadataOutput;
|
|
9
17
|
/** Environment variables which are defined as a set of <name,value> pairs. */
|
|
10
18
|
environmentVariables?: Record<string, string>;
|
|
11
19
|
/** The load test configuration. */
|
|
12
20
|
loadTestConfiguration?: LoadTestConfigurationOutput;
|
|
21
|
+
/** Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs */
|
|
22
|
+
baselineTestRunId?: string;
|
|
13
23
|
/** The input artifacts for the test. */
|
|
14
|
-
inputArtifacts?: TestInputArtifactsOutput;
|
|
15
|
-
/** Unique test
|
|
16
|
-
testId
|
|
24
|
+
readonly inputArtifacts?: TestInputArtifactsOutput;
|
|
25
|
+
/** Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. */
|
|
26
|
+
readonly testId: string;
|
|
17
27
|
/** The test description. */
|
|
18
28
|
description?: string;
|
|
19
29
|
/** Display name of a test. */
|
|
20
30
|
displayName?: string;
|
|
21
31
|
/** Subnet ID on which the load test instances should run. */
|
|
22
32
|
subnetId?: string;
|
|
33
|
+
/**
|
|
34
|
+
* Kind of test.
|
|
35
|
+
*
|
|
36
|
+
* Possible values: "URL", "JMX", "Locust"
|
|
37
|
+
*/
|
|
38
|
+
kind?: TestKindOutput;
|
|
39
|
+
/** Inject load test engines without deploying public IP for outbound access */
|
|
40
|
+
publicIPDisabled?: boolean;
|
|
23
41
|
/** Type of the managed identity referencing the Key vault. */
|
|
24
42
|
keyvaultReferenceIdentityType?: string;
|
|
25
43
|
/** Resource Id of the managed identity referencing the Key vault. */
|
|
26
44
|
keyvaultReferenceIdentityId?: string;
|
|
27
|
-
/**
|
|
28
|
-
|
|
45
|
+
/**
|
|
46
|
+
* Type of the managed identity referencing the metrics.
|
|
47
|
+
*
|
|
48
|
+
* Possible values: "SystemAssigned", "UserAssigned"
|
|
49
|
+
*/
|
|
50
|
+
metricsReferenceIdentityType?: ManagedIdentityTypeOutput;
|
|
51
|
+
/** Resource Id of the managed identity referencing the metrics. */
|
|
52
|
+
metricsReferenceIdentityId?: string;
|
|
53
|
+
/**
|
|
54
|
+
* Type of the managed identity built in load test engines
|
|
55
|
+
*
|
|
56
|
+
* Possible values: "SystemAssigned", "UserAssigned"
|
|
57
|
+
*/
|
|
58
|
+
engineBuiltInIdentityType?: ManagedIdentityTypeOutput;
|
|
59
|
+
/** Resource Ids of the managed identity built in to load test engines. Required if engineBuiltInIdentityType is UserAssigned. */
|
|
60
|
+
engineBuiltInIdentityIds?: string[];
|
|
61
|
+
/** The creation datetime(RFC 3339 literal format). */
|
|
62
|
+
readonly createdDateTime?: string;
|
|
29
63
|
/** The user that created. */
|
|
30
|
-
createdBy?: string;
|
|
31
|
-
/** The last Modified datetime(
|
|
32
|
-
lastModifiedDateTime?: string;
|
|
64
|
+
readonly createdBy?: string;
|
|
65
|
+
/** The last Modified datetime(RFC 3339 literal format). */
|
|
66
|
+
readonly lastModifiedDateTime?: string;
|
|
33
67
|
/** The user that last modified. */
|
|
34
|
-
lastModifiedBy?: string;
|
|
68
|
+
readonly lastModifiedBy?: string;
|
|
35
69
|
}
|
|
36
70
|
/** Pass fail criteria for a test. */
|
|
37
71
|
export interface PassFailCriteriaOutput {
|
|
38
72
|
/** Map of id and pass fail metrics { id : pass fail metrics }. */
|
|
39
73
|
passFailMetrics?: Record<string, PassFailMetricOutput>;
|
|
74
|
+
/** Map of id and pass fail server metrics { id : pass fail metrics }. */
|
|
75
|
+
passFailServerMetrics?: Record<string, PassFailServerMetricOutput>;
|
|
40
76
|
}
|
|
41
77
|
/** Pass fail metric */
|
|
42
78
|
export interface PassFailMetricOutput {
|
|
43
|
-
/**
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
79
|
+
/**
|
|
80
|
+
* The client metric on which the criteria should be applied.
|
|
81
|
+
*
|
|
82
|
+
* Possible values: "response_time_ms", "latency", "error", "requests", "requests_per_sec"
|
|
83
|
+
*/
|
|
84
|
+
clientMetric?: PFMetricsOutput;
|
|
85
|
+
/**
|
|
86
|
+
* The aggregation function to be applied on the client metric. Allowed functions
|
|
87
|
+
* - ‘percentage’ - for error metric , ‘avg’, percentiles like ‘p50’, ‘p90’, & so on, ‘min’,
|
|
88
|
+
* ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec,
|
|
89
|
+
* ‘count’ - for requests
|
|
90
|
+
*
|
|
91
|
+
* Possible values: "count", "percentage", "avg", "p50", "p75", "p90", "p95", "p96", "p97", "p98", "p99", "p99.9", "p99.99", "min", "max"
|
|
92
|
+
*/
|
|
93
|
+
aggregate?: PassFailAggregationFunctionOutput;
|
|
47
94
|
/** The comparison operator. Supported types ‘>’, ‘<’ */
|
|
48
95
|
condition?: string;
|
|
49
96
|
/** Request name for which the Pass fail criteria has to be applied */
|
|
50
97
|
requestName?: string;
|
|
51
|
-
/**
|
|
98
|
+
/**
|
|
99
|
+
* The value to compare with the client metric. Allowed values - ‘error : [0.0 ,
|
|
100
|
+
* 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms.
|
|
101
|
+
*/
|
|
52
102
|
value?: number;
|
|
53
|
-
/**
|
|
54
|
-
|
|
103
|
+
/**
|
|
104
|
+
* Action taken after the threshold is met. Default is ‘continue’.
|
|
105
|
+
*
|
|
106
|
+
* Possible values: "continue", "stop"
|
|
107
|
+
*/
|
|
108
|
+
action?: PassFailActionOutput;
|
|
55
109
|
/** The actual value of the client metric for the test run. */
|
|
56
|
-
actualValue?: number;
|
|
57
|
-
/**
|
|
58
|
-
|
|
110
|
+
readonly actualValue?: number;
|
|
111
|
+
/**
|
|
112
|
+
* Outcome of the test run.
|
|
113
|
+
*
|
|
114
|
+
* Possible values: "passed", "undetermined", "failed"
|
|
115
|
+
*/
|
|
116
|
+
readonly result?: PassFailResultOutput;
|
|
117
|
+
}
|
|
118
|
+
/** Pass fail server metric */
|
|
119
|
+
export interface PassFailServerMetricOutput {
|
|
120
|
+
/** The resource id of the resource emitting the metric. */
|
|
121
|
+
resourceId: string;
|
|
122
|
+
/** The server metric namespace. */
|
|
123
|
+
metricNamespace: string;
|
|
124
|
+
/** The server metric name. */
|
|
125
|
+
metricName: string;
|
|
126
|
+
/** Aggregation Type */
|
|
127
|
+
aggregation: string;
|
|
128
|
+
/** The comparison operator. Supported types ‘>’, ‘<’ */
|
|
129
|
+
condition: string;
|
|
130
|
+
/** The value to compare with the server metric. */
|
|
131
|
+
value: number;
|
|
132
|
+
/**
|
|
133
|
+
* Action taken after the threshold is met. Default is ‘continue’.
|
|
134
|
+
*
|
|
135
|
+
* Possible values: "continue", "stop"
|
|
136
|
+
*/
|
|
137
|
+
action?: PassFailActionOutput;
|
|
138
|
+
/** The actual value of the server metric */
|
|
139
|
+
readonly actualValue?: number;
|
|
140
|
+
/**
|
|
141
|
+
* Outcome of the test run.
|
|
142
|
+
*
|
|
143
|
+
* Possible values: "passed", "undetermined", "failed"
|
|
144
|
+
*/
|
|
145
|
+
readonly result?: PassFailResultOutput;
|
|
146
|
+
}
|
|
147
|
+
/** Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. */
|
|
148
|
+
export interface AutoStopCriteriaOutput {
|
|
149
|
+
/** Whether auto-stop should be disabled. The default value is false. */
|
|
150
|
+
autoStopDisabled?: boolean;
|
|
151
|
+
/** Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 */
|
|
152
|
+
errorRate?: number;
|
|
153
|
+
/** Time window during which the error percentage should be evaluated in seconds. */
|
|
154
|
+
errorRateTimeWindowInSeconds?: number;
|
|
59
155
|
}
|
|
60
156
|
/** Secret */
|
|
61
157
|
export interface SecretOutput {
|
|
62
158
|
/** The value of the secret for the respective type */
|
|
63
159
|
value?: string;
|
|
64
|
-
/**
|
|
65
|
-
|
|
160
|
+
/**
|
|
161
|
+
* Type of secret
|
|
162
|
+
*
|
|
163
|
+
* Possible values: "AKV_SECRET_URI", "SECRET_VALUE"
|
|
164
|
+
*/
|
|
165
|
+
type?: SecretTypeOutput;
|
|
66
166
|
}
|
|
67
167
|
/** Certificates metadata */
|
|
68
168
|
export interface CertificateMetadataOutput {
|
|
69
169
|
/** The value of the certificate for respective type */
|
|
70
170
|
value?: string;
|
|
71
|
-
/**
|
|
72
|
-
|
|
171
|
+
/**
|
|
172
|
+
* Type of certificate
|
|
173
|
+
*
|
|
174
|
+
* Possible values: "AKV_CERT_URI"
|
|
175
|
+
*/
|
|
176
|
+
type?: CertificateTypeOutput;
|
|
73
177
|
/** Name of the certificate. */
|
|
74
178
|
name?: string;
|
|
75
179
|
}
|
|
76
|
-
/**
|
|
180
|
+
/** Configurations for the load test. */
|
|
77
181
|
export interface LoadTestConfigurationOutput {
|
|
78
|
-
/** The number of engine instances to execute load test. Supported values are in range of 1-
|
|
182
|
+
/** The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. */
|
|
79
183
|
engineInstances?: number;
|
|
80
|
-
/**
|
|
184
|
+
/**
|
|
185
|
+
* If false, Azure Load Testing copies and processes your input files unmodified
|
|
186
|
+
* across all test engine instances. If true, Azure Load Testing splits the CSV
|
|
187
|
+
* input data evenly across all engine instances. If you provide multiple CSV
|
|
188
|
+
* files, each file will be split evenly.
|
|
189
|
+
*/
|
|
81
190
|
splitAllCSVs?: boolean;
|
|
82
|
-
/**
|
|
191
|
+
/**
|
|
192
|
+
* If true, optionalLoadTestConfig is required and JMX script for the load test is
|
|
193
|
+
* not required to upload.
|
|
194
|
+
*/
|
|
83
195
|
quickStartTest?: boolean;
|
|
84
|
-
/**
|
|
85
|
-
optionalLoadTestConfig?:
|
|
196
|
+
/** Configuration for quick load test */
|
|
197
|
+
optionalLoadTestConfig?: OptionalLoadTestConfigurationOutput;
|
|
198
|
+
/** Region distribution configuration for the load test. */
|
|
199
|
+
regionalLoadTestConfig?: Array<RegionalConfigurationOutput>;
|
|
86
200
|
}
|
|
87
|
-
/**
|
|
88
|
-
export interface
|
|
89
|
-
/** Test URL. Provide the complete HTTP URL. For example,
|
|
201
|
+
/** Configuration for quick load test */
|
|
202
|
+
export interface OptionalLoadTestConfigurationOutput {
|
|
203
|
+
/** Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login */
|
|
90
204
|
endpointUrl?: string;
|
|
91
|
-
/**
|
|
205
|
+
/** Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. */
|
|
206
|
+
requestsPerSecond?: number;
|
|
207
|
+
/** Maximum response time in milliseconds of the API/endpoint. */
|
|
208
|
+
maxResponseTimeInMs?: number;
|
|
209
|
+
/** No of concurrent virtual users. */
|
|
92
210
|
virtualUsers?: number;
|
|
93
|
-
/** Ramp up time */
|
|
211
|
+
/** Ramp up time in seconds. */
|
|
94
212
|
rampUpTime?: number;
|
|
95
|
-
/** Test run duration */
|
|
213
|
+
/** Test run duration in seconds. */
|
|
96
214
|
duration?: number;
|
|
97
215
|
}
|
|
216
|
+
/** Region distribution configuration for the load test. */
|
|
217
|
+
export interface RegionalConfigurationOutput {
|
|
218
|
+
/** The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. */
|
|
219
|
+
engineInstances: number;
|
|
220
|
+
/**
|
|
221
|
+
* Azure region name.
|
|
222
|
+
* The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus".
|
|
223
|
+
* The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command.
|
|
224
|
+
*/
|
|
225
|
+
region: string;
|
|
226
|
+
}
|
|
98
227
|
/** The input artifacts for the test. */
|
|
99
228
|
export interface TestInputArtifactsOutput {
|
|
100
|
-
/**
|
|
101
|
-
configFileInfo?:
|
|
102
|
-
/**
|
|
103
|
-
testScriptFileInfo?:
|
|
104
|
-
/**
|
|
105
|
-
userPropFileInfo?:
|
|
106
|
-
/**
|
|
107
|
-
inputArtifactsZipFileInfo?:
|
|
229
|
+
/** The load test YAML file that contains the the test configuration */
|
|
230
|
+
configFileInfo?: TestFileInfoOutput;
|
|
231
|
+
/** The test script file for the test run */
|
|
232
|
+
testScriptFileInfo?: TestFileInfoOutput;
|
|
233
|
+
/** The user properties file */
|
|
234
|
+
userPropFileInfo?: TestFileInfoOutput;
|
|
235
|
+
/** The zip file with all input artifacts */
|
|
236
|
+
inputArtifactsZipFileInfo?: TestFileInfoOutput;
|
|
237
|
+
/** The config json file for url based test */
|
|
238
|
+
urlTestConfigFileInfo?: TestFileInfoOutput;
|
|
108
239
|
/** Additional supported files for the test run */
|
|
109
|
-
additionalFileInfo?: Array<
|
|
240
|
+
readonly additionalFileInfo?: Array<TestFileInfoOutput>;
|
|
110
241
|
}
|
|
111
|
-
/**
|
|
112
|
-
export interface
|
|
113
|
-
/** File URL. */
|
|
114
|
-
url?: string;
|
|
242
|
+
/** Test file info. */
|
|
243
|
+
export interface TestFileInfoOutput {
|
|
115
244
|
/** Name of the file. */
|
|
116
|
-
fileName
|
|
117
|
-
/** File
|
|
118
|
-
|
|
119
|
-
/**
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
245
|
+
fileName: string;
|
|
246
|
+
/** File URL. */
|
|
247
|
+
readonly url?: string;
|
|
248
|
+
/**
|
|
249
|
+
* File type
|
|
250
|
+
*
|
|
251
|
+
* Possible values: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", "URL_TEST_CONFIG", "TEST_SCRIPT"
|
|
252
|
+
*/
|
|
253
|
+
readonly fileType?: FileTypeOutput;
|
|
254
|
+
/** Expiry time of the file (RFC 3339 literal format) */
|
|
255
|
+
readonly expireDateTime?: string;
|
|
256
|
+
/**
|
|
257
|
+
* Validation status of the file
|
|
258
|
+
*
|
|
259
|
+
* Possible values: "NOT_VALIDATED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", "VALIDATION_NOT_REQUIRED"
|
|
260
|
+
*/
|
|
261
|
+
readonly validationStatus?: FileValidationStatusOutput;
|
|
123
262
|
/** Validation failure error details */
|
|
124
|
-
validationFailureDetails?: string;
|
|
125
|
-
}
|
|
126
|
-
/**
|
|
127
|
-
export interface
|
|
128
|
-
/**
|
|
129
|
-
error: ErrorModelOutput;
|
|
130
|
-
}
|
|
131
|
-
/** Error from a REST request. */
|
|
132
|
-
export interface ErrorModelOutput {
|
|
133
|
-
/** The error code. */
|
|
134
|
-
code: string;
|
|
135
|
-
/** The error message. */
|
|
136
|
-
message: string;
|
|
137
|
-
/** The error target. */
|
|
138
|
-
target?: string;
|
|
139
|
-
/** Additional details and inner errors. */
|
|
140
|
-
details?: Array<ErrorModelOutput>;
|
|
141
|
-
}
|
|
142
|
-
/** Collection of tests */
|
|
143
|
-
export interface TestsListOutput {
|
|
144
|
-
/** List of tests */
|
|
263
|
+
readonly validationFailureDetails?: string;
|
|
264
|
+
}
|
|
265
|
+
/** Paged collection of Test items */
|
|
266
|
+
export interface PagedTestOutput {
|
|
267
|
+
/** The Test items on this page */
|
|
145
268
|
value: Array<TestOutput>;
|
|
146
|
-
/**
|
|
269
|
+
/** The link to the next page of items */
|
|
147
270
|
nextLink?: string;
|
|
148
271
|
}
|
|
149
|
-
/**
|
|
150
|
-
export interface
|
|
151
|
-
/**
|
|
152
|
-
value: Array<
|
|
153
|
-
/**
|
|
272
|
+
/** Paged collection of TestFileInfo items */
|
|
273
|
+
export interface PagedTestFileInfoOutput {
|
|
274
|
+
/** The TestFileInfo items on this page */
|
|
275
|
+
value: Array<TestFileInfoOutput>;
|
|
276
|
+
/** The link to the next page of items */
|
|
154
277
|
nextLink?: string;
|
|
155
278
|
}
|
|
156
|
-
/** Test app
|
|
279
|
+
/** Test app components */
|
|
157
280
|
export interface TestAppComponentsOutput {
|
|
158
|
-
/**
|
|
281
|
+
/**
|
|
282
|
+
* Azure resource collection { resource id (fully qualified resource Id e.g
|
|
283
|
+
* subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})
|
|
284
|
+
* : resource object }
|
|
285
|
+
*/
|
|
159
286
|
components: Record<string, AppComponentOutput>;
|
|
160
287
|
/** Test identifier */
|
|
161
|
-
testId?: string;
|
|
162
|
-
/** The creation datetime(
|
|
163
|
-
createdDateTime?: string;
|
|
288
|
+
readonly testId?: string;
|
|
289
|
+
/** The creation datetime(RFC 3339 literal format). */
|
|
290
|
+
readonly createdDateTime?: string;
|
|
164
291
|
/** The user that created. */
|
|
165
|
-
createdBy?: string;
|
|
166
|
-
/** The last Modified datetime(
|
|
167
|
-
lastModifiedDateTime?: string;
|
|
292
|
+
readonly createdBy?: string;
|
|
293
|
+
/** The last Modified datetime(RFC 3339 literal format). */
|
|
294
|
+
readonly lastModifiedDateTime?: string;
|
|
168
295
|
/** The user that last modified. */
|
|
169
|
-
lastModifiedBy?: string;
|
|
296
|
+
readonly lastModifiedBy?: string;
|
|
170
297
|
}
|
|
171
|
-
/** An Azure resource object (Refer azure generic resource model :
|
|
298
|
+
/** An Azure resource object (Refer azure generic resource model :https://learn.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource) */
|
|
172
299
|
export interface AppComponentOutput {
|
|
173
300
|
/** fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName} */
|
|
174
|
-
resourceId
|
|
301
|
+
readonly resourceId: string;
|
|
175
302
|
/** Azure resource name, required while creating the app component. */
|
|
176
|
-
resourceName
|
|
303
|
+
resourceName: string;
|
|
177
304
|
/** Azure resource type, required while creating the app component. */
|
|
178
|
-
resourceType
|
|
305
|
+
resourceType: string;
|
|
179
306
|
/** Azure resource display name */
|
|
180
307
|
displayName?: string;
|
|
181
308
|
/** Resource group name of the Azure resource */
|
|
182
|
-
resourceGroup?: string;
|
|
309
|
+
readonly resourceGroup?: string;
|
|
183
310
|
/** Subscription Id of the Azure resource */
|
|
184
|
-
subscriptionId?: string;
|
|
311
|
+
readonly subscriptionId?: string;
|
|
185
312
|
/** Kind of Azure resource type */
|
|
186
313
|
kind?: string;
|
|
187
314
|
}
|
|
188
315
|
/** Test server metrics configuration */
|
|
189
|
-
export interface
|
|
316
|
+
export interface TestServerMetricsConfigurationOutput {
|
|
190
317
|
/** Test identifier */
|
|
191
|
-
testId?: string;
|
|
192
|
-
/**
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
318
|
+
readonly testId?: string;
|
|
319
|
+
/**
|
|
320
|
+
* Azure resource metrics collection {metric id : metrics object} (Refer :
|
|
321
|
+
* https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition
|
|
322
|
+
* for metric id).
|
|
323
|
+
*/
|
|
324
|
+
metrics: Record<string, ResourceMetricOutput>;
|
|
325
|
+
/** The creation datetime(RFC 3339 literal format). */
|
|
326
|
+
readonly createdDateTime?: string;
|
|
196
327
|
/** The user that created. */
|
|
197
|
-
createdBy?: string;
|
|
198
|
-
/** The last Modified datetime(
|
|
199
|
-
lastModifiedDateTime?: string;
|
|
328
|
+
readonly createdBy?: string;
|
|
329
|
+
/** The last Modified datetime(RFC 3339 literal format). */
|
|
330
|
+
readonly lastModifiedDateTime?: string;
|
|
200
331
|
/** The user that last modified. */
|
|
201
|
-
lastModifiedBy?: string;
|
|
332
|
+
readonly lastModifiedBy?: string;
|
|
202
333
|
}
|
|
203
|
-
/**
|
|
334
|
+
/**
|
|
335
|
+
* Associated metric definition for particular metrics of the azure resource (
|
|
336
|
+
* Refer :
|
|
337
|
+
* https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).
|
|
338
|
+
*/
|
|
204
339
|
export interface ResourceMetricOutput {
|
|
205
340
|
/** Unique name for metric. */
|
|
206
|
-
id?: string;
|
|
341
|
+
readonly id?: string;
|
|
207
342
|
/** Azure resource id. */
|
|
208
343
|
resourceId: string;
|
|
209
344
|
/** Metric name space. */
|
|
@@ -219,127 +354,276 @@ export interface ResourceMetricOutput {
|
|
|
219
354
|
/** Azure resource type. */
|
|
220
355
|
resourceType: string;
|
|
221
356
|
}
|
|
357
|
+
/** The Test Profile Model. A Test Profile resource enables you to set up a test profile which contains various configurations for a supported resource type and a load test to execute on that resource. */
|
|
358
|
+
export interface TestProfileOutput {
|
|
359
|
+
/** Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. */
|
|
360
|
+
readonly testProfileId: string;
|
|
361
|
+
/** Display name of the test profile. */
|
|
362
|
+
displayName?: string;
|
|
363
|
+
/** Description for the test profile. */
|
|
364
|
+
description?: string;
|
|
365
|
+
/** Associated test ID for the test profile. This property is required for creating a Test Profile and it's not allowed to be updated. */
|
|
366
|
+
testId?: string;
|
|
367
|
+
/** Target resource ID on which the test profile is created. This property is required for creating a Test Profile and it's not allowed to be updated. */
|
|
368
|
+
targetResourceId?: string;
|
|
369
|
+
/** Configurations of the target resource on which testing would be done. */
|
|
370
|
+
targetResourceConfigurations?: TargetResourceConfigurationsOutput;
|
|
371
|
+
/** The creation datetime(RFC 3339 literal format). */
|
|
372
|
+
readonly createdDateTime?: string;
|
|
373
|
+
/** The user that created. */
|
|
374
|
+
readonly createdBy?: string;
|
|
375
|
+
/** The last Modified datetime(RFC 3339 literal format). */
|
|
376
|
+
readonly lastModifiedDateTime?: string;
|
|
377
|
+
/** The user that last modified. */
|
|
378
|
+
readonly lastModifiedBy?: string;
|
|
379
|
+
}
|
|
380
|
+
/** Configurations of a target resource. This varies with the kind of resource. */
|
|
381
|
+
export interface TargetResourceConfigurationsOutputParent {
|
|
382
|
+
kind: ResourceKindOutput;
|
|
383
|
+
}
|
|
384
|
+
/** Configurations for a Function App using Flex Consumption Plan. */
|
|
385
|
+
export interface FunctionFlexConsumptionTargetResourceConfigurationsOutput extends TargetResourceConfigurationsOutputParent {
|
|
386
|
+
/**
|
|
387
|
+
* The kind value to use when providing configuration.
|
|
388
|
+
* This should typically be not changed from its value.
|
|
389
|
+
*/
|
|
390
|
+
kind: "FunctionsFlexConsumption";
|
|
391
|
+
/** A map of configurations for a Function app using Flex Consumption Plan. */
|
|
392
|
+
configurations?: Record<string, FunctionFlexConsumptionResourceConfigurationOutput>;
|
|
393
|
+
}
|
|
394
|
+
/** Resource configuration instance for a Flex Consumption based Azure Function App. */
|
|
395
|
+
export interface FunctionFlexConsumptionResourceConfigurationOutput {
|
|
396
|
+
/** Memory size of the instance. Supported values are 2048, 4096. */
|
|
397
|
+
instanceMemoryMB: number;
|
|
398
|
+
/** HTTP Concurrency for the function app. */
|
|
399
|
+
httpConcurrency?: number;
|
|
400
|
+
}
|
|
401
|
+
/** Paged collection of TestProfile items */
|
|
402
|
+
export interface PagedTestProfileOutput {
|
|
403
|
+
/** The TestProfile items on this page */
|
|
404
|
+
value: Array<TestProfileOutput>;
|
|
405
|
+
/** The link to the next page of items */
|
|
406
|
+
nextLink?: string;
|
|
407
|
+
}
|
|
222
408
|
/** Load test run model */
|
|
223
409
|
export interface TestRunOutput {
|
|
410
|
+
/** Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. */
|
|
411
|
+
readonly testRunId: string;
|
|
224
412
|
/** Pass fail criteria for a test. */
|
|
225
413
|
passFailCriteria?: PassFailCriteriaOutput;
|
|
226
|
-
/**
|
|
414
|
+
/** Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. */
|
|
415
|
+
autoStopCriteria?: AutoStopCriteriaOutput;
|
|
416
|
+
/**
|
|
417
|
+
* Secrets can be stored in an Azure Key Vault or any other secret store. If the
|
|
418
|
+
* secret is stored in an Azure Key Vault, the value should be the secret
|
|
419
|
+
* identifier and the type should be AKV_SECRET_URI. If the secret is stored
|
|
420
|
+
* elsewhere, the secret value should be provided directly and the type should be
|
|
421
|
+
* SECRET_VALUE.
|
|
422
|
+
*/
|
|
227
423
|
secrets?: Record<string, SecretOutput>;
|
|
228
424
|
/** Certificates metadata */
|
|
229
425
|
certificate?: CertificateMetadataOutput;
|
|
230
426
|
/** Environment variables which are defined as a set of <name,value> pairs. */
|
|
231
427
|
environmentVariables?: Record<string, string>;
|
|
232
428
|
/** Error details if there is any failure in load test run */
|
|
233
|
-
errorDetails?: Array<ErrorDetailsOutput>;
|
|
234
|
-
/**
|
|
235
|
-
|
|
429
|
+
readonly errorDetails?: Array<ErrorDetailsOutput>;
|
|
430
|
+
/**
|
|
431
|
+
* Test run statistics. Key is the sampler name and value is the set of statistics for performance metrics like response time, throughput, etc. from the load test run.
|
|
432
|
+
* The sampler name is the same as the name mentioned in the test script.
|
|
433
|
+
* Sampler name "Total" represents the aggregated statistics of all the samplers.
|
|
434
|
+
*/
|
|
435
|
+
readonly testRunStatistics?: Record<string, TestRunStatisticsOutput>;
|
|
436
|
+
/**
|
|
437
|
+
* Regional statistics. Key is the Azure region name and value is the test run statistics.
|
|
438
|
+
* The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus".
|
|
439
|
+
* The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command.
|
|
440
|
+
*/
|
|
441
|
+
readonly regionalStatistics?: Record<string, TestRunStatisticsOutput>;
|
|
236
442
|
/** The load test configuration. */
|
|
237
|
-
loadTestConfiguration?: LoadTestConfigurationOutput;
|
|
443
|
+
readonly loadTestConfiguration?: LoadTestConfigurationOutput;
|
|
238
444
|
/** Collection of test run artifacts */
|
|
239
|
-
testArtifacts?: TestRunArtifactsOutput;
|
|
240
|
-
/**
|
|
241
|
-
|
|
445
|
+
readonly testArtifacts?: TestRunArtifactsOutput;
|
|
446
|
+
/**
|
|
447
|
+
* Test result for pass/Fail criteria used during the test run.
|
|
448
|
+
*
|
|
449
|
+
* Possible values: "PASSED", "NOT_APPLICABLE", "FAILED"
|
|
450
|
+
*/
|
|
451
|
+
readonly testResult?: PassFailTestResultOutput;
|
|
242
452
|
/** Number of virtual users, for which test has been run. */
|
|
243
|
-
virtualUsers?: number;
|
|
244
|
-
/** Unique test run name as identifier */
|
|
245
|
-
testRunId?: string;
|
|
453
|
+
readonly virtualUsers?: number;
|
|
246
454
|
/** Display name of a testRun. */
|
|
247
455
|
displayName?: string;
|
|
248
456
|
/** Associated test Id. */
|
|
249
457
|
testId?: string;
|
|
250
458
|
/** The test run description. */
|
|
251
459
|
description?: string;
|
|
252
|
-
/**
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
460
|
+
/**
|
|
461
|
+
* The test run status.
|
|
462
|
+
*
|
|
463
|
+
* Possible values: "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE"
|
|
464
|
+
*/
|
|
465
|
+
readonly status?: TestRunStatusOutput;
|
|
466
|
+
/** The test run start DateTime(RFC 3339 literal format). */
|
|
467
|
+
readonly startDateTime?: string;
|
|
468
|
+
/** The test run end DateTime(RFC 3339 literal format). */
|
|
469
|
+
readonly endDateTime?: string;
|
|
258
470
|
/** Test run initiated time. */
|
|
259
|
-
executedDateTime?: string;
|
|
471
|
+
readonly executedDateTime?: string;
|
|
260
472
|
/** Portal url. */
|
|
261
|
-
portalUrl?: string;
|
|
473
|
+
readonly portalUrl?: string;
|
|
262
474
|
/** Test run duration in milliseconds. */
|
|
263
|
-
duration?: number;
|
|
475
|
+
readonly duration?: number;
|
|
476
|
+
/** Virtual user hours consumed by the test run. */
|
|
477
|
+
readonly virtualUserHours?: number;
|
|
264
478
|
/** Subnet ID on which the load test instances should run. */
|
|
265
|
-
subnetId?: string;
|
|
266
|
-
/**
|
|
267
|
-
|
|
479
|
+
readonly subnetId?: string;
|
|
480
|
+
/**
|
|
481
|
+
* Type of test.
|
|
482
|
+
*
|
|
483
|
+
* Possible values: "URL", "JMX", "Locust"
|
|
484
|
+
*/
|
|
485
|
+
readonly kind?: TestKindOutput;
|
|
486
|
+
/**
|
|
487
|
+
* Request data collection level for test run
|
|
488
|
+
*
|
|
489
|
+
* Possible values: "NONE", "ERRORS"
|
|
490
|
+
*/
|
|
491
|
+
requestDataLevel?: RequestDataLevelOutput;
|
|
492
|
+
/** Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise */
|
|
493
|
+
debugLogsEnabled?: boolean;
|
|
494
|
+
/** Inject load test engines without deploying public IP for outbound access */
|
|
495
|
+
readonly publicIPDisabled?: boolean;
|
|
496
|
+
/**
|
|
497
|
+
* The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc).
|
|
498
|
+
*
|
|
499
|
+
* Possible values: "User", "ScheduledTrigger"
|
|
500
|
+
*/
|
|
501
|
+
createdByType?: CreatedByTypeOutput;
|
|
502
|
+
/** The creation datetime(RFC 3339 literal format). */
|
|
503
|
+
readonly createdDateTime?: string;
|
|
268
504
|
/** The user that created. */
|
|
269
|
-
createdBy?: string;
|
|
270
|
-
/** The last Modified datetime(
|
|
271
|
-
lastModifiedDateTime?: string;
|
|
505
|
+
readonly createdBy?: string;
|
|
506
|
+
/** The last Modified datetime(RFC 3339 literal format). */
|
|
507
|
+
readonly lastModifiedDateTime?: string;
|
|
272
508
|
/** The user that last modified. */
|
|
273
|
-
lastModifiedBy?: string;
|
|
509
|
+
readonly lastModifiedBy?: string;
|
|
274
510
|
}
|
|
275
511
|
/** Error details if there is any failure in load test run */
|
|
276
512
|
export interface ErrorDetailsOutput {
|
|
277
513
|
/** Error details in case test run was not successfully run. */
|
|
278
|
-
message?: string;
|
|
514
|
+
readonly message?: string;
|
|
279
515
|
}
|
|
280
516
|
/** Test run statistics. */
|
|
281
517
|
export interface TestRunStatisticsOutput {
|
|
282
518
|
/** Transaction name. */
|
|
283
|
-
transaction?: string;
|
|
519
|
+
readonly transaction?: string;
|
|
284
520
|
/** Sampler count. */
|
|
285
|
-
sampleCount?: number;
|
|
521
|
+
readonly sampleCount?: number;
|
|
286
522
|
/** Error count. */
|
|
287
|
-
errorCount?: number;
|
|
523
|
+
readonly errorCount?: number;
|
|
288
524
|
/** Error percentage. */
|
|
289
|
-
errorPct?: number;
|
|
525
|
+
readonly errorPct?: number;
|
|
290
526
|
/** Mean response time. */
|
|
291
|
-
meanResTime?: number;
|
|
527
|
+
readonly meanResTime?: number;
|
|
292
528
|
/** Median response time. */
|
|
293
|
-
medianResTime?: number;
|
|
529
|
+
readonly medianResTime?: number;
|
|
294
530
|
/** Max response time. */
|
|
295
|
-
maxResTime?: number;
|
|
531
|
+
readonly maxResTime?: number;
|
|
296
532
|
/** Minimum response time. */
|
|
297
|
-
minResTime?: number;
|
|
533
|
+
readonly minResTime?: number;
|
|
298
534
|
/** 90 percentile response time. */
|
|
299
|
-
pct1ResTime?: number;
|
|
535
|
+
readonly pct1ResTime?: number;
|
|
300
536
|
/** 95 percentile response time. */
|
|
301
|
-
pct2ResTime?: number;
|
|
537
|
+
readonly pct2ResTime?: number;
|
|
302
538
|
/** 99 percentile response time. */
|
|
303
|
-
pct3ResTime?: number;
|
|
539
|
+
readonly pct3ResTime?: number;
|
|
540
|
+
/** 75 percentile response time. */
|
|
541
|
+
readonly pct75ResTime?: number;
|
|
542
|
+
/** 96 percentile response time. */
|
|
543
|
+
readonly pct96ResTime?: number;
|
|
544
|
+
/** 97 percentile response time. */
|
|
545
|
+
readonly pct97ResTime?: number;
|
|
546
|
+
/** 98 percentile response time. */
|
|
547
|
+
readonly pct98ResTime?: number;
|
|
548
|
+
/** 99.9 percentile response time. */
|
|
549
|
+
readonly pct999ResTime?: number;
|
|
550
|
+
/** 99.99 percentile response time. */
|
|
551
|
+
readonly pct9999ResTime?: number;
|
|
304
552
|
/** Throughput. */
|
|
305
|
-
throughput?: number;
|
|
553
|
+
readonly throughput?: number;
|
|
306
554
|
/** Received network bytes. */
|
|
307
|
-
receivedKBytesPerSec?: number;
|
|
555
|
+
readonly receivedKBytesPerSec?: number;
|
|
308
556
|
/** Send network bytes. */
|
|
309
|
-
sentKBytesPerSec?: number;
|
|
557
|
+
readonly sentKBytesPerSec?: number;
|
|
310
558
|
}
|
|
311
559
|
/** Collection of test run artifacts */
|
|
312
560
|
export interface TestRunArtifactsOutput {
|
|
313
561
|
/** The input artifacts for the test run. */
|
|
314
|
-
inputArtifacts?: TestRunInputArtifactsOutput;
|
|
562
|
+
readonly inputArtifacts?: TestRunInputArtifactsOutput;
|
|
315
563
|
/** The output artifacts for the test run. */
|
|
316
564
|
outputArtifacts?: TestRunOutputArtifactsOutput;
|
|
317
565
|
}
|
|
318
566
|
/** The input artifacts for the test run. */
|
|
319
567
|
export interface TestRunInputArtifactsOutput {
|
|
320
|
-
/**
|
|
321
|
-
configFileInfo?:
|
|
322
|
-
/**
|
|
323
|
-
testScriptFileInfo?:
|
|
324
|
-
/**
|
|
325
|
-
userPropFileInfo?:
|
|
326
|
-
/**
|
|
327
|
-
inputArtifactsZipFileInfo?:
|
|
568
|
+
/** The load test YAML file that contains the the test configuration */
|
|
569
|
+
configFileInfo?: TestRunFileInfoOutput;
|
|
570
|
+
/** The test script file for the test run */
|
|
571
|
+
testScriptFileInfo?: TestRunFileInfoOutput;
|
|
572
|
+
/** The user properties file */
|
|
573
|
+
userPropFileInfo?: TestRunFileInfoOutput;
|
|
574
|
+
/** The zip file for all input artifacts */
|
|
575
|
+
inputArtifactsZipFileInfo?: TestRunFileInfoOutput;
|
|
576
|
+
/** The config json file for url based test */
|
|
577
|
+
urlTestConfigFileInfo?: TestRunFileInfoOutput;
|
|
328
578
|
/** Additional supported files for the test run */
|
|
329
|
-
additionalFileInfo?: Array<
|
|
579
|
+
readonly additionalFileInfo?: Array<TestRunFileInfoOutput>;
|
|
580
|
+
}
|
|
581
|
+
/** Test run file info. */
|
|
582
|
+
export interface TestRunFileInfoOutput {
|
|
583
|
+
/** Name of the file. */
|
|
584
|
+
fileName: string;
|
|
585
|
+
/** File URL. */
|
|
586
|
+
readonly url?: string;
|
|
587
|
+
/**
|
|
588
|
+
* File type
|
|
589
|
+
*
|
|
590
|
+
* Possible values: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", "URL_TEST_CONFIG", "TEST_SCRIPT"
|
|
591
|
+
*/
|
|
592
|
+
readonly fileType?: FileTypeOutput;
|
|
593
|
+
/** Expiry time of the file (RFC 3339 literal format) */
|
|
594
|
+
readonly expireDateTime?: string;
|
|
595
|
+
/**
|
|
596
|
+
* Validation status of the file
|
|
597
|
+
*
|
|
598
|
+
* Possible values: "NOT_VALIDATED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", "VALIDATION_NOT_REQUIRED"
|
|
599
|
+
*/
|
|
600
|
+
readonly validationStatus?: FileValidationStatusOutput;
|
|
601
|
+
/** Validation failure error details */
|
|
602
|
+
readonly validationFailureDetails?: string;
|
|
330
603
|
}
|
|
331
604
|
/** The output artifacts for the test run. */
|
|
332
605
|
export interface TestRunOutputArtifactsOutput {
|
|
333
|
-
/**
|
|
334
|
-
resultFileInfo?:
|
|
335
|
-
/**
|
|
336
|
-
logsFileInfo?:
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
606
|
+
/** The test run results file */
|
|
607
|
+
resultFileInfo?: TestRunFileInfoOutput;
|
|
608
|
+
/** The test run report with metrics */
|
|
609
|
+
logsFileInfo?: TestRunFileInfoOutput;
|
|
610
|
+
/** The container for test run artifacts. */
|
|
611
|
+
artifactsContainerInfo?: ArtifactsContainerInfoOutput;
|
|
612
|
+
/** The report file for the test run. */
|
|
613
|
+
reportFileInfo?: TestRunFileInfoOutput;
|
|
614
|
+
}
|
|
615
|
+
/** Artifacts container info. */
|
|
616
|
+
export interface ArtifactsContainerInfoOutput {
|
|
617
|
+
/** This is a SAS URI to an Azure Storage Container that contains the test run artifacts. */
|
|
618
|
+
url?: string;
|
|
619
|
+
/** Expiry time of the container (RFC 3339 literal format) */
|
|
620
|
+
expireDateTime?: string;
|
|
621
|
+
}
|
|
622
|
+
/** Paged collection of TestRun items */
|
|
623
|
+
export interface PagedTestRunOutput {
|
|
624
|
+
/** The TestRun items on this page */
|
|
341
625
|
value: Array<TestRunOutput>;
|
|
342
|
-
/**
|
|
626
|
+
/** The link to the next page of items */
|
|
343
627
|
nextLink?: string;
|
|
344
628
|
}
|
|
345
629
|
/** Represents collection of metric namespaces. */
|
|
@@ -362,24 +646,35 @@ export interface MetricDefinitionCollectionOutput {
|
|
|
362
646
|
/** Metric definition */
|
|
363
647
|
export interface MetricDefinitionOutput {
|
|
364
648
|
/** List of dimensions */
|
|
365
|
-
dimensions?: Array<
|
|
649
|
+
dimensions?: Array<NameAndDescriptionOutput>;
|
|
366
650
|
/** The metric description */
|
|
367
651
|
description?: string;
|
|
368
652
|
/** The metric name */
|
|
369
653
|
name?: string;
|
|
370
654
|
/** The namespace the metric belongs to. */
|
|
371
655
|
namespace?: string;
|
|
372
|
-
/**
|
|
373
|
-
|
|
656
|
+
/**
|
|
657
|
+
* The primary aggregation type value defining how to use the values for display.
|
|
658
|
+
*
|
|
659
|
+
* Possible values: "Average", "Count", "None", "Total", "Percentile75", "Percentile90", "Percentile95", "Percentile96", "Percentile97", "Percentile98", "Percentile99", "Percentile999", "Percentile9999"
|
|
660
|
+
*/
|
|
661
|
+
primaryAggregationType?: AggregationOutput;
|
|
374
662
|
/** The collection of what all aggregation types are supported. */
|
|
375
|
-
supportedAggregationTypes?:
|
|
376
|
-
/**
|
|
377
|
-
|
|
378
|
-
|
|
663
|
+
supportedAggregationTypes?: string[];
|
|
664
|
+
/**
|
|
665
|
+
* The unit of the metric.
|
|
666
|
+
*
|
|
667
|
+
* Possible values: "NotSpecified", "Percent", "Count", "Seconds", "Milliseconds", "Bytes", "BytesPerSecond", "CountPerSecond"
|
|
668
|
+
*/
|
|
669
|
+
unit?: MetricUnitOutput;
|
|
670
|
+
/**
|
|
671
|
+
* Metric availability specifies the time grain (aggregation interval or
|
|
672
|
+
* frequency).
|
|
673
|
+
*/
|
|
379
674
|
metricAvailabilities?: Array<MetricAvailabilityOutput>;
|
|
380
675
|
}
|
|
381
676
|
/** The name and description */
|
|
382
|
-
export interface
|
|
677
|
+
export interface NameAndDescriptionOutput {
|
|
383
678
|
/** The description */
|
|
384
679
|
description?: string;
|
|
385
680
|
/** The name */
|
|
@@ -387,14 +682,19 @@ export interface NameAndDescOutput {
|
|
|
387
682
|
}
|
|
388
683
|
/** Metric availability specifies the time grain (aggregation interval or frequency) */
|
|
389
684
|
export interface MetricAvailabilityOutput {
|
|
390
|
-
/**
|
|
391
|
-
|
|
685
|
+
/**
|
|
686
|
+
* The time grain specifies the aggregation interval for the metric. Expressed as
|
|
687
|
+
* a duration 'PT1M', 'PT1H', etc.
|
|
688
|
+
*
|
|
689
|
+
* Possible values: "PT5S", "PT10S", "PT1M", "PT5M", "PT1H"
|
|
690
|
+
*/
|
|
691
|
+
timeGrain?: TimeGrainOutput;
|
|
392
692
|
}
|
|
393
693
|
/** The response to a metrics query. */
|
|
394
694
|
export interface MetricsOutput {
|
|
395
|
-
/**
|
|
396
|
-
|
|
397
|
-
/**
|
|
695
|
+
/** The TimeSeriesElement items on this page */
|
|
696
|
+
value: Array<TimeSeriesElementOutput>;
|
|
697
|
+
/** The link to the next page of items */
|
|
398
698
|
nextLink?: string;
|
|
399
699
|
}
|
|
400
700
|
/** The time series returned when a data query is performed. */
|
|
@@ -406,7 +706,7 @@ export interface TimeSeriesElementOutput {
|
|
|
406
706
|
}
|
|
407
707
|
/** Represents a metric value. */
|
|
408
708
|
export interface MetricValueOutput {
|
|
409
|
-
/** The timestamp for the metric value in
|
|
709
|
+
/** The timestamp for the metric value in RFC 3339 format. */
|
|
410
710
|
timestamp?: string;
|
|
411
711
|
/** The metric value. */
|
|
412
712
|
value?: number;
|
|
@@ -420,39 +720,376 @@ export interface DimensionValueOutput {
|
|
|
420
720
|
}
|
|
421
721
|
/** Metrics dimension values. */
|
|
422
722
|
export interface DimensionValueListOutput {
|
|
423
|
-
/** The dimension
|
|
424
|
-
|
|
425
|
-
/**
|
|
723
|
+
/** The dimension name */
|
|
724
|
+
readonly name?: string;
|
|
725
|
+
/** The dimension value */
|
|
726
|
+
value?: string[];
|
|
727
|
+
/** Link for the next set of values in case of paginated results, if applicable. */
|
|
426
728
|
nextLink?: string;
|
|
427
729
|
}
|
|
428
730
|
/** Test run app component */
|
|
429
731
|
export interface TestRunAppComponentsOutput {
|
|
430
|
-
/**
|
|
732
|
+
/**
|
|
733
|
+
* Azure resource collection { resource id (fully qualified resource Id e.g
|
|
734
|
+
* subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})
|
|
735
|
+
* : resource object }
|
|
736
|
+
*/
|
|
431
737
|
components: Record<string, AppComponentOutput>;
|
|
432
738
|
/** Test run identifier */
|
|
433
|
-
testRunId?: string;
|
|
434
|
-
/** The creation datetime(
|
|
435
|
-
createdDateTime?: string;
|
|
739
|
+
readonly testRunId?: string;
|
|
740
|
+
/** The creation datetime(RFC 3339 literal format). */
|
|
741
|
+
readonly createdDateTime?: string;
|
|
436
742
|
/** The user that created. */
|
|
437
|
-
createdBy?: string;
|
|
438
|
-
/** The last Modified datetime(
|
|
439
|
-
lastModifiedDateTime?: string;
|
|
743
|
+
readonly createdBy?: string;
|
|
744
|
+
/** The last Modified datetime(RFC 3339 literal format). */
|
|
745
|
+
readonly lastModifiedDateTime?: string;
|
|
440
746
|
/** The user that last modified. */
|
|
441
|
-
lastModifiedBy?: string;
|
|
747
|
+
readonly lastModifiedBy?: string;
|
|
442
748
|
}
|
|
443
749
|
/** Test run server metrics configuration */
|
|
444
|
-
export interface
|
|
750
|
+
export interface TestRunServerMetricsConfigurationOutput {
|
|
445
751
|
/** Test run identifier */
|
|
446
|
-
testRunId?: string;
|
|
447
|
-
/**
|
|
752
|
+
readonly testRunId?: string;
|
|
753
|
+
/**
|
|
754
|
+
* Azure resource metrics collection {metric id : metrics object} (Refer :
|
|
755
|
+
* https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition
|
|
756
|
+
* for metric id).
|
|
757
|
+
*/
|
|
448
758
|
metrics?: Record<string, ResourceMetricOutput>;
|
|
449
|
-
/** The creation datetime(
|
|
450
|
-
createdDateTime?: string;
|
|
759
|
+
/** The creation datetime(RFC 3339 literal format). */
|
|
760
|
+
readonly createdDateTime?: string;
|
|
761
|
+
/** The user that created. */
|
|
762
|
+
readonly createdBy?: string;
|
|
763
|
+
/** The last Modified datetime(RFC 3339 literal format). */
|
|
764
|
+
readonly lastModifiedDateTime?: string;
|
|
765
|
+
/** The user that last modified. */
|
|
766
|
+
readonly lastModifiedBy?: string;
|
|
767
|
+
}
|
|
768
|
+
/** The Test Profile Run Model. Test Profile Run resource enables you to instantiate an already created test profile and run load tests to get recommendations on the optimal configuration for the target resource. */
|
|
769
|
+
export interface TestProfileRunOutput {
|
|
770
|
+
/** Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. */
|
|
771
|
+
readonly testProfileRunId: string;
|
|
772
|
+
/** Display name for the test profile run. */
|
|
773
|
+
displayName?: string;
|
|
774
|
+
/** The test profile run description */
|
|
775
|
+
description?: string;
|
|
776
|
+
/** Associated test profile ID for the test profile run. This is required to create a test profile run and can't be updated. */
|
|
777
|
+
testProfileId?: string;
|
|
778
|
+
/** Target resource ID on which the test profile run is created */
|
|
779
|
+
readonly targetResourceId?: string;
|
|
780
|
+
/** Configurations of the target resource on which the test profile ran. */
|
|
781
|
+
readonly targetResourceConfigurations?: TargetResourceConfigurationsOutput;
|
|
782
|
+
/**
|
|
783
|
+
* The test profile run status.
|
|
784
|
+
*
|
|
785
|
+
* Possible values: "ACCEPTED", "NOTSTARTED", "EXECUTING", "DONE", "CANCELLING", "CANCELLED", "FAILED"
|
|
786
|
+
*/
|
|
787
|
+
readonly status?: TestProfileRunStatusOutput;
|
|
788
|
+
/** Error details if there is any failure in test profile run. These errors are specific to the Test Profile Run. */
|
|
789
|
+
readonly errorDetails?: Array<ErrorDetailsOutput>;
|
|
790
|
+
/** The test profile run start DateTime(RFC 3339 literal format). */
|
|
791
|
+
readonly startDateTime?: string;
|
|
792
|
+
/** The test profile run end DateTime(RFC 3339 literal format). */
|
|
793
|
+
readonly endDateTime?: string;
|
|
794
|
+
/** Test profile run duration in seconds. */
|
|
795
|
+
readonly durationInSeconds?: number;
|
|
796
|
+
/**
|
|
797
|
+
* Details of the test runs ran as part of the test profile run.
|
|
798
|
+
* Key is the testRunId of the corresponding testRun.
|
|
799
|
+
*/
|
|
800
|
+
readonly testRunDetails?: Record<string, TestRunDetailOutput>;
|
|
801
|
+
/** Recommendations provided based on a successful test profile run. */
|
|
802
|
+
readonly recommendations?: Array<TestProfileRunRecommendationOutput>;
|
|
803
|
+
/** The creation datetime(RFC 3339 literal format). */
|
|
804
|
+
readonly createdDateTime?: string;
|
|
805
|
+
/** The user that created. */
|
|
806
|
+
readonly createdBy?: string;
|
|
807
|
+
/** The last Modified datetime(RFC 3339 literal format). */
|
|
808
|
+
readonly lastModifiedDateTime?: string;
|
|
809
|
+
/** The user that last modified. */
|
|
810
|
+
readonly lastModifiedBy?: string;
|
|
811
|
+
}
|
|
812
|
+
/** Details of a particular test run for a test profile run. */
|
|
813
|
+
export interface TestRunDetailOutput {
|
|
814
|
+
/**
|
|
815
|
+
* Status of the test run.
|
|
816
|
+
*
|
|
817
|
+
* Possible values: "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE"
|
|
818
|
+
*/
|
|
819
|
+
status: TestRunStatusOutput;
|
|
820
|
+
/** ID of the configuration on which the test ran. */
|
|
821
|
+
configurationId: string;
|
|
822
|
+
/** Key value pair of extra properties associated with the test run. */
|
|
823
|
+
properties: Record<string, string>;
|
|
824
|
+
}
|
|
825
|
+
/** A recommendation object that provides a list of configuration that optimizes its category. */
|
|
826
|
+
export interface TestProfileRunRecommendationOutput {
|
|
827
|
+
/**
|
|
828
|
+
* Category of the recommendation.
|
|
829
|
+
*
|
|
830
|
+
* Possible values: "ThroughputOptimized", "CostOptimized"
|
|
831
|
+
*/
|
|
832
|
+
category: RecommendationCategoryOutput;
|
|
833
|
+
/** List of configurations IDs for which the recommendation is applicable. These are a subset of the provided target resource configurations. */
|
|
834
|
+
configurations?: string[];
|
|
835
|
+
}
|
|
836
|
+
/** Paged collection of TestProfileRun items */
|
|
837
|
+
export interface PagedTestProfileRunOutput {
|
|
838
|
+
/** The TestProfileRun items on this page */
|
|
839
|
+
value: Array<TestProfileRunOutput>;
|
|
840
|
+
/** The link to the next page of items */
|
|
841
|
+
nextLink?: string;
|
|
842
|
+
}
|
|
843
|
+
/** Trigger model. */
|
|
844
|
+
export interface TriggerOutputParent {
|
|
845
|
+
/** The unique identifier of the trigger. */
|
|
846
|
+
readonly triggerId: string;
|
|
847
|
+
/** The name of the trigger. */
|
|
848
|
+
displayName: string;
|
|
849
|
+
/** The description of the trigger. */
|
|
850
|
+
description?: string;
|
|
851
|
+
/**
|
|
852
|
+
* The current state of the trigger.
|
|
853
|
+
*
|
|
854
|
+
* Possible values: "Active", "Paused", "Completed", "Disabled"
|
|
855
|
+
*/
|
|
856
|
+
state?: TriggerStateOutput;
|
|
857
|
+
/** Details of current state of the trigger. */
|
|
858
|
+
readonly stateDetails?: StateDetailsOutput;
|
|
859
|
+
/** The creation datetime(RFC 3339 literal format). */
|
|
860
|
+
readonly createdDateTime?: string;
|
|
451
861
|
/** The user that created. */
|
|
452
|
-
createdBy?: string;
|
|
453
|
-
/** The last Modified datetime(
|
|
454
|
-
lastModifiedDateTime?: string;
|
|
862
|
+
readonly createdBy?: string;
|
|
863
|
+
/** The last Modified datetime(RFC 3339 literal format). */
|
|
864
|
+
readonly lastModifiedDateTime?: string;
|
|
455
865
|
/** The user that last modified. */
|
|
456
|
-
lastModifiedBy?: string;
|
|
866
|
+
readonly lastModifiedBy?: string;
|
|
867
|
+
kind: TriggerTypeOutput;
|
|
868
|
+
}
|
|
869
|
+
/** State details of the trigger. */
|
|
870
|
+
export interface StateDetailsOutput {
|
|
871
|
+
/** The error message if the trigger is in disabled state. */
|
|
872
|
+
message?: string;
|
|
873
|
+
}
|
|
874
|
+
/** ScheduleTestsTrigger model. */
|
|
875
|
+
export interface ScheduleTestsTriggerOutput extends TriggerOutputParent {
|
|
876
|
+
/** The type of the trigger is ScheduleTestsTrigger. */
|
|
877
|
+
kind: "ScheduleTestsTrigger";
|
|
878
|
+
/** The test id of test to be triggered by this schedule trigger. Currently only one test is supported for a trigger. */
|
|
879
|
+
testIds: string[];
|
|
880
|
+
/** Start date time of the trigger in UTC timezone. (RFC 3339 literal format) */
|
|
881
|
+
startDateTime?: string;
|
|
882
|
+
readonly recurrenceStatus?: RecurrenceStatusOutput;
|
|
883
|
+
/** Recurrence details of the trigger. Null if schedule is not recurring. */
|
|
884
|
+
recurrence?: RecurrenceOutput;
|
|
885
|
+
}
|
|
886
|
+
/** Actual state of the recurrence for the trigger. */
|
|
887
|
+
export interface RecurrenceStatusOutput {
|
|
888
|
+
/** The number of occurrences remaining for the trigger. Null if recurrence end has end date instead of number of occurrences. */
|
|
889
|
+
remainingOccurrences?: number;
|
|
890
|
+
/** The next three execution times of the trigger. (RFC 3339 literal format) */
|
|
891
|
+
nextScheduledDateTimes?: string[];
|
|
892
|
+
}
|
|
893
|
+
/** Recurrence model. */
|
|
894
|
+
export interface RecurrenceOutputParent {
|
|
895
|
+
/** Recurrence end model. You can specify the end either by providing a numberOfOccurrences (which will end the recurrence after the specified number of occurrences) or by providing an endDateTime (which will end the recurrence after the specified date). If neither value is provided, the recurrence will continue until it is manually ended. However, if both values are provided, an error will be thrown. */
|
|
896
|
+
recurrenceEnd?: RecurrenceEndOutput;
|
|
897
|
+
frequency: FrequencyOutput;
|
|
898
|
+
}
|
|
899
|
+
/** Recurrence end model. Either provide numberOfOccurrences if you want recurrence to end after a specified number of occurrences or provide endDate if you want recurrence to end after a specified end date. If both values are provided, a validation error will be thrown indicating that only one field should be provided. If neither value is provided, the recurrence will end when manually ended. */
|
|
900
|
+
export interface RecurrenceEndOutput {
|
|
901
|
+
/** Number of occurrences after which the recurrence will end. */
|
|
902
|
+
numberOfOccurrences?: number;
|
|
903
|
+
/** The date after which the recurrence will end. (RFC 3339 literal format) */
|
|
904
|
+
endDateTime?: string;
|
|
905
|
+
}
|
|
906
|
+
/** Recurrence model when frequency is set as Daily. */
|
|
907
|
+
export interface DailyRecurrenceOutput extends RecurrenceOutputParent {
|
|
908
|
+
/** Frequency of the day recurrence. */
|
|
909
|
+
frequency: "Daily";
|
|
910
|
+
/** The interval at which the recurrence should repeat. It signifies the number of days between each recurrence. */
|
|
911
|
+
interval: number;
|
|
912
|
+
}
|
|
913
|
+
/** Recurrence model when frequency is set as Hourly. */
|
|
914
|
+
export interface HourlyRecurrenceOutput extends RecurrenceOutputParent {
|
|
915
|
+
/** Frequency of the hour recurrence. */
|
|
916
|
+
frequency: "Hourly";
|
|
917
|
+
/** The interval at which the recurrence should repeat. It signifies the number of hours between each recurrence. */
|
|
918
|
+
interval: number;
|
|
919
|
+
}
|
|
920
|
+
/** Recurrence model when frequency is set as MonthlyByDays . */
|
|
921
|
+
export interface MonthlyRecurrenceByWeekDaysOutput extends RecurrenceOutputParent {
|
|
922
|
+
/** Frequency of the month recurrence. */
|
|
923
|
+
frequency: "MonthlyByDays";
|
|
924
|
+
/** Specific days of the week when the recurrence should repeat. */
|
|
925
|
+
weekDaysInMonth?: WeekDaysOutput[];
|
|
926
|
+
/** Index of the week in a month at which the recurrence should repeat. For example, if the index is '2', weekDay is 'Monday', interval is 3 and frequency is 'Month', the recurrence will run every second Monday of the month and repeat every 3 months. Value of index can be 1 to 5. */
|
|
927
|
+
index: number;
|
|
928
|
+
/** The interval at which the recurrence should repeat. It signifies the number of months between each recurrence. */
|
|
929
|
+
interval: number;
|
|
930
|
+
}
|
|
931
|
+
/** Recurrence model when frequency is set as MonthlyByDates. */
|
|
932
|
+
export interface MonthlyRecurrenceByDatesOutput extends RecurrenceOutputParent {
|
|
933
|
+
/** Frequency of the month recurrence. */
|
|
934
|
+
frequency: "MonthlyByDates";
|
|
935
|
+
/** Recurrence set to repeat on the specified dates of the month. Value of dates can be 1 to 31 and -1. -1 represents the last day of the month. */
|
|
936
|
+
datesInMonth?: number[];
|
|
937
|
+
/** The interval at which the recurrence should repeat. It signifies the number of months between each recurrence. */
|
|
938
|
+
interval?: number;
|
|
939
|
+
}
|
|
940
|
+
/** Recurrence is set based on cron expression. */
|
|
941
|
+
export interface RecurrenceWithCronOutput extends RecurrenceOutputParent {
|
|
942
|
+
/** Specify frequency using a cron expression. */
|
|
943
|
+
frequency: "Cron";
|
|
944
|
+
/** Cron expression for the recurrence. */
|
|
945
|
+
cronExpression: string;
|
|
946
|
+
}
|
|
947
|
+
/** Recurrence model when frequency is set as weekly. */
|
|
948
|
+
export interface WeeklyRecurrenceOutput extends RecurrenceOutputParent {
|
|
949
|
+
/** Frequency of the week recurrence. */
|
|
950
|
+
frequency: "Weekly";
|
|
951
|
+
/** Recurrence set to repeat on the specified days of the week. */
|
|
952
|
+
daysOfWeek?: WeekDaysOutput[];
|
|
953
|
+
/** The interval at which the recurrence should repeat. It signifies the number of weeks between each recurrence. */
|
|
954
|
+
interval?: number;
|
|
955
|
+
}
|
|
956
|
+
/** Paged collection of Trigger items */
|
|
957
|
+
export interface PagedTriggerOutput {
|
|
958
|
+
/** The Trigger items on this page */
|
|
959
|
+
value: Array<TriggerOutput>;
|
|
960
|
+
/** The link to the next page of items */
|
|
961
|
+
nextLink?: string;
|
|
962
|
+
}
|
|
963
|
+
/** Notification rule model. */
|
|
964
|
+
export interface NotificationRuleOutputParent {
|
|
965
|
+
/** The unique identifier of the notification rule. */
|
|
966
|
+
readonly notificationRuleId: string;
|
|
967
|
+
/** The name of the notification rule. */
|
|
968
|
+
displayName: string;
|
|
969
|
+
/** The action groups to notify. */
|
|
970
|
+
actionGroupIds: string[];
|
|
971
|
+
/** The creation datetime(RFC 3339 literal format). */
|
|
972
|
+
readonly createdDateTime?: string;
|
|
973
|
+
/** The user that created. */
|
|
974
|
+
readonly createdBy?: string;
|
|
975
|
+
/** The last Modified datetime(RFC 3339 literal format). */
|
|
976
|
+
readonly lastModifiedDateTime?: string;
|
|
977
|
+
/** The user that last modified. */
|
|
978
|
+
readonly lastModifiedBy?: string;
|
|
979
|
+
scope: NotificationScopeTypeOutput;
|
|
980
|
+
}
|
|
981
|
+
/** Tests Notification rule model. */
|
|
982
|
+
export interface TestsNotificationRuleOutput extends NotificationRuleOutputParent {
|
|
983
|
+
/** Scope of type Tests. */
|
|
984
|
+
scope: "Tests";
|
|
985
|
+
/** The test ids to include. If not provided, notification will be sent for all testIds. */
|
|
986
|
+
testIds?: string[];
|
|
987
|
+
/**
|
|
988
|
+
* The event to receive notifications for along with filtering conditions.
|
|
989
|
+
* Key is a user-assigned identifier for the event filter.
|
|
990
|
+
*/
|
|
991
|
+
eventFilters: Record<string, TestsNotificationEventFilterOutput>;
|
|
992
|
+
}
|
|
993
|
+
/** The notification event filter for Tests scope. */
|
|
994
|
+
export interface TestsNotificationEventFilterOutputParent {
|
|
995
|
+
kind: NotificationEventTypeOutput;
|
|
996
|
+
}
|
|
997
|
+
/** The notification event filter when the event type is TestRunEnded and scope is Tests. */
|
|
998
|
+
export interface TestRunEndedNotificationEventFilterOutput extends TestsNotificationEventFilterOutputParent {
|
|
999
|
+
/** Event type for test run ended event. */
|
|
1000
|
+
kind: "TestRunEnded";
|
|
1001
|
+
/** Event filtering condition. */
|
|
1002
|
+
condition?: TestRunEndedEventConditionOutput;
|
|
1003
|
+
}
|
|
1004
|
+
/** TestRunEnded Event condition. */
|
|
1005
|
+
export interface TestRunEndedEventConditionOutput {
|
|
1006
|
+
/** The test run statuses to send notification for. */
|
|
1007
|
+
testRunStatuses?: TestRunStatusOutput[];
|
|
1008
|
+
/** The test run results to send notification for. */
|
|
1009
|
+
testRunResults?: PassFailTestResultOutput[];
|
|
1010
|
+
}
|
|
1011
|
+
/** The notification event filter when the event type is TestRunStarted and scope is Tests. */
|
|
1012
|
+
export interface TestRunStartedNotificationEventFilterOutput extends TestsNotificationEventFilterOutputParent {
|
|
1013
|
+
/** Event type for test run started event. */
|
|
1014
|
+
kind: "TestRunStarted";
|
|
1015
|
+
}
|
|
1016
|
+
/** The notification event filter when the event type is TriggerCompleted. */
|
|
1017
|
+
export interface TriggerCompletedNotificationEventFilterOutput extends TestsNotificationEventFilterOutputParent {
|
|
1018
|
+
/** Event type for trigger ended event. */
|
|
1019
|
+
kind: "TriggerCompleted";
|
|
1020
|
+
}
|
|
1021
|
+
/** The notification event filter when the event type is TriggerDisabled. */
|
|
1022
|
+
export interface TriggerDisabledNotificationEventFilterOutput extends TestsNotificationEventFilterOutputParent {
|
|
1023
|
+
/** Event type for trigger disabled event. */
|
|
1024
|
+
kind: "TriggerDisabled";
|
|
1025
|
+
}
|
|
1026
|
+
/** Paged collection of NotificationRule items */
|
|
1027
|
+
export interface PagedNotificationRuleOutput {
|
|
1028
|
+
/** The NotificationRule items on this page */
|
|
1029
|
+
value: Array<NotificationRuleOutput>;
|
|
1030
|
+
/** The link to the next page of items */
|
|
1031
|
+
nextLink?: string;
|
|
457
1032
|
}
|
|
1033
|
+
/** Configurations of a target resource. This varies with the kind of resource. */
|
|
1034
|
+
export type TargetResourceConfigurationsOutput = TargetResourceConfigurationsOutputParent | FunctionFlexConsumptionTargetResourceConfigurationsOutput;
|
|
1035
|
+
/** Trigger model. */
|
|
1036
|
+
export type TriggerOutput = TriggerOutputParent | ScheduleTestsTriggerOutput;
|
|
1037
|
+
/** Recurrence model. */
|
|
1038
|
+
export type RecurrenceOutput = RecurrenceOutputParent | DailyRecurrenceOutput | HourlyRecurrenceOutput | MonthlyRecurrenceByWeekDaysOutput | MonthlyRecurrenceByDatesOutput | RecurrenceWithCronOutput | WeeklyRecurrenceOutput;
|
|
1039
|
+
/** Notification rule model. */
|
|
1040
|
+
export type NotificationRuleOutput = NotificationRuleOutputParent | TestsNotificationRuleOutput;
|
|
1041
|
+
/** The notification event filter for Tests scope. */
|
|
1042
|
+
export type TestsNotificationEventFilterOutput = TestsNotificationEventFilterOutputParent | TestRunEndedNotificationEventFilterOutput | TestRunStartedNotificationEventFilterOutput | TriggerCompletedNotificationEventFilterOutput | TriggerDisabledNotificationEventFilterOutput;
|
|
1043
|
+
/** Alias for PFMetricsOutput */
|
|
1044
|
+
export type PFMetricsOutput = string;
|
|
1045
|
+
/** Alias for PassFailAggregationFunctionOutput */
|
|
1046
|
+
export type PassFailAggregationFunctionOutput = string;
|
|
1047
|
+
/** Alias for PassFailActionOutput */
|
|
1048
|
+
export type PassFailActionOutput = string;
|
|
1049
|
+
/** Alias for PassFailResultOutput */
|
|
1050
|
+
export type PassFailResultOutput = string;
|
|
1051
|
+
/** Alias for SecretTypeOutput */
|
|
1052
|
+
export type SecretTypeOutput = string;
|
|
1053
|
+
/** Alias for CertificateTypeOutput */
|
|
1054
|
+
export type CertificateTypeOutput = string;
|
|
1055
|
+
/** Alias for FileTypeOutput */
|
|
1056
|
+
export type FileTypeOutput = string;
|
|
1057
|
+
/** Alias for FileValidationStatusOutput */
|
|
1058
|
+
export type FileValidationStatusOutput = string;
|
|
1059
|
+
/** Alias for TestKindOutput */
|
|
1060
|
+
export type TestKindOutput = string;
|
|
1061
|
+
/** Alias for ManagedIdentityTypeOutput */
|
|
1062
|
+
export type ManagedIdentityTypeOutput = string;
|
|
1063
|
+
/** Alias for ResourceKindOutput */
|
|
1064
|
+
export type ResourceKindOutput = string;
|
|
1065
|
+
/** Alias for PassFailTestResultOutput */
|
|
1066
|
+
export type PassFailTestResultOutput = string;
|
|
1067
|
+
/** Alias for TestRunStatusOutput */
|
|
1068
|
+
export type TestRunStatusOutput = string;
|
|
1069
|
+
/** Alias for RequestDataLevelOutput */
|
|
1070
|
+
export type RequestDataLevelOutput = string;
|
|
1071
|
+
/** Alias for CreatedByTypeOutput */
|
|
1072
|
+
export type CreatedByTypeOutput = string;
|
|
1073
|
+
/** Alias for AggregationOutput */
|
|
1074
|
+
export type AggregationOutput = string;
|
|
1075
|
+
/** Alias for MetricUnitOutput */
|
|
1076
|
+
export type MetricUnitOutput = string;
|
|
1077
|
+
/** Alias for TimeGrainOutput */
|
|
1078
|
+
export type TimeGrainOutput = string;
|
|
1079
|
+
/** Alias for TestProfileRunStatusOutput */
|
|
1080
|
+
export type TestProfileRunStatusOutput = string;
|
|
1081
|
+
/** Alias for RecommendationCategoryOutput */
|
|
1082
|
+
export type RecommendationCategoryOutput = string;
|
|
1083
|
+
/** Alias for TriggerTypeOutput */
|
|
1084
|
+
export type TriggerTypeOutput = string;
|
|
1085
|
+
/** Alias for TriggerStateOutput */
|
|
1086
|
+
export type TriggerStateOutput = string;
|
|
1087
|
+
/** Alias for FrequencyOutput */
|
|
1088
|
+
export type FrequencyOutput = string;
|
|
1089
|
+
/** Alias for WeekDaysOutput */
|
|
1090
|
+
export type WeekDaysOutput = string;
|
|
1091
|
+
/** Alias for NotificationScopeTypeOutput */
|
|
1092
|
+
export type NotificationScopeTypeOutput = string;
|
|
1093
|
+
/** Alias for NotificationEventTypeOutput */
|
|
1094
|
+
export type NotificationEventTypeOutput = string;
|
|
458
1095
|
//# sourceMappingURL=outputModels.d.ts.map
|