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

az ams live-event

管理 Azure 媒体服务帐户的直播活动。

命令

名称 说明 类型 Status
az ams live-event create

创建直播活动。

核心 GA
az ams live-event delete

删除实时事件。

核心 GA
az ams live-event list

列出Azure 媒体服务帐户的所有实时事件。

核心 GA
az ams live-event reset

重置实时事件。

核心 GA
az ams live-event show

显示直播活动的详细信息。

核心 GA
az ams live-event standby

分配要稍后启动的实时事件。

核心 GA
az ams live-event start

启动直播活动。

核心 GA
az ams live-event stop

停止直播活动。

核心 GA
az ams live-event update

更新实时事件的详细信息。

核心 GA
az ams live-event wait

将 CLI 置于等待状态,直到满足实时事件的条件。

核心 GA

az ams live-event create

创建直播活动。

az ams live-event create --account-name
                         --ips
                         --name
                         --resource-group
                         --streaming-protocol {FragmentedMP4, RTMP}
                         [--access-token]
                         [--alternative-media-id]
                         [--auto-start]
                         [--client-access-policy]
                         [--cross-domain-policy]
                         [--description]
                         [--encoding-type]
                         [--hostname-prefix]
                         [--key-frame-interval]
                         [--key-frame-interval-duration]
                         [--no-wait]
                         [--preset-name]
                         [--preview-ips]
                         [--preview-locator]
                         [--stream-options {Default, LowLatency, LowLatencyV2}]
                         [--streaming-policy-name]
                         [--stretch-mode]
                         [--tags]
                         [--transcription-lang]
                         [--use-static-hostname]

必需参数

--account-name -a

Azure 媒体服务帐户的名称。

--ips

用于访问控制的空间分隔 IP 地址。 允许的 IP 地址可以指定为单个 IP 地址(例如“10.0.0.1”),也可以使用 IP 地址和 CIDR 子网掩码(例如“10.0.0.1/22”)作为 IP 范围。 使用“”清除现有列表。 使用“AllowAll”允许所有 IP 地址。 不建议在生产环境中允许所有 IP。

--name -n

直播活动的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--streaming-protocol

直播活动的流式处理协议。 此值在创建时指定,无法更新。

接受的值: FragmentedMP4, RTMP

可选参数

--access-token

流的唯一标识符。 这可以在创建时指定,但不能更新。 如果省略,服务将生成唯一值。

--alternative-media-id

与为预览创建的 StreamingLocator 关联的备用媒体标识符。 此值在创建时指定,无法更新。 该标识符可以在 CustomLicenseAcquisitionUrlTemplate 或 StreamingPolicyName 字段中指定的 StreamingPolicy 的 CustomKeyAcquisitionUrlTemplate 中使用。

--auto-start

该标志指示是否应在创建时自动启动资源。

默认值: False
--client-access-policy

Microsoft Silverlight 和 Adobe Flash 使用的clientaccesspolicy.xml的文件路径。 使用 @{file} 从文件加载。

--cross-domain-policy

Microsoft Silverlight 和 Adobe Flash 使用的crossdomain.xml的文件路径。 使用 @{file} 从文件加载。

--description

实时事件说明。

--encoding-type

实时事件的编码类型。 此值在创建时指定,无法更新。 允许的值:高级版1080p、None、Standard。

--hostname-prefix

将 useStaticHostname 设置为 true 时,hostname_prefix指定分配给实时事件预览和引入终结点的主机名的第一部分。 最终主机名将是此前缀、媒体服务帐户名称和 Azure 媒体服务数据中心的短代码的组合。

--key-frame-interval

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

--key-frame-interval-duration

关键帧间隔持续时间的 ISO 8601 时间跨度持续时间(以秒为单位)。 该值应介于 1(PT1S 或 00:00:01)到 30(PT30S 或 00:00:30)秒之间。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--preset-name

编码预设名称。 此值在创建时指定,无法更新。

--preview-ips

用于访问控制的空间分隔 IP 地址。 允许的 IP 地址可以指定为单个 IP 地址(例如“10.0.0.1”),也可以使用 IP 地址和 CIDR 子网掩码(例如“10.0.0.1/22”)作为 IP 范围。 使用“”清除现有列表。 使用“AllowAll”允许所有 IP 地址。 不建议在生产环境中允许所有 IP。

--preview-locator

Guid 格式的预览定位符的标识符。 在创建时指定此项允许调用方在创建事件之前知道预览定位符 URL。 如果省略,服务将生成随机标识符。 创建实时事件后,无法更新此值。

--stream-options

用于 LiveEvent 的选项。 此值在创建时指定,无法更新。

接受的值: Default, LowLatency, LowLatencyV2
--streaming-policy-name

用于实时事件预览的流式处理策略的名称。 这可以在创建时指定,但不能更新。

--stretch-mode

指定如何调整输入视频的大小以适应所需的输出分辨率。 默认值为 None。 允许的值:None、AutoSize、AutoFit。

--tags

空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。

--transcription-lang

直播活动的实时听录语言。 允许的值:ca-ES、da-DK、de-DE、en-AU、en-CA、en-GB、en-IN、en-NZ、es-ES、es-ES、es-MX、fi-FI、fr-CA、fr-FR、it-IT、nl-NL、pt-BR、pt-PT、sv-标准版 了解有关https://go.microsoft.com/fwlink/?linkid=2133742实时听录功能的详细信息。

--use-static-hostname

