streaming_policies

Creates, updates, deletes, gets or lists a streaming_policies resource.

Overview

Name	streaming_policies
Type	Resource
Id	azure_extras.media.streaming_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	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.
commonEncryptionCbcs	object	Configuration of CommonEncryptionCbcs.
commonEncryptionCenc	object	Configuration of CommonEncryptionCenc.
created	string (date-time)	Creation time of Streaming Policy.
defaultContentKeyPolicyName	string	Default ContentKey used by current Streaming Policy.
envelopeEncryption	object	Configuration of EnvelopeEncryption.
noEncryption	object	Configurations of NoEncryption.
systemData	object	The system metadata relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	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.
commonEncryptionCbcs	object	Configuration of CommonEncryptionCbcs.
commonEncryptionCenc	object	Configuration of CommonEncryptionCenc.
created	string (date-time)	Creation time of Streaming Policy.
defaultContentKeyPolicyName	string	Default ContentKey used by current Streaming Policy.
envelopeEncryption	object	Configuration of EnvelopeEncryption.
noEncryption	object	Configurations of NoEncryption.
systemData	object	The system metadata relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, streaming_policy_name, subscription_id		Get a Streaming Policy. Get the details of a Streaming Policy in the Media Services account.
list	select	resource_group_name, account_name, subscription_id	$filter, $top, $orderby	List Streaming Policies. Lists the Streaming Policies in the account.
create	insert	resource_group_name, account_name, streaming_policy_name, subscription_id		Create a Streaming Policy. Create a Streaming Policy in the Media Services account.
delete	delete	resource_group_name, account_name, streaming_policy_name, subscription_id		Delete a Streaming Policy. Deletes a Streaming Policy in the Media Services account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_name	string	The Media Services account name. Required.
resource_group_name	string	The name of the resource group within the Azure subscription. Required.
streaming_policy_name	string	The Streaming Policy name. Required.
subscription_id	string
$filter	string	Restricts the set of items returned. Default value is None.
$orderby	string	Specifies the key by which the result collection should be ordered. Default value is None.
$top	integer	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. Default value is None.

SELECT examples

get

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

SELECT
id,
name,
commonEncryptionCbcs,
commonEncryptionCenc,
created,
defaultContentKeyPolicyName,
envelopeEncryption,
noEncryption,
systemData,
type
FROM azure_extras.media.streaming_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND streaming_policy_name = '{{ streaming_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Streaming Policies. Lists the Streaming Policies in the account.

SELECT
id,
name,
commonEncryptionCbcs,
commonEncryptionCenc,
created,
defaultContentKeyPolicyName,
envelopeEncryption,
noEncryption,
systemData,
type
FROM azure_extras.media.streaming_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create

Create a Streaming Policy. Create a Streaming Policy in the Media Services account.

INSERT INTO azure_extras.media.streaming_policies (
properties,
resource_group_name,
account_name,
streaming_policy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ streaming_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: streaming_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the streaming_policies resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the streaming_policies resource.
  - name: streaming_policy_name
    value: "{{ streaming_policy_name }}"
    description: Required parameter for the streaming_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the streaming_policies resource.
  - name: properties
    value:
      defaultContentKeyPolicyName: "{{ defaultContentKeyPolicyName }}"
      envelopeEncryption:
        enabledProtocols:
          download: {{ download }}
          dash: {{ dash }}
          hls: {{ hls }}
          smoothStreaming: {{ smoothStreaming }}
        clearTracks:
          - trackSelections: "{{ trackSelections }}"
        contentKeys:
          defaultKey:
            label: "{{ label }}"
            policyName: "{{ policyName }}"
          keyToTrackMappings:
            - label: "{{ label }}"
              policyName: "{{ policyName }}"
              tracks: "{{ tracks }}"
        customKeyAcquisitionUrlTemplate: "{{ customKeyAcquisitionUrlTemplate }}"
      commonEncryptionCenc:
        enabledProtocols:
          download: {{ download }}
          dash: {{ dash }}
          hls: {{ hls }}
          smoothStreaming: {{ smoothStreaming }}
        clearTracks:
          - trackSelections: "{{ trackSelections }}"
        contentKeys:
          defaultKey:
            label: "{{ label }}"
            policyName: "{{ policyName }}"
          keyToTrackMappings:
            - label: "{{ label }}"
              policyName: "{{ policyName }}"
              tracks: "{{ tracks }}"
        drm:
          playReady:
            customLicenseAcquisitionUrlTemplate: "{{ customLicenseAcquisitionUrlTemplate }}"
            playReadyCustomAttributes: "{{ playReadyCustomAttributes }}"
          widevine:
            customLicenseAcquisitionUrlTemplate: "{{ customLicenseAcquisitionUrlTemplate }}"
        clearKeyEncryptionConfiguration:
          customKeysAcquisitionUrlTemplate: "{{ customKeysAcquisitionUrlTemplate }}"
      commonEncryptionCbcs:
        enabledProtocols:
          download: {{ download }}
          dash: {{ dash }}
          hls: {{ hls }}
          smoothStreaming: {{ smoothStreaming }}
        clearTracks:
          - trackSelections: "{{ trackSelections }}"
        contentKeys:
          defaultKey:
            label: "{{ label }}"
            policyName: "{{ policyName }}"
          keyToTrackMappings:
            - label: "{{ label }}"
              policyName: "{{ policyName }}"
              tracks: "{{ tracks }}"
        drm:
          fairPlay:
            customLicenseAcquisitionUrlTemplate: "{{ customLicenseAcquisitionUrlTemplate }}"
            allowPersistentLicense: {{ allowPersistentLicense }}
          playReady:
            customLicenseAcquisitionUrlTemplate: "{{ customLicenseAcquisitionUrlTemplate }}"
            playReadyCustomAttributes: "{{ playReadyCustomAttributes }}"
          widevine:
            customLicenseAcquisitionUrlTemplate: "{{ customLicenseAcquisitionUrlTemplate }}"
        clearKeyEncryptionConfiguration:
          customKeysAcquisitionUrlTemplate: "{{ customKeysAcquisitionUrlTemplate }}"
      noEncryption:
        enabledProtocols:
          download: {{ download }}
          dash: {{ dash }}
          hls: {{ hls }}
          smoothStreaming: {{ smoothStreaming }}

DELETE examples

delete

Delete a Streaming Policy. Deletes a Streaming Policy in the Media Services account.

DELETE FROM azure_extras.media.streaming_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND streaming_policy_name = '{{ streaming_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;