-
Notifications
You must be signed in to change notification settings - Fork 250
/
Copy pathazure.developer.loadtesting.aio.LoadTestRunClient.yml
1338 lines (1268 loc) · 80.9 KB
/
azure.developer.loadtesting.aio.LoadTestRunClient.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
### YamlMime:PythonClass
uid: azure.developer.loadtesting.aio.LoadTestRunClient
name: LoadTestRunClient
fullName: azure.developer.loadtesting.aio.LoadTestRunClient
module: azure.developer.loadtesting.aio
summary: These APIs allow end users to create, view and run load tests using Azure
Load Test Service.
constructor:
syntax: 'LoadTestRunClient(endpoint: str, credential: AsyncTokenCredential, **kwargs:
Any)'
parameters:
- name: endpoint
description: URL to perform data plane API operations on the resource. Required.
isRequired: true
types:
- <xref:str>
- name: credential
description: Credential needed for the client to connect to Azure. Required.
isRequired: true
types:
- <xref:azure.core.credentials_async.AsyncTokenCredential>
keywordOnlyParameters:
- name: api_version
description: 'Api Version. Default value is "2022-11-01". Note that overriding
this
default value may result in unsupported behavior.'
types:
- <xref:str>
methods:
- uid: azure.developer.loadtesting.aio.LoadTestRunClient.begin_test_run
name: begin_test_run
summary: 'Create and start a new test run with the given name.
Create and start a new test run with the given name.'
signature: 'begin_test_run(test_run_id: str, body: MutableMapping[str, Any] | IO,
*, old_test_run_id: str | None = None, **kwargs: Any) -> AsyncLROPoller[MutableMapping[str,
Any]]'
parameters:
- name: test_run_id
description: 'Unique name for the load test run, must contain only lower-case
alphabetic,
numeric, underscore or hyphen characters. Required.'
isRequired: true
types:
- <xref:str>
- name: body
description: Load test run model. Is either a model type or a IO type. Required.
isRequired: true
types:
- <xref:JSON>
- <xref:typing.IO>
keywordOnlyParameters:
- name: old_test_run_id
description: 'Existing test run identifier that should be rerun, if this is
provided, the test will run with the JMX file, configuration and app components
from the
existing test run. You can override the configuration values for new test run
in the request
body. Default value is None.'
defaultValue: None
types:
- <xref:str>
- name: content_type
description: 'Body Parameter content-type. Known values are:
''application/merge-patch+json''. Default value is None.'
types:
- <xref:str>
return:
types:
- <xref:azure.developer.loadtesting._polling.LoadTestingLROPoller>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- type: azure.core.exceptions.ResourceNotFoundError
- uid: azure.developer.loadtesting.aio.LoadTestRunClient.close
name: close
signature: async close() -> None
- uid: azure.developer.loadtesting.aio.LoadTestRunClient.create_or_update_app_components
name: create_or_update_app_components
summary: 'Associate an app component (collection of azure resources) to a test run.
Associate an app component (collection of azure resources) to a test run.'
signature: 'async create_or_update_app_components(test_run_id: str, body: MutableMapping[str,
Any] | IO, **kwargs: Any) -> MutableMapping[str, Any]'
parameters:
- name: test_run_id
description: 'Unique name for the load test run, must contain only lower-case
alphabetic,
numeric, underscore or hyphen characters. Required.'
isRequired: true
types:
- <xref:str>
- name: body
description: App Component model. Is either a JSON type or a IO type. Required.
isRequired: true
types:
- <xref:JSON>
- <xref:typing.IO>
keywordOnlyParameters:
- name: content_type
description: 'Body Parameter content-type. Known values are:
''application/merge-patch+json''. Default value is None.'
types:
- <xref:str>
return:
description: JSON object
types:
- <xref:JSON>
exceptions:
- type: azure.core.exceptions.HttpResponseError
examples:
- "<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
: [], \"backrefs\": [], \"xml:space\": \"preserve\", \"force\": false, \"language\"\
: \"python\", \"highlight_args\": {}, \"linenos\": false} -->\n\n````python\n\n\
\ # JSON input template you can fill out and use as your body input.\n body\
\ = {\n \"components\": {\n \"str\": {\n \"displayName\"\
: \"str\", # Optional. Azure resource display\n name.\n \
\ \"kind\": \"str\", # Optional. Kind of Azure resource type.\n \
\ \"resourceGroup\": \"str\", # Optional. Resource group name of\n\
\ the Azure resource.\n \"resourceId\": \"str\"\
, # Optional. fully qualified resource Id\n e.g\n \
\ subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.\n\
\ \"resourceName\": \"str\", # Optional. Azure resource name,\n\
\ required while creating the app component.\n \"\
resourceType\": \"str\", # Optional. Azure resource type,\n required\
\ while creating the app component.\n \"subscriptionId\": \"str\"\
\ # Optional. Subscription Id of the\n Azure resource.\n \
\ }\n },\n \"createdBy\": \"str\", # Optional. The user that\
\ created.\n \"createdDateTime\": \"2020-02-20 00:00:00\", # Optional.\
\ The creation\n datetime(ISO 8601 literal format).\n \"lastModifiedBy\"\
: \"str\", # Optional. The user that last modified.\n \"lastModifiedDateTime\"\
: \"2020-02-20 00:00:00\", # Optional. The last Modified\n datetime(ISO\
\ 8601 literal format).\n \"testRunId\": \"str\" # Optional. Test run identifier.\n\
\ }\n\n # response body for status code(s): 200, 201\n response == {\n \
\ \"components\": {\n \"str\": {\n \"displayName\"\
: \"str\", # Optional. Azure resource display\n name.\n \
\ \"kind\": \"str\", # Optional. Kind of Azure resource type.\n \
\ \"resourceGroup\": \"str\", # Optional. Resource group name of\n\
\ the Azure resource.\n \"resourceId\": \"str\"\
, # Optional. fully qualified resource Id\n e.g\n \
\ subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.\n\
\ \"resourceName\": \"str\", # Optional. Azure resource name,\n\
\ required while creating the app component.\n \"\
resourceType\": \"str\", # Optional. Azure resource type,\n required\
\ while creating the app component.\n \"subscriptionId\": \"str\"\
\ # Optional. Subscription Id of the\n Azure resource.\n \
\ }\n },\n \"createdBy\": \"str\", # Optional. The user that\
\ created.\n \"createdDateTime\": \"2020-02-20 00:00:00\", # Optional.\
\ The creation\n datetime(ISO 8601 literal format).\n \"lastModifiedBy\"\
: \"str\", # Optional. The user that last modified.\n \"lastModifiedDateTime\"\
: \"2020-02-20 00:00:00\", # Optional. The last Modified\n datetime(ISO\
\ 8601 literal format).\n \"testRunId\": \"str\" # Optional. Test run identifier.\n\
\ }\n ````\n"
- uid: azure.developer.loadtesting.aio.LoadTestRunClient.create_or_update_server_metrics_config
name: create_or_update_server_metrics_config
summary: 'Configure server metrics for a test run.
Configure server metrics for a test run.'
signature: 'async create_or_update_server_metrics_config(test_run_id: str, body:
MutableMapping[str, Any] | IO, **kwargs: Any) -> MutableMapping[str, Any]'
parameters:
- name: test_run_id
description: 'Unique name for the load test run, must contain only lower-case
alphabetic,
numeric, underscore or hyphen characters. Required.'
isRequired: true
types:
- <xref:str>
- name: body
description: Server metric configuration model. Is either a JSON type or a IO
type. Required.
isRequired: true
types:
- <xref:JSON>
- <xref:typing.IO>
keywordOnlyParameters:
- name: content_type
description: 'Body Parameter content-type. Known values are:
''application/merge-patch+json''. Default value is None.'
types:
- <xref:str>
return:
description: JSON object
types:
- <xref:JSON>
exceptions:
- type: azure.core.exceptions.HttpResponseError
examples:
- "<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
: [], \"backrefs\": [], \"xml:space\": \"preserve\", \"force\": false, \"language\"\
: \"python\", \"highlight_args\": {}, \"linenos\": false} -->\n\n````python\n\n\
\ # JSON input template you can fill out and use as your body input.\n body\
\ = {\n \"createdBy\": \"str\", # Optional. The user that created.\n \
\ \"createdDateTime\": \"2020-02-20 00:00:00\", # Optional. The creation\n\
\ datetime(ISO 8601 literal format).\n \"lastModifiedBy\": \"str\"\
, # Optional. The user that last modified.\n \"lastModifiedDateTime\":\
\ \"2020-02-20 00:00:00\", # Optional. The last Modified\n datetime(ISO\
\ 8601 literal format).\n \"metrics\": {\n \"str\": {\n \
\ \"aggregation\": \"str\", # Metric aggregation. Required.\n \
\ \"metricNamespace\": \"str\", # Metric name space. Required.\n \
\ \"name\": \"str\", # The invariant value of metric name.\n \
\ Required.\n \"resourceId\": \"str\", # Azure resource\
\ id. Required.\n \"resourceType\": \"str\", # Azure resource type.\
\ Required.\n \"displayDescription\": \"str\", # Optional. Metric\
\ description.\n \"id\": \"str\", # Optional. Unique name for metric.\n\
\ \"unit\": \"str\" # Optional. Metric unit.\n }\n \
\ },\n \"testRunId\": \"str\" # Optional. Test run identifier.\n \
\ }\n\n # response body for status code(s): 200, 201\n response == {\n \
\ \"createdBy\": \"str\", # Optional. The user that created.\n \"createdDateTime\"\
: \"2020-02-20 00:00:00\", # Optional. The creation\n datetime(ISO 8601\
\ literal format).\n \"lastModifiedBy\": \"str\", # Optional. The user\
\ that last modified.\n \"lastModifiedDateTime\": \"2020-02-20 00:00:00\"\
, # Optional. The last Modified\n datetime(ISO 8601 literal format).\n\
\ \"metrics\": {\n \"str\": {\n \"aggregation\"\
: \"str\", # Metric aggregation. Required.\n \"metricNamespace\"\
: \"str\", # Metric name space. Required.\n \"name\": \"str\",\
\ # The invariant value of metric name.\n Required.\n \
\ \"resourceId\": \"str\", # Azure resource id. Required.\n \
\ \"resourceType\": \"str\", # Azure resource type. Required.\n \
\ \"displayDescription\": \"str\", # Optional. Metric description.\n \
\ \"id\": \"str\", # Optional. Unique name for metric.\n \
\ \"unit\": \"str\" # Optional. Metric unit.\n }\n },\n\
\ \"testRunId\": \"str\" # Optional. Test run identifier.\n }\n ````\n"
- uid: azure.developer.loadtesting.aio.LoadTestRunClient.delete_test_run
name: delete_test_run
summary: 'Delete a test run by its name.
Delete a test run by its name.'
signature: 'async delete_test_run(test_run_id: str, **kwargs: Any) -> None'
parameters:
- name: test_run_id
description: 'Unique name for the load test run, must contain only lower-case
alphabetic,
numeric, underscore or hyphen characters. Required.'
isRequired: true
types:
- <xref:str>
return:
description: None
types:
- <xref:None>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.developer.loadtesting.aio.LoadTestRunClient.get_app_components
name: get_app_components
summary: 'Get associated app component (collection of azure resources) for the given
test run.
Get associated app component (collection of azure resources) for the given test
run.'
signature: 'async get_app_components(test_run_id: str, **kwargs: Any) -> MutableMapping[str,
Any]'
parameters:
- name: test_run_id
description: 'Unique name for the load test run, must contain only lower-case
alphabetic,
numeric, underscore or hyphen characters. Required.'
isRequired: true
types:
- <xref:str>
return:
description: JSON object
types:
- <xref:JSON>
exceptions:
- type: azure.core.exceptions.HttpResponseError
examples:
- "<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
: [], \"backrefs\": [], \"xml:space\": \"preserve\", \"force\": false, \"language\"\
: \"python\", \"highlight_args\": {}, \"linenos\": false} -->\n\n````python\n\n\
\ # response body for status code(s): 200\n response == {\n \"components\"\
: {\n \"str\": {\n \"displayName\": \"str\", # Optional.\
\ Azure resource display\n name.\n \"kind\": \"\
str\", # Optional. Kind of Azure resource type.\n \"resourceGroup\"\
: \"str\", # Optional. Resource group name of\n the Azure resource.\n\
\ \"resourceId\": \"str\", # Optional. fully qualified resource\
\ Id\n e.g\n subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.\n\
\ \"resourceName\": \"str\", # Optional. Azure resource name,\n\
\ required while creating the app component.\n \"\
resourceType\": \"str\", # Optional. Azure resource type,\n required\
\ while creating the app component.\n \"subscriptionId\": \"str\"\
\ # Optional. Subscription Id of the\n Azure resource.\n \
\ }\n },\n \"createdBy\": \"str\", # Optional. The user that\
\ created.\n \"createdDateTime\": \"2020-02-20 00:00:00\", # Optional.\
\ The creation\n datetime(ISO 8601 literal format).\n \"lastModifiedBy\"\
: \"str\", # Optional. The user that last modified.\n \"lastModifiedDateTime\"\
: \"2020-02-20 00:00:00\", # Optional. The last Modified\n datetime(ISO\
\ 8601 literal format).\n \"testRunId\": \"str\" # Optional. Test run identifier.\n\
\ }\n ````\n"
- uid: azure.developer.loadtesting.aio.LoadTestRunClient.get_metric_definitions
name: get_metric_definitions
summary: 'List the metric definitions for a load test run.
List the metric definitions for a load test run.'
signature: 'async get_metric_definitions(test_run_id: str, *, metric_namespace:
str, **kwargs: Any) -> MutableMapping[str, Any]'
parameters:
- name: test_run_id
description: 'Unique name for the load test run, must contain only lower-case
alphabetic,
numeric, underscore or hyphen characters. Required.'
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: metric_namespace
description: Metric namespace to query metric definitions for. Required.
types:
- <xref:str>
return:
description: JSON object
types:
- <xref:JSON>
exceptions:
- type: azure.core.exceptions.HttpResponseError
examples:
- "<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
: [], \"backrefs\": [], \"xml:space\": \"preserve\", \"force\": false, \"language\"\
: \"python\", \"highlight_args\": {}, \"linenos\": false} -->\n\n````python\n\n\
\ # response body for status code(s): 200\n response == {\n \"value\"\
: [\n {\n \"description\": \"str\", # Optional. The metric\
\ description.\n \"dimensions\": [\n {\n \
\ \"description\": \"str\", # Optional. The\n \
\ description.\n \"name\": \"str\" # Optional.\
\ The name.\n }\n ],\n \"metricAvailabilities\"\
: [\n {\n \"timeGrain\": \"str\" # Optional.\
\ The time\n grain specifies the aggregation interval\
\ for the metric.\n Expressed as a duration 'PT1M', 'PT1H',\
\ etc. Known values are:\n \"PT5S\", \"PT10S\", \"PT1M\"\
, \"PT5M\", and \"PT1H\".\n }\n ],\n \
\ \"name\": \"str\", # Optional. The metric name.\n \"namespace\"\
: \"str\", # Optional. The namespace the metric\n belongs to.\n\
\ \"primaryAggregationType\": \"str\", # Optional. The primary\n\
\ aggregation type value defining how to use the values for display.\
\ Known\n values are: \"Average\", \"Count\", \"None\", \"Total\"\
, \"Percentile90\",\n \"Percentile95\", and \"Percentile99\".\n\
\ \"supportedAggregationTypes\": [\n \"str\" \
\ # Optional. The collection of what all\n aggregation types\
\ are supported.\n ],\n \"unit\": \"str\" # Optional.\
\ The unit of the metric. Known\n values are: \"NotSpecified\"\
, \"Percent\", \"Count\", \"Seconds\",\n \"Milliseconds\", \"\
Bytes\", \"BytesPerSecond\", and \"CountPerSecond\".\n }\n ]\n\
\ }\n ````\n"
- uid: azure.developer.loadtesting.aio.LoadTestRunClient.get_metric_namespaces
name: get_metric_namespaces
summary: 'List the metric namespaces for a load test run.
List the metric namespaces for a load test run.'
signature: 'async get_metric_namespaces(test_run_id: str, **kwargs: Any) -> MutableMapping[str,
Any]'
parameters:
- name: test_run_id
description: 'Unique name for the load test run, must contain only lower-case
alphabetic,
numeric, underscore or hyphen characters. Required.'
isRequired: true
types:
- <xref:str>
return:
description: JSON object
types:
- <xref:JSON>
exceptions:
- type: azure.core.exceptions.HttpResponseError
examples:
- "<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
: [], \"backrefs\": [], \"xml:space\": \"preserve\", \"force\": false, \"language\"\
: \"python\", \"highlight_args\": {}, \"linenos\": false} -->\n\n````python\n\n\
\ # response body for status code(s): 200\n response == {\n \"value\"\
: [\n {\n \"description\": \"str\", # Optional. The namespace\
\ description.\n \"name\": \"str\" # Optional. The metric namespace\
\ name.\n }\n ]\n }\n ````\n"
- uid: azure.developer.loadtesting.aio.LoadTestRunClient.get_server_metrics_config
name: get_server_metrics_config
summary: 'List server metrics configuration for the given test run.
List server metrics configuration for the given test run.'
signature: 'async get_server_metrics_config(test_run_id: str, **kwargs: Any) ->
MutableMapping[str, Any]'
parameters:
- name: test_run_id
description: 'Unique name for the load test run, must contain only lower-case
alphabetic,
numeric, underscore or hyphen characters. Required.'
isRequired: true
types:
- <xref:str>
return:
description: JSON object
types:
- <xref:JSON>
exceptions:
- type: azure.core.exceptions.HttpResponseError
examples:
- "<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
: [], \"backrefs\": [], \"xml:space\": \"preserve\", \"force\": false, \"language\"\
: \"python\", \"highlight_args\": {}, \"linenos\": false} -->\n\n````python\n\n\
\ # response body for status code(s): 200\n response == {\n \"createdBy\"\
: \"str\", # Optional. The user that created.\n \"createdDateTime\": \"\
2020-02-20 00:00:00\", # Optional. The creation\n datetime(ISO 8601 literal\
\ format).\n \"lastModifiedBy\": \"str\", # Optional. The user that last\
\ modified.\n \"lastModifiedDateTime\": \"2020-02-20 00:00:00\", # Optional.\
\ The last Modified\n datetime(ISO 8601 literal format).\n \"metrics\"\
: {\n \"str\": {\n \"aggregation\": \"str\", # Metric\
\ aggregation. Required.\n \"metricNamespace\": \"str\", # Metric\
\ name space. Required.\n \"name\": \"str\", # The invariant value\
\ of metric name.\n Required.\n \"resourceId\":\
\ \"str\", # Azure resource id. Required.\n \"resourceType\": \"\
str\", # Azure resource type. Required.\n \"displayDescription\"\
: \"str\", # Optional. Metric description.\n \"id\": \"str\", \
\ # Optional. Unique name for metric.\n \"unit\": \"str\" # Optional.\
\ Metric unit.\n }\n },\n \"testRunId\": \"str\" # Optional.\
\ Test run identifier.\n }\n ````\n"
- uid: azure.developer.loadtesting.aio.LoadTestRunClient.get_test_run
name: get_test_run
summary: 'Get test run details by name.
Get test run details by name.'
signature: 'async get_test_run(test_run_id: str, **kwargs: Any) -> MutableMapping[str,
Any]'
parameters:
- name: test_run_id
description: 'Unique name for the load test run, must contain only lower-case
alphabetic,
numeric, underscore or hyphen characters. Required.'
isRequired: true
types:
- <xref:str>
return:
description: JSON object
types:
- <xref:JSON>
exceptions:
- type: azure.core.exceptions.HttpResponseError
examples:
- "<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
: [], \"backrefs\": [], \"xml:space\": \"preserve\", \"force\": false, \"language\"\
: \"python\", \"highlight_args\": {}, \"linenos\": false} -->\n\n````python\n\n\
\ # response body for status code(s): 200\n response == {\n \"certificate\"\
: {\n \"name\": \"str\", # Optional. Name of the certificate.\n \
\ \"type\": \"str\", # Optional. Type of certificate. \"AKV_CERT_URI\"\
\n \"value\": \"str\" # Optional. The value of the certificate for\n\
\ respective type.\n },\n \"createdBy\": \"str\", # Optional.\
\ The user that created.\n \"createdDateTime\": \"2020-02-20 00:00:00\"\
, # Optional. The creation\n datetime(ISO 8601 literal format).\n \
\ \"description\": \"str\", # Optional. The test run description.\n \
\ \"displayName\": \"str\", # Optional. Display name of a testRun.\n \"\
duration\": 0, # Optional. Test run duration in milliseconds.\n \"endDateTime\"\
: \"2020-02-20 00:00:00\", # Optional. The test run end\n DateTime(ISO\
\ 8601 literal format).\n \"environmentVariables\": {\n \"str\"\
: \"str\" # Optional. Environment variables which are defined as\n \
\ a set of <name,value> pairs.\n },\n \"errorDetails\": [\n \
\ {\n \"message\": \"str\" # Optional. Error details in case\
\ test run\n was not successfully run.\n }\n ],\n\
\ \"executedDateTime\": \"2020-02-20 00:00:00\", # Optional. Test run initiated\n\
\ time.\n \"lastModifiedBy\": \"str\", # Optional. The user that\
\ last modified.\n \"lastModifiedDateTime\": \"2020-02-20 00:00:00\", #\
\ Optional. The last Modified\n datetime(ISO 8601 literal format).\n \
\ \"loadTestConfiguration\": {\n \"engineInstances\": 0, # Optional.\
\ The number of engine instances to\n execute load test. Supported\
\ values are in range of 1-45. Required for\n creating a new test.\n\
\ \"optionalLoadTestConfig\": {\n \"duration\": 0, #\
\ Optional. Test run duration.\n \"endpointUrl\": \"str\", # Optional.\
\ Test URL. Provide the\n complete HTTP URL. For example,\n \
\ http://contoso-app.azurewebsites.net/login.\n \"\
rampUpTime\": 0, # Optional. Ramp up time.\n \"virtualUsers\":\
\ 0 # Optional. No of concurrent virtual\n users.\n \
\ },\n \"quickStartTest\": False, # Optional. Default value is False.\
\ If\n true, optionalLoadTestConfig is required and JMX script for\
\ the load test is\n not required to upload.\n \"splitAllCSVs\"\
: False # Optional. Default value is False. If false,\n Azure Load\
\ Testing copies and processes your input files unmodified across\n \
\ all test engine instances. If true, Azure Load Testing splits the CSV input\n\
\ data evenly across all engine instances. If you provide multiple\
\ CSV files,\n each file will be split evenly.\n },\n \
\ \"passFailCriteria\": {\n \"passFailMetrics\": {\n \"\
str\": {\n \"action\": \"continue\", # Optional. Default value\
\ is\n \"continue\". Action taken after the threshold is met.\
\ Default is\n \"u2018continue\"u2019. Known values are: \"\
continue\" and \"stop\".\n \"actualValue\": 0.0, # Optional.\
\ The actual value of\n the client metric for the test run.\n\
\ \"aggregate\": \"str\", # Optional. The aggregation\n \
\ function to be applied on the client metric. Allowed functions\
\ -\n \"u2018percentage\"u2019 - for error metric , \"u2018avg\"\
u2019,\n \"u2018p50\"u2019, \"u2018p90\"u2019, \"u2018p95\"\
u2019, \"u2018p99\"u2019,\n \"u2018min\"u2019, \"u2018max\"\
u2019 - for response_time_ms and latency\n metric, \"u2018avg\"\
u2019 - for requests_per_sec, \"u2018count\"u2019 -\n for\
\ requests. Known values are: \"count\", \"percentage\", \"avg\", \"p50\",\n \
\ \"p90\", \"p95\", \"p99\", \"min\", and \"max\".\n \
\ \"clientMetric\": \"str\", # Optional. The client metric\n \
\ on which the criteria should be applied. Known values are:\n\
\ \"response_time_ms\", \"latency\", \"error\", \"requests\"\
, and\n \"requests_per_sec\".\n \"condition\"\
: \"str\", # Optional. The comparison\n operator. Supported\
\ types \"u2018>\"u2019, \"u2018<\"u2019.\n \"requestName\"\
: \"str\", # Optional. Request name for\n which the Pass\
\ fail criteria has to be applied.\n \"result\": \"str\", #\
\ Optional. Outcome of the test\n run. Known values are: \"\
passed\", \"undetermined\", and \"failed\".\n \"value\": 0.0\
\ # Optional. The value to compare with\n the client metric.\
\ Allowed values - \"u2018error : [0.0 , 100.0] unit-\n %\
\ \"u2019, response_time_ms and latency : any integer value unit- ms.\n \
\ }\n }\n },\n \"portalUrl\": \"str\", # Optional.\
\ Portal url.\n \"secrets\": {\n \"str\": {\n \"\
type\": \"str\", # Optional. Type of secret. Known values are:\n \
\ \"AKV_SECRET_URI\" and \"SECRET_VALUE\".\n \"value\": \"str\"\
\ # Optional. The value of the secret for the\n respective type.\n\
\ }\n },\n \"startDateTime\": \"2020-02-20 00:00:00\", \
\ # Optional. The test run start\n DateTime(ISO 8601 literal format).\n\
\ \"status\": \"str\", # Optional. The test run status. Known values are:\n\
\ \"ACCEPTED\", \"NOTSTARTED\", \"PROVISIONING\", \"PROVISIONED\", \"\
CONFIGURING\",\n \"CONFIGURED\", \"EXECUTING\", \"EXECUTED\", \"DEPROVISIONING\"\
, \"DEPROVISIONED\", \"DONE\",\n \"CANCELLING\", \"CANCELLED\", \"FAILED\"\
, \"VALIDATION_SUCCESS\", and\n \"VALIDATION_FAILURE\".\n \"subnetId\"\
: \"str\", # Optional. Subnet ID on which the load test instances\n should\
\ run.\n \"testArtifacts\": {\n \"inputArtifacts\": {\n \
\ \"additionalFileInfo\": [\n {\n \
\ \"expireDateTime\": \"2020-02-20 00:00:00\", #\n \
\ Optional. Expiry time of the file (ISO 8601 literal format).\n \
\ \"fileName\": \"str\", # Optional. Name of the\n \
\ file.\n \"fileType\": \"str\", # Optional. File\
\ type.\n Known values are: \"JMX_FILE\", \"USER_PROPERTIES\"\
, and\n \"ADDITIONAL_ARTIFACTS\".\n \
\ \"url\": \"str\", # Optional. File URL.\n \"validationFailureDetails\"\
: \"str\", #\n Optional. Validation failure error details.\n\
\ \"validationStatus\": \"str\" # Optional.\n \
\ Validation status of the file. Known values are: \"NOT_VALIDATED\"\
,\n \"VALIDATION_SUCCESS\", \"VALIDATION_FAILURE\",\n\
\ \"VALIDATION_INITIATED\", and \"VALIDATION_NOT_REQUIRED\"\
.\n }\n ],\n \"configFileInfo\"\
: {\n \"expireDateTime\": \"2020-02-20 00:00:00\", # Optional.\n\
\ Expiry time of the file (ISO 8601 literal format).\n \
\ \"fileName\": \"str\", # Optional. Name of the file.\n \
\ \"fileType\": \"str\", # Optional. File type. Known\n \
\ values are: \"JMX_FILE\", \"USER_PROPERTIES\", and\n \
\ \"ADDITIONAL_ARTIFACTS\".\n \"url\": \"str\", #\
\ Optional. File URL.\n \"validationFailureDetails\": \"str\"\
, # Optional.\n Validation failure error details.\n \
\ \"validationStatus\": \"str\" # Optional. Validation\n \
\ status of the file. Known values are: \"NOT_VALIDATED\",\n \
\ \"VALIDATION_SUCCESS\", \"VALIDATION_FAILURE\", \"VALIDATION_INITIATED\"\
,\n and \"VALIDATION_NOT_REQUIRED\".\n },\n\
\ \"inputArtifactsZipFileInfo\": {\n \"expireDateTime\"\
: \"2020-02-20 00:00:00\", # Optional.\n Expiry time of the\
\ file (ISO 8601 literal format).\n \"fileName\": \"str\", \
\ # Optional. Name of the file.\n \"fileType\": \"str\", #\
\ Optional. File type. Known\n values are: \"JMX_FILE\", \"\
USER_PROPERTIES\", and\n \"ADDITIONAL_ARTIFACTS\".\n \
\ \"url\": \"str\", # Optional. File URL.\n \"\
validationFailureDetails\": \"str\", # Optional.\n Validation\
\ failure error details.\n \"validationStatus\": \"str\" #\
\ Optional. Validation\n status of the file. Known values\
\ are: \"NOT_VALIDATED\",\n \"VALIDATION_SUCCESS\", \"VALIDATION_FAILURE\"\
, \"VALIDATION_INITIATED\",\n and \"VALIDATION_NOT_REQUIRED\"\
.\n },\n \"testScriptFileInfo\": {\n \
\ \"expireDateTime\": \"2020-02-20 00:00:00\", # Optional.\n \
\ Expiry time of the file (ISO 8601 literal format).\n \
\ \"fileName\": \"str\", # Optional. Name of the file.\n \
\ \"fileType\": \"str\", # Optional. File type. Known\n \
\ values are: \"JMX_FILE\", \"USER_PROPERTIES\", and\n \"\
ADDITIONAL_ARTIFACTS\".\n \"url\": \"str\", # Optional. File\
\ URL.\n \"validationFailureDetails\": \"str\", # Optional.\n\
\ Validation failure error details.\n \"\
validationStatus\": \"str\" # Optional. Validation\n status\
\ of the file. Known values are: \"NOT_VALIDATED\",\n \"VALIDATION_SUCCESS\"\
, \"VALIDATION_FAILURE\", \"VALIDATION_INITIATED\",\n and\
\ \"VALIDATION_NOT_REQUIRED\".\n },\n \"userPropFileInfo\"\
: {\n \"expireDateTime\": \"2020-02-20 00:00:00\", # Optional.\n\
\ Expiry time of the file (ISO 8601 literal format).\n \
\ \"fileName\": \"str\", # Optional. Name of the file.\n \
\ \"fileType\": \"str\", # Optional. File type. Known\n \
\ values are: \"JMX_FILE\", \"USER_PROPERTIES\", and\n \
\ \"ADDITIONAL_ARTIFACTS\".\n \"url\": \"str\", #\
\ Optional. File URL.\n \"validationFailureDetails\": \"str\"\
, # Optional.\n Validation failure error details.\n \
\ \"validationStatus\": \"str\" # Optional. Validation\n \
\ status of the file. Known values are: \"NOT_VALIDATED\",\n \
\ \"VALIDATION_SUCCESS\", \"VALIDATION_FAILURE\", \"VALIDATION_INITIATED\"\
,\n and \"VALIDATION_NOT_REQUIRED\".\n }\n \
\ },\n \"outputArtifacts\": {\n \"logsFileInfo\"\
: {\n \"expireDateTime\": \"2020-02-20 00:00:00\", # Optional.\n\
\ Expiry time of the file (ISO 8601 literal format).\n \
\ \"fileName\": \"str\", # Optional. Name of the file.\n \
\ \"fileType\": \"str\", # Optional. File type. Known\n \
\ values are: \"JMX_FILE\", \"USER_PROPERTIES\", and\n \
\ \"ADDITIONAL_ARTIFACTS\".\n \"url\": \"str\", #\
\ Optional. File URL.\n \"validationFailureDetails\": \"str\"\
, # Optional.\n Validation failure error details.\n \
\ \"validationStatus\": \"str\" # Optional. Validation\n \
\ status of the file. Known values are: \"NOT_VALIDATED\",\n \
\ \"VALIDATION_SUCCESS\", \"VALIDATION_FAILURE\", \"VALIDATION_INITIATED\"\
,\n and \"VALIDATION_NOT_REQUIRED\".\n },\n\
\ \"resultFileInfo\": {\n \"expireDateTime\":\
\ \"2020-02-20 00:00:00\", # Optional.\n Expiry time of the\
\ file (ISO 8601 literal format).\n \"fileName\": \"str\", \
\ # Optional. Name of the file.\n \"fileType\": \"str\", #\
\ Optional. File type. Known\n values are: \"JMX_FILE\", \"\
USER_PROPERTIES\", and\n \"ADDITIONAL_ARTIFACTS\".\n \
\ \"url\": \"str\", # Optional. File URL.\n \"\
validationFailureDetails\": \"str\", # Optional.\n Validation\
\ failure error details.\n \"validationStatus\": \"str\" #\
\ Optional. Validation\n status of the file. Known values\
\ are: \"NOT_VALIDATED\",\n \"VALIDATION_SUCCESS\", \"VALIDATION_FAILURE\"\
, \"VALIDATION_INITIATED\",\n and \"VALIDATION_NOT_REQUIRED\"\
.\n }\n }\n },\n \"testId\": \"str\", # Optional.\
\ Associated test Id.\n \"testResult\": \"str\", # Optional. Test result\
\ for pass/Fail criteria used\n during the test run. Known values are:\
\ \"PASSED\", \"NOT_APPLICABLE\", and \"FAILED\".\n \"testRunId\": \"str\"\
, # Optional. Unique test run name as identifier.\n \"testRunStatistics\"\
: {\n \"str\": {\n \"errorCount\": 0.0, # Optional. Error\
\ count.\n \"errorPct\": 0.0, # Optional. Error percentage.\n \
\ \"maxResTime\": 0.0, # Optional. Max response time.\n \
\ \"meanResTime\": 0.0, # Optional. Mean response time.\n \
\ \"medianResTime\": 0.0, # Optional. Median response time.\n \
\ \"minResTime\": 0.0, # Optional. Minimum response time.\n \"\
pct1ResTime\": 0.0, # Optional. 90 percentile response time.\n \
\ \"pct2ResTime\": 0.0, # Optional. 95 percentile response time.\n \
\ \"pct3ResTime\": 0.0, # Optional. 99 percentile response time.\n \
\ \"receivedKBytesPerSec\": 0.0, # Optional. Received network\n \
\ bytes.\n \"sampleCount\": 0.0, # Optional. Sampler\
\ count.\n \"sentKBytesPerSec\": 0.0, # Optional. Send network\
\ bytes.\n \"throughput\": 0.0, # Optional. Throughput.\n \
\ \"transaction\": \"str\" # Optional. Transaction name.\n \
\ }\n },\n \"virtualUsers\": 0 # Optional. Number of virtual users,\
\ for which test has\n been run.\n }\n ````\n"
- uid: azure.developer.loadtesting.aio.LoadTestRunClient.get_test_run_file
name: get_test_run_file
summary: 'Get test run file by file name.
Get test run file by file name.'
signature: 'async get_test_run_file(test_run_id: str, file_name: str, **kwargs:
Any) -> MutableMapping[str, Any]'
parameters:
- name: test_run_id
description: 'Unique name for the load test run, must contain only lower-case
alphabetic,
numeric, underscore or hyphen characters. Required.'
isRequired: true
types:
- <xref:str>
- name: file_name
description: Test run file name with file extension. Required.
isRequired: true
types:
- <xref:str>
return:
description: JSON object
types:
- <xref:JSON>
exceptions:
- type: azure.core.exceptions.HttpResponseError
examples:
- "<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
: [], \"backrefs\": [], \"xml:space\": \"preserve\", \"force\": false, \"language\"\
: \"python\", \"highlight_args\": {}, \"linenos\": false} -->\n\n````python\n\n\
\ # response body for status code(s): 200\n response == {\n \"expireDateTime\"\
: \"2020-02-20 00:00:00\", # Optional. Expiry time of the file\n (ISO\
\ 8601 literal format).\n \"fileName\": \"str\", # Optional. Name of the\
\ file.\n \"fileType\": \"str\", # Optional. File type. Known values are:\
\ \"JMX_FILE\",\n \"USER_PROPERTIES\", and \"ADDITIONAL_ARTIFACTS\".\n\
\ \"url\": \"str\", # Optional. File URL.\n \"validationFailureDetails\"\
: \"str\", # Optional. Validation failure error\n details.\n \"\
validationStatus\": \"str\" # Optional. Validation status of the file. Known\n\
\ values are: \"NOT_VALIDATED\", \"VALIDATION_SUCCESS\", \"VALIDATION_FAILURE\"\
,\n \"VALIDATION_INITIATED\", and \"VALIDATION_NOT_REQUIRED\".\n }\n\
\ ````\n"
- uid: azure.developer.loadtesting.aio.LoadTestRunClient.list_metric_dimension_values
name: list_metric_dimension_values
summary: 'List the dimension values for the given metric dimension name.
List the dimension values for the given metric dimension name.'
signature: 'list_metric_dimension_values(test_run_id: str, name: str, *, metric_name:
str, metric_namespace: str, time_interval: str, interval: str | None = None, **kwargs:
Any) -> AsyncIterable[str]'
parameters:
- name: test_run_id
description: 'Unique name for the load test run, must contain only lower-case
alphabetic,
numeric, underscore or hyphen characters. Required.'
isRequired: true
types:
- <xref:str>
- name: name
description: Dimension name. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: metric_name
description: Metric name. Required.
types:
- <xref:str>
- name: metric_namespace
description: Metric namespace to query metric definitions for. Required.
types:
- <xref:str>
- name: time_interval
description: 'The timespan of the query. It is a string with the following format
''startDateTime_ISO/endDateTime_ISO''. Required.'
types:
- <xref:str>
- name: interval
description: 'The interval (i.e. timegrain) of the query. Known values are: "PT5S",
"PT10S", "PT1M", "PT5M", and "PT1H". Default value is None.'
defaultValue: None
types:
- <xref:str>
return:
description: An iterator like instance of str
types:
- <xref:azure.core.async_paging.AsyncItemPaged>[<xref:str>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
examples:
- "<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
: [], \"backrefs\": [], \"xml:space\": \"preserve\", \"force\": false, \"language\"\
: \"python\", \"highlight_args\": {}, \"linenos\": false} -->\n\n````python\n\n\
\ # response body for status code(s): 200\n response == \"str\" # Optional.\n\
\ ````\n"
- uid: azure.developer.loadtesting.aio.LoadTestRunClient.list_metrics
name: list_metrics
summary: 'List the metric values for a load test run.
List the metric values for a load test run.'
signature: 'list_metrics(test_run_id: str, body: MutableMapping[str, Any] | IO |
None = None, *, metric_name: str, metric_namespace: str, time_interval: str, aggregation:
str | None = None, interval: str | None = None, **kwargs: Any) -> AsyncIterable[MutableMapping[str,
Any]]'
parameters:
- name: test_run_id
description: 'Unique name for the load test run, must contain only lower-case
alphabetic,
numeric, underscore or hyphen characters. Required.'
isRequired: true
types:
- <xref:str>
- name: body
description: 'Metric dimension filter. Is either a JSON type or a IO type. Default
value is
None.'
defaultValue: None
types:
- <xref:JSON>
- <xref:typing.IO>
keywordOnlyParameters:
- name: metric_name
description: Metric name. Required.
types:
- <xref:str>
- name: metric_namespace
description: Metric namespace to query metric definitions for. Required.
types:
- <xref:str>
- name: time_interval
description: 'The timespan of the query. It is a string with the following format
''startDateTime_ISO/endDateTime_ISO''. Required.'
types:
- <xref:str>
- name: aggregation
description: The aggregation. Default value is None.
defaultValue: None
types:
- <xref:str>
- name: interval
description: 'The interval (i.e. timegrain) of the query. Known values are: "PT5S",
"PT10S", "PT1M", "PT5M", and "PT1H". Default value is None.'
defaultValue: None
types:
- <xref:str>
- name: content_type
description: 'Body Parameter content-type. Known values are: ''application/json''.
Default value is None.'
types:
- <xref:str>
return:
description: An iterator like instance of JSON object
types:
- <xref:azure.core.async_paging.AsyncItemPaged>[<xref:JSON>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
examples:
- "<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
: [], \"backrefs\": [], \"xml:space\": \"preserve\", \"force\": false, \"language\"\
: \"python\", \"highlight_args\": {}, \"linenos\": false} -->\n\n````python\n\n\
\ # JSON input template you can fill out and use as your body input.\n body\
\ = {\n \"filters\": [\n {\n \"name\": \"str\",\
\ # Optional. The dimension name.\n \"values\": [\n \
\ \"str\" # Optional. The dimension values. Maximum\n \
\ values can be 20.\n ]\n }\n ]\n }\n\n \
\ # response body for status code(s): 200\n response == {\n \"data\":\
\ [\n {\n \"timestamp\": \"str\", # Optional. The timestamp\
\ for the metric\n value in ISO 8601 format.\n \"\
value\": 0.0 # Optional. The metric value.\n }\n ],\n \"\
dimensionValues\": [\n {\n \"name\": \"str\", # Optional.\
\ The name of the dimension.\n \"value\": \"str\" # Optional. The\
\ value of the dimension.\n }\n ]\n }\n ````\n"
- uid: azure.developer.loadtesting.aio.LoadTestRunClient.list_test_runs
name: list_test_runs
summary: 'Get all test runs with given filters.
Get all test runs with given filters.'
signature: 'list_test_runs(*, orderby: str | None = None, search: str | None = None,
test_id: str | None = None, execution_from: datetime | None = None, execution_to:
datetime | None = None, status: str | None = None, **kwargs: Any) -> AsyncIterable[MutableMapping[str,
Any]]'
keywordOnlyParameters:
- name: orderby
description: 'Sort on the supported fields in (field asc/desc) format. eg: executedDateTime
asc. Supported fields - executedDateTime. Default value is None.'
defaultValue: None
types:
- <xref:str>
- name: search
description: 'Prefix based, case sensitive search on searchable fields - description,
executedUser. For example, to search for a test run, with description 500 VUs,
the search
parameter can be 500. Default value is None.'
defaultValue: None
types:
- <xref:str>
- name: test_id
description: Unique name of an existing load test. Default value is None.
defaultValue: None
types:
- <xref:str>
- name: execution_from
description: 'Start DateTime(ISO 8601 literal format) of test-run execution time
filter range. Default value is None.'
defaultValue: None
types:
- <xref:datetime.datetime>
- name: execution_to
description: 'End DateTime(ISO 8601 literal format) of test-run execution time
filter
range. Default value is None.'
defaultValue: None
types:
- <xref:datetime.datetime>
- name: status
description: Comma separated list of test run status. Default value is None.
defaultValue: None
types:
- <xref:str>
return:
description: An iterator like instance of JSON object
types:
- <xref:azure.core.async_paging.AsyncItemPaged>[<xref:JSON>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
examples:
- "<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
: [], \"backrefs\": [], \"xml:space\": \"preserve\", \"force\": false, \"language\"\
: \"python\", \"highlight_args\": {}, \"linenos\": false} -->\n\n````python\n\n\
\ # response body for status code(s): 200\n response == {\n \"certificate\"\
: {\n \"name\": \"str\", # Optional. Name of the certificate.\n \
\ \"type\": \"str\", # Optional. Type of certificate. \"AKV_CERT_URI\"\
\n \"value\": \"str\" # Optional. The value of the certificate for\n\
\ respective type.\n },\n \"createdBy\": \"str\", # Optional.\
\ The user that created.\n \"createdDateTime\": \"2020-02-20 00:00:00\"\
, # Optional. The creation\n datetime(ISO 8601 literal format).\n \
\ \"description\": \"str\", # Optional. The test run description.\n \
\ \"displayName\": \"str\", # Optional. Display name of a testRun.\n \"\
duration\": 0, # Optional. Test run duration in milliseconds.\n \"endDateTime\"\
: \"2020-02-20 00:00:00\", # Optional. The test run end\n DateTime(ISO\
\ 8601 literal format).\n \"environmentVariables\": {\n \"str\"\
: \"str\" # Optional. Environment variables which are defined as\n \
\ a set of <name,value> pairs.\n },\n \"errorDetails\": [\n \
\ {\n \"message\": \"str\" # Optional. Error details in case\
\ test run\n was not successfully run.\n }\n ],\n\
\ \"executedDateTime\": \"2020-02-20 00:00:00\", # Optional. Test run initiated\n\
\ time.\n \"lastModifiedBy\": \"str\", # Optional. The user that\
\ last modified.\n \"lastModifiedDateTime\": \"2020-02-20 00:00:00\", #\
\ Optional. The last Modified\n datetime(ISO 8601 literal format).\n \
\ \"loadTestConfiguration\": {\n \"engineInstances\": 0, # Optional.\
\ The number of engine instances to\n execute load test. Supported\
\ values are in range of 1-45. Required for\n creating a new test.\n\
\ \"optionalLoadTestConfig\": {\n \"duration\": 0, #\
\ Optional. Test run duration.\n \"endpointUrl\": \"str\", # Optional.\
\ Test URL. Provide the\n complete HTTP URL. For example,\n \
\ http://contoso-app.azurewebsites.net/login.\n \"\
rampUpTime\": 0, # Optional. Ramp up time.\n \"virtualUsers\":\
\ 0 # Optional. No of concurrent virtual\n users.\n \
\ },\n \"quickStartTest\": False, # Optional. Default value is False.\
\ If\n true, optionalLoadTestConfig is required and JMX script for\
\ the load test is\n not required to upload.\n \"splitAllCSVs\"\
: False # Optional. Default value is False. If false,\n Azure Load\
\ Testing copies and processes your input files unmodified across\n \
\ all test engine instances. If true, Azure Load Testing splits the CSV input\n\
\ data evenly across all engine instances. If you provide multiple\
\ CSV files,\n each file will be split evenly.\n },\n \
\ \"passFailCriteria\": {\n \"passFailMetrics\": {\n \"\
str\": {\n \"action\": \"continue\", # Optional. Default value\
\ is\n \"continue\". Action taken after the threshold is met.\
\ Default is\n \"u2018continue\"u2019. Known values are: \"\
continue\" and \"stop\".\n \"actualValue\": 0.0, # Optional.\
\ The actual value of\n the client metric for the test run.\n\
\ \"aggregate\": \"str\", # Optional. The aggregation\n \
\ function to be applied on the client metric. Allowed functions\
\ -\n \"u2018percentage\"u2019 - for error metric , \"u2018avg\"\
u2019,\n \"u2018p50\"u2019, \"u2018p90\"u2019, \"u2018p95\"\
u2019, \"u2018p99\"u2019,\n \"u2018min\"u2019, \"u2018max\"\
u2019 - for response_time_ms and latency\n metric, \"u2018avg\"\
u2019 - for requests_per_sec, \"u2018count\"u2019 -\n for\
\ requests. Known values are: \"count\", \"percentage\", \"avg\", \"p50\",\n \
\ \"p90\", \"p95\", \"p99\", \"min\", and \"max\".\n \
\ \"clientMetric\": \"str\", # Optional. The client metric\n \
\ on which the criteria should be applied. Known values are:\n\
\ \"response_time_ms\", \"latency\", \"error\", \"requests\"\
, and\n \"requests_per_sec\".\n \"condition\"\
: \"str\", # Optional. The comparison\n operator. Supported\
\ types \"u2018>\"u2019, \"u2018<\"u2019.\n \"requestName\"\
: \"str\", # Optional. Request name for\n which the Pass\
\ fail criteria has to be applied.\n \"result\": \"str\", #\
\ Optional. Outcome of the test\n run. Known values are: \"\
passed\", \"undetermined\", and \"failed\".\n \"value\": 0.0\
\ # Optional. The value to compare with\n the client metric.\
\ Allowed values - \"u2018error : [0.0 , 100.0] unit-\n %\
\ \"u2019, response_time_ms and latency : any integer value unit- ms.\n \
\ }\n }\n },\n \"portalUrl\": \"str\", # Optional.\
\ Portal url.\n \"secrets\": {\n \"str\": {\n \"\
type\": \"str\", # Optional. Type of secret. Known values are:\n \
\ \"AKV_SECRET_URI\" and \"SECRET_VALUE\".\n \"value\": \"str\"\
\ # Optional. The value of the secret for the\n respective type.\n\
\ }\n },\n \"startDateTime\": \"2020-02-20 00:00:00\", \
\ # Optional. The test run start\n DateTime(ISO 8601 literal format).\n\
\ \"status\": \"str\", # Optional. The test run status. Known values are:\n\
\ \"ACCEPTED\", \"NOTSTARTED\", \"PROVISIONING\", \"PROVISIONED\", \"\
CONFIGURING\",\n \"CONFIGURED\", \"EXECUTING\", \"EXECUTED\", \"DEPROVISIONING\"\
, \"DEPROVISIONED\", \"DONE\",\n \"CANCELLING\", \"CANCELLED\", \"FAILED\"\
, \"VALIDATION_SUCCESS\", and\n \"VALIDATION_FAILURE\".\n \"subnetId\"\
: \"str\", # Optional. Subnet ID on which the load test instances\n should\
\ run.\n \"testArtifacts\": {\n \"inputArtifacts\": {\n \
\ \"additionalFileInfo\": [\n {\n \
\ \"expireDateTime\": \"2020-02-20 00:00:00\", #\n \
\ Optional. Expiry time of the file (ISO 8601 literal format).\n \
\ \"fileName\": \"str\", # Optional. Name of the\n \
\ file.\n \"fileType\": \"str\", # Optional. File\
\ type.\n Known values are: \"JMX_FILE\", \"USER_PROPERTIES\"\
, and\n \"ADDITIONAL_ARTIFACTS\".\n \
\ \"url\": \"str\", # Optional. File URL.\n \"validationFailureDetails\"\
: \"str\", #\n Optional. Validation failure error details.\n\
\ \"validationStatus\": \"str\" # Optional.\n \
\ Validation status of the file. Known values are: \"NOT_VALIDATED\"\
,\n \"VALIDATION_SUCCESS\", \"VALIDATION_FAILURE\",\n\
\ \"VALIDATION_INITIATED\", and \"VALIDATION_NOT_REQUIRED\"\
.\n }\n ],\n \"configFileInfo\"\
: {\n \"expireDateTime\": \"2020-02-20 00:00:00\", # Optional.\n\
\ Expiry time of the file (ISO 8601 literal format).\n \
\ \"fileName\": \"str\", # Optional. Name of the file.\n \
\ \"fileType\": \"str\", # Optional. File type. Known\n \
\ values are: \"JMX_FILE\", \"USER_PROPERTIES\", and\n \
\ \"ADDITIONAL_ARTIFACTS\".\n \"url\": \"str\", #\
\ Optional. File URL.\n \"validationFailureDetails\": \"str\"\
, # Optional.\n Validation failure error details.\n \
\ \"validationStatus\": \"str\" # Optional. Validation\n \
\ status of the file. Known values are: \"NOT_VALIDATED\",\n \
\ \"VALIDATION_SUCCESS\", \"VALIDATION_FAILURE\", \"VALIDATION_INITIATED\"\