Content Key Policies - List

Service:

Media Services

API Version:

2022-08-01

List Content Key Policies
Lists the Content Key Policies in the account

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

With optional parameters:

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

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.
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.
$filter	query		string	Restricts the set of items returned.
$orderby	query		string	Specifies the key by which the result collection should be ordered.
$top	query		integer int32	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.

Responses

Name	Type	Description
200 OK	ContentKeyPolicyCollection	OK
Other Status Codes	ErrorResponse	Detailed error information.

Examples

Lists all Content Key Policies

Lists Content Key Policies ordered by last modified.

Lists Content Key Policies with created and last modified filters.

Lists all Content Key Policies

Sample Request

HTTP

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

Java

/** Samples for ContentKeyPolicies List. */
public final class Main {
    /*
     * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/content-key-policies-list-all.json
     */
    /**
     * Sample code: Lists all Content Key Policies.
     *
     * @param manager Entry point to MediaServicesManager.
     */
    public static void listsAllContentKeyPolicies(
        com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager
            .contentKeyPolicies()
            .list("contosorg", "contosomedia", null, null, null, 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 contentkeypolicieslistall.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.content_key_policies.list(
        resource_group_name="contoso",
        account_name="contosomedia",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/content-key-policies-list-all.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/content-key-policies-list-all.json
func ExampleContentKeyPoliciesClient_NewListPager_listsAllContentKeyPolicies() {
	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)
	}
	pager := clientFactory.NewContentKeyPoliciesClient().NewListPager("contoso", "contosomedia", &armmediaservices.ContentKeyPoliciesClientListOptions{Filter: nil,
		Top:     nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ContentKeyPolicyCollection = armmediaservices.ContentKeyPolicyCollection{
		// 	Value: []*armmediaservices.ContentKeyPolicy{
		// 		{
		// 			Name: to.Ptr("PolicyWithClearKeyOptionAndTokenRestriction"),
		// 			Type: to.Ptr("Microsoft.Media/mediaservices/contentKeyPolicies"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction"),
		// 			Properties: &armmediaservices.ContentKeyPolicyProperties{
		// 				Description: to.Ptr("A policy with one ClearKey option and Open Restriction."),
		// 				Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-01T00:00:00.000Z"); return t}()),
		// 				LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-01T00:00:00.000Z"); return t}()),
		// 				Options: []*armmediaservices.ContentKeyPolicyOption{
		// 					{
		// 						Configuration: &armmediaservices.ContentKeyPolicyClearKeyConfiguration{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration"),
		// 						},
		// 						PolicyOptionID: to.Ptr("a3448d09-567a-4642-8309-d17e846be59f"),
		// 						Restriction: &armmediaservices.ContentKeyPolicyTokenRestriction{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyTokenRestriction"),
		// 							AlternateVerificationKeys: []armmediaservices.ContentKeyPolicyRestrictionTokenKeyClassification{
		// 							},
		// 							Audience: to.Ptr("urn:test"),
		// 							Issuer: to.Ptr("http://testacs"),
		// 							PrimaryVerificationKey: &armmediaservices.ContentKeyPolicySymmetricTokenKey{
		// 								ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicySymmetricTokenKey"),
		// 								KeyValue: []byte(""),
		// 							},
		// 							RequiredClaims: []*armmediaservices.ContentKeyPolicyTokenClaim{
		// 								{
		// 									ClaimType: to.Ptr("urn:microsoft:azure:mediaservices:contentkeyidentifier"),
		// 								},
		// 								{
		// 									ClaimType: to.Ptr("DRM"),
		// 									ClaimValue: to.Ptr("Widevine"),
		// 							}},
		// 							RestrictionTokenType: to.Ptr(armmediaservices.ContentKeyPolicyRestrictionTokenTypeJwt),
		// 						},
		// 				}},
		// 				PolicyID: to.Ptr("8352435b-ebea-4681-aae7-e19277771f64"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("PolicyWithMultipleOptions"),
		// 			Type: to.Ptr("Microsoft.Media/mediaservices/contentKeyPolicies"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions"),
		// 			Properties: &armmediaservices.ContentKeyPolicyProperties{
		// 				Description: to.Ptr("A policy with multiple options."),
		// 				Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-12-01T00:00:00.000Z"); return t}()),
		// 				LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-12-02T00:00:00.000Z"); return t}()),
		// 				Options: []*armmediaservices.ContentKeyPolicyOption{
		// 					{
		// 						Configuration: &armmediaservices.ContentKeyPolicyClearKeyConfiguration{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration"),
		// 						},
		// 						PolicyOptionID: to.Ptr("caf1e28c-8288-4301-8c46-c0f9312c512f"),
		// 						Restriction: &armmediaservices.ContentKeyPolicyTokenRestriction{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyTokenRestriction"),
		// 							AlternateVerificationKeys: []armmediaservices.ContentKeyPolicyRestrictionTokenKeyClassification{
		// 							},
		// 							Audience: to.Ptr("urn:test"),
		// 							Issuer: to.Ptr("http://testacs"),
		// 							PrimaryVerificationKey: &armmediaservices.ContentKeyPolicySymmetricTokenKey{
		// 								ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicySymmetricTokenKey"),
		// 								KeyValue: []byte(""),
		// 							},
		// 							RequiredClaims: []*armmediaservices.ContentKeyPolicyTokenClaim{
		// 								{
		// 									ClaimType: to.Ptr("urn:microsoft:azure:mediaservices:contentkeyidentifier"),
		// 								},
		// 								{
		// 									ClaimType: to.Ptr("DRM"),
		// 									ClaimValue: to.Ptr("Widevine"),
		// 							}},
		// 							RestrictionTokenType: to.Ptr(armmediaservices.ContentKeyPolicyRestrictionTokenTypeJwt),
		// 						},
		// 					},
		// 					{
		// 						Configuration: &armmediaservices.ContentKeyPolicyWidevineConfiguration{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyWidevineConfiguration"),
		// 							WidevineTemplate: to.Ptr("{\"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}}"),
		// 						},
		// 						PolicyOptionID: to.Ptr("da346259-0cd6-4609-89dc-15ac131bd92f"),
		// 						Restriction: &armmediaservices.ContentKeyPolicyOpenRestriction{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyOpenRestriction"),
		// 						},
		// 				}},
		// 				PolicyID: to.Ptr("ed7f3d1b-cfa7-4181-b966-e0b3027eec3a"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("PolicyWithPlayReadyOptionAndOpenRestriction"),
		// 			Type: to.Ptr("Microsoft.Media/mediaservices/contentKeyPolicies"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction"),
		// 			Properties: &armmediaservices.ContentKeyPolicyProperties{
		// 				Description: to.Ptr("A policy with one PlayReady option and Open Restriction."),
		// 				Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2012-11-01T00:00:00.000Z"); return t}()),
		// 				LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2012-11-01T00:00:00.000Z"); return t}()),
		// 				Options: []*armmediaservices.ContentKeyPolicyOption{
		// 					{
		// 						Configuration: &armmediaservices.ContentKeyPolicyPlayReadyConfiguration{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration"),
		// 							Licenses: []*armmediaservices.ContentKeyPolicyPlayReadyLicense{
		// 								{
		// 									AllowTestDevices: to.Ptr(false),
		// 									ContentKeyLocation: &armmediaservices.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader{
		// 										ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader"),
		// 									},
		// 									ContentType: to.Ptr(armmediaservices.ContentKeyPolicyPlayReadyContentTypeUnspecified),
		// 									LicenseType: to.Ptr(armmediaservices.ContentKeyPolicyPlayReadyLicenseTypeNonPersistent),
		// 									PlayRight: &armmediaservices.ContentKeyPolicyPlayReadyPlayRight{
		// 										AllowPassingVideoContentToUnknownOutput: to.Ptr(armmediaservices.ContentKeyPolicyPlayReadyUnknownOutputPassingOptionNotAllowed),
		// 										DigitalVideoOnlyContentRestriction: to.Ptr(false),
		// 										ImageConstraintForAnalogComponentVideoRestriction: to.Ptr(false),
		// 										ImageConstraintForAnalogComputerMonitorRestriction: to.Ptr(false),
		// 									},
		// 									SecurityLevel: to.Ptr(armmediaservices.SecurityLevelSL2000),
		// 							}},
		// 							ResponseCustomData: to.Ptr("testCustomData"),
		// 						},
		// 						PolicyOptionID: to.Ptr("294a833f-f128-48be-9edf-8d1bb5b35ff3"),
		// 						Restriction: &armmediaservices.ContentKeyPolicyOpenRestriction{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyOpenRestriction"),
		// 						},
		// 				}},
		// 				PolicyID: to.Ptr("a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04"),
		// 			},
		// 	}},
		// }
	}
}

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 Lists the Content Key Policies in the account
 *
 * @summary Lists the Content Key Policies in the account
 * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/content-key-policies-list-all.json
 */
async function listsAllContentKeyPolicies() {
  const subscriptionId =
    process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contoso";
  const accountName = "contosomedia";
  const credential = new DefaultAzureCredential();
  const client = new AzureMediaServices(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.contentKeyPolicies.list(resourceGroupName, accountName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/content-key-policies-list-all.json
// this example is just showing the usage of "ContentKeyPolicies_List" 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 MediaServicesAccountResource created on azure
// for more information of creating MediaServicesAccountResource, please refer to the document of MediaServicesAccountResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contoso";
string accountName = "contosomedia";
ResourceIdentifier mediaServicesAccountResourceId = MediaServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
MediaServicesAccountResource mediaServicesAccount = client.GetMediaServicesAccountResource(mediaServicesAccountResourceId);

// get the collection of this ContentKeyPolicyResource
ContentKeyPolicyCollection collection = mediaServicesAccount.GetContentKeyPolicies();

// invoke the operation and iterate over the result
await foreach (ContentKeyPolicyResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ContentKeyPolicyData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

{
  "value": [
    {
      "name": "PolicyWithClearKeyOptionAndTokenRestriction",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction",
      "type": "Microsoft.Media/mediaservices/contentKeyPolicies",
      "properties": {
        "policyId": "8352435b-ebea-4681-aae7-e19277771f64",
        "created": "2017-12-01T00:00:00Z",
        "lastModified": "2017-11-01T00:00:00Z",
        "description": "A policy with one ClearKey option and Open Restriction.",
        "options": [
          {
            "policyOptionId": "a3448d09-567a-4642-8309-d17e846be59f",
            "name": null,
            "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",
                  "claimValue": null
                },
                {
                  "claimType": "DRM",
                  "claimValue": "Widevine"
                }
              ],
              "restrictionTokenType": "Jwt",
              "openIdConnectDiscoveryDocument": null
            }
          }
        ]
      }
    },
    {
      "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",
            "name": null,
            "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",
                  "claimValue": null
                },
                {
                  "claimType": "DRM",
                  "claimValue": "Widevine"
                }
              ],
              "restrictionTokenType": "Jwt",
              "openIdConnectDiscoveryDocument": null
            }
          },
          {
            "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f",
            "name": null,
            "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"
            }
          }
        ]
      }
    },
    {
      "name": "PolicyWithPlayReadyOptionAndOpenRestriction",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction",
      "type": "Microsoft.Media/mediaservices/contentKeyPolicies",
      "properties": {
        "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04",
        "created": "2012-11-01T00:00:00Z",
        "lastModified": "2012-11-01T00:00:00Z",
        "description": "A policy with one PlayReady option and Open Restriction.",
        "options": [
          {
            "policyOptionId": "294a833f-f128-48be-9edf-8d1bb5b35ff3",
            "name": null,
            "configuration": {
              "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration",
              "licenses": [
                {
                  "allowTestDevices": false,
                  "beginDate": null,
                  "expirationDate": null,
                  "relativeBeginDate": null,
                  "relativeExpirationDate": null,
                  "gracePeriod": null,
                  "playRight": {
                    "firstPlayExpiration": null,
                    "scmsRestriction": null,
                    "agcAndColorStripeRestriction": null,
                    "explicitAnalogTelevisionOutputRestriction": null,
                    "digitalVideoOnlyContentRestriction": false,
                    "imageConstraintForAnalogComponentVideoRestriction": false,
                    "imageConstraintForAnalogComputerMonitorRestriction": false,
                    "allowPassingVideoContentToUnknownOutput": "NotAllowed",
                    "uncompressedDigitalVideoOpl": null,
                    "compressedDigitalVideoOpl": null,
                    "analogVideoOpl": null,
                    "compressedDigitalAudioOpl": null,
                    "uncompressedDigitalAudioOpl": null
                  },
                  "licenseType": "NonPersistent",
                  "contentKeyLocation": {
                    "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader"
                  },
                  "contentType": "Unspecified",
                  "securityLevel": "SL2000"
                }
              ],
              "responseCustomData": "testCustomData"
            },
            "restriction": {
              "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction"
            }
          }
        ]
      }
    }
  ]
}

