Get

Get one Content Key Policy

RBAC Capability Required: ams.contentkeypolicy.get

Authentication

Authorization Bearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

• project_name: string (Required)
• policy_name: string (Required)

Response

200 - Returns a single Content Key Policy

• id: string (Optional)
  Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

• name: string (Optional) (1-260 characters) pattern: ^[^\'<>%&:\?/*+]+$
  The name of the resource

• properties: object ContentKeyPolicyProperties (Required)
  The key policy.

Properties

• created: string (Optional) format: date-time
  The creation date of the Policy

• description: string (Optional) (0-1024 characters)
  A description for the Policy.

• fairPlayAmsCompatibility: boolean (Optional)
  FairPlay AMS compatibility enabled.

• lastModified: string (Optional) format: date-time
  The last modified date of the Policy

• options: list of objects ContentKeyPolicyOption (Required)
  The Key Policy options.

Configuration

• configuration: object (Required)
  The key delivery configuration.
  • @odata.type: string (Required)

Variants

1. Microsoft.Media.ContentKeyPolicyClearKeyConfiguration
   Represents a configuration for non-DRM keys.

2. Microsoft.Media.ContentKeyPolicyFairPlayConfiguration
   Specifies a configuration for FairPlay licenses.

   • ask: string or null (Required) format: byte
   • fairPlayPfx: string or null (Required)
   • fairPlayPfxPassword: string or null (Required)

3. Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration
   Specifies a configuration for PlayReady licenses.

4. Microsoft.Media.ContentKeyPolicyWidevineConfiguration
   Specifies a configuration for Widevine licenses.

   • widevineTemplate: string (Required)

• ** licenses**: list of objects ContentKeyPolicyPlayReadyLicense (Required)
  The PlayReady licenses.

Errors

400 - Bad Request

• error: object ErrorDetail (Required)
  Pertinent information about the error
  • code: string (Required)
  • detail: string (Required)
  • ref: string (Required)
  • status: integer (Required)

401 - Unauthorized

• error: object ErrorDetail (Required)

403 - Forbidden

• error: object ErrorDetail (Required)

404 - Not Found

• error: object ErrorDetail (Required)

429 - Too Many Requests

• error: object ErrorDetail (Required)

500 - Internal Server Error

• error: object ErrorDetail (Required)