live_outputs

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

Overview

Name	live_outputs
Type	Resource
Id	azure_extras.media.live_outputs

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.
archiveWindowLength	string	ISO 8601 time between 1 minute to 25 hours to indicate the maximum content length that can be archived in the asset for this live output. This also sets the maximum content length for the rewind window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window.
assetName	string	The asset that the live output will write to.
created	string (date-time)	The creation time the live output.
description	string	The description of the live output.
hls	object	HTTP Live Streaming (HLS) packing setting for the live output.
lastModified	string (date-time)	The time the live output was last modified.
manifestName	string	The manifest file name. If not provided, the service will generate one automatically.
outputSnapTime	integer	The initial timestamp that the live output will start at, any content before this value will not be archived.
provisioningState	string	The provisioning state of the live output.
resourceState	string	The resource state of the live output. Known values are: "Creating", "Running", and "Deleting".
rewindWindowLength	string	ISO 8601 time between 1 minute to the duration of archiveWindowLength to control seek-able window length during Live. The service won't use this property once LiveOutput stops. The archived VOD will have full content with original ArchiveWindowLength. For example, use PT1H30M to indicate 1 hour and 30 minutes of rewind window length. Service will use implicit default value 30m only if Live Event enables LL.
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.
archiveWindowLength	string	ISO 8601 time between 1 minute to 25 hours to indicate the maximum content length that can be archived in the asset for this live output. This also sets the maximum content length for the rewind window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window.
assetName	string	The asset that the live output will write to.
created	string (date-time)	The creation time the live output.
description	string	The description of the live output.
hls	object	HTTP Live Streaming (HLS) packing setting for the live output.
lastModified	string (date-time)	The time the live output was last modified.
manifestName	string	The manifest file name. If not provided, the service will generate one automatically.
outputSnapTime	integer	The initial timestamp that the live output will start at, any content before this value will not be archived.
provisioningState	string	The provisioning state of the live output.
resourceState	string	The resource state of the live output. Known values are: "Creating", "Running", and "Deleting".
rewindWindowLength	string	ISO 8601 time between 1 minute to the duration of archiveWindowLength to control seek-able window length during Live. The service won't use this property once LiveOutput stops. The archived VOD will have full content with original ArchiveWindowLength. For example, use PT1H30M to indicate 1 hour and 30 minutes of rewind window length. Service will use implicit default value 30m only if Live Event enables LL.
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, live_event_name, live_output_name, subscription_id		Get Live Output. Gets a live output.
list	select	resource_group_name, account_name, live_event_name, subscription_id		List Live Outputs. Lists the live outputs of a live event.
create	insert	resource_group_name, account_name, live_event_name, live_output_name, subscription_id		Create Live Output. Creates a new live output.
delete	delete	resource_group_name, account_name, live_event_name, live_output_name, subscription_id		Delete Live Output. Deletes a live output. Deleting a live output does not delete the asset the live output is writing to.
async_operation	exec	resource_group_name, account_name, operation_id, subscription_id		Get operation status. Get a Live Output operation status.
operation_location	exec	resource_group_name, account_name, live_event_name, live_output_name, operation_id, subscription_id		Get operation status. 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
account_name	string	The Media Services account name. Required.
live_event_name	string	The name of the live event, maximum length is 32. Required.
live_output_name	string	The name of the live output. Required.
operation_id	string	The ID of an ongoing async operation. Required.
resource_group_name	string	The name of the resource group within the Azure subscription. Required.
subscription_id	string

SELECT examples

get

Get Live Output. Gets a live output.

SELECT
id,
name,
archiveWindowLength,
assetName,
created,
description,
hls,
lastModified,
manifestName,
outputSnapTime,
provisioningState,
resourceState,
rewindWindowLength,
systemData,
type
FROM azure_extras.media.live_outputs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND live_event_name = '{{ live_event_name }}' -- required
AND live_output_name = '{{ live_output_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Live Outputs. Lists the live outputs of a live event.

SELECT
id,
name,
archiveWindowLength,
assetName,
created,
description,
hls,
lastModified,
manifestName,
outputSnapTime,
provisioningState,
resourceState,
rewindWindowLength,
systemData,
type
FROM azure_extras.media.live_outputs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND live_event_name = '{{ live_event_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create Live Output. Creates a new live output.

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

Manifest

# Description fields are for documentation purposes
- name: live_outputs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the live_outputs resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the live_outputs resource.
  - name: live_event_name
    value: "{{ live_event_name }}"
    description: Required parameter for the live_outputs resource.
  - name: live_output_name
    value: "{{ live_output_name }}"
    description: Required parameter for the live_outputs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the live_outputs resource.
  - name: properties
    value:
      description: "{{ description }}"
      assetName: "{{ assetName }}"
      archiveWindowLength: "{{ archiveWindowLength }}"
      rewindWindowLength: "{{ rewindWindowLength }}"
      manifestName: "{{ manifestName }}"
      hls:
        fragmentsPerTsSegment: {{ fragmentsPerTsSegment }}
      outputSnapTime: {{ outputSnapTime }}

DELETE examples

delete

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

DELETE FROM azure_extras.media.live_outputs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND live_event_name = '{{ live_event_name }}' --required
AND live_output_name = '{{ live_output_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

async_operation

Get operation status. Get a Live Output operation status.

EXEC azure_extras.media.live_outputs.async_operation 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@operation_id='{{ operation_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

operation_location

Get operation status. Get a Live Output operation status.

EXEC azure_extras.media.live_outputs.operation_location 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@live_event_name='{{ live_event_name }}' --required, 
@live_output_name='{{ live_output_name }}' --required, 
@operation_id='{{ operation_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;