Content Key Policies - Get

Get a Content Key Policy
Get the details of a Content Key Policy in the Media Services account

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}?api-version=2022-08-01

URI Parameters

Name In Required Type Description
accountName
path True

string

The Media Services account name.

contentKeyPolicyName
path True

string

The Content Key Policy name.

resourceGroupName
path True

string

The name of the resource group within the Azure subscription.

subscriptionId
path True

string

The unique identifier for a Microsoft Azure subscription.

api-version
query True

string

The version of the API to be used with the client request.

Responses

Name Type Description
200 OK

ContentKeyPolicy

OK

Other Status Codes

ErrorResponse

Detailed error information.

Examples

Get a Content Key Policy by name

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions?api-version=2022-08-01

Sample response

{
  "name": "PolicyWithMultipleOptions",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions",
  "type": "Microsoft.Media/mediaservices/contentKeyPolicies",
  "properties": {
    "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a",
    "created": "2015-12-01T00:00:00Z",
    "lastModified": "2016-12-02T00:00:00Z",
    "description": "A policy with multiple options.",
    "options": [
      {
        "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f",
        "configuration": {
          "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration"
        },
        "restriction": {
          "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction",
          "issuer": "http://testacs",
          "audience": "urn:test",
          "primaryVerificationKey": {
            "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey",
            "keyValue": ""
          },
          "alternateVerificationKeys": [],
          "requiredClaims": [
            {
              "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier"
            },
            {
              "claimType": "DRM",
              "claimValue": "Widevine"
            }
          ],
          "restrictionTokenType": "Jwt"
        }
      },
      {
        "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f",
        "configuration": {
          "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration",
          "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}"
        },
        "restriction": {
          "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction"
        }
      }
    ]
  }
}

Definitions

Name Description
ContentKeyPolicy

A Content Key Policy resource.

ContentKeyPolicyClearKeyConfiguration

Represents a configuration for non-DRM keys.

ContentKeyPolicyFairPlayConfiguration

Specifies a configuration for FairPlay licenses.

ContentKeyPolicyFairPlayOfflineRentalConfiguration
ContentKeyPolicyFairPlayRentalAndLeaseKeyType

The rental and lease key type.

ContentKeyPolicyOpenRestriction

Represents an open restriction. License or key will be delivered on every request.

ContentKeyPolicyOption

Represents a policy option.

ContentKeyPolicyPlayReadyConfiguration

Specifies a configuration for PlayReady licenses.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader

Specifies that the content key ID is in the PlayReady header.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier

Specifies that the content key ID is specified in the PlayReady configuration.

ContentKeyPolicyPlayReadyContentType

The PlayReady content type.

ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction

Configures the Explicit Analog Television Output Restriction control bits. For further details see the PlayReady Compliance Rules.

ContentKeyPolicyPlayReadyLicense

The PlayReady license

ContentKeyPolicyPlayReadyLicenseType

The license type.

ContentKeyPolicyPlayReadyPlayRight

Configures the Play Right in the PlayReady license.

ContentKeyPolicyPlayReadyUnknownOutputPassingOption

Configures Unknown output handling settings of the license.

ContentKeyPolicyRestrictionTokenType

The type of token.

ContentKeyPolicyRsaTokenKey

Specifies a RSA key for token validation

ContentKeyPolicySymmetricTokenKey

Specifies a symmetric key for token validation.

ContentKeyPolicyTokenClaim

Represents a token claim.

ContentKeyPolicyTokenRestriction

Represents a token restriction. Provided token must match these requirements for successful license or key delivery.

ContentKeyPolicyUnknownConfiguration

Represents a ContentKeyPolicyConfiguration that is unavailable in the current API version.

ContentKeyPolicyUnknownRestriction

Represents a ContentKeyPolicyRestriction that is unavailable in the current API version.

ContentKeyPolicyWidevineConfiguration

Specifies a configuration for Widevine licenses.

ContentKeyPolicyX509CertificateTokenKey

Specifies a certificate for token validation.

createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

SecurityLevel

The security level.

systemData

Metadata pertaining to creation and last modification of the resource.

ContentKeyPolicy

A Content Key Policy resource.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties.created

string

The creation date of the Policy

properties.description

string

A description for the Policy.

properties.lastModified

string

The last modified date of the Policy

properties.options

ContentKeyPolicyOption[]

The Key Policy options.

properties.policyId

string

The legacy Policy ID.

systemData

systemData

The system metadata relating to this resource.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ContentKeyPolicyClearKeyConfiguration

Represents a configuration for non-DRM keys.

Name Type Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration

