Live Events - List Get Status

Reference

Service:: Media Services

API Version:: 2022-11-01

Get status of one live event
Gets status telemetry of a live event.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/getStatus?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])$`
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	LiveEventGetStatusResult	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. Headers Location: string Azure-AsyncOperation: string
Other Status Codes		Not Modified. The eTag in the request header is the same as the eTag in the storage container.
Other Status Codes	ErrorResponse	The streaming error response describing why the operation failed.

Examples

Get status of a LiveEvent

POST https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveEvents/myLiveEvent1/getStatus?api-version=2022-11-01


/**
 * Samples for LiveEvents ListGetStatus.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/examples/liveevent-get-
     * status.json
     */
    /**
     * Sample code: Get status of a LiveEvent.
     * 
     * @param manager Entry point to MediaServicesManager.
     */
    public static void getStatusOfALiveEvent(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager.liveEvents().listGetStatus("mediaresources", "slitestmedia10", "myLiveEvent1",
            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:: 200

{
  "value": [
    {
      "state": "Stopped",
      "healthStatus": "",
      "healthDescriptions": [
        "No issues with ingest."
      ],
      "lastUpdatedTime": "2022-10-19T22:23:05.22Z",
      "ingestion": {
        "streamName": "myStream",
        "begin": "2022-08-17T22:13:59.45Z",
        "end": "2022-08-17T22:20:36.33Z",
        "endReason": "MPE_CLIENT_TERMINATED_SESSION",
        "ingestInterruptions": [
          {
            "begin": "2022-08-17T22:14:32.33Z",
            "end": "2022-08-17T22:15:33.22Z",
            "duration": "PT1S",
            "reason": "MPE_CLIENT_TERMINATED_SESSION"
          }
        ]
      },
      "trackStatus": [
        {
          "trackId": "audio_128000",
          "expectedBitrate": 128000,
          "incomingBitrate": null,
          "ingestDrift": "",
          "requestReceived": null,
          "requestSucceeded": null
        },
        {
          "trackId": "video_2025000",
          "expectedBitrate": 2025000,
          "incomingBitrate": null,
          "ingestDrift": "",
          "requestReceived": null,
          "requestSucceeded": null
        }
      ]
    }
  ]
}

Status code:: 202

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

Status code:: 304

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
LiveEventGetStatusResult	Get live event status result.
LiveEventHealthStatus	Health status of last 20 seconds.
LiveEventIngestInterruption	The live event ingest interruption data.
LiveEventIngestion	The live event ingestion telemetry data.
LiveEventState	Current state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information.
LiveEventStatus	The live event status.
LiveEventTrackStatus	The live event track status.

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.

LiveEventGetStatusResult

Get live event status result.

Name	Type	Description
value	LiveEventStatus[]	The result of the get live event status.

LiveEventHealthStatus

Health status of last 20 seconds.

Name	Type	Description
Excellent	string	Incoming bitrate >= 75% of target bitrate AND no Ingest warning and error AND ABS(IngestDrift) is equal to 0.
Good	string	Incoming bitrate >= 20% AND no Ingest Error or warning exception discontinuities which gap < 10 seconds.
Poor	string	Otherwise.

LiveEventIngestInterruption

The live event ingest interruption data.

Name	Type	Description
begin	string	UTC time of interruption start, encoder disconnected.
duration	string	Duration of interruption in ISO 8601 time. For example, use PT1H30M to indicate 1 hour and 30 minutes.
end	string	UTC time of interruption end, encoder re-connected.
reason	string	Interruption reason.

LiveEventIngestion

The live event ingestion telemetry data.

Name	Type	Description
begin	string	Ingestion begin time in UTC.
end	string	Ingestion end time in UTC. Empty if it's not stopped yet.
endReason	string	Reason why ingestion stops. Empty if it's not stopped yet. E.g) Service Stopped. No Ingestion.
ingestInterruptions	LiveEventIngestInterruption[]	IngestInterruption entry list.
streamName	string	Ingestion stream name.

LiveEventState

Current state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information.

Name	Type	Description
Running	string	The live event resources have been allocated, ingest and preview URLs have been generated, and it is capable of receiving live streams. At this point, billing is active. You must explicitly call Stop on the live event resource to halt further billing.
Stopped	string	This is the initial state of the live event after creation (unless autostart was set to true.) No billing occurs in this state. In this state, the live event properties can be updated but streaming is not allowed.

LiveEventStatus

The live event status.

Name	Type	Description
healthDescriptions	string[]	List of strings justifying the health status.
healthStatus	LiveEventHealthStatus	Health status of last 20 seconds.
ingestion	LiveEventIngestion	Live event ingestion entry.
lastUpdatedTime	string	Last updated UTC time of this status.
state	LiveEventState	Current state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information.
trackStatus	LiveEventTrackStatus[]	Track entry list.

LiveEventTrackStatus

The live event track status.

Name	Type	Description
expectedBitrate	integer	Expected bitrate for this track.
incomingBitrate	integer	Average incoming bitrate for last 20 seconds when live event is running.
ingestDrift	string	Current ingest drift value in seconds for last 1 minute.
requestReceived	integer	Total number of timed metadata request received.
requestSucceeded	integer	Total number of successful timed metadata request received.
trackId	string	Track Id.

Share via