指定是否将静态主机名分配给实时事件预览和引入终结点。 仅当实时事件处于待机状态时,才能更新此值。 如果未指定hostname_prefix,实时事件名称将用作主机名前缀。

默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ams live-event delete

删除实时事件。

az ams live-event delete [--account-name]
                         [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

可选参数

--account-name -a

Azure 媒体服务帐户的名称。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

直播活动的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ams live-event list

列出Azure 媒体服务帐户的所有实时事件。

az ams live-event list --account-name
                       --resource-group

示例

按名称和 resourceState 快速列出所有实时事件。

az ams live-event list -a amsAccount -g resourceGroup --query [].{liveEventName:name,state:resourceState}

必需参数

--account-name -a

Azure 媒体服务帐户的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ams live-event reset

重置实时事件。

az ams live-event reset [--account-name]
                        [--ids]
                        [--name]
                        [--no-wait]
                        [--resource-group]
                        [--subscription]

可选参数

--account-name -a

Azure 媒体服务帐户的名称。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

直播活动的名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ams live-event show

显示直播活动的详细信息。

az ams live-event show [--account-name]
                       [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]

可选参数

--account-name -a

Azure 媒体服务帐户的名称。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

直播活动的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ams live-event standby

分配要稍后启动的实时事件。

az ams live-event standby [--account-name]
                          [--ids]
                          [--name]
                          [--no-wait]
                          [--resource-group]
                          [--subscription]

可选参数

--account-name -a

Azure 媒体服务帐户的名称。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

直播活动的名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ams live-event start

启动直播活动。

az ams live-event start [--account-name]
                        [--ids]
                        [--name]
                        [--no-wait]
                        [--resource-group]
                        [--subscription]

可选参数

--account-name -a

Azure 媒体服务帐户的名称。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

直播活动的名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ams live-event stop

停止直播活动。

az ams live-event stop [--account-name]
                       [--ids]
                       [--name]
                       [--no-wait]
                       [--remove-outputs-on-stop]
                       [--resource-group]
                       [--subscription]

可选参数

--account-name -a

Azure 媒体服务帐户的名称。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

直播活动的名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--remove-outputs-on-stop

停止时删除实时输出。

默认值: False
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ams live-event update

更新实时事件的详细信息。

az ams live-event update [--account-name]
                         [--add]
                         [--client-access-policy]
                         [--cross-domain-policy]
                         [--description]
                         [--force-string]
                         [--ids]
                         [--ips]
                         [--key-frame-interval-duration]
                         [--name]
                         [--preview-ips]
                         [--remove]
                         [--resource-group]
                         [--set]
                         [--subscription]
                         [--tags]

示例

设置新的允许 IP 地址,并删除索引为“0”的现有 IP 地址。

az ams live-event update -a amsAccount -g resourceGroup -n liveEventName --remove input.accessControl.ip.allow 0 --add input.accessControl.ip.allow 1.2.3.4/22

清除现有 IP 地址并设置新地址。

az ams live-event update -a amsAccount -g resourceGroup -n liveEventName --ips 1.2.3.4/22 5.6.7.8/30

可选参数

--account-name -a

Azure 媒体服务帐户的名称。

--add

通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>

默认值: []
--client-access-policy

Microsoft Silverlight 和 Adobe Flash 使用的clientaccesspolicy.xml的文件路径。 使用 @{file} 从文件加载。

--cross-domain-policy

Microsoft Silverlight 和 Adobe Flash 使用的crossdomain.xml的文件路径。 使用 @{file} 从文件加载。

--description

实时事件说明。

--force-string

使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。

默认值: False
--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--ips

用于访问控制的空间分隔 IP 地址。 允许的 IP 地址可以指定为单个 IP 地址(例如“10.0.0.1”),也可以使用 IP 地址和 CIDR 子网掩码(例如“10.0.0.1/22”)作为 IP 范围。 使用“”清除现有列表。 使用“AllowAll”允许所有 IP 地址。 不建议在生产环境中允许所有 IP。

--key-frame-interval-duration

关键帧间隔持续时间的 ISO 8601 时间跨度持续时间(以秒为单位)。 该值应介于 1(PT1S 或 00:00:01)到 30(PT30S 或 00:00:30)秒之间。

--name -n

直播活动的名称。

--preview-ips

用于访问控制的空间分隔 IP 地址。 允许的 IP 地址可以指定为单个 IP 地址(例如“10.0.0.1”),也可以使用 IP 地址和 CIDR 子网掩码(例如“10.0.0.1/22”)作为 IP 范围。 使用“”清除现有列表。 使用“AllowAll”允许所有 IP 地址。 不建议在生产环境中允许所有 IP。

--remove

从列表中删除属性或元素。 示例: --remove property.list <indexToRemove> OR --remove propertyToRemove.

默认值: []
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--set

通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=<value>

默认值: []
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--tags

空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az ams live-event wait

将 CLI 置于等待状态,直到满足实时事件的条件。

az ams live-event wait [--account-name]
                       [--created]
                       [--custom]
                       [--deleted]
                       [--exists]
                       [--ids]
                       [--interval]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--timeout]
                       [--updated]

示例

将 CLI 置于等待状态,直到创建实时事件。

az ams live-event wait -g MyResourceGroup -a MyAmsAccount -n MyLiveEvent --created

可选参数

--account-name -a

Azure 媒体服务帐户的名称。

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--interval

轮询间隔(以秒为单位)。

默认值: 30
--name -n

直播活动的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--timeout

最大等待(以秒为单位)。

默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。