Lists Content Key Policies ordered by last modified.

Sample Request

HTTP

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

Java

/** Samples for ContentKeyPolicies List. */
public final class Main {
    /*
     * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/content-key-policies-list-by-lastModified.json
     */
    /**
     * Sample code: Lists Content Key Policies ordered by last modified.
     *
     * @param manager Entry point to MediaServicesManager.
     */
    public static void listsContentKeyPoliciesOrderedByLastModified(
        com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager
            .contentKeyPolicies()
            .list("contosorg", "contosomedia", null, null, "properties/lastModified", 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 contentkeypolicieslistbylast_modified.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.content_key_policies.list(
        resource_group_name="contoso",
        account_name="contosomedia",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/content-key-policies-list-by-lastModified.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/azcore/to"
	"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/content-key-policies-list-by-lastModified.json
func ExampleContentKeyPoliciesClient_NewListPager_listsContentKeyPoliciesOrderedByLastModified() {
	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)
	}
	pager := clientFactory.NewContentKeyPoliciesClient().NewListPager("contoso", "contosomedia", &armmediaservices.ContentKeyPoliciesClientListOptions{Filter: nil,
		Top:     nil,
		Orderby: to.Ptr("properties/lastModified"),
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ContentKeyPolicyCollection = armmediaservices.ContentKeyPolicyCollection{
		// 	Value: []*armmediaservices.ContentKeyPolicy{
		// 		{
		// 			Name: to.Ptr("PolicyWithPlayReadyOptionAndOpenRestriction"),
		// 			Type: to.Ptr("Microsoft.Media/mediaservices/contentKeyPolicies"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction"),
		// 			Properties: &armmediaservices.ContentKeyPolicyProperties{
		// 				Description: to.Ptr("A policy with one PlayReady option and Open Restriction."),
		// 				Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2012-11-01T00:00:00.000Z"); return t}()),
		// 				LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2012-11-01T00:00:00.000Z"); return t}()),
		// 				Options: []*armmediaservices.ContentKeyPolicyOption{
		// 					{
		// 						Configuration: &armmediaservices.ContentKeyPolicyPlayReadyConfiguration{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration"),
		// 							Licenses: []*armmediaservices.ContentKeyPolicyPlayReadyLicense{
		// 								{
		// 									AllowTestDevices: to.Ptr(false),
		// 									ContentKeyLocation: &armmediaservices.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader{
		// 										ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader"),
		// 									},
		// 									ContentType: to.Ptr(armmediaservices.ContentKeyPolicyPlayReadyContentTypeUnspecified),
		// 									LicenseType: to.Ptr(armmediaservices.ContentKeyPolicyPlayReadyLicenseTypeNonPersistent),
		// 									PlayRight: &armmediaservices.ContentKeyPolicyPlayReadyPlayRight{
		// 										AllowPassingVideoContentToUnknownOutput: to.Ptr(armmediaservices.ContentKeyPolicyPlayReadyUnknownOutputPassingOptionNotAllowed),
		// 										DigitalVideoOnlyContentRestriction: to.Ptr(false),
		// 										ImageConstraintForAnalogComponentVideoRestriction: to.Ptr(false),
		// 										ImageConstraintForAnalogComputerMonitorRestriction: to.Ptr(false),
		// 									},
		// 									SecurityLevel: to.Ptr(armmediaservices.SecurityLevelSL2000),
		// 							}},
		// 							ResponseCustomData: to.Ptr("testCustomData"),
		// 						},
		// 						PolicyOptionID: to.Ptr("294a833f-f128-48be-9edf-8d1bb5b35ff3"),
		// 						Restriction: &armmediaservices.ContentKeyPolicyOpenRestriction{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyOpenRestriction"),
		// 						},
		// 				}},
		// 				PolicyID: to.Ptr("a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("PolicyWithMultipleOptions"),
		// 			Type: to.Ptr("Microsoft.Media/mediaservices/contentKeyPolicies"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions"),
		// 			Properties: &armmediaservices.ContentKeyPolicyProperties{
		// 				Description: to.Ptr("A policy with multiple options."),
		// 				Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-12-01T00:00:00.000Z"); return t}()),
		// 				LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-12-02T00:00:00.000Z"); return t}()),
		// 				Options: []*armmediaservices.ContentKeyPolicyOption{
		// 					{
		// 						Configuration: &armmediaservices.ContentKeyPolicyClearKeyConfiguration{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration"),
		// 						},
		// 						PolicyOptionID: to.Ptr("caf1e28c-8288-4301-8c46-c0f9312c512f"),
		// 						Restriction: &armmediaservices.ContentKeyPolicyTokenRestriction{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyTokenRestriction"),
		// 							AlternateVerificationKeys: []armmediaservices.ContentKeyPolicyRestrictionTokenKeyClassification{
		// 							},
		// 							Audience: to.Ptr("urn:test"),
		// 							Issuer: to.Ptr("http://testacs"),
		// 							PrimaryVerificationKey: &armmediaservices.ContentKeyPolicySymmetricTokenKey{
		// 								ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicySymmetricTokenKey"),
		// 								KeyValue: []byte(""),
		// 							},
		// 							RequiredClaims: []*armmediaservices.ContentKeyPolicyTokenClaim{
		// 								{
		// 									ClaimType: to.Ptr("urn:microsoft:azure:mediaservices:contentkeyidentifier"),
		// 								},
		// 								{
		// 									ClaimType: to.Ptr("DRM"),
		// 									ClaimValue: to.Ptr("Widevine"),
		// 							}},
		// 							RestrictionTokenType: to.Ptr(armmediaservices.ContentKeyPolicyRestrictionTokenTypeJwt),
		// 						},
		// 					},
		// 					{
		// 						Configuration: &armmediaservices.ContentKeyPolicyWidevineConfiguration{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyWidevineConfiguration"),
		// 							WidevineTemplate: to.Ptr("{\"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}}"),
		// 						},
		// 						PolicyOptionID: to.Ptr("da346259-0cd6-4609-89dc-15ac131bd92f"),
		// 						Restriction: &armmediaservices.ContentKeyPolicyOpenRestriction{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyOpenRestriction"),
		// 						},
		// 				}},
		// 				PolicyID: to.Ptr("ed7f3d1b-cfa7-4181-b966-e0b3027eec3a"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("PolicyWithClearKeyOptionAndTokenRestriction"),
		// 			Type: to.Ptr("Microsoft.Media/mediaservices/contentKeyPolicies"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction"),
		// 			Properties: &armmediaservices.ContentKeyPolicyProperties{
		// 				Description: to.Ptr("A policy with one ClearKey option and Open Restriction."),
		// 				Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-12-01T00:00:00.000Z"); return t}()),
		// 				LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-01T00:00:00.000Z"); return t}()),
		// 				Options: []*armmediaservices.ContentKeyPolicyOption{
		// 					{
		// 						Configuration: &armmediaservices.ContentKeyPolicyClearKeyConfiguration{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration"),
		// 						},
		// 						PolicyOptionID: to.Ptr("a3448d09-567a-4642-8309-d17e846be59f"),
		// 						Restriction: &armmediaservices.ContentKeyPolicyTokenRestriction{
		// 							ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicyTokenRestriction"),
		// 							AlternateVerificationKeys: []armmediaservices.ContentKeyPolicyRestrictionTokenKeyClassification{
		// 							},
		// 							Audience: to.Ptr("urn:test"),
		// 							Issuer: to.Ptr("http://testacs"),
		// 							PrimaryVerificationKey: &armmediaservices.ContentKeyPolicySymmetricTokenKey{
		// 								ODataType: to.Ptr("#Microsoft.Media.ContentKeyPolicySymmetricTokenKey"),
		// 								KeyValue: []byte(""),
		// 							},
		// 							RequiredClaims: []*armmediaservices.ContentKeyPolicyTokenClaim{
		// 								{
		// 									ClaimType: to.Ptr("urn:microsoft:azure:mediaservices:contentkeyidentifier"),
		// 								},
		// 								{
		// 									ClaimType: to.Ptr("DRM"),
		// 									ClaimValue: to.Ptr("Widevine"),
		// 							}},
		// 							RestrictionTokenType: to.Ptr(armmediaservices.ContentKeyPolicyRestrictionTokenTypeJwt),
		// 						},
		// 				}},
		// 				PolicyID: to.Ptr("8352435b-ebea-4681-aae7-e19277771f64"),
		// 			},
		// 	}},
		// }
	}
}

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 Lists the Content Key Policies in the account
 *
 * @summary Lists the Content Key Policies in the account
 * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/content-key-policies-list-by-lastModified.json
 */
async function listsContentKeyPoliciesOrderedByLastModified() {
  const subscriptionId =
    process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contoso";
  const accountName = "contosomedia";
  const orderby = "properties/lastModified";
  const options = { orderby };
  const credential = new DefaultAzureCredential();
  const client = new AzureMediaServices(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.contentKeyPolicies.list(resourceGroupName, accountName, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/content-key-policies-list-by-lastModified.json
// this example is just showing the usage of "ContentKeyPolicies_List" 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 MediaServicesAccountResource created on azure
// for more information of creating MediaServicesAccountResource, please refer to the document of MediaServicesAccountResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contoso";
string accountName = "contosomedia";
ResourceIdentifier mediaServicesAccountResourceId = MediaServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
MediaServicesAccountResource mediaServicesAccount = client.GetMediaServicesAccountResource(mediaServicesAccountResourceId);

// get the collection of this ContentKeyPolicyResource
ContentKeyPolicyCollection collection = mediaServicesAccount.GetContentKeyPolicies();

// invoke the operation and iterate over the result
string orderby = "properties/lastModified";
await foreach (ContentKeyPolicyResource item in collection.GetAllAsync(orderby: orderby))
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ContentKeyPolicyData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

{
  "value": [
    {
      "name": "PolicyWithPlayReadyOptionAndOpenRestriction",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction",
      "type": "Microsoft.Media/mediaservices/contentKeyPolicies",
      "properties": {
        "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04",
        "created": "2012-11-01T00:00:00Z",
        "lastModified": "2012-11-01T00:00:00Z",
        "description": "A policy with one PlayReady option and Open Restriction.",
        "options": [
          {
            "policyOptionId": "294a833f-f128-48be-9edf-8d1bb5b35ff3",
            "configuration": {
              "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration",
              "licenses": [
                {
                  "allowTestDevices": false,
                  "playRight": {
                    "digitalVideoOnlyContentRestriction": false,
                    "imageConstraintForAnalogComponentVideoRestriction": false,
                    "imageConstraintForAnalogComputerMonitorRestriction": false,
                    "allowPassingVideoContentToUnknownOutput": "NotAllowed"
                  },
                  "licenseType": "NonPersistent",
                  "contentKeyLocation": {
                    "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader"
                  },
                  "contentType": "Unspecified",
                  "securityLevel": "SL2000"
                }
              ],
              "responseCustomData": "testCustomData"
            },
            "restriction": {
              "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction"
            }
          }
        ]
      }
    },
    {
      "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"
            }
          }
        ]
      }
    },
    {
      "name": "PolicyWithClearKeyOptionAndTokenRestriction",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction",
      "type": "Microsoft.Media/mediaservices/contentKeyPolicies",
      "properties": {
        "policyId": "8352435b-ebea-4681-aae7-e19277771f64",
        "created": "2017-12-01T00:00:00Z",
        "lastModified": "2017-11-01T00:00:00Z",
        "description": "A policy with one ClearKey option and Open Restriction.",
        "options": [
          {
            "policyOptionId": "a3448d09-567a-4642-8309-d17e846be59f",
            "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"
            }
          }
        ]
      }
    }
  ]
}

Lists Content Key Policies with created and last modified filters.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/contentKeyPolicies?api-version=2022-08-01&$filter=properties/lastModified gt 2016-06-01 and properties/created lt 2013-07-01

Java

/** Samples for ContentKeyPolicies List. */
public final class Main {
    /*
     * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/content-key-policies-list-in-date-range.json
     */
    /**
     * Sample code: Lists Content Key Policies with created and last modified filters.
     *
     * @param manager Entry point to MediaServicesManager.
     */
    public static void listsContentKeyPoliciesWithCreatedAndLastModifiedFilters(
        com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager
            .contentKeyPolicies()
            .list(
                "contosorg",
                "contosomedia",
                "properties/lastModified gt 2016-06-01 and properties/created lt 2013-07-01",
                null,
                null,
                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 contentkeypolicieslistindaterange.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.content_key_policies.list(
        resource_group_name="contoso",
        account_name="contosomedia",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/content-key-policies-list-in-date-range.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/azcore/to"
	"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/content-key-policies-list-in-date-range.json
func ExampleContentKeyPoliciesClient_NewListPager_listsContentKeyPoliciesWithCreatedAndLastModifiedFilters() {
	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)
	}
	pager := clientFactory.NewContentKeyPoliciesClient().NewListPager("contoso", "contosomedia", &armmediaservices.ContentKeyPoliciesClientListOptions{Filter: to.Ptr("properties/lastModified gt 2016-06-01 and properties/created lt 2013-07-01"),
		Top:     nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ContentKeyPolicyCollection = armmediaservices.ContentKeyPolicyCollection{
		// 	Value: []*armmediaservices.ContentKeyPolicy{
		// 	},
		// }
	}
}

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 Lists the Content Key Policies in the account
 *
 * @summary Lists the Content Key Policies in the account
 * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/content-key-policies-list-in-date-range.json
 */
async function listsContentKeyPoliciesWithCreatedAndLastModifiedFilters() {
  const subscriptionId =
    process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contoso";
  const accountName = "contosomedia";
  const filter = "properties/lastModified gt 2016-06-01 and properties/created lt 2013-07-01";
  const options = { filter };
  const credential = new DefaultAzureCredential();
  const client = new AzureMediaServices(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.contentKeyPolicies.list(resourceGroupName, accountName, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/content-key-policies-list-in-date-range.json
// this example is just showing the usage of "ContentKeyPolicies_List" 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 MediaServicesAccountResource created on azure
// for more information of creating MediaServicesAccountResource, please refer to the document of MediaServicesAccountResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contoso";
string accountName = "contosomedia";
ResourceIdentifier mediaServicesAccountResourceId = MediaServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
MediaServicesAccountResource mediaServicesAccount = client.GetMediaServicesAccountResource(mediaServicesAccountResourceId);

// get the collection of this ContentKeyPolicyResource
ContentKeyPolicyCollection collection = mediaServicesAccount.GetContentKeyPolicies();

// invoke the operation and iterate over the result
string filter = "properties/lastModified gt 2016-06-01 and properties/created lt 2013-07-01";
await foreach (ContentKeyPolicyResource item in collection.GetAllAsync(filter: filter))
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ContentKeyPolicyData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

{
  "value": []
}

Definitions

Name	Description
ContentKeyPolicy	A Content Key Policy resource.
ContentKeyPolicyClearKeyConfiguration	Represents a configuration for non-DRM keys.
ContentKeyPolicyCollection	A collection of ContentKeyPolicy items.
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.

ContentKeyPolicyCollection

A collection of ContentKeyPolicy items.

Name	Type	Description
@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	ContentKeyPolicy[]	A collection of ContentKeyPolicy items.

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: ContentKeyPolicyClearKeyConfiguration ContentKeyPolicyFairPlayConfiguration ContentKeyPolicyPlayReadyConfiguration ContentKeyPolicyUnknownConfiguration ContentKeyPolicyWidevineConfiguration	The key delivery configuration.
name	string	The Policy Option description.
policyOptionId	string	The legacy Policy Option ID.
restriction	ContentKeyPolicyRestriction: ContentKeyPolicyOpenRestriction ContentKeyPolicyTokenRestriction ContentKeyPolicyUnknownRestriction	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: ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier	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[]: ContentKeyPolicyRsaTokenKey[] ContentKeyPolicySymmetricTokenKey[] ContentKeyPolicyX509CertificateTokenKey[]	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: ContentKeyPolicyRsaTokenKey ContentKeyPolicySymmetricTokenKey ContentKeyPolicyX509CertificateTokenKey	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.