ContentKeyPolicyOption
object
Represents a policy option.
configurationobjectRequired
The key delivery configuration.
Show 5 variantsHide 5 variants
Discriminated by @odata.type. Select one variant:
#Microsoft.Media.ContentKeyPolicyClearKeyConfigurationobjectContentKeyPolicyClearKeyConfiguration
Represents a configuration for non-DRM keys.
@odata.typestringRequired
The discriminator for derived types.
#Microsoft.Media.ContentKeyPolicyFairPlayConfigurationobjectContentKeyPolicyFairPlayConfiguration
Specifies a configuration for FairPlay licenses.
@odata.typestringRequired
The discriminator for derived types.
askstring or nullRequiredformat: byte
The key that must be used as FairPlay Application Secret key. This needs to be base64 encoded.
fairPlayPfxstring or nullRequired
The Base64 representation of FairPlay certificate in PKCS 12 (pfx) format (including private key).
fairPlayPfxPasswordstring or nullRequired
The password encrypting FairPlay certificate in PKCS 12 (pfx) format.
Offline rental policy
Show 2 propertiesHide 2 properties
playbackDurationSecondsintegerRequired
Playback duration
storageDurationSecondsintegerRequired
Storage duration
rentalAndLeaseKeyTypeenumRequired
The rental and lease key type.
Allowed values:UnknownUndefinedDualExpiryPersistentUnlimitedPersistentLimited
rentalDurationintegerRequired
The rental duration. Must be greater than or equal to 0.
#Microsoft.Media.ContentKeyPolicyPlayReadyConfigurationobjectContentKeyPolicyPlayReadyConfiguration
Specifies a configuration for PlayReady licenses.
@odata.typestringRequired
The discriminator for derived types.
The PlayReady licenses.
Show 11 propertiesHide 11 properties
allowTestDevicesbooleanRequired
A flag indicating whether test devices can use the license.
beginDatestringOptionalformat: date-time
The begin date of license
contentKeyLocationobjectRequired
The content key location.
Show 2 variantsHide 2 variants
Discriminated by @odata.type. Select one variant:
#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeaderobjectContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader
Specifies that the content key ID is in the PlayReady header.
@odata.typestringRequired
The discriminator for derived types.
#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifierobjectContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier
Specifies that the content key ID is specified in the PlayReady configuration.
@odata.typestringRequired
The discriminator for derived types.
keyIdstring or nullRequiredformat: uuid
The content key ID.
contentTypeenumRequired
The PlayReady content type.
Allowed values:UnknownUnspecifiedUltraVioletDownloadUltraVioletStreaming
expirationDatestringOptionalformat: date-time
The expiration date of license.
gracePeriodstringOptionalformat: duration
The grace period of license.
licenseTypeenumRequired
The license type.
Allowed values:UnknownNonPersistentPersistent
The license PlayRight
Show 13 propertiesHide 13 properties
agcAndColorStripeRestrictionintegerOptional0 to 3
Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive.
allowPassingVideoContentToUnknownOutputenumRequired
Configures Unknown output handling settings of the license.
Allowed values:UnknownNotAllowedAllowedAllowedWithVideoConstriction
analogVideoOplintegerOptional
Specifies the output protection level for compressed digital audio.
compressedDigitalAudioOplintegerOptional
Specifies the output protection level for compressed digital audio.
compressedDigitalVideoOplintegerOptional
Specifies the output protection level for compressed digital video.
digitalVideoOnlyContentRestrictionbooleanRequired
Enables the Image Constraint For Analog Component Video Restriction in the license.
explicitAnalogTelevisionOutputRestrictionobjectContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestrictionOptional
Configures the Explicit Analog Television Output Restriction in the license. Configuration data must be between 0 and 3 inclusive.
Show 2 propertiesHide 2 properties
bestEffortbooleanRequired
Indicates whether this restriction is enforced on a Best Effort basis.
configurationDataintegerRequired0 to 3
Configures the restriction control bits. Must be between 0 and 3 inclusive.
firstPlayExpirationstringOptionalformat: duration
The amount of time that the license is valid after the license is first used to play content.
imageConstraintForAnalogComponentVideoRestrictionbooleanRequired
Enables the Image Constraint For Analog Component Video Restriction in the license.
imageConstraintForAnalogComputerMonitorRestrictionbooleanRequired
Enables the Image Constraint For Analog Component Video Restriction in the license.
scmsRestrictionintegerOptional0 to 3
Configures the Serial Copy Management System (SCMS) in the license. Must be between 0 and 3 inclusive.
uncompressedDigitalAudioOplintegerOptional
Specifies the output protection level for uncompressed digital audio.
uncompressedDigitalVideoOplintegerOptional
Specifies the output protection level for uncompressed digital video.
relativeBeginDatestringOptionalformat: duration
The relative begin date of license.
relativeExpirationDatestringOptionalformat: duration
The relative expiration date of license.
securityLevelenumOptional
The security level.
Allowed values:UnknownSL150SL2000SL3000
responseCustomDatastringOptional
The custom response data.
#Microsoft.Media.ContentKeyPolicyUnknownConfigurationobjectContentKeyPolicyUnknownConfiguration
Represents a ContentKeyPolicyConfiguration that is unavailable in the current API version.
@odata.typestringRequired
The discriminator for derived types.
#Microsoft.Media.ContentKeyPolicyWidevineConfigurationobjectContentKeyPolicyWidevineConfiguration
Specifies a configuration for Widevine licenses.
@odata.typestringRequired
The discriminator for derived types.
widevineTemplatestringRequired
The Widevine template.
namestringOptional
The Policy Option description.
policyOptionIdstringOptionalformat: uuid
The legacy Policy Option ID.
restrictionobjectRequired
The requirements that must be met to deliver keys with this configuration
Show 3 variantsHide 3 variants
Discriminated by @odata.type. Select one variant:
#Microsoft.Media.ContentKeyPolicyOpenRestrictionobjectContentKeyPolicyOpenRestriction
Represents an open restriction. License or key will be delivered on every request.
@odata.typestringRequired
The discriminator for derived types.
#Microsoft.Media.ContentKeyPolicyTokenRestrictionobjectContentKeyPolicyTokenRestriction
Represents a token restriction. Provided token must match these requirements for successful license or key delivery.
@odata.typestringRequired
The discriminator for derived types.
alternateVerificationKeyslist of objectsOptional
A list of alternative verification keys.
Show 3 variantsHide 3 variants
Discriminated by @odata.type. Select one variant:
#Microsoft.Media.ContentKeyPolicyRsaTokenKeyobjectContentKeyPolicyRsaTokenKey
Specifies a RSA key for token validation
@odata.typestringRequired
The discriminator for derived types.
exponentstring or nullRequiredformat: byte
The RSA Parameter exponent
modulusstring or nullRequiredformat: byte
The RSA Parameter modulus
#Microsoft.Media.ContentKeyPolicySymmetricTokenKeyobjectContentKeyPolicySymmetricTokenKey
Specifies a symmetric key for token validation.
@odata.typestringRequired
The discriminator for derived types.
keyValuestring or nullRequiredformat: byte
The key value of the key
#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKeyobjectContentKeyPolicyX509CertificateTokenKey
Specifies a certificate for token validation.
@odata.typestringRequired
The discriminator for derived types.
rawBodystring or nullRequiredformat: byte
The raw data field of a certificate in PKCS 12 format (X509Certificate2 in .NET)
audiencestringRequired
The audience for the token.
issuerstringRequired
The token issuer.
openIdConnectDiscoveryDocumentstringOptional
The OpenID connect discovery document.
primaryVerificationKeyobject or nullRequired
The primary verification key.
Show 3 variantsHide 3 variants
Discriminated by @odata.type. Select one variant:
#Microsoft.Media.ContentKeyPolicyRsaTokenKeyobjectContentKeyPolicyRsaTokenKey
Specifies a RSA key for token validation
@odata.typestringRequired
The discriminator for derived types.
exponentstring or nullRequiredformat: byte
The RSA Parameter exponent
modulusstring or nullRequiredformat: byte
The RSA Parameter modulus
#Microsoft.Media.ContentKeyPolicySymmetricTokenKeyobjectContentKeyPolicySymmetricTokenKey
Specifies a symmetric key for token validation.
@odata.typestringRequired
The discriminator for derived types.
keyValuestring or nullRequiredformat: byte
The key value of the key
#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKeyobjectContentKeyPolicyX509CertificateTokenKey
Specifies a certificate for token validation.
@odata.typestringRequired
The discriminator for derived types.
rawBodystring or nullRequiredformat: byte
The raw data field of a certificate in PKCS 12 format (X509Certificate2 in .NET)
A list of required token claims.
Show 2 propertiesHide 2 properties
claimTypestringOptional
Token claim type.
claimValuestringOptional
Token claim value.
restrictionTokenTypeenumRequired
The type of token.
Allowed values:UnknownSwtJwt
#Microsoft.Media.ContentKeyPolicyUnknownRestrictionobjectContentKeyPolicyUnknownRestriction
Represents a ContentKeyPolicyRestriction that is unavailable in the current API version.
@odata.typestringRequired
The discriminator for derived types.