通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Live Events - Get

  • 参考
服务:
Media Services
API 版本:
2022-11-01

获取直播活动
获取实时事件的属性。

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

URI 参数

名称 在 必需 类型 说明
accountName
 path True

string

媒体服务帐户名称。
liveEventName
 path True

string

直播活动的名称，最大长度为 32。

正则表达式模式: ^[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 版本。

响应

名称 类型 说明
200 OK

LiveEvent

没问题。 请求已成功。
Other Status Codes

ErrorResponse

描述操作失败原因的流式处理错误响应。

示例

Get a LiveEvent by name

示例请求

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

示例响应

状态代码:
200 
{
  "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": {},
  "properties": {
    "description": "",
    "resourceState": "Stopped",
    "provisioningState": "Succeeded",
    "created": "2018-03-03T02:25:08.3474032Z",
    "lastModified": "2018-03-03T02:25:08.3474032Z",
    "useStaticHostname": false,
    "streamOptions": [
      "Default"
    ],
    "input": {
      "keyFrameIntervalDuration": "PT6S",
      "streamingProtocol": "FragmentedMP4",
      "accessToken": null,
      "endpoints": [
        {
          "protocol": "FragmentedMP4",
          "url": "http://clouddeployment.media-test.net/ingest.isml"
        }
      ],
      "timedMetadataEndpoints": []
    },
    "preview": {
      "previewLocator": "763f3ea4-d94f-441c-a634-c833f61a4e04",
      "streamingPolicyName": null,
      "accessControl": {
        "ip": {
          "allow": [
            {
              "name": "AllowAll",
              "address": "0.0.0.0",
              "subnetPrefixLength": 0
            }
          ]
        }
      },
      "endpoints": [
        {
          "protocol": "FragmentedMP4",
          "url": "https://testeventopito4idh2r-weibzmedia05.preview-ts051.channel.media-test.windows-int.net/763f3ea4-d94f-441c-a634-c833f61a4e04/preview.ism/manifest"
        }
      ]
    },
    "encoding": {
      "encodingType": "None",
      "presetName": null
    },
    "crossSiteAccessPolicies": {
      "clientAccessPolicy": "<access-policy><cross-domain-access><policy><allow-from http-methods=\"*\"><domain uri=\"http://*\"/></allow-from><grant-to><resource path=\"/\" include-subpaths=\"true\"/></grant-to></policy></cross-domain-access></access-policy>",
      "crossDomainPolicy": "<cross-domain-policy><allow-access-from domain=\"*\" secure=\"false\" /></cross-domain-policy>"
    }
  }
}

定义

名称 说明
createdByType

创建资源的标识类型。
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

曲目选择条件。 此属性保留供将来使用，将忽略此属性上设置的任何值。
LiveEventOutputTranscriptionTrack

描述使用语音转文本听录生成的实时事件输出中的听录轨迹。 此属性保留供将来使用，将忽略此属性上设置的任何值。
LiveEventPreview

实时事件预览设置。
LiveEventPreviewAccessControl

实时事件预览终结点的 IP 访问控制。
LiveEventResourceState

实时事件的资源状态。 有关详细信息，请参阅https://go.microsoft.com/fwlink/?linkid=2139012。
LiveEventTimedMetadataEndpoint

实时事件元数据插入终结点。
LiveEventTranscription

描述使用语音转文本听录生成的实时事件的输出中的听录轨道。 此属性保留供将来使用，将忽略此属性上设置的任何值。
StreamOptionsFlag

用于 LiveEvent 的选项。 此值在创建时指定，无法更新。 数组条目值的有效值为“Default”和“LowLatency”。
StretchMode

指定如何调整输入视频的大小以适应所需的输出分辨率 () 。 默认值为 None
systemData

与资源的创建和上次修改相关的元数据。

createdByType

创建资源的标识类型。

名称 类型 说明
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

错误对象。

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 媒体服务数据中心的短代码的组合。
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

使用介于 0.5 到 20 秒之间的 ISO 8601 时间值指定编码实时事件的视频和音频轨迹的输出片段长度。 例如，使用 PT2S 指示 2 秒。 对于视频轨道，它还定义关键帧间隔或 GoP (组图片) 的长度。 如果未为编码实时事件设置此值，则片段持续时间默认为 2 秒。 无法为直通实时事件设置值。
presetName

string

当 encodingType 不是“无”时使用的可选编码预设名称。 此值在创建时指定，无法更新。 如果 encodingType 设置为“标准”，则默认预设名称为“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

引入的流通过贡献编码器的实时事件，无需任何进一步处理。 在 PassthroughBasic 模式下，引入限制为高达 5Mbps，并且仅允许 1 个并发实时输出。 实时听录不可用。
PassthroughStandard

string

引入的流通过贡献编码器的实时事件，无需任何进一步处理。 可以使用实时听录。 引入比特率限制要高得多，最多允许 3 个并发实时输出。
Premium1080p

string

贡献实时编码器将单比特率流发送到实时事件，媒体服务将创建多个比特率流。 输出分辨率不能超过 1080p。
Standard

string

贡献实时编码器将单比特率流发送到实时事件，媒体服务将创建多个比特率流。 输出分辨率不能超过 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

要选择的属性值。 此属性保留供将来使用，将忽略此属性上设置的任何值。

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，并且能够接收实时传送流。 此时，计费处于活动状态。 必须显式对直播活动资源调用停止操作才能停止进一步计费。
StandBy

string

直播活动资源已预配，并已准备好启动。 此状态下将进行计费。 大多数属性仍可进行更新，但在此状态下不允许引入或流式传输。
Starting

string

正在启动直播活动并分配资源。 此状态下不会发生计费。 此状态下不允许进行更新或流式处理。 如果发生错误，则直播活动会返回到“已停止”状态。
Stopped

string

这是直播活动在创建后的初始状态（除非设置了自动启动）此状态下不会发生计费。 在此状态下，可以更新实时事件属性，但不允许流式传输。
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

替代输出分辨率，并更改它以匹配输入的显示纵横比，而无需填充。 例如，如果输入为 1920x1080，而编码预设要求提供 1280x1280，则会重写预设中的值，输出将是 1280x720，这样可以保持 16:9 的输入纵横比。
None

string

严格遵循编码预设中指定的输出分辨率，而不考虑输入视频的像素纵横比或显示纵横比。

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源的创建时间戳 (UTC) 。
createdBy

string

创建资源的标识。
createdByType

createdByType

创建资源的标识类型。
lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。
lastModifiedByType

createdByType

上次修改资源的标识类型。