-
Notifications
You must be signed in to change notification settings - Fork 5.2k
/
Copy pathVideos.json
1052 lines (1052 loc) · 38.2 KB
/
Videos.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
{
"schemes": [
"https"
],
"swagger": "2.0",
"info": {
"title": "Azure Video Analyzer Resource Provider",
"description": "Azure Video Analyzer resource provider API definition.",
"version": "2021-11-01-preview"
},
"host": "management.azure.com",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"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"
}
}
},
"definitions": {
"VideoContentUrls": {
"properties": {
"downloadUrl": {
"type": "string",
"description": "Video file download URL. This URL can be used in conjunction with the video content authorization token to download the video MP4 file. The resulting MP4 file can be played on any standard media player. It is available when the video type is 'file' and video file is available for consumption."
},
"archiveBaseUrl": {
"type": "string",
"description": "Video archive streaming base URL. The archived content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token on any compatible DASH or HLS players by appending the following to the base URL:\r\n\r\n - HLSv4: /manifest(format=m3u8-aapl).m3u8\r\n - HLS CMAF: /manifest(format=m3u8-cmaf)\r\n - DASH CMAF: /manifest(format=mpd-time-cmaf)\r\n\r\n Moreover, an ongoing video recording can be played in \"live mode\" with latencies which are approximately double of the chosen video segment length. It is available when the video type is 'archive' and video archiving is enabled."
},
"rtspTunnelUrl": {
"type": "string",
"description": "Video low-latency streaming URL. The live content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token to expose a WebSocket tunneled RTSP stream. It is available when the video type is 'archive' and a live, low-latency feed is available from the source."
},
"previewImageUrls": {
"$ref": "#/definitions/VideoPreviewImageUrls",
"description": "Video preview image URLs. These URLs can be used in conjunction with the video content authorization token to download the most recent still image from the video archive in different resolutions. They are available when the video type is 'archive' and preview images are enabled."
}
},
"type": "object",
"description": "Set of URLs to the video content."
},
"VideoPreviewImageUrls": {
"properties": {
"small": {
"type": "string",
"description": "Low resolution preview image URL."
},
"medium": {
"type": "string",
"description": "Medium resolution preview image URL."
},
"large": {
"type": "string",
"description": "High resolution preview image URL."
}
},
"type": "object",
"description": "Video preview image URLs. These URLs can be used in conjunction with the video content authorization token to download the most recent still image from the video archive in different resolutions. They are available when the video type is 'archive' and preview images are enabled."
},
"VideoFlags": {
"properties": {
"canStream": {
"type": "boolean",
"description": "Value indicating whether or not the video can be streamed. Only \"archive\" type videos can be streamed."
},
"hasData": {
"type": "boolean",
"description": "Value indicating whether or not there has ever been data recorded or uploaded into the video. Newly created videos have this value set to false."
},
"isInUse": {
"type": "boolean",
"description": "Value indicating whether or not the video is currently being referenced be an active pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time."
}
},
"type": "object",
"required": [
"canStream",
"hasData",
"isInUse"
],
"description": "Video flags contain information about the available video actions and its dynamic properties based on the current video state."
},
"VideoMediaInfo": {
"properties": {
"segmentLength": {
"type": "string",
"description": "Video segment length indicates the length of individual video files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. \"PT30S\" equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments.",
"readOnly": true
}
},
"type": "object",
"description": "Contains information about the video and audio content."
},
"VideoContentToken": {
"properties": {
"expirationDate": {
"type": "string",
"format": "date-time",
"description": "The content token expiration date in ISO8601 format (eg. 2021-01-01T00:00:00Z).",
"readOnly": true,
"x-nullable": false
},
"token": {
"type": "string",
"description": "The content token value to be added to the video content URL as the value for the \"token\" query string parameter. The token is specific to a single video.",
"readOnly": true
}
},
"type": "object",
"description": "\"Video content token grants access to the video content URLs.\""
},
"VideoProperties": {
"properties": {
"title": {
"type": "string",
"description": "Optional video title provided by the user. Value can be up to 256 characters long."
},
"description": {
"type": "string",
"description": "Optional video description provided by the user. Value can be up to 2048 characters long."
},
"type": {
"type": "string",
"enum": [
"Archive",
"File"
],
"x-ms-enum": {
"name": "VideoType",
"values": [
{
"value": "Archive",
"description": "Archive is flexible format that represents a video stream associated with wall-clock time. The video archive can either be continuous or discontinuous. An archive is discontinuous when there are gaps in the recording due to various reasons, such as the live pipeline being stopped, camera being disconnected or due to the use of event based recordings through the use of a signal gate. There is no limit to the archive duration and new video data can be appended to the existing archive at any time, as long as the same video codec and codec parameters are being used. Videos of this type are suitable for appending and long term archival."
},
{
"value": "File",
"description": "File represents a video which is stored as a single media file, such as MP4. Videos of this type are suitable to be downloaded for external consumption."
}
],
"modelAsString": true
},
"description": "Video content type. Different content types are suitable for different applications and scenarios.",
"readOnly": true,
"x-nullable": false
},
"flags": {
"$ref": "#/definitions/VideoFlags",
"description": "Video flags contain information about the available video actions and its dynamic properties based on the current video state.",
"readOnly": true
},
"contentUrls": {
"$ref": "#/definitions/VideoContentUrls",
"description": "Set of URLs to the video content.",
"readOnly": true
},
"mediaInfo": {
"$ref": "#/definitions/VideoMediaInfo",
"description": "Contains information about the video and audio content.",
"readOnly": true
},
"archival": {
"$ref": "#/definitions/VideoArchival",
"description": "Video archival properties."
}
},
"type": "object",
"description": "Application level properties for the video resource."
},
"VideoArchival": {
"properties": {
"retentionPeriod": {
"type": "string",
"description": "Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours."
}
},
"type": "object",
"description": "Video archival properties."
},
"AuthenticationBase": {
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "The discriminator for derived types."
}
},
"type": "object",
"required": [
"@type"
],
"description": "Base class for access policies authentication methods."
},
"TokenClaim": {
"properties": {
"name": {
"type": "string",
"description": "Name of the claim which must be present on the token."
},
"value": {
"type": "string",
"description": "Expected value of the claim to be present on the token."
}
},
"type": "object",
"required": [
"name",
"value"
],
"description": "Properties for expected token claims."
},
"JwtAuthentication": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.JwtAuthentication",
"allOf": [
{
"$ref": "#/definitions/AuthenticationBase"
}
],
"properties": {
"issuers": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of expected token issuers. Token issuer is valid if it matches at least one of the given values."
},
"audiences": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of expected token audiences. Token audience is valid if it matches at least one of the given values."
},
"claims": {
"type": "array",
"items": {
"$ref": "#/definitions/TokenClaim"
},
"description": "List of additional token claims to be validated. Token must contains all claims and respective values for it to be valid."
},
"keys": {
"type": "array",
"items": {
"$ref": "#/definitions/TokenKey"
},
"description": "List of keys which can be used to validate access tokens. Having multiple keys allow for seamless key rotation of the token signing key. Token signature must match exactly one key."
}
},
"type": "object",
"description": "Properties for access validation based on JSON Web Tokens (JWT)."
},
"TokenKey": {
"discriminator": "@type",
"properties": {
"@type": {
"type": "string",
"description": "The discriminator for derived types."
},
"kid": {
"type": "string",
"description": "JWT token key id. Validation keys are looked up based on the key id present on the JWT token header."
}
},
"type": "object",
"required": [
"@type",
"kid"
],
"description": "Key properties for JWT token validation."
},
"RsaTokenKey": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.RsaTokenKey",
"allOf": [
{
"$ref": "#/definitions/TokenKey"
}
],
"properties": {
"alg": {
"type": "string",
"enum": [
"RS256",
"RS384",
"RS512"
],
"x-ms-enum": {
"name": "AccessPolicyRsaAlgo",
"values": [
{
"value": "RS256",
"description": "RS256"
},
{
"value": "RS384",
"description": "RS384"
},
{
"value": "RS512",
"description": "RS512"
}
],
"modelAsString": true
},
"description": "RSA algorithm to be used: RS256, RS384 or RS512."
},
"n": {
"type": "string",
"description": "RSA public key modulus."
},
"e": {
"type": "string",
"description": "RSA public key exponent."
}
},
"type": "object",
"required": [
"alg",
"n",
"e"
],
"description": "Required validation properties for tokens generated with RSA algorithm."
},
"EccTokenKey": {
"x-ms-discriminator-value": "#Microsoft.VideoAnalyzer.EccTokenKey",
"allOf": [
{
"$ref": "#/definitions/TokenKey"
}
],
"properties": {
"alg": {
"type": "string",
"enum": [
"ES256",
"ES384",
"ES512"
],
"x-ms-enum": {
"name": "AccessPolicyEccAlgo",
"values": [
{
"value": "ES256",
"description": "ES265"
},
{
"value": "ES384",
"description": "ES384"
},
{
"value": "ES512",
"description": "ES512"
}
],
"modelAsString": true
},
"description": "Elliptical curve algorithm to be used: ES256, ES384 or ES512."
},
"x": {
"type": "string",
"description": "X coordinate."
},
"y": {
"type": "string",
"description": "Y coordinate."
}
},
"type": "object",
"required": [
"alg",
"x",
"y"
],
"description": "Required validation properties for tokens generated with Elliptical Curve algorithm."
},
"AccessPolicyProperties": {
"properties": {
"role": {
"type": "string",
"enum": [
"Reader"
],
"x-ms-enum": {
"name": "AccessPolicyRole",
"values": [
{
"value": "Reader",
"description": "Reader role allows for read-only operations to be performed through the client APIs."
}
],
"modelAsString": true
},
"description": "Defines the access level granted by this policy.",
"x-nullable": true
},
"authentication": {
"$ref": "#/definitions/AuthenticationBase",
"description": "Authentication method to be used when validating client API access."
}
},
"type": "object",
"description": "Application level properties for the access policy resource."
},
"VideoEntity": {
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
],
"properties": {
"properties": {
"$ref": "#/definitions/VideoProperties",
"description": "The resource properties.",
"x-ms-client-flatten": true
}
},
"type": "object",
"description": "Represents a video resource within Azure Video Analyzer. Videos can be ingested from RTSP cameras through live pipelines or can be created by exporting sequences from existing captured video through a pipeline job. Videos ingested through live pipelines can be streamed through Azure Video Analyzer Player Widget or compatible players. Exported videos can be downloaded as MP4 files."
},
"AccessPolicyEntity": {
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
],
"properties": {
"properties": {
"$ref": "#/definitions/AccessPolicyProperties",
"description": "The resource properties.",
"x-ms-client-flatten": true
}
},
"type": "object",
"description": "Access policies help define the authentication rules, and control access to specific video resources."
},
"VideoEntityCollection": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/VideoEntity"
},
"description": "A collection of VideoEntity items."
},
"@nextLink": {
"type": "string",
"description": "A link to the next page of the collection (when the collection contains too many results to return in one response)."
}
},
"type": "object",
"description": "A collection of VideoEntity items."
},
"AccessPolicyEntityCollection": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/AccessPolicyEntity"
},
"description": "A collection of AccessPolicyEntity items."
},
"@nextLink": {
"type": "string",
"description": "A link to the next page of the collection (when the collection contains too many results to return in one response)."
}
},
"type": "object",
"description": "A collection of AccessPolicyEntity items."
}
},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/videos": {
"get": {
"summary": "Retrieves all existing video resources.",
"description": "Retrieves a list of video resources that have been created, along with their JSON representations.",
"operationId": "Videos_List",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/VideoEntityCollection"
}
},
"default": {
"description": "Detailed error information.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AzureVideoAnalyzerAccountName"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"name": "$top",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n."
}
],
"x-ms-pageable": {
"nextLinkName": "@nextLink"
},
"x-ms-examples": {
"Lists video entities.": {
"$ref": "examples/video-list.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/videos/{videoName}": {
"get": {
"summary": "Retrieves an existing video resource.",
"description": "Retrieves an existing video resource with the given name.",
"operationId": "Videos_Get",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/VideoEntity"
}
},
"default": {
"description": "Detailed error information.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AzureVideoAnalyzerAccountName"
},
{
"name": "videoName",
"in": "path",
"required": true,
"type": "string",
"description": "The Video name."
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"x-ms-examples": {
"Gets a video entity.": {
"$ref": "examples/video-get.json"
}
}
},
"put": {
"summary": "Creates a new video resource or updates an existing one.",
"description": "Creates a new video resource or updates an existing video resource with the given name.",
"operationId": "Videos_CreateOrUpdate",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/VideoEntity"
}
},
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/VideoEntity"
}
},
"default": {
"description": "Detailed error information.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AzureVideoAnalyzerAccountName"
},
{
"name": "videoName",
"in": "path",
"required": true,
"type": "string",
"description": "The Video name."
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/VideoEntity"
},
"description": "The request parameters"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"x-ms-examples": {
"Register video entity.": {
"$ref": "examples/video-create.json"
}
}
},
"delete": {
"summary": "Deletes an existing video resource and its underlying data.",
"description": "Deletes an existing video resource and its underlying data. This operation is irreversible.",
"operationId": "Videos_Delete",
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "NoContent"
},
"default": {
"description": "Detailed error information.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AzureVideoAnalyzerAccountName"
},
{
"name": "videoName",
"in": "path",
"required": true,
"type": "string",
"description": "The Video name."
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"x-ms-examples": {
"Deletes a video entity.": {
"$ref": "examples/video-delete.json"
}
}
},
"patch": {
"summary": "Updates individual properties of an existing video resource.",
"description": "Updates individual properties of an existing video resource with the given name.",
"operationId": "Videos_Update",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/VideoEntity"
}
},
"default": {
"description": "Detailed error information.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AzureVideoAnalyzerAccountName"
},
{
"name": "videoName",
"in": "path",
"required": true,
"type": "string",
"description": "The Video name."
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/VideoEntity"
},
"description": "The request parameters"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"x-ms-examples": {
"Update video entity.": {
"$ref": "examples/video-patch.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/videos/{videoName}/listContentToken": {
"post": {
"summary": "Generates a streaming token which can be used for accessing content from video content URLs.",
"description": "Generates a streaming token which can be used for accessing content from video content URLs, for a video resource with the given name.",
"operationId": "Videos_ListContentToken",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/VideoContentToken"
}
},
"default": {
"description": "Detailed error information.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AzureVideoAnalyzerAccountName"
},
{
"name": "videoName",
"in": "path",
"required": true,
"type": "string",
"description": "The Video name."
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"x-ms-examples": {
"Generate a content token for media endpoint authorization.": {
"$ref": "examples/video-listContentToken.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/accessPolicies": {
"get": {
"summary": "List all existing access policy resources.",
"description": "Retrieves all existing access policy resources, along with their JSON representations.",
"operationId": "AccessPolicies_List",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AccessPolicyEntityCollection"
}
},
"default": {
"description": "Detailed error information.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AzureVideoAnalyzerAccountName"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"name": "$top",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n."
}
],
"x-ms-pageable": {
"nextLinkName": "@nextLink"
},
"x-ms-examples": {
"Lists access policy entities.": {
"$ref": "examples/access-policy-list.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/accessPolicies/{accessPolicyName}": {
"get": {
"summary": "Retrieves an existing access policy resource.",
"description": "Retrieves an existing access policy resource with the given name.",
"operationId": "AccessPolicies_Get",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AccessPolicyEntity"
}
},
"default": {
"description": "Detailed error information.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AzureVideoAnalyzerAccountName"
},
{
"name": "accessPolicyName",
"in": "path",
"required": true,
"type": "string",
"description": "The Access Policy name."
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"x-ms-examples": {
"Gets an access policy entity.": {
"$ref": "examples/access-policy-get.json"
}
}
},
"put": {
"summary": "Creates a new access policy resource or updates an existing one.",
"description": "Creates a new access policy resource or updates an existing one with the given name.",
"operationId": "AccessPolicies_CreateOrUpdate",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AccessPolicyEntity"
}
},
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/AccessPolicyEntity"
}
},
"default": {
"description": "Detailed error information.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AzureVideoAnalyzerAccountName"
},
{
"name": "accessPolicyName",
"in": "path",
"required": true,
"type": "string",
"description": "The Access Policy name."
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AccessPolicyEntity"
},
"description": "The request parameters"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"x-ms-examples": {
"Register access policy entity.": {
"$ref": "examples/access-policy-create.json"
}
}
},
"delete": {
"summary": "Deletes an existing access policy resource.",
"description": "Deletes an existing access policy resource with the given name.",
"operationId": "AccessPolicies_Delete",
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "NoContent"
},
"default": {
"description": "Detailed error information.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/AzureVideoAnalyzerAccountName"
},
{
"name": "accessPolicyName",
"in": "path",
"required": true,
"type": "string",
"description": "The Access Policy name."
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"x-ms-examples": {
"Deletes an access policy entity.": {
"$ref": "examples/access-policy-delete.json"
}
}
},
"patch": {
"summary": "Updates individual properties of an existing access policy resource.",
"description": "Updates individual properties of an existing access policy resource with the given name.",
"operationId": "AccessPolicies_Update",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AccessPolicyEntity"
}
},
"default": {
"description": "Detailed error information.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"