The discriminator for derived types.

ContentKeyPolicyFairPlayConfiguration

Specifies a configuration for FairPlay licenses.

Name Type Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyFairPlayConfiguration

The discriminator for derived types.

ask

string

The key that must be used as FairPlay Application Secret key. This needs to be base64 encoded.

fairPlayPfx

string

The Base64 representation of FairPlay certificate in PKCS 12 (pfx) format (including private key).

fairPlayPfxPassword

string

The password encrypting FairPlay certificate in PKCS 12 (pfx) format.

offlineRentalConfiguration

ContentKeyPolicyFairPlayOfflineRentalConfiguration

Offline rental policy

rentalAndLeaseKeyType

ContentKeyPolicyFairPlayRentalAndLeaseKeyType

The rental and lease key type.

rentalDuration

integer

The rental duration. Must be greater than or equal to 0.

ContentKeyPolicyFairPlayOfflineRentalConfiguration

Name Type Description
playbackDurationSeconds

integer

Playback duration

storageDurationSeconds

integer

Storage duration

ContentKeyPolicyFairPlayRentalAndLeaseKeyType

The rental and lease key type.

Name Type Description
DualExpiry

string

Dual expiry for offline rental.

PersistentLimited

string

Content key can be persisted and the valid duration is limited by the Rental Duration value

PersistentUnlimited

string

Content key can be persisted with an unlimited duration

Undefined

string

Key duration is not specified.

Unknown

string

Represents a ContentKeyPolicyFairPlayRentalAndLeaseKeyType that is unavailable in current API version.

ContentKeyPolicyOpenRestriction

Represents an open restriction. License or key will be delivered on every request.

Name Type Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyOpenRestriction

The discriminator for derived types.

ContentKeyPolicyOption

Represents a policy option.

Name Type Description
configuration ContentKeyPolicyConfiguration:

The key delivery configuration.

name

string

The Policy Option description.

policyOptionId

string

The legacy Policy Option ID.

restriction ContentKeyPolicyRestriction:

The requirements that must be met to deliver keys with this configuration

ContentKeyPolicyPlayReadyConfiguration

Specifies a configuration for PlayReady licenses.

Name Type Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration

The discriminator for derived types.

licenses

ContentKeyPolicyPlayReadyLicense[]

The PlayReady licenses.

responseCustomData

string

The custom response data.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader

Specifies that the content key ID is in the PlayReady header.

Name Type Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader

The discriminator for derived types.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier

Specifies that the content key ID is specified in the PlayReady configuration.

Name Type Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier

The discriminator for derived types.

keyId

string

The content key ID.

ContentKeyPolicyPlayReadyContentType

The PlayReady content type.

Name Type Description
UltraVioletDownload

string

Ultraviolet download content type.

UltraVioletStreaming

string

Ultraviolet streaming content type.

Unknown

string

Represents a ContentKeyPolicyPlayReadyContentType that is unavailable in current API version.

Unspecified

string

Unspecified content type.

ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction

Configures the Explicit Analog Television Output Restriction control bits. For further details see the PlayReady Compliance Rules.

Name Type Description
bestEffort

boolean

Indicates whether this restriction is enforced on a Best Effort basis.

configurationData

integer

Configures the restriction control bits. Must be between 0 and 3 inclusive.

ContentKeyPolicyPlayReadyLicense

The PlayReady license

Name Type Description
allowTestDevices

boolean

A flag indicating whether test devices can use the license.

beginDate

string

The begin date of license

contentKeyLocation ContentKeyPolicyPlayReadyContentKeyLocation:

The content key location.

contentType

ContentKeyPolicyPlayReadyContentType

The PlayReady content type.

expirationDate

string

The expiration date of license.

gracePeriod

string

The grace period of license.

licenseType

ContentKeyPolicyPlayReadyLicenseType

The license type.

playRight

ContentKeyPolicyPlayReadyPlayRight

The license PlayRight

relativeBeginDate

string

The relative begin date of license.

relativeExpirationDate

string

The relative expiration date of license.

securityLevel

SecurityLevel

The security level.

ContentKeyPolicyPlayReadyLicenseType

The license type.

Name Type Description
NonPersistent

string

Non persistent license.

Persistent

string

Persistent license. Allows offline playback.

Unknown

string

Represents a ContentKeyPolicyPlayReadyLicenseType that is unavailable in current API version.

ContentKeyPolicyPlayReadyPlayRight

Configures the Play Right in the PlayReady license.

Name Type Description
agcAndColorStripeRestriction

integer

Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive.

allowPassingVideoContentToUnknownOutput

ContentKeyPolicyPlayReadyUnknownOutputPassingOption

