Live Events - Stop

Reference

Service:: Media Services

API Version:: 2022-11-01

Stop Live Event
Stops a running live event.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/stop?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.

Request Body

Name	Type	Description
removeOutputsOnStop	boolean	The flag indicates whether live outputs are automatically deleted when live event is being stopped. Deleting live outputs do not delete the underlying assets.

Responses

Name	Type	Description
200 OK		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

Stop a LiveEvent

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

{
  "removeOutputsOnStop": false
}


import com.azure.resourcemanager.mediaservices.models.LiveEventActionInput;

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

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:: 200

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
LiveEventActionInput	The LiveEvent action input parameter definition.

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.

LiveEventActionInput

The LiveEvent action input parameter definition.

Name	Type	Description
removeOutputsOnStop	boolean	The flag indicates whether live outputs are automatically deleted when live event is being stopped. Deleting live outputs do not delete the underlying assets.

Share via