Streaming Policies - Get

Reference

Service:: Media Services

API Version:: 2022-08-01

Get a Streaming Policy
Get the details of a Streaming Policy in the Media Services account

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies/{streamingPolicyName}?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.
streamingPolicyName	path	True	string	The Streaming Policy 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	StreamingPolicy	OK
Other Status Codes	ErrorResponse	Detailed error information.

Examples

Get a Streaming Policy by name

Sample request

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


/**
 * Samples for StreamingPolicies Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-policy
     * -get-by-name.json
     */
    /**
     * Sample code: Get a Streaming Policy by name.
     * 
     * @param manager Entry point to MediaServicesManager.
     */
    public static void getAStreamingPolicyByName(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager.streamingPolicies().getWithResponse("contosorg", "contosomedia", "clearStreamingPolicy",
            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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-media
# USAGE
    python streamingpolicygetbyname.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_policies.get(
        resource_group_name="contoso",
        account_name="contosomedia",
        streaming_policy_name="clearStreamingPolicy",
    )
    print(response)


# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-policy-get-by-name.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

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-policy-get-by-name.json
func ExampleStreamingPoliciesClient_Get() {
	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.NewStreamingPoliciesClient().Get(ctx, "contoso", "contosomedia", "clearStreamingPolicy", 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.StreamingPolicy = armmediaservices.StreamingPolicy{
	// 	Name: to.Ptr("clearStreamingPolicy"),
	// 	Type: to.Ptr("Microsoft.Media/mediaservices/streamingPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/clearStreamingPolicy"),
	// 	Properties: &armmediaservices.StreamingPolicyProperties{
	// 		Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-08T18:29:30.850Z"); return t}()),
	// 		NoEncryption: &armmediaservices.NoEncryption{
	// 			EnabledProtocols: &armmediaservices.EnabledProtocols{
	// 				Dash: to.Ptr(true),
	// 				Download: to.Ptr(true),
	// 				Hls: to.Ptr(true),
	// 				SmoothStreaming: to.Ptr(true),
	// 			},
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Get the details of a Streaming Policy in the Media Services account
 *
 * @summary Get the details of a Streaming Policy in the Media Services account
 * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-policy-get-by-name.json
 */
async function getAStreamingPolicyByName() {
  const subscriptionId =
    process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contoso";
  const accountName = "contosomedia";
  const streamingPolicyName = "clearStreamingPolicy";
  const credential = new DefaultAzureCredential();
  const client = new AzureMediaServices(credential, subscriptionId);
  const result = await client.streamingPolicies.get(
    resourceGroupName,
    accountName,
    streamingPolicyName
  );
  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

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-policy-get-by-name.json
// this example is just showing the usage of "StreamingPolicies_Get" 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 StreamingPolicyResource
StreamingPolicyCollection collection = mediaServicesAccount.GetStreamingPolicies();

// invoke the operation
string streamingPolicyName = "clearStreamingPolicy";
bool result = await collection.ExistsAsync(streamingPolicyName);

Console.WriteLine($"Succeeded: {result}");

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

{
  "name": "clearStreamingPolicy",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/clearStreamingPolicy",
  "type": "Microsoft.Media/mediaservices/streamingPolicies",
  "properties": {
    "created": "2018-08-08T18:29:30.8501486Z",
    "noEncryption": {
      "enabledProtocols": {
        "download": true,
        "dash": true,
        "hls": true,
        "smoothStreaming": true
      }
    }
  }
}

Definitions

Name	Description
CbcsDrmConfiguration	Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy
CencDrmConfiguration	Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy
ClearKeyEncryptionConfiguration	Class to specify ClearKey configuration of common encryption schemes in Streaming Policy
CommonEncryptionCbcs	Class for CommonEncryptionCbcs encryption scheme
CommonEncryptionCenc	Class for envelope encryption scheme
createdByType	The type of identity that created the resource.
DefaultKey	Class to specify properties of default content key for each encryption scheme
EnabledProtocols	Class to specify which protocols are enabled
EnvelopeEncryption	Class for EnvelopeEncryption encryption scheme
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
NoEncryption	Class for NoEncryption scheme
StreamingPolicy	A Streaming Policy resource
StreamingPolicyContentKey	Class to specify properties of content key
StreamingPolicyContentKeys	Class to specify properties of all content keys in Streaming Policy
StreamingPolicyFairPlayConfiguration	Class to specify configurations of FairPlay in Streaming Policy
StreamingPolicyPlayReadyConfiguration	Class to specify configurations of PlayReady in Streaming Policy
StreamingPolicyWidevineConfiguration	Class to specify configurations of Widevine in Streaming Policy
systemData	Metadata pertaining to creation and last modification of the resource.
TrackPropertyCompareOperation	Track property condition operation
TrackPropertyCondition	Class to specify one track property condition
TrackPropertyType	Track property type
TrackSelection	Class to select a track

CbcsDrmConfiguration

Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy

Name	Type	Description
fairPlay	StreamingPolicyFairPlayConfiguration	FairPlay configurations
playReady	StreamingPolicyPlayReadyConfiguration	PlayReady configurations
widevine	StreamingPolicyWidevineConfiguration	Widevine configurations

CencDrmConfiguration

Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy

Name	Type	Description
playReady	StreamingPolicyPlayReadyConfiguration	PlayReady configurations
widevine	StreamingPolicyWidevineConfiguration	Widevine configurations

ClearKeyEncryptionConfiguration

Class to specify ClearKey configuration of common encryption schemes in Streaming Policy

Name	Type	Description
customKeysAcquisitionUrlTemplate	string	Template for the URL of the custom service delivering content keys to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token value is {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId.

CommonEncryptionCbcs

Class for CommonEncryptionCbcs encryption scheme

Name	Type	Description
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	Optional configuration supporting ClearKey in CommonEncryptionCbcs encryption scheme.
clearTracks	TrackSelection[]	Representing which tracks should not be encrypted
contentKeys	StreamingPolicyContentKeys	Representing default content key for each encryption scheme and separate content keys for specific tracks
drm	CbcsDrmConfiguration	Configuration of DRMs for current encryption scheme
enabledProtocols	EnabledProtocols	Representing supported protocols

CommonEncryptionCenc

Class for envelope encryption scheme

Name	Type	Description
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	Optional configuration supporting ClearKey in CommonEncryptionCenc encryption scheme.
clearTracks	TrackSelection[]	Representing which tracks should not be encrypted
contentKeys	StreamingPolicyContentKeys	Representing default content key for each encryption scheme and separate content keys for specific tracks
drm	CencDrmConfiguration	Configuration of DRMs for CommonEncryptionCenc encryption scheme
enabledProtocols	EnabledProtocols	Representing supported protocols

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultKey

Class to specify properties of default content key for each encryption scheme

Name	Type	Description
label	string	Label can be used to specify Content Key when creating a Streaming Locator
policyName	string	Policy used by Default Key

EnabledProtocols

Class to specify which protocols are enabled

Name	Type	Description
dash	boolean	Enable DASH protocol or not
download	boolean	Enable Download protocol or not
hls	boolean	Enable HLS protocol or not
smoothStreaming	boolean	Enable SmoothStreaming protocol or not

EnvelopeEncryption

Class for EnvelopeEncryption encryption scheme

Name	Type	Description
clearTracks	TrackSelection[]	Representing which tracks should not be encrypted
contentKeys	StreamingPolicyContentKeys	Representing default content key for each encryption scheme and separate content keys for specific tracks
customKeyAcquisitionUrlTemplate	string	Template for the URL of the custom service delivering keys to end user players. Not required when using Azure Media Services for issuing keys. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.
enabledProtocols	EnabledProtocols	Representing supported protocols

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.

NoEncryption

Class for NoEncryption scheme

Name	Type	Description
enabledProtocols	EnabledProtocols	Representing supported protocols

StreamingPolicy

A Streaming 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.commonEncryptionCbcs	CommonEncryptionCbcs	Configuration of CommonEncryptionCbcs
properties.commonEncryptionCenc	CommonEncryptionCenc	Configuration of CommonEncryptionCenc
properties.created	string	Creation time of Streaming Policy
properties.defaultContentKeyPolicyName	string	Default ContentKey used by current Streaming Policy
properties.envelopeEncryption	EnvelopeEncryption	Configuration of EnvelopeEncryption
properties.noEncryption	NoEncryption	Configurations of NoEncryption
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"

StreamingPolicyContentKey

Class to specify properties of content key

Name	Type	Description
label	string	Label can be used to specify Content Key when creating a Streaming Locator
policyName	string	Policy used by Content Key
tracks	TrackSelection[]	Tracks which use this content key

StreamingPolicyContentKeys

Class to specify properties of all content keys in Streaming Policy

Name	Type	Description
defaultKey	DefaultKey	Default content key for an encryption scheme
keyToTrackMappings	StreamingPolicyContentKey[]	Representing tracks needs separate content key

StreamingPolicyFairPlayConfiguration

Class to specify configurations of FairPlay in Streaming Policy

Name	Type	Description
allowPersistentLicense	boolean	All license to be persistent or not
customLicenseAcquisitionUrlTemplate	string	Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.

StreamingPolicyPlayReadyConfiguration

Class to specify configurations of PlayReady in Streaming Policy

Name	Type	Description
customLicenseAcquisitionUrlTemplate	string	Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.
playReadyCustomAttributes	string	Custom attributes for PlayReady

StreamingPolicyWidevineConfiguration

Class to specify configurations of Widevine in Streaming Policy

Name	Type	Description
customLicenseAcquisitionUrlTemplate	string	Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.

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.

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)