Live Events - List

リファレンス

Service:: Media Services

API Version:: 2022-11-01

ライブイベントを一覧表示する
アカウント内のすべてのライブイベントをListsします。

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

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string	Media Services アカウント名。
resourceGroupName	path	True	string	Azure サブスクリプション内のリソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションの一意識別子。
api-version	query	True	string	クライアント要求で使用される API のバージョン。

応答

名前	型	説明
200 OK	LiveEventListResult	OK です。要求は成功しました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するストリーミングエラー応答。

例

List all LiveEvents

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

/** Samples for LiveEvents List. */
public final class Main {
    /*
     * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/examples/liveevent-list-all.json
     */
    /**
     * Sample code: List all LiveEvents.
     *
     * @param manager Entry point to MediaServicesManager.
     */
    public static void listAllLiveEvents(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager.liveEvents().list("mediaresources", "slitestmedia10", 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": [
    {
      "name": "myLiveEvent1",
      "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1",
      "type": "Microsoft.Media/mediaservices/liveevents",
      "location": "West US",
      "tags": {
        "tag1": "value1",
        "tag2": "value2"
      },
      "properties": {
        "description": "test event 1",
        "resourceState": "Stopped",
        "provisioningState": "Succeeded",
        "created": "2018-03-03T02:25:08.5564064Z",
        "lastModified": "2018-03-03T02:25:08.5564064Z",
        "useStaticHostname": false,
        "streamOptions": [],
        "input": {
          "keyFrameIntervalDuration": "PT6S",
          "streamingProtocol": "RTMP",
          "accessToken": "<accessToken>",
          "endpoints": [
            {
              "protocol": "RTMP",
              "url": "rtmp://clouddeployment.media-test.net:1935/live/de153bb0814542d9b7e2339ce9430dc4"
            },
            {
              "protocol": "RTMP",
              "url": "rtmp://clouddeployment.media-test.net:1936/live/de153bb0814542d9b7e2339ce9430dc4"
            },
            {
              "protocol": "RTMP",
              "url": "rtmps://clouddeployment.media-test.net:2935/live/de153bb0814542d9b7e2339ce9430dc4"
            },
            {
              "protocol": "RTMP",
              "url": "rtmps://clouddeployment.media-test.net:2936/live/de153bb0814542d9b7e2339ce9430dc4"
            }
          ],
          "timedMetadataEndpoints": [
            {
              "url": "https://clouddeployment.media-test.net/de153bb0814542d9b7e2339ce9430dc4/ingest.isml/eventdata"
            }
          ]
        },
        "preview": {
          "previewLocator": "a220e223-faf8-4e03-b9a9-2c2432f48025",
          "streamingPolicyName": null,
          "accessControl": {
            "ip": {
              "allow": [
                {
                  "name": "AllowAll",
                  "address": "0.0.0.0",
                  "subnetPrefixLength": 0
                }
              ]
            }
          },
          "endpoints": [
            {
              "protocol": "FragmentedMP4",
              "url": "https://myliveevent1-slitestmedia10.preview-usso.channel.mediaservices.windows.net/a220e223-faf8-4e03-b9a9-2c2432f48025/preview.ism/manifest"
            }
          ]
        },
        "encoding": {
          "encodingType": "None",
          "presetName": null
        },
        "crossSiteAccessPolicies": {
          "clientAccessPolicy": null,
          "crossDomainPolicy": null
        }
      }
    }
  ]
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
CrossSiteAccessPolicies	クライアントアクセスポリシー。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
IPAccessControl	IP アクセス制御。
IPRange	CIDR スキームの IP アドレス範囲。
LiveEvent	ライブイベント。
LiveEventEncoding	ライブイベントの種類と、ライブイベントをエンコードするためのオプションのエンコード設定を指定します。
LiveEventEncodingType	ライブイベントの種類。 encodingType が PassthroughBasic または PassthroughStandard に設定されている場合、サービスは単に受信ビデオとオーディオレイヤーを経由して出力に渡します。 encodingType が Standard または Premium1080p に設定されている場合、ライブエンコーダーは受信ストリームを複数のビットレートまたはレイヤーにトランスコードします。詳細については、「 https://go.microsoft.com/fwlink/?linkid=2095101 」を参照してください。ライブイベントの作成後にこのプロパティを変更することはできません。
LiveEventEndpoint	ライブイベントエンドポイント。
LiveEventInput	ライブイベントの入力。
LiveEventInputAccessControl	ライブイベント入力の IP アクセス制御。
LiveEventInputProtocol	ライブイベントの入力プロトコル。これは作成時に指定され、更新できません。
LiveEventInputTrackSelection	トラック選択条件。このプロパティは将来使用するために予約されています。このプロパティに設定された値は無視されます。
LiveEventListResult	LiveEventListResult
LiveEventOutputTranscriptionTrack	音声テキスト変換文字起こしを使用して生成されるライブイベントの出力内の文字起こしトラックについて説明します。このプロパティは将来使用するために予約されています。このプロパティに設定された値は無視されます。
LiveEventPreview	ライブイベントプレビューの設定。
LiveEventPreviewAccessControl	ライブイベントプレビューエンドポイントの IP アクセス制御。
LiveEventResourceState	ライブイベントのリソース状態。詳細については、「 https://go.microsoft.com/fwlink/?linkid=2139012 」を参照してください。
LiveEventTimedMetadataEndpoint	ライブイベントメタデータ挿入エンドポイント。
LiveEventTranscription	音声テキスト変換を使用して生成されたライブイベントの出力における文字起こしトラックについて説明します。このプロパティは今後使用するために予約されています。このプロパティに設定された値はすべて無視されます。
StreamOptionsFlag	LiveEvent に使用するオプション。この値は作成時に指定され、更新できません。配列エントリ値の有効な値は、'Default' と 'LowLatency' です。
StretchMode	目的の出力解像度に合わせて入力ビデオのサイズを変更する方法を指定します。既定値は None です
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

CrossSiteAccessPolicies

クライアントアクセスポリシー。

名前	型	説明
clientAccessPolicy	string	Silverlight で使用 clientaccesspolicy.xml の内容。
crossDomainPolicy	string	Silverlight で使用 crossdomain.xml の内容。

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

IPAccessControl

IP アクセス制御。

名前	型	説明
allow	IPRange[]	IP 許可リスト。

IPRange

CIDR スキームの IP アドレス範囲。

名前	型	説明
address	string	IP アドレスです。
name	string	IP アドレス範囲のフレンドリ名。
subnetPrefixLength	integer	サブネットマスクプレフィックスの長さ (CIDR 表記を参照)。

LiveEvent

ライブイベント。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	リソースが保存されている地理的な場所
name	string	リソースの名前
properties.created	string	ライブイベントの作成時間
properties.crossSiteAccessPolicies	CrossSiteAccessPolicies	ライブイベントのクロスサイトアクセスポリシー。
properties.description	string	ライブイベントの説明。
properties.encoding	LiveEventEncoding	ライブイベントのエンコード設定。ライブエンコーダーをライブイベントに使用するかどうかを構成し、ライブエンコーダーを使用する場合は設定します。
properties.hostnamePrefix	string	useStaticHostname が true に設定されている場合、hostnamePrefix は、ライブイベントプレビューと取り込みエンドポイントに割り当てられたホスト名の最初の部分を指定します。最終的なホスト名は、このプレフィックス、メディアサービスアカウント名、および Azure Media Services データセンターの短いコードの組み合わせになります。
properties.input	LiveEventInput	ライブイベントの入力設定。ライブイベントがコントリビューションエンコーダーから入力を受け取る方法を定義します。
properties.lastModified	string	ライブイベントの最終変更時刻。
properties.preview	LiveEventPreview	ライブイベントプレビューの設定。プレビューを使用すると、ライブイベントプロデューサーはライブ出力を作成せずにライブストリーミングコンテンツをプレビューできます。
properties.provisioningState	string	ライブイベントのプロビジョニング状態。
properties.resourceState	LiveEventResourceState	ライブイベントのリソースの状態。詳細については、「 https://go.microsoft.com/fwlink/?linkid=2139012 」を参照してください。
properties.streamOptions	StreamOptionsFlag[]	LiveEvent に使用するオプション。この値は作成時に指定され、更新できません。配列エントリ値の有効な値は、'Default' と 'LowLatency' です。
properties.transcriptions	LiveEventTranscription[]	ライブイベントのライブ文字起こし設定。ライブ文字起こし機能の詳細については、以下を参照してください https://go.microsoft.com/fwlink/?linkid=2133742 。
properties.useStaticHostname	boolean	静的ホスト名をライブイベントプレビューと取り込みエンドポイントに割り当てるかどうかを指定します。この値は、ライブイベントがスタンバイ状態の場合にのみ更新できます
systemData	systemData	このリソースに関連するシステムメタデータ。
tags	object	リソースタグ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

LiveEventEncoding

ライブイベントの種類と、ライブイベントをエンコードするためのオプションのエンコード設定を指定します。

名前	型	説明
encodingType	LiveEventEncodingType	ライブイベントの種類。 encodingType が PassthroughBasic または PassthroughStandard に設定されている場合、サービスは受信したビデオレイヤーとオーディオレイヤーを単に出力に渡します。 encodingType が Standard または Premium1080p に設定されている場合、ライブエンコーダーは受信ストリームを複数のビットレートまたはレイヤーにトランスコードします。詳細については、「 https://go.microsoft.com/fwlink/?linkid=2095101 」を参照してください。このプロパティは、ライブイベントが作成された後は変更できません。
keyFrameInterval	string	エンコードライブイベントのビデオトラックとオーディオトラックの出力フラグメント長を指定するには、ISO 8601 時間値を 0.5 から 20 秒の範囲で使用します。たとえば、PT2S を使用して 2 秒を示します。ビデオトラックの場合は、キーフレーム間隔、または GoP (画像のグループ) の長さも定義します。エンコードライブイベントに対してこの値が設定されていない場合、フラグメント期間の既定値は 2 秒です。パススルーライブイベントに値を設定することはできません。
presetName	string	encodingType が None でない場合に使用される、省略可能なエンコードプリセット名。この値は作成時に指定され、更新できません。 encodingType が Standard に設定されている場合、既定のプリセット名は 'Default720p' になります。それ以外の場合、encodingType が Premium1080p に設定されている場合、既定のプリセットは "Default1080p" になります。
stretchMode	StretchMode	目的の出力解像度に合わせて入力ビデオのサイズを変更する方法を指定します。既定値は None です

LiveEventEncodingType

ライブイベントの種類。 encodingType が PassthroughBasic または PassthroughStandard に設定されている場合、サービスは単に受信ビデオとオーディオレイヤーを経由して出力に渡します。 encodingType が Standard または Premium1080p に設定されている場合、ライブエンコーダーは受信ストリームを複数のビットレートまたはレイヤーにトランスコードします。詳細については、「 https://go.microsoft.com/fwlink/?linkid=2095101 」を参照してください。ライブイベントの作成後にこのプロパティを変更することはできません。

名前	型	説明
None	string	これは PassthroughStandard と同じです。以下の説明を参照してください。この列挙値は非推奨になっています。
PassthroughBasic	string	取り込まれたストリームは、それ以上の処理を行わずにコントリビューションエンコーダーからライブイベントを通過します。パススルー基本モードでは、インジェストは最大 5 Mbps に制限され、同時ライブ出力は 1 つだけ許可されます。ライブ文字起こしは使用できません。
PassthroughStandard	string	取り込まれたストリームは、それ以上の処理を行わずにコントリビューションエンコーダーからライブイベントを通過します。ライブ文字起こしを使用できます。インジェストビットレートの制限ははるかに高く、最大 3 つの同時ライブ出力が許可されます。
Premium1080p	string	コントリビューションライブエンコーダーは、1 つのビットレートストリームをライブイベントに送信し、Media Services は複数のビットレートストリームを作成します。出力の解像度は 1080p を超えることはできません。
Standard	string	コントリビューションライブエンコーダーは、1 つのビットレートストリームをライブイベントに送信し、Media Services は複数のビットレートストリームを作成します。出力の解像度は 720p を超えることはできません。

LiveEventEndpoint

ライブイベントエンドポイント。

名前	型	説明
protocol	string	エンドポイントプロトコル。
url	string	エンドポイント URL。

LiveEventInput

ライブイベントの入力。

名前	型	説明
accessControl	LiveEventInputAccessControl	ライブイベント入力のアクセス制御。
accessToken	string	ストリームを一意に識別するための文字列形式の UUID。これは作成時に指定できますが、更新することはできません。省略すると、サービスによって一意の値が生成されます。
endpoints	LiveEventEndpoint[]	ライブイベントの入力エンドポイント。
keyFrameIntervalDuration	string	入力のキーフレーム間隔期間の ISO 8601 時間。この値は、HLS 出力の EXT-X-TARGETDURATION プロパティを設定します。たとえば、PT2S を使用して 2 秒を示します。ライブイベントをエンコードする場合は、値を空のままにします。
streamingProtocol	LiveEventInputProtocol	ライブイベントの入力プロトコル。これは作成時に指定され、更新できません。
timedMetadataEndpoints	LiveEventTimedMetadataEndpoint[]	ライブイベントのメタデータエンドポイント。

LiveEventInputAccessControl

ライブイベント入力の IP アクセス制御。

名前	型	説明
ip	IPAccessControl	IP アクセス制御プロパティ。

LiveEventInputProtocol

ライブイベントの入力プロトコル。これは作成時に指定され、更新できません。

名前	型	説明
FragmentedMP4	string	スムーズストリーミング入力は、コントリビューションエンコーダーによってライブイベントに送信されます。
RTMP	string	RTMP 入力は、コントリビューションエンコーダーによってライブイベントに送信されます。

LiveEventInputTrackSelection

トラック選択条件。このプロパティは将来使用するために予約されています。このプロパティに設定された値は無視されます。

名前	型	説明
operation	string	操作の比較。このプロパティは将来使用するために予約されています。このプロパティに設定された値は無視されます。
property	string	選択するプロパティ名。このプロパティは将来使用するために予約されています。このプロパティに設定された値は無視されます。
value	string	選択するプロパティ値。このプロパティは将来使用するために予約されています。このプロパティに設定された値は無視されます。

LiveEventListResult

名前	型	説明
@odata.count	integer	結果の数。
@odata.nextLink	string	次の結果セットへのリンク。 value にライブ出力の不完全なリストが含まれている場合は空ではありません。
value	LiveEvent[]	ライブイベントの一覧表示操作の結果。

LiveEventOutputTranscriptionTrack

音声テキスト変換文字起こしを使用して生成されるライブイベントの出力内の文字起こしトラックについて説明します。このプロパティは将来使用するために予約されています。このプロパティに設定された値は無視されます。

名前	型	説明
trackName	string	出力トラック名。このプロパティは将来使用するために予約されています。このプロパティに設定された値は無視されます。

LiveEventPreview

ライブイベントプレビューの設定。

名前	型	説明
accessControl	LiveEventPreviewAccessControl	ライブイベントプレビューのアクセス制御。
alternativeMediaId	string	プレビュー用に作成されたストリーミングロケーターに関連付けられている代替メディア識別子。この値は作成時に指定され、更新できません。識別子は、StreamingPolicyName フィールドで指定された StreamingPolicy の CustomLicenseAcquisitionUrlTemplate または CustomKeyAcquisitionUrlTemplate で使用できます。
endpoints	LiveEventEndpoint[]	プレビュー用のエンドポイント。ライブイベントの対象ユーザーとプレビュー URL を共有しないでください。
previewLocator	string	Guid 形式のプレビューロケーターの識別子。作成時にこれを指定すると、呼び出し元は、イベントが作成される前にプレビューロケーター URL を知ることができます。省略すると、サービスによってランダムな識別子が生成されます。この値は、ライブイベントが作成されると更新できません。
streamingPolicyName	string	ライブイベントプレビューに使用されるストリーミングポリシーの名前。この値は作成時に指定され、更新できません。

LiveEventPreviewAccessControl

ライブイベントプレビューエンドポイントの IP アクセス制御。

名前	型	説明
ip	IPAccessControl	IP アクセス制御プロパティ。

LiveEventResourceState

ライブイベントのリソース状態。詳細については、「 https://go.microsoft.com/fwlink/?linkid=2139012 」を参照してください。

名前	型	説明
Allocating	string	ライブイベントで割り当てアクションが呼び出され、このライブイベントに対してリソースがプロビジョニングされています。割り当てが正常に完了すると、ライブイベントは StandBy 状態に移行します。
Deleting	string	ライブイベントを削除しています。この遷移状態では、課金は行われません。この状態の間は、更新もストリーミングもできません。
Running	string	ライブイベントのリソースが割り当てられ、取り込み URL とプレビュー URL も生成済みで、ライブストリームを受信することができます。この時点で、課金がアクティブになります。それ以上の課金を停止するには、ライブイベントリソースの Stop を明示的に呼び出す必要があります。
StandBy	string	ライブイベントリソースがプロビジョニングされ、開始する準備ができました。この状態では、課金が行われます。ほとんどのプロパティは引き続き更新できますが、この状態では取り込みまたはストリーミングは許可されません。
Starting	string	ライブイベントが開始され、リソースが割り当てられています。この状態では、課金は行われません。この状態の間は、更新もストリーミングもできません。エラーが発生した場合、ライブイベントは停止状態に戻ります。
Stopped	string	これは、ライブイベント作成後の初期状態です (自動開始が true に設定された場合を除く)。この状態では、課金は行われません。この状態では、ライブイベントのプロパティを更新できますが、ストリーミングは許可されません。
Stopping	string	ライブイベントが停止され、リソースのプロビジョニングが解除されています。この遷移状態では、課金は行われません。この状態の間は、更新もストリーミングもできません。

LiveEventTimedMetadataEndpoint

ライブイベントメタデータ挿入エンドポイント。

名前	型	説明
url	string	メタデータエンドポイント URL。

LiveEventTranscription

音声テキスト変換を使用して生成されたライブイベントの出力における文字起こしトラックについて説明します。このプロパティは今後使用するために予約されています。このプロパティに設定された値はすべて無視されます。

名前	型	説明
inputTrackSelection	LiveEventInputTrackSelection[]	音声テキスト変換が適用される入力ライブフィードでオーディオトラックを選択するメカニズムを提供します。このプロパティは将来使用するために予約されています。このプロパティに設定された値は無視されます。
language	string	音声テキスト変換の文字起こしに使用する言語 (ロケール) を指定します。オーディオトラックの音声言語と一致する必要があります。値は BCP-47 形式である必要があります (例: 'en-US')。ライブ文字起こし機能の詳細と、サポートされている言語の一覧を参照してください https://go.microsoft.com/fwlink/?linkid=2133742 。
outputTranscriptionTrack	LiveEventOutputTranscriptionTrack	音声テキスト変換文字起こしを使用して生成されるライブイベントの出力内の文字起こしトラックについて説明します。このプロパティは将来使用するために予約されています。このプロパティに設定された値は無視されます。

StreamOptionsFlag

LiveEvent に使用するオプション。この値は作成時に指定され、更新できません。配列エントリ値の有効な値は、'Default' と 'LowLatency' です。

名前	型	説明
Default	string	特別な待機時間の最適化のないライブストリーミング。
LowLatency	string	ライブイベントは、内部バッファーを減らすことで、エンドツーエンドの待機時間を短縮します。
LowLatencyV2	string	ライブイベントは、エンドツーエンドの待機時間用に最適化されています。このオプションは、RTMP 入力を使用してライブイベントをエンコードする場合にのみ使用できます。出力は、HLS 形式または DASH 形式を使用してストリーミングできます。出力のアーカイブまたは DVR 巻き戻しの長さは 6 時間に制限されます。他のすべてのシナリオでは、"LowLatency" ストリームオプションを使用します。

StretchMode

目的の出力解像度に合わせて入力ビデオのサイズを変更する方法を指定します。既定値は None です

名前	型	説明
AutoFit	string	出力のアクティブなビデオ領域の縦横比が入力と同じであることを確認しながら、出力の解像度を考慮して出力 (レターボックスまたは柱ボックス) を埋め込みます。たとえば、入力が 1920x1080 で、エンコードプリセットが 1280x1280 を要求する場合、出力は 1280x1280 になり、縦横比が 16:9 の内側の四角形 1280x720、左右に 280 ピクセル幅の柱ボックス領域が含まれます。
AutoSize	string	出力解像度をオーバーライドし、埋め込みなしで入力の表示縦横比に合わせて変更します。たとえば入力が 1920 x 1080 であるとき、エンコードプリセットによって 1280 x 1280 が要求された場合、プリセットの値がオーバーライドされ、出力は 1280 x 720 となり、入力の縦横比 (16:9) が維持されます。
None	string	入力ビデオのピクセル縦横比や表示縦横比を考慮せずに、エンコードプリセットで指定された出力解像度を厳密に尊重します。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。