streaming_locators

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

Overview

Name	streaming_locators
Type	Resource
Id	azure_extras.media.streaming_locators

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.
alternativeMediaId	string	Alternative Media ID of this Streaming Locator.
assetName	string	Asset Name.
contentKeys	array	The ContentKeys used by this Streaming Locator.
created	string (date-time)	The creation time of the Streaming Locator.
defaultContentKeyPolicyName	string	Name of the default ContentKeyPolicy used by this Streaming Locator.
endTime	string (date-time)	The end time of the Streaming Locator.
filters	array	A list of asset or account filters which apply to this streaming locator.
startTime	string (date-time)	The start time of the Streaming Locator.
streamingLocatorId	string	The StreamingLocatorId of the Streaming Locator.
streamingPolicyName	string	Name of the Streaming Policy used by this Streaming Locator. Either specify the name of Streaming Policy you created or use one of the predefined Streaming Policies. The predefined Streaming Policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_MultiDrmCencStreaming' and 'Predefined_MultiDrmStreaming'.
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.
alternativeMediaId	string	Alternative Media ID of this Streaming Locator.
assetName	string	Asset Name.
contentKeys	array	The ContentKeys used by this Streaming Locator.
created	string (date-time)	The creation time of the Streaming Locator.
defaultContentKeyPolicyName	string	Name of the default ContentKeyPolicy used by this Streaming Locator.
endTime	string (date-time)	The end time of the Streaming Locator.
filters	array	A list of asset or account filters which apply to this streaming locator.
startTime	string (date-time)	The start time of the Streaming Locator.
streamingLocatorId	string	The StreamingLocatorId of the Streaming Locator.
streamingPolicyName	string	Name of the Streaming Policy used by this Streaming Locator. Either specify the name of Streaming Policy you created or use one of the predefined Streaming Policies. The predefined Streaming Policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_MultiDrmCencStreaming' and 'Predefined_MultiDrmStreaming'.
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_locator_name, subscription_id		Get a Streaming Locator. Get the details of a Streaming Locator in the Media Services account.
list	select	resource_group_name, account_name, subscription_id	$filter, $top, $orderby	List Streaming Locators. Lists the Streaming Locators in the account.
create	insert	resource_group_name, account_name, streaming_locator_name, subscription_id		Create a Streaming Locator. Create a Streaming Locator in the Media Services account.
delete	delete	resource_group_name, account_name, streaming_locator_name, subscription_id		Delete a Streaming Locator. Deletes a Streaming Locator in the Media Services account.
list_content_keys	exec	resource_group_name, account_name, streaming_locator_name, subscription_id		List Content Keys. List Content Keys used by this Streaming Locator.
list_paths	exec	resource_group_name, account_name, streaming_locator_name, subscription_id		List Paths. List Paths supported by this Streaming Locator.

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_locator_name	string	The Streaming Locator 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 Locator. Get the details of a Streaming Locator in the Media Services account.

SELECT
id,
name,
alternativeMediaId,
assetName,
contentKeys,
created,
defaultContentKeyPolicyName,
endTime,
filters,
startTime,
streamingLocatorId,
streamingPolicyName,
systemData,
type
FROM azure_extras.media.streaming_locators
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND streaming_locator_name = '{{ streaming_locator_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Streaming Locators. Lists the Streaming Locators in the account.

SELECT
id,
name,
alternativeMediaId,
assetName,
contentKeys,
created,
defaultContentKeyPolicyName,
endTime,
filters,
startTime,
streamingLocatorId,
streamingPolicyName,
systemData,
type
FROM azure_extras.media.streaming_locators
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 Locator. Create a Streaming Locator in the Media Services account.

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

Manifest

# Description fields are for documentation purposes
- name: streaming_locators
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the streaming_locators resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the streaming_locators resource.
  - name: streaming_locator_name
    value: "{{ streaming_locator_name }}"
    description: Required parameter for the streaming_locators resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the streaming_locators resource.
  - name: properties
    value:
      assetName: "{{ assetName }}"
      startTime: "{{ startTime }}"
      endTime: "{{ endTime }}"
      streamingLocatorId: "{{ streamingLocatorId }}"
      streamingPolicyName: "{{ streamingPolicyName }}"
      defaultContentKeyPolicyName: "{{ defaultContentKeyPolicyName }}"
      contentKeys:
        - id: "{{ id }}"
          type: "{{ type }}"
          labelReferenceInStreamingPolicy: "{{ labelReferenceInStreamingPolicy }}"
          value: "{{ value }}"
          policyName: "{{ policyName }}"
          tracks: "{{ tracks }}"
      alternativeMediaId: "{{ alternativeMediaId }}"
      filters:
        - "{{ filters }}"

DELETE examples

delete

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

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

Lifecycle Methods

list_content_keys

List Content Keys. List Content Keys used by this Streaming Locator.

EXEC azure_extras.media.streaming_locators.list_content_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@streaming_locator_name='{{ streaming_locator_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_paths

List Paths. List Paths supported by this Streaming Locator.

EXEC azure_extras.media.streaming_locators.list_paths 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@streaming_locator_name='{{ streaming_locator_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;