-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
ContentKeyPolicies.json
1175 lines (1175 loc) · 38 KB
/
ContentKeyPolicies.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 Media Services",
"description": "This Swagger was generated by the API Framework.",
"version": "2021-11-01"
},
"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": {
"ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction": {
"properties": {
"bestEffort": {
"type": "boolean",
"description": "Indicates whether this restriction is enforced on a Best Effort basis."
},
"configurationData": {
"type": "integer",
"format": "int32",
"description": "Configures the restriction control bits. Must be between 0 and 3 inclusive."
}
},
"type": "object",
"required": [
"bestEffort",
"configurationData"
],
"description": "Configures the Explicit Analog Television Output Restriction control bits. For further details see the PlayReady Compliance Rules."
},
"ContentKeyPolicyPlayReadyContentKeyLocation": {
"discriminator": "@odata.type",
"properties": {
"@odata.type": {
"type": "string",
"description": "The discriminator for derived types."
}
},
"type": "object",
"required": [
"@odata.type"
],
"description": "Base class for content key ID location. A derived class must be used to represent the location."
},
"ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader": {
"x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader",
"allOf": [
{
"$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation"
}
],
"properties": {},
"type": "object",
"description": "Specifies that the content key ID is in the PlayReady header."
},
"ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier": {
"x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier",
"allOf": [
{
"$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation"
}
],
"properties": {
"keyId": {
"type": "string",
"format": "uuid",
"description": "The content key ID.",
"x-nullable": true
}
},
"type": "object",
"required": [
"keyId"
],
"description": "Specifies that the content key ID is specified in the PlayReady configuration."
},
"ContentKeyPolicyPlayReadyPlayRight": {
"properties": {
"firstPlayExpiration": {
"type": "string",
"format": "duration",
"description": "The amount of time that the license is valid after the license is first used to play content."
},
"scmsRestriction": {
"type": "integer",
"format": "int32",
"description": "Configures the Serial Copy Management System (SCMS) in the license. Must be between 0 and 3 inclusive."
},
"agcAndColorStripeRestriction": {
"type": "integer",
"format": "int32",
"description": "Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive."
},
"explicitAnalogTelevisionOutputRestriction": {
"$ref": "#/definitions/ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction",
"description": "Configures the Explicit Analog Television Output Restriction in the license. Configuration data must be between 0 and 3 inclusive."
},
"digitalVideoOnlyContentRestriction": {
"type": "boolean",
"description": "Enables the Image Constraint For Analog Component Video Restriction in the license."
},
"imageConstraintForAnalogComponentVideoRestriction": {
"type": "boolean",
"description": "Enables the Image Constraint For Analog Component Video Restriction in the license."
},
"imageConstraintForAnalogComputerMonitorRestriction": {
"type": "boolean",
"description": "Enables the Image Constraint For Analog Component Video Restriction in the license."
},
"allowPassingVideoContentToUnknownOutput": {
"type": "string",
"enum": [
"Unknown",
"NotAllowed",
"Allowed",
"AllowedWithVideoConstriction"
],
"x-ms-enum": {
"name": "ContentKeyPolicyPlayReadyUnknownOutputPassingOption",
"values": [
{
"value": "Unknown",
"description": "Represents a ContentKeyPolicyPlayReadyUnknownOutputPassingOption that is unavailable in current API version."
},
{
"value": "NotAllowed",
"description": "Passing the video portion of protected content to an Unknown Output is not allowed."
},
{
"value": "Allowed",
"description": "Passing the video portion of protected content to an Unknown Output is allowed."
},
{
"value": "AllowedWithVideoConstriction",
"description": "Passing the video portion of protected content to an Unknown Output is allowed but with constrained resolution."
}
],
"modelAsString": true
},
"description": "Configures Unknown output handling settings of the license."
},
"uncompressedDigitalVideoOpl": {
"type": "integer",
"format": "int32",
"description": "Specifies the output protection level for uncompressed digital video."
},
"compressedDigitalVideoOpl": {
"type": "integer",
"format": "int32",
"description": "Specifies the output protection level for compressed digital video."
},
"analogVideoOpl": {
"type": "integer",
"format": "int32",
"description": "Specifies the output protection level for compressed digital audio."
},
"compressedDigitalAudioOpl": {
"type": "integer",
"format": "int32",
"description": "Specifies the output protection level for compressed digital audio."
},
"uncompressedDigitalAudioOpl": {
"type": "integer",
"format": "int32",
"description": "Specifies the output protection level for uncompressed digital audio."
}
},
"type": "object",
"required": [
"digitalVideoOnlyContentRestriction",
"imageConstraintForAnalogComponentVideoRestriction",
"imageConstraintForAnalogComputerMonitorRestriction",
"allowPassingVideoContentToUnknownOutput"
],
"description": "Configures the Play Right in the PlayReady license."
},
"ContentKeyPolicyTokenClaim": {
"properties": {
"claimType": {
"type": "string",
"description": "Token claim type."
},
"claimValue": {
"type": "string",
"description": "Token claim value."
}
},
"type": "object",
"description": "Represents a token claim."
},
"ContentKeyPolicyPlayReadyLicense": {
"properties": {
"allowTestDevices": {
"type": "boolean",
"description": "A flag indicating whether test devices can use the license."
},
"beginDate": {
"type": "string",
"format": "date-time",
"description": "The begin date of license"
},
"expirationDate": {
"type": "string",
"format": "date-time",
"description": "The expiration date of license."
},
"relativeBeginDate": {
"type": "string",
"format": "duration",
"description": "The relative begin date of license."
},
"relativeExpirationDate": {
"type": "string",
"format": "duration",
"description": "The relative expiration date of license."
},
"gracePeriod": {
"type": "string",
"format": "duration",
"description": "The grace period of license."
},
"playRight": {
"$ref": "#/definitions/ContentKeyPolicyPlayReadyPlayRight",
"description": "The license PlayRight"
},
"licenseType": {
"type": "string",
"enum": [
"Unknown",
"NonPersistent",
"Persistent"
],
"x-ms-enum": {
"name": "ContentKeyPolicyPlayReadyLicenseType",
"values": [
{
"value": "Unknown",
"description": "Represents a ContentKeyPolicyPlayReadyLicenseType that is unavailable in current API version."
},
{
"value": "NonPersistent",
"description": "Non persistent license."
},
{
"value": "Persistent",
"description": "Persistent license. Allows offline playback."
}
],
"modelAsString": true
},
"description": "The license type."
},
"contentKeyLocation": {
"$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation",
"description": "The content key location."
},
"contentType": {
"type": "string",
"enum": [
"Unknown",
"Unspecified",
"UltraVioletDownload",
"UltraVioletStreaming"
],
"x-ms-enum": {
"name": "ContentKeyPolicyPlayReadyContentType",
"values": [
{
"value": "Unknown",
"description": "Represents a ContentKeyPolicyPlayReadyContentType that is unavailable in current API version."
},
{
"value": "Unspecified",
"description": "Unspecified content type."
},
{
"value": "UltraVioletDownload",
"description": "Ultraviolet download content type."
},
{
"value": "UltraVioletStreaming",
"description": "Ultraviolet streaming content type."
}
],
"modelAsString": true
},
"description": "The PlayReady content type."
}
},
"type": "object",
"required": [
"allowTestDevices",
"licenseType",
"contentKeyLocation",
"contentType"
],
"description": "The PlayReady license"
},
"ContentKeyPolicyRestriction": {
"discriminator": "@odata.type",
"properties": {
"@odata.type": {
"type": "string",
"description": "The discriminator for derived types."
}
},
"type": "object",
"required": [
"@odata.type"
],
"description": "Base class for Content Key Policy restrictions. A derived class must be used to create a restriction."
},
"ContentKeyPolicyOpenRestriction": {
"x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyOpenRestriction",
"allOf": [
{
"$ref": "#/definitions/ContentKeyPolicyRestriction"
}
],
"properties": {},
"type": "object",
"description": "Represents an open restriction. License or key will be delivered on every request."
},
"ContentKeyPolicyUnknownRestriction": {
"x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyUnknownRestriction",
"allOf": [
{
"$ref": "#/definitions/ContentKeyPolicyRestriction"
}
],
"properties": {},
"type": "object",
"description": "Represents a ContentKeyPolicyRestriction that is unavailable in the current API version."
},
"ContentKeyPolicyConfiguration": {
"discriminator": "@odata.type",
"properties": {
"@odata.type": {
"type": "string",
"description": "The discriminator for derived types."
}
},
"type": "object",
"required": [
"@odata.type"
],
"description": "Base class for Content Key Policy configuration. A derived class must be used to create a configuration."
},
"ContentKeyPolicyRestrictionTokenKey": {
"discriminator": "@odata.type",
"properties": {
"@odata.type": {
"type": "string",
"description": "The discriminator for derived types."
}
},
"type": "object",
"required": [
"@odata.type"
],
"description": "Base class for Content Key Policy key for token validation. A derived class must be used to create a token key."
},
"ContentKeyPolicySymmetricTokenKey": {
"x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey",
"allOf": [
{
"$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey"
}
],
"properties": {
"keyValue": {
"type": "string",
"format": "byte",
"description": "The key value of the key",
"x-nullable": true
}
},
"type": "object",
"required": [
"keyValue"
],
"description": "Specifies a symmetric key for token validation."
},
"ContentKeyPolicyRsaTokenKey": {
"x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey",
"allOf": [
{
"$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey"
}
],
"properties": {
"exponent": {
"type": "string",
"format": "byte",
"description": "The RSA Parameter exponent",
"x-nullable": true
},
"modulus": {
"type": "string",
"format": "byte",
"description": "The RSA Parameter modulus",
"x-nullable": true
}
},
"type": "object",
"required": [
"exponent",
"modulus"
],
"description": "Specifies a RSA key for token validation"
},
"ContentKeyPolicyX509CertificateTokenKey": {
"x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKey",
"allOf": [
{
"$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey"
}
],
"properties": {
"rawBody": {
"type": "string",
"format": "byte",
"description": "The raw data field of a certificate in PKCS 12 format (X509Certificate2 in .NET)",
"x-nullable": true
}
},
"type": "object",
"required": [
"rawBody"
],
"description": "Specifies a certificate for token validation."
},
"ContentKeyPolicyTokenRestriction": {
"x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyTokenRestriction",
"allOf": [
{
"$ref": "#/definitions/ContentKeyPolicyRestriction"
}
],
"properties": {
"issuer": {
"type": "string",
"description": "The token issuer."
},
"audience": {
"type": "string",
"description": "The audience for the token."
},
"primaryVerificationKey": {
"$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey",
"description": "The primary verification key."
},
"alternateVerificationKeys": {
"type": "array",
"items": {
"$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey"
},
"x-ms-identifiers": [],
"description": "A list of alternative verification keys."
},
"requiredClaims": {
"type": "array",
"items": {
"$ref": "#/definitions/ContentKeyPolicyTokenClaim"
},
"x-ms-identifiers": [],
"description": "A list of required token claims."
},
"restrictionTokenType": {
"type": "string",
"enum": [
"Unknown",
"Swt",
"Jwt"
],
"x-ms-enum": {
"name": "ContentKeyPolicyRestrictionTokenType",
"values": [
{
"value": "Unknown",
"description": "Represents a ContentKeyPolicyRestrictionTokenType that is unavailable in current API version."
},
{
"value": "Swt",
"description": "Simple Web Token."
},
{
"value": "Jwt",
"description": "JSON Web Token."
}
],
"modelAsString": true
},
"description": "The type of token."
},
"openIdConnectDiscoveryDocument": {
"type": "string",
"description": "The OpenID connect discovery document."
}
},
"type": "object",
"required": [
"issuer",
"audience",
"primaryVerificationKey",
"restrictionTokenType"
],
"description": "Represents a token restriction. Provided token must match these requirements for successful license or key delivery."
},
"ContentKeyPolicyClearKeyConfiguration": {
"x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration",
"allOf": [
{
"$ref": "#/definitions/ContentKeyPolicyConfiguration"
}
],
"properties": {},
"type": "object",
"description": "Represents a configuration for non-DRM keys."
},
"ContentKeyPolicyUnknownConfiguration": {
"x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyUnknownConfiguration",
"allOf": [
{
"$ref": "#/definitions/ContentKeyPolicyConfiguration"
}
],
"properties": {},
"type": "object",
"description": "Represents a ContentKeyPolicyConfiguration that is unavailable in the current API version."
},
"ContentKeyPolicyWidevineConfiguration": {
"x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration",
"allOf": [
{
"$ref": "#/definitions/ContentKeyPolicyConfiguration"
}
],
"properties": {
"widevineTemplate": {
"type": "string",
"description": "The Widevine template."
}
},
"type": "object",
"required": [
"widevineTemplate"
],
"description": "Specifies a configuration for Widevine licenses."
},
"ContentKeyPolicyPlayReadyConfiguration": {
"x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration",
"allOf": [
{
"$ref": "#/definitions/ContentKeyPolicyConfiguration"
}
],
"properties": {
"licenses": {
"type": "array",
"items": {
"$ref": "#/definitions/ContentKeyPolicyPlayReadyLicense"
},
"x-ms-identifiers": [],
"description": "The PlayReady licenses."
},
"responseCustomData": {
"type": "string",
"description": "The custom response data."
}
},
"type": "object",
"required": [
"licenses"
],
"description": "Specifies a configuration for PlayReady licenses."
},
"ContentKeyPolicyFairPlayOfflineRentalConfiguration": {
"properties": {
"playbackDurationSeconds": {
"type": "integer",
"format": "int64",
"description": "Playback duration"
},
"storageDurationSeconds": {
"type": "integer",
"format": "int64",
"description": "Storage duration"
}
},
"type": "object",
"required": [
"playbackDurationSeconds",
"storageDurationSeconds"
]
},
"ContentKeyPolicyFairPlayConfiguration": {
"x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyFairPlayConfiguration",
"allOf": [
{
"$ref": "#/definitions/ContentKeyPolicyConfiguration"
}
],
"properties": {
"ask": {
"type": "string",
"format": "byte",
"description": "The key that must be used as FairPlay Application Secret key.",
"x-nullable": true
},
"fairPlayPfxPassword": {
"type": "string",
"description": "The password encrypting FairPlay certificate in PKCS 12 (pfx) format.",
"x-nullable": true
},
"fairPlayPfx": {
"type": "string",
"description": "The Base64 representation of FairPlay certificate in PKCS 12 (pfx) format (including private key).",
"x-nullable": true
},
"rentalAndLeaseKeyType": {
"type": "string",
"enum": [
"Unknown",
"Undefined",
"DualExpiry",
"PersistentUnlimited",
"PersistentLimited"
],
"x-ms-enum": {
"name": "ContentKeyPolicyFairPlayRentalAndLeaseKeyType",
"values": [
{
"value": "Unknown",
"description": "Represents a ContentKeyPolicyFairPlayRentalAndLeaseKeyType that is unavailable in current API version."
},
{
"value": "Undefined",
"description": "Key duration is not specified."
},
{
"value": "DualExpiry",
"description": "Dual expiry for offline rental."
},
{
"value": "PersistentUnlimited",
"description": "Content key can be persisted with an unlimited duration"
},
{
"value": "PersistentLimited",
"description": "Content key can be persisted and the valid duration is limited by the Rental Duration value"
}
],
"modelAsString": true
},
"description": "The rental and lease key type."
},
"rentalDuration": {
"type": "integer",
"format": "int64",
"description": "The rental duration. Must be greater than or equal to 0."
},
"offlineRentalConfiguration": {
"$ref": "#/definitions/ContentKeyPolicyFairPlayOfflineRentalConfiguration",
"description": "Offline rental policy"
}
},
"type": "object",
"required": [
"ask",
"fairPlayPfxPassword",
"fairPlayPfx",
"rentalAndLeaseKeyType",
"rentalDuration"
],
"description": "Specifies a configuration for FairPlay licenses."
},
"ContentKeyPolicyOption": {
"properties": {
"policyOptionId": {
"type": "string",
"format": "uuid",
"description": "The legacy Policy Option ID.",
"readOnly": true,
"x-nullable": false
},
"name": {
"type": "string",
"description": "The Policy Option description."
},
"configuration": {
"$ref": "#/definitions/ContentKeyPolicyConfiguration",
"description": "The key delivery configuration."
},
"restriction": {
"$ref": "#/definitions/ContentKeyPolicyRestriction",
"description": "The requirements that must be met to deliver keys with this configuration"
}
},
"type": "object",
"required": [
"configuration",
"restriction"
],
"description": "Represents a policy option."
},
"ContentKeyPolicyProperties": {
"properties": {
"policyId": {
"type": "string",
"format": "uuid",
"description": "The legacy Policy ID.",
"readOnly": true,
"x-nullable": false
},
"created": {
"type": "string",
"format": "date-time",
"description": "The creation date of the Policy",
"readOnly": true,
"x-nullable": false
},
"lastModified": {
"type": "string",
"format": "date-time",
"description": "The last modified date of the Policy",
"readOnly": true,
"x-nullable": false
},
"description": {
"type": "string",
"description": "A description for the Policy."
},
"options": {
"type": "array",
"items": {
"$ref": "#/definitions/ContentKeyPolicyOption"
},
"x-ms-identifiers": [
"policyOptionId"
],
"description": "The Key Policy options."
}
},
"type": "object",
"required": [
"options"
],
"description": "The properties of the Content Key Policy."
},
"ContentKeyPolicy": {
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource"
}
],
"properties": {
"properties": {
"$ref": "#/definitions/ContentKeyPolicyProperties",
"x-ms-client-flatten": true
},
"systemData": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
"description": "The system metadata relating to this resource.",
"readOnly": true
}
},
"type": "object",
"description": "A Content Key Policy resource."
},
"ContentKeyPolicyCollection": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/ContentKeyPolicy"
},
"description": "A collection of ContentKeyPolicy items."
},
"@odata.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 ContentKeyPolicy items."
}
},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies": {
"get": {
"summary": "List Content Key Policies",
"description": "Lists the Content Key Policies in the account",
"operationId": "ContentKeyPolicies_List",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ContentKeyPolicyCollection"
}
},
"default": {
"description": "Detailed error information.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
"parameters": [
{
"$ref": "#/parameters/SubscriptionId"
},
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/MediaServicesAccountName"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"name": "$filter",
"in": "query",
"required": false,
"type": "string",
"description": "Restricts the set of items returned."
},
{
"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."
},
{
"name": "$orderby",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies the key by which the result collection should be ordered."
}
],
"x-ms-pageable": {
"nextLinkName": "@odata.nextLink"
},
"x-ms-odata": "#/definitions/ContentKeyPolicy",
"x-ms-examples": {
"Lists all Content Key Policies": {
"$ref": "examples/content-key-policies-list-all.json"
},
"Lists Content Key Policies ordered by last modified.": {
"$ref": "examples/content-key-policies-list-by-lastModified.json"
},
"Lists Content Key Policies with created and last modified filters.": {
"$ref": "examples/content-key-policies-list-in-date-range.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}": {
"get": {
"summary": "Get a Content Key Policy",
"description": "Get the details of a Content Key Policy in the Media Services account",
"operationId": "ContentKeyPolicies_Get",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ContentKeyPolicy"
}
},
"default": {
"description": "Detailed error information.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
"parameters": [
{
"$ref": "#/parameters/SubscriptionId"
},
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/MediaServicesAccountName"
},
{
"name": "contentKeyPolicyName",
"in": "path",
"required": true,
"type": "string",
"description": "The Content Key Policy name."
},
{
"$ref": "#/parameters/ApiVersion"
}
],
"x-ms-examples": {
"Get a Content Key Policy by name": {
"$ref": "examples/content-key-policies-get-by-name.json"
}
}
},
"put": {
"summary": "Create or update an Content Key Policy",
"description": "Create or update a Content Key Policy in the Media Services account",
"operationId": "ContentKeyPolicies_CreateOrUpdate",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ContentKeyPolicy"
}
},
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/ContentKeyPolicy"
}
},
"default": {
"description": "Detailed error information.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
"parameters": [
{
"$ref": "#/parameters/SubscriptionId"
},
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/MediaServicesAccountName"
},
{
"name": "contentKeyPolicyName",
"in": "path",
"required": true,
"type": "string",
"description": "The Content Key Policy name."
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ContentKeyPolicy"
},
"description": "The request parameters"
},
{
"$ref": "#/parameters/ApiVersion"
}
],
"x-ms-examples": {
"Creates a Content Key Policy with PlayReady option and Open Restriction": {
"$ref": "examples/content-key-policies-create-playready-open.json"
},
"Creates a Content Key Policy with Widevine option and Token Restriction": {
"$ref": "examples/content-key-policies-create-widevine-token.json"
},
"Creates a Content Key Policy with ClearKey option and Token Restriction": {
"$ref": "examples/content-key-policies-create-nodrm-token.json"
},
"Creates a Content Key Policy with multiple options": {
"$ref": "examples/content-key-policies-create-multiple-options.json"
}
}
},
"delete": {
"summary": "Delete a Content Key Policy",
"description": "Deletes a Content Key Policy in the Media Services account",
"operationId": "ContentKeyPolicies_Delete",
"responses": {
"200": {