live_events

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

Overview

Name	live_events
Type	Resource
Id	azure.media_services.live_events

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 live event properties.
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 live event properties.
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, liveEventName	api-version	Gets properties of a live event.
list	select	subscriptionId, resourceGroupName, accountName	api-version	Lists all the live events in the account.
create	insert	subscriptionId, resourceGroupName, accountName, liveEventName	api-version, autoStart	Creates a new live event.
update	update	subscriptionId, resourceGroupName, accountName, liveEventName	api-version	Updates settings on an existing live event.
delete	delete	subscriptionId, resourceGroupName, accountName, liveEventName	api-version	Deletes a live event.
allocate	exec	subscriptionId, resourceGroupName, accountName, liveEventName	api-version	A live event is in StandBy state after allocation completes, and is ready to start.
start	exec	subscriptionId, resourceGroupName, accountName, liveEventName	api-version	A live event in Stopped or StandBy state will be in Running state after the start operation completes.
stop	exec	subscriptionId, resourceGroupName, accountName, liveEventName	api-version	Stops a running live event.
reset	exec	subscriptionId, resourceGroupName, accountName, liveEventName	api-version	Resets an existing live event. All live outputs for the live event are deleted and the live event is stopped and will be started again. All assets used by the live outputs and streaming locators created on these assets are unaffected.
async_operation	exec	subscriptionId, resourceGroupName, accountName, operationId	api-version	Get a live event operation status.
operation_location	exec	subscriptionId, resourceGroupName, accountName, liveEventName, operationId	api-version	Get a live event 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.
liveEventName	string	The name of the live event, maximum length is 32.
operationId	string	The ID of an ongoing async operation.
resourceGroupName	string	The name of the resource group within the Azure subscription.
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 properties of a live event.

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

list

Lists all the live events in the account.

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

INSERT examples

create

Creates a new live event.

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

Manifest

# Description fields are for documentation purposes
- name: live_events
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the live_events resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the live_events resource.
    - name: accountName
      value: string
      description: Required parameter for the live_events resource.
    - name: liveEventName
      value: string
      description: Required parameter for the live_events resource.
    - name: properties
      value: object
      description: |
        The live event properties.
    - 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 settings on an existing live event.

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

DELETE examples

delete

Deletes a live event.

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

Lifecycle Methods

allocate

A live event is in StandBy state after allocation completes, and is ready to start.

EXEC azure.media_services.live_events.allocate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@liveEventName='{{ liveEventName }}' --required, 
@api-version='{{ api-version }}'
;

start

A live event in Stopped or StandBy state will be in Running state after the start operation completes.

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

stop

Stops a running live event.

EXEC azure.media_services.live_events.stop 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@liveEventName='{{ liveEventName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"removeOutputsOnStop": {{ removeOutputsOnStop }}
}'
;

reset

Resets an existing live event. All live outputs for the live event are deleted and the live event is stopped and will be started again. All assets used by the live outputs and streaming locators created on these assets are unaffected.

EXEC azure.media_services.live_events.reset 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@liveEventName='{{ liveEventName }}' --required, 
@api-version='{{ api-version }}'
;

async_operation

Get a live event operation status.

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

operation_location

Get a live event operation status.

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