Live Outputs - Create

Create Live Output
Creates a new live output.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs/{liveOutputName}?api-version=2021-06-01

URI Parameters

Name In Required Type Description
accountName
path True
  • string

The Media Services account name.

liveEventName
path True
  • string

The name of the live event, maximum length is 32.

Regex pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$

liveOutputName
path True
  • string

The name of the live output.

Regex pattern: ^([a-zA-Z0-9])+(-*[a-zA-Z0-9])*$

resourceGroupName
path True
  • string

The name of the resource group within the Azure subscription.

subscriptionId
path True
  • string

The unique identifier for a Microsoft Azure subscription.

api-version
query True
  • string

The version of the API to be used with the client request.

Request Body

Name Required Type Description
properties.archiveWindowLength True
  • 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.

properties.assetName True
  • string

The asset that the live output will write to.

properties.description
  • string

The description of the live output.

properties.hls

HTTP Live Streaming (HLS) packing setting for the live output.

properties.manifestName
  • string

The manifest file name. If not provided, the service will generate one automatically.

properties.outputSnapTime
  • integer

The initial timestamp that the live output will start at, any content before this value will not be archived.

Responses

Name Type Description
200 OK

OK. The request has succeeded.

201 Created

Created. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on monitoring asynchronous Azure operations using the Azure-AsyncOperation response header.

Other Status Codes

The streaming error response describing why the operation failed.

Examples

Create a LiveOutput

Sample Request

PUT https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveEvents/myLiveEvent1/liveOutputs/myLiveOutput1?api-version=2021-06-01
{
  "properties": {
    "description": "test live output 1",
    "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212",
    "archiveWindowLength": "PT5M",
    "manifestName": "testmanifest",
    "hls": {
      "fragmentsPerTsSegment": 5
    }
  }
}

Sample Response

{
  "name": "myLiveOutput1",
  "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1",
  "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs",
  "properties": {
    "description": "test live output 1",
    "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212",
    "archiveWindowLength": "PT5M",
    "manifestName": "testmanifest",
    "outputSnapTime": 0,
    "resourceState": "Stopped",
    "provisioningState": "Succeeded",
    "created": "2018-03-03T02:25:09.9431835Z",
    "lastModified": "2018-03-03T02:25:09.9431835Z",
    "hls": {
      "fragmentsPerTsSegment": 5
    }
  }
}
{
  "name": "myLiveOutput1",
  "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1",
  "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs",
  "properties": {
    "description": "test live output 1",
    "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212",
    "archiveWindowLength": "PT5M",
    "manifestName": "testmanifest",
    "outputSnapTime": 0,
    "resourceState": "Creating",
    "provisioningState": "InProgress",
    "created": "2018-03-03T02:25:09.9431835Z",
    "lastModified": "2018-03-03T02:25:09.9431835Z",
    "hls": {
      "fragmentsPerTsSegment": 5
    }
  }
}

Definitions

createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

Hls

HTTP Live Streaming (HLS) packing setting for the live output.

LiveOutput

The Live Output.

LiveOutputResourceState

The resource state of the live output.

systemData

Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

ErrorResponse

Error response

Name Type Description
error

The error object.

Hls

HTTP Live Streaming (HLS) packing setting for the live output.

Name Type Description
fragmentsPerTsSegment
  • integer

The number of fragments in an HTTP Live Streaming (HLS) TS segment in the output of the live event. This value does not affect the packing ratio for HLS CMAF output.

LiveOutput

The Live Output.

Name Type 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

properties.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.

properties.assetName
  • string

The asset that the live output will write to.

properties.created
  • string

The creation time the live output.

properties.description
  • string

The description of the live output.

properties.hls

HTTP Live Streaming (HLS) packing setting for the live output.

properties.lastModified
  • string

The time the live output was last modified.

properties.manifestName
  • string

The manifest file name. If not provided, the service will generate one automatically.

properties.outputSnapTime
  • integer

The initial timestamp that the live output will start at, any content before this value will not be archived.

properties.provisioningState
  • string

The provisioning state of the live output.

properties.resourceState

The resource state of the live output.

systemData

The system metadata relating to this resource.

type
  • string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

LiveOutputResourceState

The resource state of the live output.

Name Type Description
Creating
  • string

Live output is being created. No content is archived in the asset until the live output is in running state.

Deleting
  • string

Live output is being deleted. The live asset is being converted from live to on-demand asset. Any streaming URLs created on the live output asset continue to work.

Running
  • string

Live output is running and archiving live streaming content to the asset if there is valid input from a contribution encoder.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt
  • string

The timestamp of resource creation (UTC).

createdBy
  • string

The identity that created the resource.

createdByType

The type of identity that created the resource.

lastModifiedAt
  • string

The timestamp of resource last modification (UTC)

lastModifiedBy
  • string

The identity that last modified the resource.

lastModifiedByType

The type of identity that last modified the resource.