Configures Unknown output handling settings of the license.

analogVideoOpl

integer

Specifies the output protection level for compressed digital audio.

compressedDigitalAudioOpl

integer

Specifies the output protection level for compressed digital audio.

compressedDigitalVideoOpl

integer

Specifies the output protection level for compressed digital video.

digitalVideoOnlyContentRestriction

boolean

Enables the Image Constraint For Analog Component Video Restriction in the license.

explicitAnalogTelevisionOutputRestriction

ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction

Configures the Explicit Analog Television Output Restriction in the license. Configuration data must be between 0 and 3 inclusive.

firstPlayExpiration

string

The amount of time that the license is valid after the license is first used to play content.

imageConstraintForAnalogComponentVideoRestriction

boolean

Enables the Image Constraint For Analog Component Video Restriction in the license.

imageConstraintForAnalogComputerMonitorRestriction

boolean

Enables the Image Constraint For Analog Component Video Restriction in the license.

scmsRestriction

integer

Configures the Serial Copy Management System (SCMS) in the license. Must be between 0 and 3 inclusive.

uncompressedDigitalAudioOpl

integer

Specifies the output protection level for uncompressed digital audio.

uncompressedDigitalVideoOpl

integer

Specifies the output protection level for uncompressed digital video.

ContentKeyPolicyPlayReadyUnknownOutputPassingOption

Configures Unknown output handling settings of the license.

Name Type Description
Allowed

string

Passing the video portion of protected content to an Unknown Output is allowed.

AllowedWithVideoConstriction

string

Passing the video portion of protected content to an Unknown Output is allowed but with constrained resolution.

NotAllowed

string

Passing the video portion of protected content to an Unknown Output is not allowed.

Unknown

string

Represents a ContentKeyPolicyPlayReadyUnknownOutputPassingOption that is unavailable in current API version.

ContentKeyPolicyRestrictionTokenType

The type of token.

Name Type Description
Jwt

string

JSON Web Token.

Swt

string

Simple Web Token.

Unknown

string

Represents a ContentKeyPolicyRestrictionTokenType that is unavailable in current API version.

ContentKeyPolicyRsaTokenKey

Specifies a RSA key for token validation

Name Type Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyRsaTokenKey

The discriminator for derived types.

exponent

string

The RSA Parameter exponent

modulus

string

The RSA Parameter modulus

ContentKeyPolicySymmetricTokenKey

Specifies a symmetric key for token validation.

Name Type Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicySymmetricTokenKey

The discriminator for derived types.

keyValue

string

The key value of the key

ContentKeyPolicyTokenClaim

Represents a token claim.

Name Type Description
claimType

string

Token claim type.

claimValue

string

Token claim value.

ContentKeyPolicyTokenRestriction

Represents a token restriction. Provided token must match these requirements for successful license or key delivery.

Name Type Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyTokenRestriction

The discriminator for derived types.

alternateVerificationKeys ContentKeyPolicyRestrictionTokenKey[]:

A list of alternative verification keys.

audience

string

The audience for the token.

issuer

string

The token issuer.

openIdConnectDiscoveryDocument

string

The OpenID connect discovery document.

primaryVerificationKey ContentKeyPolicyRestrictionTokenKey:

The primary verification key.

requiredClaims

ContentKeyPolicyTokenClaim[]

A list of required token claims.

restrictionTokenType

ContentKeyPolicyRestrictionTokenType

The type of token.

ContentKeyPolicyUnknownConfiguration

Represents a ContentKeyPolicyConfiguration that is unavailable in the current API version.

Name Type Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyUnknownConfiguration

The discriminator for derived types.

ContentKeyPolicyUnknownRestriction

Represents a ContentKeyPolicyRestriction that is unavailable in the current API version.

Name Type Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyUnknownRestriction

The discriminator for derived types.

ContentKeyPolicyWidevineConfiguration

Specifies a configuration for Widevine licenses.

Name Type Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyWidevineConfiguration

The discriminator for derived types.

widevineTemplate

string

The Widevine template.

ContentKeyPolicyX509CertificateTokenKey

Specifies a certificate for token validation.

Name Type Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKey

The discriminator for derived types.

rawBody

string

The raw data field of a certificate in PKCS 12 format (X509Certificate2 in .NET)

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

SecurityLevel

The security level.

Name Type Description
SL150

string

For clients under development or test. No protection against unauthorized use.

SL2000

string

For hardened devices and applications consuming commercial content. Software or hardware protection.

SL3000

string

For hardened devices only. Hardware protection.

Unknown

string

Represents a SecurityLevel that is unavailable in current API version.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.