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 パラメーター

名前	/	必須	型	説明
accountName	path	True	string	Media Services アカウント名。
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 のバージョン。

要求本文

名前	型	説明
removeOutputsOnStop	boolean	フラグは、ライブイベントの停止時にライブ出力が自動的に削除されるかどうかを示します。ライブ出力を削除すると、基になる資産は削除されません。

応答

名前	型	説明
200 OK		OK です。要求は成功しました。
202 Accepted		受理されました。要求は処理のために受け入れられ、操作は非同期的に完了します。非同期 Azure 操作の監視の詳細については、「」を参照してください https://go.microsoft.com/fwlink/?linkid=2087017 。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するストリーミングエラー応答。

例

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

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
LiveEventActionInput	LiveEvent アクションの入力パラメーター定義。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

LiveEventActionInput

LiveEvent アクションの入力パラメーター定義。

名前	型	説明
removeOutputsOnStop	boolean	フラグは、ライブイベントの停止時にライブ出力が自動的に削除されるかどうかを示します。ライブ出力を削除すると、基になる資産は削除されません。