Streaming Policies - List
List Streaming Policies
Lists the Streaming Policies in the account
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies?api-version=2022-08-01&$filter={$filter}&$top={$top}&$orderby={$orderby}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
path | True |
string |
The Media Services account name. |
resource
|
path | True |
string |
The name of the resource group within the Azure subscription. |
subscription
|
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 |
OK |
|
Other Status Codes |
Detailed error information. |
Examples
Lists Streaming Policies
Sample request
Sample response
{
"value": [
{
"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.676067Z",
"noEncryption": {
"enabledProtocols": {
"download": true,
"dash": true,
"hls": true,
"smoothStreaming": true
}
}
}
},
{
"name": "secureStreamingPolicy",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicy",
"type": "Microsoft.Media/mediaservices/streamingPolicies",
"properties": {
"created": "2018-08-08T18:29:30.6781134Z",
"defaultContentKeyPolicyName": "PolicyWithMultipleOptions",
"envelopeEncryption": {
"enabledProtocols": {
"download": false,
"dash": true,
"hls": true,
"smoothStreaming": true
},
"clearTracks": [],
"contentKeys": {
"defaultKey": {
"label": "aesDefaultKey"
},
"keyToTrackMappings": []
},
"customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}"
},
"commonEncryptionCenc": {
"enabledProtocols": {
"download": false,
"dash": true,
"hls": false,
"smoothStreaming": true
},
"clearTracks": [
{
"trackSelections": [
{
"property": "FourCC",
"operation": "Unknown",
"value": "hev1"
}
]
}
],
"contentKeys": {
"defaultKey": {
"label": "cencDefaultKey"
},
"keyToTrackMappings": []
},
"drm": {
"playReady": {
"customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}",
"playReadyCustomAttributes": "PlayReady CustomAttributes"
},
"widevine": {
"customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId"
}
}
},
"commonEncryptionCbcs": {
"enabledProtocols": {
"download": false,
"dash": false,
"hls": true,
"smoothStreaming": false
},
"clearTracks": [],
"contentKeys": {
"defaultKey": {
"label": "cbcsDefaultKey"
},
"keyToTrackMappings": []
},
"drm": {
"fairPlay": {
"customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}",
"allowPersistentLicense": true
}
}
}
}
},
{
"name": "secureStreamingPolicyWithCommonEncryptionCbcsOnly",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithCommonEncryptionCbcsOnly",
"type": "Microsoft.Media/mediaservices/streamingPolicies",
"properties": {
"created": "2018-08-08T18:29:30.6781134Z",
"defaultContentKeyPolicyName": "PolicyWithMultipleOptions",
"commonEncryptionCbcs": {
"enabledProtocols": {
"download": false,
"dash": false,
"hls": true,
"smoothStreaming": false
},
"clearTracks": [],
"contentKeys": {
"defaultKey": {
"label": "cbcsDefaultKey"
},
"keyToTrackMappings": []
},
"drm": {
"fairPlay": {
"customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}",
"allowPersistentLicense": true
}
}
}
}
},
{
"name": "secureStreamingPolicyWithCommonEncryptionCencOnly",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithCommonEncryptionCencOnly",
"type": "Microsoft.Media/mediaservices/streamingPolicies",
"properties": {
"created": "2018-08-08T18:29:30.6781134Z",
"defaultContentKeyPolicyName": "PolicyWithMultipleOptions",
"commonEncryptionCenc": {
"enabledProtocols": {
"download": false,
"dash": true,
"hls": false,
"smoothStreaming": true
},
"clearTracks": [
{
"trackSelections": [
{
"property": "FourCC",
"operation": "Unknown",
"value": "hev1"
}
]
}
],
"contentKeys": {
"defaultKey": {
"label": "cencDefaultKey"
},
"keyToTrackMappings": []
},
"drm": {
"playReady": {
"customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}",
"playReadyCustomAttributes": "PlayReady CustomAttributes"
},
"widevine": {
"customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId"
}
}
}
}
},
{
"name": "secureStreamingPolicyWithEnvelopeEncryptionOnly",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithEnvelopeEncryptionOnly",
"type": "Microsoft.Media/mediaservices/streamingPolicies",
"properties": {
"created": "2018-08-08T18:29:30.6781134Z",
"defaultContentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction",
"envelopeEncryption": {
"enabledProtocols": {
"download": false,
"dash": true,
"hls": true,
"smoothStreaming": true
},
"clearTracks": [],
"contentKeys": {
"defaultKey": {
"label": "aesDefaultKey"
},
"keyToTrackMappings": []
},
"customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}"
}
}
}
],
"@odata.nextLink": "http://server/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/streamingPolicies?api-version=2022-08-01&$skiptoken=secureStreamingPolicyWithEnvelopeEncryptionOnly"
}
Definitions
Name | Description |
---|---|
Cbcs |
Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy |
Cenc |
Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy |
Clear |
Class to specify ClearKey configuration of common encryption schemes in Streaming Policy |
Common |
Class for CommonEncryptionCbcs encryption scheme |
Common |
Class for envelope encryption scheme |
created |
The type of identity that created the resource. |
Default |
Class to specify properties of default content key for each encryption scheme |
Enabled |
Class to specify which protocols are enabled |
Envelope |
Class for EnvelopeEncryption encryption scheme |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
No |
Class for NoEncryption scheme |
Streaming |
A Streaming Policy resource |
Streaming |
A collection of StreamingPolicy items. |
Streaming |
Class to specify properties of content key |
Streaming |
Class to specify properties of all content keys in Streaming Policy |
Streaming |
Class to specify configurations of FairPlay in Streaming Policy |
Streaming |
Class to specify configurations of PlayReady in Streaming Policy |
Streaming |
Class to specify configurations of Widevine in Streaming Policy |
system |
Metadata pertaining to creation and last modification of the resource. |
Track |
Track property condition operation |
Track |
Class to specify one track property condition |
Track |
Track property type |
Track |
Class to select a track |
CbcsDrmConfiguration
Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy
Name | Type | Description |
---|---|---|
fairPlay |
FairPlay configurations |
|
playReady |
PlayReady configurations |
|
widevine |
Widevine configurations |
CencDrmConfiguration
Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy
Name | Type | Description |
---|---|---|
playReady |
PlayReady configurations |
|
widevine |
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 |
Optional configuration supporting ClearKey in CommonEncryptionCbcs encryption scheme. |
|
clearTracks |
Representing which tracks should not be encrypted |
|
contentKeys |
Representing default content key for each encryption scheme and separate content keys for specific tracks |
|
drm |
Configuration of DRMs for current encryption scheme |
|
enabledProtocols |
Representing supported protocols |
CommonEncryptionCenc
Class for envelope encryption scheme
Name | Type | Description |
---|---|---|
clearKeyEncryptionConfiguration |
Optional configuration supporting ClearKey in CommonEncryptionCenc encryption scheme. |
|
clearTracks |
Representing which tracks should not be encrypted |
|
contentKeys |
Representing default content key for each encryption scheme and separate content keys for specific tracks |
|
drm |
Configuration of DRMs for CommonEncryptionCenc encryption scheme |
|
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 |
Representing which tracks should not be encrypted |
|
contentKeys |
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 |
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 |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
NoEncryption
Class for NoEncryption scheme
Name | Type | Description |
---|---|---|
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 |
Configuration of CommonEncryptionCbcs |
|
properties.commonEncryptionCenc |
Configuration of CommonEncryptionCenc |
|
properties.created |
string |
Creation time of Streaming Policy |
properties.defaultContentKeyPolicyName |
string |
Default ContentKey used by current Streaming Policy |
properties.envelopeEncryption |
Configuration of EnvelopeEncryption |
|
properties.noEncryption |
Configurations of NoEncryption |
|
systemData |
The system metadata relating to this resource. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
StreamingPolicyCollection
A collection of StreamingPolicy 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 |
A collection of StreamingPolicy items. |
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 |
Tracks which use this content key |
StreamingPolicyContentKeys
Class to specify properties of all content keys in Streaming Policy
Name | Type | Description |
---|---|---|
defaultKey |
Default content key for an encryption scheme |
|
keyToTrackMappings |
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 |
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 |
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 |
Track property condition operation |
|
property |
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 |
TrackSelections is a track property condition list which can specify track(s) |