streaming_locators

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

Overview

Name	streaming_locators
Type	Resource
Id	azure.media_services.streaming_locators

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Properties of the Streaming Locator.
systemData	object	The system metadata relating to this resource.

list

Name	Datatype	Description
properties	object	Properties of the Streaming Locator.
systemData	object	The system metadata relating to this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, streamingLocatorName	api-version	Get the details of a Streaming Locator in the Media Services account
list	select	subscriptionId, resourceGroupName, accountName	api-version, $filter, $top, $orderby	Lists the Streaming Locators in the account
create	insert	subscriptionId, resourceGroupName, accountName, streamingLocatorName	api-version	Create a Streaming Locator in the Media Services account
delete	delete	subscriptionId, resourceGroupName, accountName, streamingLocatorName	api-version	Deletes a Streaming Locator 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
accountName	string	The Media Services account name.
resourceGroupName	string	The name of the resource group within the Azure subscription.
streamingLocatorName	string	The Streaming Locator name.
subscriptionId	string	The unique identifier for a Microsoft Azure subscription.
$filter	string	Restricts the set of items returned.
$orderby	string	Specifies the key by which the result collection should be ordered.
$top	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.
api-version	string	The version of the API to be used with the client request.

SELECT examples

get

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

SELECT
properties,
systemData
FROM azure.media_services.streaming_locators
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND streamingLocatorName = '{{ streamingLocatorName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Lists the Streaming Locators in the account

SELECT
properties,
systemData
FROM azure.media_services.streaming_locators
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND api-version = '{{ api-version }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create

Create a Streaming Locator in the Media Services account

INSERT INTO azure.media_services.streaming_locators (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
streamingLocatorName,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ streamingLocatorName }}',
'{{ api-version }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: streaming_locators
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the streaming_locators resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the streaming_locators resource.
    - name: accountName
      value: string
      description: Required parameter for the streaming_locators resource.
    - name: streamingLocatorName
      value: string
      description: Required parameter for the streaming_locators resource.
    - name: properties
      value: object
      description: |
        Properties of the Streaming Locator.
    - name: api-version
      value: string
      description: The version of the API to be used with the client request.

DELETE examples

delete

Deletes a Streaming Locator in the Media Services account

DELETE FROM azure.media_services.streaming_locators
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND streamingLocatorName = '{{ streamingLocatorName }}' --required
AND api-version = '{{ api-version }}'
;