Streaming Locators - List Content Keys

Service:

Media Services

API Version:

2022-08-01

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

HTTP

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

Java

/** Samples for StreamingLocators ListContentKeys. */
public final class Main {
    /*
     * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-locators-list-content-keys.json
     */
    /**
     * Sample code: List Content Keys.
     *
     * @param manager Entry point to MediaServicesManager.
     */
    public static void listContentKeys(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager
            .streamingLocators()
            .listContentKeysWithResponse(
                "contosorg", "contosomedia", "secureStreamingLocator", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.media import AzureMediaServices

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-media
# USAGE
    python streaminglocatorslistcontentkeys.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AzureMediaServices(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.streaming_locators.list_content_keys(
        resource_group_name="contoso",
        account_name="contosomedia",
        streaming_locator_name="secureStreamingLocator",
    )
    print(response)


# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-locators-list-content-keys.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armmediaservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mediaservices/armmediaservices/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e7bf3adfa2d5e5cdbb804eec35279501794f461c/specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-locators-list-content-keys.json
func ExampleStreamingLocatorsClient_ListContentKeys() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmediaservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewStreamingLocatorsClient().ListContentKeys(ctx, "contoso", "contosomedia", "secureStreamingLocator", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ListContentKeysResponse = armmediaservices.ListContentKeysResponse{
	// 	ContentKeys: []*armmediaservices.StreamingLocatorContentKey{
	// 		{
	// 			Type: to.Ptr(armmediaservices.StreamingLocatorContentKeyTypeEnvelopeEncryption),
	// 			ID: to.Ptr("9259eb06-eeee-4f77-987f-48f4ea5c649f"),
	// 			LabelReferenceInStreamingPolicy: to.Ptr("aesDefaultKey"),
	// 			PolicyName: to.Ptr("PolicyWithMultipleOptions"),
	// 			Tracks: []*armmediaservices.TrackSelection{
	// 			},
	// 			Value: to.Ptr("QpiqeQROdN5xamnfUF2Wdw=="),
	// 		},
	// 		{
	// 			Type: to.Ptr(armmediaservices.StreamingLocatorContentKeyTypeCommonEncryptionCenc),
	// 			ID: to.Ptr("06bfeff1-2bb6-4f58-af27-a2767f058bca"),
	// 			LabelReferenceInStreamingPolicy: to.Ptr("cencDefaultKey"),
	// 			PolicyName: to.Ptr("PolicyWithMultipleOptions"),
	// 			Tracks: []*armmediaservices.TrackSelection{
	// 			},
	// 			Value: to.Ptr("ZjgWhNnqnqcov/h+wrYusw=="),
	// 		},
	// 		{
	// 			Type: to.Ptr(armmediaservices.StreamingLocatorContentKeyTypeCommonEncryptionCbcs),
	// 			ID: to.Ptr("799e78a0-ed6f-4179-9222-ed4ec4223cec"),
	// 			LabelReferenceInStreamingPolicy: to.Ptr("cbcsDefaultKey"),
	// 			PolicyName: to.Ptr("PolicyWithMultipleOptions"),
	// 			Tracks: []*armmediaservices.TrackSelection{
	// 			},
	// 			Value: to.Ptr("FjZ3n3yRcVxRFftdYFbe9g=="),
	// 	}},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AzureMediaServices } = require("@azure/arm-mediaservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List Content Keys used by this Streaming Locator
 *
 * @summary List Content Keys used by this Streaming Locator
 * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-locators-list-content-keys.json
 */
async function listContentKeys() {
  const subscriptionId =
    process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contoso";
  const accountName = "contosomedia";
  const streamingLocatorName = "secureStreamingLocator";
  const credential = new DefaultAzureCredential();
  const client = new AzureMediaServices(credential, subscriptionId);
  const result = await client.streamingLocators.listContentKeys(
    resourceGroupName,
    accountName,
    streamingLocatorName
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Media;
using Azure.ResourceManager.Media.Models;

// Generated from example definition: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-locators-list-content-keys.json
// this example is just showing the usage of "StreamingLocators_ListContentKeys" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this StreamingLocatorResource created on azure
// for more information of creating StreamingLocatorResource, please refer to the document of StreamingLocatorResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contoso";
string accountName = "contosomedia";
string streamingLocatorName = "secureStreamingLocator";
ResourceIdentifier streamingLocatorResourceId = StreamingLocatorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, streamingLocatorName);
StreamingLocatorResource streamingLocator = client.GetStreamingLocatorResource(streamingLocatorResourceId);

// invoke the operation and iterate over the result
await foreach (StreamingLocatorContentKey item in streamingLocator.GetContentKeysAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "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)