-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
streamingjobs.json
1193 lines (1193 loc) · 45.4 KB
/
streamingjobs.json
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
{
"swagger": "2.0",
"info": {
"title": "StreamAnalyticsManagementClient",
"version": "2021-10-01-preview"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/providers/Microsoft.StreamAnalytics/operations": {
"get": {
"tags": [
"Operations"
],
"operationId": "Operations_List",
"description": "Lists all of the available Stream Analytics related operations.",
"x-ms-examples": {
"List available operations for the Stream Analytics resource provider": {
"$ref": "./examples/Operation_List.json"
}
},
"parameters": [
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully listed the available operations.",
"schema": {
"$ref": "#/definitions/OperationListResult"
}
},
"default": {
"description": "Error.",
"schema": {
"$ref": "../../common/v1/definitions.json#/definitions/Error"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}": {
"put": {
"tags": [
"StreamingJobs"
],
"operationId": "StreamingJobs_CreateOrReplace",
"description": "Creates a streaming job or replaces an already existing streaming job.",
"x-ms-examples": {
"Create a streaming job shell (a streaming job with no inputs, outputs, transformation, or functions)": {
"$ref": "./examples/StreamingJob_Create_JobShell.json"
},
"Create a complete streaming job (a streaming job with a transformation, at least 1 input and at least 1 output)": {
"$ref": "./examples/StreamingJob_Create_CompleteJob.json"
}
},
"parameters": [
{
"name": "streamingJob",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StreamingJob"
},
"description": "The definition of the streaming job that will be used to create a new streaming job or replace the existing one."
},
{
"name": "If-Match",
"in": "header",
"required": false,
"type": "string",
"x-ms-client-name": "IfMatch",
"description": "The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes."
},
{
"name": "If-None-Match",
"in": "header",
"required": false,
"type": "string",
"x-ms-client-name": "IfNoneMatch",
"description": "Set to '*' to allow a new streaming job to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response."
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter"
}
],
"responses": {
"200": {
"description": "The streaming job was successfully created or replaced.",
"schema": {
"$ref": "#/definitions/StreamingJob"
},
"headers": {
"ETag": {
"description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.",
"type": "string"
}
}
},
"201": {
"description": "The streaming job was successfully created or replaced.",
"schema": {
"$ref": "#/definitions/StreamingJob"
},
"headers": {
"ETag": {
"description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.",
"type": "string"
}
}
},
"default": {
"description": "Error.",
"schema": {
"$ref": "../../common/v1/definitions.json#/definitions/Error"
}
}
},
"x-ms-long-running-operation": true
},
"patch": {
"tags": [
"StreamingJobs"
],
"operationId": "StreamingJobs_Update",
"description": "Updates an existing streaming job. This can be used to partially update (ie. update one or two properties) a streaming job without affecting the rest the job definition.",
"x-ms-examples": {
"Update a streaming job": {
"$ref": "./examples/StreamingJob_Update.json"
}
},
"parameters": [
{
"name": "streamingJob",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StreamingJob"
},
"description": "A streaming job object. The properties specified here will overwrite the corresponding properties in the existing streaming job (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing input will remain the same and not change as a result of this PATCH operation."
},
{
"name": "If-Match",
"in": "header",
"required": false,
"type": "string",
"x-ms-client-name": "IfMatch",
"description": "The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes."
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter"
}
],
"responses": {
"200": {
"description": "The streaming job was successfully updated.",
"schema": {
"$ref": "#/definitions/StreamingJob"
},
"headers": {
"ETag": {
"description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.",
"type": "string"
}
}
},
"default": {
"description": "Error.",
"schema": {
"$ref": "../../common/v1/definitions.json#/definitions/Error"
}
}
}
},
"delete": {
"tags": [
"StreamingJobs"
],
"operationId": "StreamingJobs_Delete",
"description": "Deletes a streaming job.",
"x-ms-examples": {
"Delete a streaming job": {
"$ref": "./examples/StreamingJob_Delete.json"
}
},
"parameters": [
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter"
}
],
"responses": {
"200": {
"description": "The streaming job was successfully deleted."
},
"202": {
"description": "The delete request was successfully initiated."
},
"204": {
"description": "The streaming job does not exist."
},
"default": {
"description": "Error.",
"schema": {
"$ref": "../../common/v1/definitions.json#/definitions/Error"
}
}
},
"x-ms-long-running-operation": true
},
"get": {
"tags": [
"StreamingJobs"
],
"operationId": "StreamingJobs_Get",
"description": "Gets details about the specified streaming job.",
"x-ms-examples": {
"Get a streaming job and do not use the $expand OData query parameter": {
"$ref": "./examples/StreamingJob_Get_NoExpand.json"
},
"Get a streaming job and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions": {
"$ref": "./examples/StreamingJob_Get_Expand.json"
}
},
"parameters": [
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
"description": "The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'."
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter"
}
],
"responses": {
"200": {
"description": "Successfully retrieved the specified streaming job.",
"schema": {
"$ref": "#/definitions/StreamingJob"
},
"headers": {
"ETag": {
"description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.",
"type": "string"
}
}
},
"default": {
"description": "Error.",
"schema": {
"$ref": "../../common/v1/definitions.json#/definitions/Error"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs": {
"get": {
"tags": [
"StreamingJobs"
],
"operationId": "StreamingJobs_ListByResourceGroup",
"description": "Lists all of the streaming jobs in the specified resource group.",
"x-ms-examples": {
"List all streaming jobs in a resource group and do not use the $expand OData query parameter": {
"$ref": "./examples/StreamingJob_List_ByResourceGroup_NoExpand.json"
},
"List all streaming jobs in a resource group and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions": {
"$ref": "./examples/StreamingJob_List_ByResourceGroup_Expand.json"
}
},
"parameters": [
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
"description": "The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'."
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "Successfully listed the streaming jobs under the specified resource group.",
"schema": {
"$ref": "#/definitions/StreamingJobListResult"
}
},
"default": {
"description": "Error.",
"schema": {
"$ref": "../../common/v1/definitions.json#/definitions/Error"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/streamingjobs": {
"get": {
"tags": [
"StreamingJobs"
],
"operationId": "StreamingJobs_List",
"description": "Lists all of the streaming jobs in the given subscription.",
"x-ms-examples": {
"List all streaming jobs in a subscription and do not use the $expand OData query parameter": {
"$ref": "./examples/StreamingJob_List_BySubscription_NoExpand.json"
},
"List all streaming jobs in a subscription and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions": {
"$ref": "./examples/StreamingJob_List_BySubscription_Expand.json"
}
},
"parameters": [
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
"description": "The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'."
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Successfully listed the streaming jobs under the given subscription.",
"schema": {
"$ref": "#/definitions/StreamingJobListResult"
}
},
"default": {
"description": "Error.",
"schema": {
"$ref": "../../common/v1/definitions.json#/definitions/Error"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/start": {
"post": {
"tags": [
"StreamingJobs"
],
"operationId": "StreamingJobs_Start",
"description": "Starts a streaming job. Once a job is started it will start processing input events and produce output.",
"x-ms-examples": {
"Start a streaming job with CustomTime output start mode": {
"$ref": "./examples/StreamingJob_Start_CustomTime.json"
},
"Start a streaming job with JobStartTime output start mode": {
"$ref": "./examples/StreamingJob_Start_JobStartTime.json"
},
"Start a streaming job with LastOutputEventTime output start mode": {
"$ref": "./examples/StreamingJob_Start_LastOutputEventTime.json"
}
},
"parameters": [
{
"name": "startJobParameters",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/StartStreamingJobParameters"
},
"description": "Parameters applicable to a start streaming job operation."
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter"
}
],
"responses": {
"200": {
"description": "The streaming job was successfully started."
},
"202": {
"description": "The start streaming job request was successfully initiated."
},
"default": {
"description": "Error.",
"schema": {
"$ref": "../../common/v1/definitions.json#/definitions/Error"
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/stop": {
"post": {
"tags": [
"StreamingJobs"
],
"operationId": "StreamingJobs_Stop",
"description": "Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.",
"x-ms-examples": {
"Stop a streaming job": {
"$ref": "./examples/StreamingJob_Stop.json"
}
},
"parameters": [
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter"
}
],
"responses": {
"200": {
"description": "The streaming job was successfully stopped."
},
"202": {
"description": "The stop streaming job request was successfully initiated."
},
"default": {
"description": "Error.",
"schema": {
"$ref": "../../common/v1/definitions.json#/definitions/Error"
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/scale": {
"post": {
"tags": [
"StreamingJobs"
],
"operationId": "StreamingJobs_Scale",
"description": "Scales a streaming job when the job is running.",
"x-ms-examples": {
"Scale a streaming job": {
"$ref": "./examples/StreamingJob_Scale.json"
}
},
"parameters": [
{
"name": "scaleJobParameters",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/ScaleStreamingJobParameters"
},
"description": "Parameters applicable to a scale streaming job operation."
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter"
}
],
"responses": {
"202": {
"description": "The scale streaming job request was successfully initiated."
},
"default": {
"description": "Error.",
"schema": {
"$ref": "../../common/v1/definitions.json#/definitions/Error"
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/skus": {
"get": {
"tags": [
"StreamingJobs"
],
"operationId": "Sku_List",
"description": "Gets a list of available SKUs about the specified streaming job.",
"x-ms-examples": {
"Get valid SKUs list for the specified streaming job": {
"$ref": "./examples/StreamingJob_GetSkus.json"
}
},
"parameters": [
{
"$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter"
}
],
"responses": {
"200": {
"description": "Successfully retrieved the valid SKUs for the specified streaming job.",
"schema": {
"$ref": "#/definitions/GetStreamingJobSkuResults"
}
},
"default": {
"description": "Error.",
"schema": {
"$ref": "../../common/v1/definitions.json#/definitions/Error"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
"OperationListResult": {
"type": "object",
"description": "Result of the request to list Stream Analytics operations. It contains a list of operations and a URL link to get the next set of results.",
"properties": {
"value": {
"description": "List of Stream Analytics operations supported by the Microsoft.StreamAnalytics resource provider.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/Operation"
},
"x-ms-identifiers": []
},
"nextLink": {
"description": "URL to get the next set of operation list results if there are any.",
"type": "string",
"readOnly": true
}
}
},
"Operation": {
"description": "A Stream Analytics REST API operation",
"type": "object",
"properties": {
"name": {
"description": "The name of the operation being performed on this particular object.",
"type": "string",
"readOnly": true
},
"isDataAction": {
"description": "Indicates whether the operation is a data action",
"type": "boolean"
},
"display": {
"type": "object",
"description": "Contains the localized display information for this particular operation / action.",
"readOnly": true,
"properties": {
"provider": {
"description": "The localized friendly form of the resource provider name.",
"type": "string",
"readOnly": true
},
"resource": {
"description": "The localized friendly form of the resource type related to this action/operation.",
"type": "string",
"readOnly": true
},
"operation": {
"description": "The localized friendly name for the operation.",
"type": "string",
"readOnly": true
},
"description": {
"description": "The localized friendly description for the operation.",
"type": "string",
"readOnly": true
}
}
}
}
},
"StreamingJob": {
"type": "object",
"description": "A streaming job object, containing all information associated with the named streaming job.",
"allOf": [
{
"$ref": "../../common/v1/definitions.json#/definitions/TrackedResource"
}
],
"properties": {
"sku": {
"description": "Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.",
"$ref": "#/definitions/Sku"
},
"properties": {
"$ref": "#/definitions/StreamingJobProperties",
"description": "The properties that are associated with a streaming job. Required on PUT (CreateOrReplace) requests.",
"x-ms-client-flatten": true
},
"identity": {
"$ref": "#/definitions/Identity",
"description": "Describes the managed identity assigned to this job that can be used to authenticate with inputs and outputs."
}
}
},
"StreamingJobProperties": {
"type": "object",
"description": "The properties that are associated with a streaming job.",
"properties": {
"sku": {
"description": "Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.",
"$ref": "#/definitions/Sku"
},
"jobId": {
"readOnly": true,
"type": "string",
"description": "A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job."
},
"provisioningState": {
"readOnly": true,
"type": "string",
"description": "Describes the provisioning status of the streaming job."
},
"jobState": {
"readOnly": true,
"type": "string",
"description": "Describes the state of the streaming job."
},
"jobType": {
"type": "string",
"description": "Describes the type of the job. Valid modes are `Cloud` and 'Edge'.",
"enum": [
"Cloud",
"Edge"
],
"x-ms-enum": {
"name": "JobType",
"modelAsString": true
}
},
"outputStartMode": {
"$ref": "#/definitions/OutputStartMode",
"description": "This property should only be utilized when it is desired that the job be started immediately upon creation. Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time."
},
"outputStartTime": {
"type": "string",
"format": "date-time",
"description": "Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime."
},
"lastOutputEventTime": {
"readOnly": true,
"type": "string",
"format": "date-time",
"description": "Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set."
},
"eventsOutOfOrderPolicy": {
"$ref": "#/definitions/EventsOutOfOrderPolicy",
"description": "Indicates the policy to apply to events that arrive out of order in the input event stream."
},
"outputErrorPolicy": {
"$ref": "#/definitions/OutputErrorPolicy",
"description": "Indicates the policy to apply to events that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size)."
},
"eventsOutOfOrderMaxDelayInSeconds": {
"type": "integer",
"format": "int32",
"description": "The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order."
},
"eventsLateArrivalMaxDelayInSeconds": {
"type": "integer",
"format": "int32",
"description": "The maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 to 1814399 (20.23:59:59 days) and -1 is used to specify wait indefinitely. If the property is absent, it is interpreted to have a value of -1."
},
"dataLocale": {
"type": "string",
"description": "The data locale of the stream analytics job. Value should be the name of a supported .NET Culture from the set https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Defaults to 'en-US' if none specified."
},
"compatibilityLevel": {
"$ref": "#/definitions/CompatibilityLevel",
"description": "Controls certain runtime behaviors of the streaming job."
},
"createdDate": {
"readOnly": true,
"type": "string",
"format": "date-time",
"description": "Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created."
},
"inputs": {
"type": "array",
"items": {
"$ref": "./inputs.json#/definitions/Input"
},
"description": "A list of one or more inputs to the streaming job. The name property for each input is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual input."
},
"transformation": {
"$ref": "./transformations.json#/definitions/Transformation",
"description": "Indicates the query and the number of streaming units to use for the streaming job. The name property of the transformation is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation."
},
"outputs": {
"type": "array",
"items": {
"$ref": "./outputs.json#/definitions/Output"
},
"description": "A list of one or more outputs for the streaming job. The name property for each output is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual output."
},
"functions": {
"type": "array",
"items": {
"$ref": "./functions.json#/definitions/Function"
},
"description": "A list of one or more functions for the streaming job. The name property for each function is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency."
},
"jobStorageAccount": {
"description": "The properties that are associated with an Azure Storage account with MSI",
"$ref": "#/definitions/JobStorageAccount"
},
"contentStoragePolicy": {
"readOnly": false,
"type": "string",
"description": "Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. .",
"enum": [
"SystemAccount",
"JobStorageAccount"
],
"x-ms-enum": {
"name": "ContentStoragePolicy",
"modelAsString": true
}
},
"externals": {
"$ref": "#/definitions/External",
"description": "The storage account where the custom code artifacts are located."
},
"cluster": {
"$ref": "#/definitions/ClusterInfo",
"description": "The cluster which streaming jobs will run on."
}
}
},
"ClusterInfo": {
"type": "object",
"description": "The properties associated with a Stream Analytics cluster.",
"properties": {
"id": {
"description": "The resource id of cluster.",
"type": "string"
}
}
},
"Sku": {
"type": "object",
"description": "The properties that are associated with a SKU.",
"properties": {
"name": {
"type": "string",
"description": "The name of the SKU. Required on PUT (CreateOrReplace) requests.",
"enum": [
"Standard"
],
"x-ms-enum": {
"name": "SkuName",
"modelAsString": true
}
},
"capacity": {
"type": "integer",
"format": "int32",
"description": "The capacity of the SKU."
}
}
},
"StreamingJobListResult": {
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/StreamingJob"
},
"readOnly": true,
"description": "A list of streaming jobs. Populated by a 'List' operation."
},
"nextLink": {
"type": "string",
"readOnly": true,
"description": "The link (url) to the next page of results."
}
},
"description": "Object containing a list of streaming jobs."
},
"StartStreamingJobParameters": {
"type": "object",
"description": "Parameters supplied to the Start Streaming Job operation.",
"properties": {
"outputStartMode": {
"$ref": "#/definitions/OutputStartMode",
"description": "Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time."
},
"outputStartTime": {
"type": "string",
"format": "date-time",
"description": "Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime."
}
}
},
"OutputStartMode": {
"type": "string",
"description": "Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.",
"enum": [
"JobStartTime",
"CustomTime",
"LastOutputEventTime"
],
"x-ms-enum": {
"name": "OutputStartMode",
"modelAsString": true
}
},
"ScaleStreamingJobParameters": {
"type": "object",
"description": "Parameters supplied to the Scale Streaming Job operation.",
"properties": {
"streamingUnits": {
"type": "integer",
"format": "int32",
"description": "Specifies the number of streaming units that the streaming job will scale to."
}
}
},
"EventsOutOfOrderPolicy": {
"type": "string",
"description": "Indicates the policy to apply to events that arrive out of order in the input event stream.",
"enum": [
"Adjust",
"Drop"
],
"x-ms-enum": {
"name": "EventsOutOfOrderPolicy",
"modelAsString": true
}
},
"OutputErrorPolicy": {
"type": "string",
"description": "Indicates the policy to apply to events that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size).",
"enum": [
"Stop",
"Drop"
],
"x-ms-enum": {
"name": "OutputErrorPolicy",
"modelAsString": true
}
},
"CompatibilityLevel": {
"type": "string",
"description": "Controls certain runtime behaviors of the streaming job.",
"enum": [
"1.0",
"1.2"
],
"x-ms-enum": {
"name": "CompatibilityLevel",
"modelAsString": true
}
},
"JobStorageAccount": {
"type": "object",
"description": "The properties that are associated with an Azure Storage account with MSI",
"allOf": [
{
"$ref": "./inputs.json#/definitions/StorageAccount"
}
],
"properties": {
"authenticationMode": {
"$ref": "../../common/v1/definitions.json#/definitions/AuthenticationMode",
"description": "Authentication Mode."
}
}
},
"Identity": {
"type": "object",
"description": "Describes how identity is verified",
"properties": {
"tenantId": {
"type": "string",
"description": "The tenantId of the identity.",
"readOnly": true
},
"principalId": {
"type": "string",
"description": "The principalId of the identity.",
"readOnly": true