Live Events - Stop

Service:

Media Services

API Version:

2022-11-01

停止即時活動
停止執行中的即時活動。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/stop?api-version=2022-11-01

URI 參數

名稱	位於	必要	類型	Description
accountName	path	True	string	媒體服務帳戶名稱。
liveEventName	path	True	string	實時活動的名稱，最大長度為32。 Regex pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
resourceGroupName	path	True	string	Azure 訂用帳戶內的資源組名。
subscriptionId	path	True	string	Microsoft Azure 訂用帳戶的唯一標識符。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。

要求本文

名稱	類型	Description
removeOutputsOnStop	boolean	旗標會指出即時輸出是否在即時活動停止時自動刪除。 刪除實時輸出並不會刪除基礎資產。

回應

名稱	類型	Description
200 OK		正常。 要求已成功。
202 Accepted		已接受。 已接受要求進行處理，且作業會以異步方式完成。 如需監視異步 Azure 作業的詳細資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2087017 。
Other Status Codes	ErrorResponse	串流錯誤回應，描述作業失敗的原因。

範例

Stop a LiveEvent

Sample Request

HTTP

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
}

Java

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

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
LiveEventActionInput	LiveEvent 動作輸入參數定義。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

LiveEventActionInput

LiveEvent 動作輸入參數定義。

名稱	類型	Description
removeOutputsOnStop	boolean	旗標會指出即時輸出是否在即時活動停止時自動刪除。 刪除實時輸出並不會刪除基礎資產。