Live Outputs - Operation Location

Reference

Service:: Media Services

API Version:: 2022-11-01

Get operation status.
Get a Live Output operation status.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs/{liveOutputName}/operationLocations/{operationId}?api-version=2022-11-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])$`
operationId	path	True	string	The ID of an ongoing async operation.
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.

Responses

Name	Type	Description
200 OK	LiveOutput	OK. The request has succeeded.
202 Accepted		Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations.
Other Status Codes	ErrorResponse	The streaming error response describing why the operation failed.

Examples

Get the LiveOutput operation status

GET https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveEvents/myLiveEvent1/liveOutputs/myLiveOutput1/operationLocations/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-11-01

/** Samples for LiveOutputs OperationLocation. */
public final class Main {
    /*
     * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/examples/liveoutput-operation-location.json
     */
    /**
     * Sample code: Get the LiveOutput operation status.
     *
     * @param manager Entry point to MediaServicesManager.
     */
    public static void getTheLiveOutputOperationStatus(
        com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager
            .liveOutputs()
            .operationLocationWithResponse(
                "mediaresources",
                "slitestmedia10",
                "myLiveEvent1",
                "myLiveOutput1",
                "62e4d893-d233-4005-988e-a428d9f77076",
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 202

Status code:: 200

{
  "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": null,
    "assetName": "cb2ae0bc-677a-4830-9c8e-06ce4c4cb607",
    "archiveWindowLength": "PT5M",
    "manifestName": "fc7096f5-c488-4b86-8302-f3bfde53fc27",
    "outputSnapTime": 0,
    "resourceState": "Running",
    "provisioningState": "Succeeded",
    "created": "0001-01-01T00:00:00-08:00",
    "lastModified": "0001-01-01T00:00:00-08:00",
    "hls": {
      "fragmentsPerTsSegment": 5
    },
    "rewindWindowLength": "PT5M"
  },
  "systemData": {
    "createdBy": "example@microsoft.com",
    "createdByType": "User",
    "createdAt": "0001-01-01T00:00:00-08:00",
    "lastModifiedBy": "example@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "0001-01-01T00:00:00-08:00"
  }
}

Definitions

Name	Description
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	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	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	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	LiveOutputResourceState	The resource state of the live output.
properties.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	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	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	createdByType	The type of identity that last modified the resource.