streaming_endpoints

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

Overview

Name	streaming_endpoints
Type	Resource
Id	azure.media_services.streaming_endpoints

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The streaming endpoint properties.
sku	object	The streaming endpoint sku.
systemData	object	The system metadata relating to this resource.
tags	object	Resource tags.

list

OK. The request has succeeded.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The streaming endpoint properties.
sku	object	The streaming endpoint sku.
systemData	object	The system metadata relating to this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, streamingEndpointName	api-version	Gets a streaming endpoint.
list	select	subscriptionId, resourceGroupName, accountName	api-version	Lists the streaming endpoints in the account.
create	insert	subscriptionId, resourceGroupName, accountName, streamingEndpointName	api-version, autoStart	Creates a streaming endpoint.
update	update	subscriptionId, resourceGroupName, accountName, streamingEndpointName	api-version	Updates a existing streaming endpoint.
delete	delete	subscriptionId, resourceGroupName, accountName, streamingEndpointName	api-version	Deletes a streaming endpoint.
skus	exec	subscriptionId, resourceGroupName, accountName, streamingEndpointName	api-version	List streaming endpoint supported skus.
start	exec	subscriptionId, resourceGroupName, accountName, streamingEndpointName	api-version	Starts an existing streaming endpoint.
stop	exec	subscriptionId, resourceGroupName, accountName, streamingEndpointName	api-version	Stops an existing streaming endpoint.
scale	exec	subscriptionId, resourceGroupName, accountName, streamingEndpointName	api-version	Scales an existing streaming endpoint.
async_operation	exec	subscriptionId, resourceGroupName, accountName, operationId	api-version	Get a streaming endpoint operation status.
operation_location	exec	subscriptionId, resourceGroupName, accountName, streamingEndpointName, operationId	api-version	Get a streaming endpoint operation status.

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.
operationId	string	The ID of an ongoing async operation.
resourceGroupName	string	The name of the resource group within the Azure subscription.
streamingEndpointName	string	The name of the streaming endpoint, maximum length is 24.
subscriptionId	string	The unique identifier for a Microsoft Azure subscription.
api-version	string	The version of the API to be used with the client request.
autoStart	boolean	The flag indicates if the resource should be automatically started on creation.

SELECT examples

get

Gets a streaming endpoint.

SELECT
location,
properties,
sku,
systemData,
tags
FROM azure.media_services.streaming_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND streamingEndpointName = '{{ streamingEndpointName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Lists the streaming endpoints in the account.

SELECT
location,
properties,
sku,
systemData,
tags
FROM azure.media_services.streaming_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

Creates a streaming endpoint.

INSERT INTO azure.media_services.streaming_endpoints (
data__properties,
data__sku,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
accountName,
streamingEndpointName,
api-version,
autoStart
)
SELECT 
'{{ properties }}',
'{{ sku }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ streamingEndpointName }}',
'{{ api-version }}',
'{{ autoStart }}'
RETURNING
location,
properties,
sku,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: streaming_endpoints
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the streaming_endpoints resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the streaming_endpoints resource.
    - name: accountName
      value: string
      description: Required parameter for the streaming_endpoints resource.
    - name: streamingEndpointName
      value: string
      description: Required parameter for the streaming_endpoints resource.
    - name: properties
      value: object
      description: |
        The streaming endpoint properties.
    - name: sku
      value: object
      description: |
        The streaming endpoint sku.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: api-version
      value: string
      description: The version of the API to be used with the client request.
    - name: autoStart
      value: boolean
      description: The flag indicates if the resource should be automatically started on creation.

UPDATE examples

update

Updates a existing streaming endpoint.

UPDATE azure.media_services.streaming_endpoints
SET 
data__properties = '{{ properties }}',
data__sku = '{{ sku }}',
data__tags = '{{ tags }}',
data__location = '{{ location }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND streamingEndpointName = '{{ streamingEndpointName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
location,
properties,
sku,
systemData,
tags;

DELETE examples

delete

Deletes a streaming endpoint.

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

Lifecycle Methods

skus

List streaming endpoint supported skus.

EXEC azure.media_services.streaming_endpoints.skus 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@streamingEndpointName='{{ streamingEndpointName }}' --required, 
@api-version='{{ api-version }}'
;

start

Starts an existing streaming endpoint.

EXEC azure.media_services.streaming_endpoints.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@streamingEndpointName='{{ streamingEndpointName }}' --required, 
@api-version='{{ api-version }}'
;

stop

Stops an existing streaming endpoint.

EXEC azure.media_services.streaming_endpoints.stop 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@streamingEndpointName='{{ streamingEndpointName }}' --required, 
@api-version='{{ api-version }}'
;

scale

Scales an existing streaming endpoint.

EXEC azure.media_services.streaming_endpoints.scale 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@streamingEndpointName='{{ streamingEndpointName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"scaleUnit": {{ scaleUnit }}
}'
;

async_operation

Get a streaming endpoint operation status.

EXEC azure.media_services.streaming_endpoints.async_operation 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@operationId='{{ operationId }}' --required, 
@api-version='{{ api-version }}'
;

operation_location

Get a streaming endpoint operation status.

EXEC azure.media_services.streaming_endpoints.operation_location 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@streamingEndpointName='{{ streamingEndpointName }}' --required, 
@operationId='{{ operationId }}' --required, 
@api-version='{{ api-version }}'
;