@datafire/azure_mediaservices_contentkeypolicies

Client library for Azure Media Services

Installation and Usage

npm install --save @datafire/azure_mediaservices_contentkeypolicies

let azure_mediaservices_contentkeypolicies = require('@datafire/azure_mediaservices_contentkeypolicies').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

This Swagger was generated by the API Framework.

Actions

ContentKeyPolicies_List

Lists the Content Key Policies in the account

azure_mediaservices_contentkeypolicies.ContentKeyPolicies_List({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • api-version required string: The Version of the API to be used with the client request.
  • $filter string: Restricts the set of items returned.
  • $top integer: 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.
  • $orderby string: Specifies the key by which the result collection should be ordered.

Output

• output ContentKeyPolicyCollection

ContentKeyPolicies_Delete

Deletes a Content Key Policy in the Media Services account

azure_mediaservices_contentkeypolicies.ContentKeyPolicies_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "contentKeyPolicyName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • contentKeyPolicyName required string: The Content Key Policy name.
  • api-version required string: The Version of the API to be used with the client request.

Output

Output schema unknown

ContentKeyPolicies_Get

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

azure_mediaservices_contentkeypolicies.ContentKeyPolicies_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "contentKeyPolicyName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • contentKeyPolicyName required string: The Content Key Policy name.
  • api-version required string: The Version of the API to be used with the client request.

Output

• output ContentKeyPolicy

ContentKeyPolicies_Update

Updates an existing Content Key Policy in the Media Services account

azure_mediaservices_contentkeypolicies.ContentKeyPolicies_Update({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "contentKeyPolicyName": "",
  "parameters": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • contentKeyPolicyName required string: The Content Key Policy name.
  • parameters required ContentKeyPolicy
  • api-version required string: The Version of the API to be used with the client request.

Output

• output ContentKeyPolicy

ContentKeyPolicies_CreateOrUpdate

Create or update a Content Key Policy in the Media Services account

azure_mediaservices_contentkeypolicies.ContentKeyPolicies_CreateOrUpdate({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "contentKeyPolicyName": "",
  "parameters": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • contentKeyPolicyName required string: The Content Key Policy name.
  • parameters required ContentKeyPolicy
  • api-version required string: The Version of the API to be used with the client request.

Output

• output ContentKeyPolicy

ContentKeyPolicies_GetPolicyPropertiesWithSecrets

Get a Content Key Policy including secret values

azure_mediaservices_contentkeypolicies.ContentKeyPolicies_GetPolicyPropertiesWithSecrets({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "contentKeyPolicyName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • contentKeyPolicyName required string: The Content Key Policy name.
  • api-version required string: The Version of the API to be used with the client request.

Output

• output ContentKeyPolicyProperties

Definitions

ApiError

• ApiError object: The API error.
  • error ODataError

ContentKeyPolicy

• ContentKeyPolicy object: A Content Key Policy resource.
  • properties ContentKeyPolicyProperties
  • id string: Fully qualified resource ID for the resource.
  • name string: The name of the resource.
  • type string: The type of the resource.

ContentKeyPolicyClearKeyConfiguration

• ContentKeyPolicyClearKeyConfiguration object: Represents a configuration for non-DRM keys.
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyCollection

• ContentKeyPolicyCollection object: A collection of ContentKeyPolicy items.
  • @odata.nextLink string: A link to the next page of the collection (when the collection contains too many results to return in one response).
  • value array: A collection of ContentKeyPolicy items.
    • items ContentKeyPolicy

ContentKeyPolicyConfiguration

• ContentKeyPolicyConfiguration object: Base class for Content Key Policy configuration. A derived class must be used to create a configuration.
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyFairPlayConfiguration

• ContentKeyPolicyFairPlayConfiguration object: Specifies a configuration for FairPlay licenses.
  • ask required string: The key that must be used as FairPlay Application Secret key.
  • fairPlayPfx required string: The Base64 representation of FairPlay certificate in PKCS 12 (pfx) format (including private key).
  • fairPlayPfxPassword required string: The password encrypting FairPlay certificate in PKCS 12 (pfx) format.
  • rentalAndLeaseKeyType required string (values: Unknown, Undefined, PersistentUnlimited, PersistentLimited): The rental and lease key type.
  • rentalDuration required integer: The rental duration. Must be greater than or equal to 0.
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyOpenRestriction

• ContentKeyPolicyOpenRestriction object: Represents an open restriction. License or key will be delivered on every request.
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyOption

• ContentKeyPolicyOption object: Represents a policy option.
  • configuration required ContentKeyPolicyConfiguration
  • name string: The Policy Option description.
  • policyOptionId string: The legacy Policy Option ID.
  • restriction required ContentKeyPolicyRestriction

ContentKeyPolicyPlayReadyConfiguration

• ContentKeyPolicyPlayReadyConfiguration object: Specifies a configuration for PlayReady licenses.
  • licenses required array: The PlayReady licenses.
    • items ContentKeyPolicyPlayReadyLicense
  • responseCustomData string: The custom response data.
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader

• ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader object: Specifies that the content key ID is in the PlayReady header.
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier

• ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier object: Specifies that the content key ID is specified in the PlayReady configuration.
  • keyId required string: The content key ID.
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyPlayReadyContentKeyLocation

• ContentKeyPolicyPlayReadyContentKeyLocation object: Base class for content key ID location. A derived class must be used to represent the location.
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction

• ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction object: Configures the Explicit Analog Television Output Restriction control bits. For further details see the PlayReady Compliance Rules.
  • bestEffort required boolean: Indicates whether this restriction is enforced on a Best Effort basis.
  • configurationData required integer: Configures the restriction control bits. Must be between 0 and 3 inclusive.

ContentKeyPolicyPlayReadyLicense

• ContentKeyPolicyPlayReadyLicense object: The PlayReady license
  • allowTestDevices required boolean: A flag indicating whether test devices can use the license.
  • beginDate string: The begin date of license
  • contentKeyLocation required ContentKeyPolicyPlayReadyContentKeyLocation
  • contentType required string (values: Unknown, Unspecified, UltraVioletDownload, UltraVioletStreaming): The PlayReady content type.
  • expirationDate string: The expiration date of license.
  • gracePeriod string: The grace period of license.
  • licenseType required string (values: Unknown, NonPersistent, Persistent): The license type.
  • playRight ContentKeyPolicyPlayReadyPlayRight
  • relativeBeginDate string: The relative begin date of license.
  • relativeExpirationDate string: The relative expiration date of license.

ContentKeyPolicyPlayReadyPlayRight

• ContentKeyPolicyPlayReadyPlayRight object: Configures the Play Right in the PlayReady license.
  • agcAndColorStripeRestriction integer: Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive.
  • allowPassingVideoContentToUnknownOutput required string (values: Unknown, NotAllowed, Allowed, AllowedWithVideoConstriction): 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 required boolean: Enables the Image Constraint For Analog Component Video Restriction in the license.
  • explicitAnalogTelevisionOutputRestriction ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction
  • firstPlayExpiration string: The amount of time that the license is valid after the license is first used to play content.
  • imageConstraintForAnalogComponentVideoRestriction required boolean: Enables the Image Constraint For Analog Component Video Restriction in the license.
  • imageConstraintForAnalogComputerMonitorRestriction required 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.

ContentKeyPolicyProperties

• ContentKeyPolicyProperties object: The properties of the Content Key Policy.
  • created string: The creation date of the Policy
  • description string: A description for the Policy.
  • lastModified string: The last modified date of the Policy
  • options required array: The Key Policy options.
    • items ContentKeyPolicyOption
  • policyId string: The legacy Policy ID.

ContentKeyPolicyRestriction

• ContentKeyPolicyRestriction object: Base class for Content Key Policy restrictions. A derived class must be used to create a restriction.
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyRestrictionTokenKey

• ContentKeyPolicyRestrictionTokenKey object: Base class for Content Key Policy key for token validation. A derived class must be used to create a token key.
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyRsaTokenKey

• ContentKeyPolicyRsaTokenKey object: Specifies a RSA key for token validation
  • exponent required string: The RSA Parameter exponent
  • modulus required string: The RSA Parameter modulus
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicySymmetricTokenKey

• ContentKeyPolicySymmetricTokenKey object: Specifies a symmetric key for token validation.
  • keyValue required string: The key value of the key
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyTokenClaim

• ContentKeyPolicyTokenClaim object: Represents a token claim.
  • claimType string: Token claim type.
  • claimValue string: Token claim value.

ContentKeyPolicyTokenRestriction

• ContentKeyPolicyTokenRestriction object: Represents a token restriction. Provided token must match these requirements for successful license or key delivery.
  • alternateVerificationKeys array: A list of alternative verification keys.
    • items ContentKeyPolicyRestrictionTokenKey
  • audience required string: The audience for the token.
  • issuer required string: The token issuer.
  • openIdConnectDiscoveryDocument string: The OpenID connect discovery document.
  • primaryVerificationKey required ContentKeyPolicyRestrictionTokenKey
  • requiredClaims array: A list of required token claims.
    • items ContentKeyPolicyTokenClaim
  • restrictionTokenType required string (values: Unknown, Swt, Jwt): The type of token.
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyUnknownConfiguration

• ContentKeyPolicyUnknownConfiguration object: Represents a ContentKeyPolicyConfiguration that is unavailable in the current API version.
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyUnknownRestriction

• ContentKeyPolicyUnknownRestriction object: Represents a ContentKeyPolicyRestriction that is unavailable in the current API version.
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyWidevineConfiguration

• ContentKeyPolicyWidevineConfiguration object: Specifies a configuration for Widevine licenses.
  • widevineTemplate required string: The Widevine template.
  • @odata.type required string: The discriminator for derived types.

ContentKeyPolicyX509CertificateTokenKey

• ContentKeyPolicyX509CertificateTokenKey object: Specifies a certificate for token validation.
  • rawBody required string: The raw data field of a certificate in PKCS 12 format (X509Certificate2 in .NET)
  • @odata.type required string: The discriminator for derived types.

ODataError

• ODataError object: Information about an error.
  • code string: A language-independent error name.
  • details array: The error details.
    • items ODataError
  • message string: The error message.
  • target string: The target of the error (for example, the name of the property in error).