Streaming Locators - List Content Keys

List Content Keys used by this Streaming Locator

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listContentKeys?api-version=2022-08-01

URI Parameters

Name In Required Type Description
accountName
path True

string

The Media Services account name.

resourceGroupName
path True

string

The name of the resource group within the Azure subscription.

streamingLocatorName
path True

string

The Streaming Locator name.

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

ListContentKeysResponse

OK

Other Status Codes

ErrorResponse

Detailed error information.

Examples

List Content Keys

Sample request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/streamingLocators/secureStreamingLocator/listContentKeys?api-version=2022-08-01

Sample response

{
  "contentKeys": [
    {
      "id": "9259eb06-eeee-4f77-987f-48f4ea5c649f",
      "type": "EnvelopeEncryption",
      "labelReferenceInStreamingPolicy": "aesDefaultKey",
      "value": "QpiqeQROdN5xamnfUF2Wdw==",
      "policyName": "PolicyWithMultipleOptions",
      "tracks": []
    },
    {
      "id": "06bfeff1-2bb6-4f58-af27-a2767f058bca",
      "type": "CommonEncryptionCenc",
      "labelReferenceInStreamingPolicy": "cencDefaultKey",
      "value": "ZjgWhNnqnqcov/h+wrYusw==",
      "policyName": "PolicyWithMultipleOptions",
      "tracks": []
    },
    {
      "id": "799e78a0-ed6f-4179-9222-ed4ec4223cec",
      "type": "CommonEncryptionCbcs",
      "labelReferenceInStreamingPolicy": "cbcsDefaultKey",
      "value": "FjZ3n3yRcVxRFftdYFbe9g==",
      "policyName": "PolicyWithMultipleOptions",
      "tracks": []
    }
  ]
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

ListContentKeysResponse

Class of response for listContentKeys action

StreamingLocatorContentKey

Class for content key in Streaming Locator

StreamingLocatorContentKeyType

Encryption type of Content Key

TrackPropertyCompareOperation

Track property condition operation

TrackPropertyCondition

Class to specify one track property condition

TrackPropertyType

Track property type

TrackSelection

Class to select a track

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.

ListContentKeysResponse

Class of response for listContentKeys action

Name Type Description
contentKeys

StreamingLocatorContentKey[]

ContentKeys used by current Streaming Locator

StreamingLocatorContentKey

Class for content key in Streaming Locator

Name Type Description
id

string

ID of Content Key

labelReferenceInStreamingPolicy

string

Label of Content Key as specified in the Streaming Policy

policyName

string

ContentKeyPolicy used by Content Key

tracks

TrackSelection[]

Tracks which use this Content Key

type

StreamingLocatorContentKeyType

Encryption type of Content Key

value

string

Value of Content Key

StreamingLocatorContentKeyType

Encryption type of Content Key

Name Type Description
CommonEncryptionCbcs

string

Common Encryption using CBCS

CommonEncryptionCenc

string

Common Encryption using CENC

EnvelopeEncryption

string

Envelope Encryption

TrackPropertyCompareOperation

Track property condition operation

Name Type Description
Equal

string

Equal operation

Unknown

string

Unknown track property compare operation

TrackPropertyCondition

Class to specify one track property condition

Name Type Description
operation

TrackPropertyCompareOperation

Track property condition operation

property

TrackPropertyType

Track property type

value

string

Track property value

TrackPropertyType

Track property type

Name Type Description
FourCC

string

Track FourCC

Unknown

string

Unknown track property

TrackSelection

Class to select a track

Name Type Description
trackSelections

TrackPropertyCondition[]

TrackSelections is a track property condition list which can specify track(s)