live_outputs

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

Overview

Name	live_outputs
Type	Resource
Id	azure.media_services.live_outputs

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

Name	Datatype	Description
properties	object	Live output properties.
systemData	object	The system metadata relating to this resource.

list

OK. The request has succeeded.

Name	Datatype	Description
properties	object	Live output properties.
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, liveEventName, liveOutputName	api-version	Gets a live output.
list	select	subscriptionId, resourceGroupName, accountName, liveEventName	api-version	Lists the live outputs of a live event.
create	insert	subscriptionId, resourceGroupName, accountName, liveEventName, liveOutputName	api-version	Creates a new live output.
delete	delete	subscriptionId, resourceGroupName, accountName, liveEventName, liveOutputName	api-version	Deletes a live output. Deleting a live output does not delete the asset the live output is writing to.
async_operation	exec	subscriptionId, resourceGroupName, accountName, operationId	api-version	Get a Live Output operation status.
operation_location	exec	subscriptionId, resourceGroupName, accountName, liveEventName, liveOutputName, operationId	api-version	Get a Live Output 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.
liveOutputName	string	The name of the live output.
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.

SELECT examples

get

Gets a live output.

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

list

Lists the live outputs of a live event.

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

INSERT examples

create

Creates a new live output.

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

Manifest

# Description fields are for documentation purposes
- name: live_outputs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the live_outputs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the live_outputs resource.
    - name: accountName
      value: string
      description: Required parameter for the live_outputs resource.
    - name: liveEventName
      value: string
      description: Required parameter for the live_outputs resource.
    - name: liveOutputName
      value: string
      description: Required parameter for the live_outputs resource.
    - name: properties
      value: object
      description: |
        Live output properties.
    - name: api-version
      value: string
      description: The version of the API to be used with the client request.

DELETE examples

delete

Deletes a live output. Deleting a live output does not delete the asset the live output is writing to.

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

Lifecycle Methods

async_operation

Get a Live Output operation status.

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

operation_location

Get a Live Output operation status.

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