az ams live-event

Manage live events for an Azure Media Service account.

Commands

az ams live-event create Create a live event.
az ams live-event delete Delete a live event.
az ams live-event list List all the live events of an Azure Media Services account.
az ams live-event reset Reset a live event.
az ams live-event show Show the details of a live event.
az ams live-event start Start a live event.
az ams live-event stop Stop a live event.
az ams live-event update Update the details of a live event.
az ams live-event wait Place the CLI in a waiting state until a condition of the live event is met.

az ams live-event create

Create a live event.

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]
[--key-frame-interval-duration]
[--no-wait]
[--preset-name]
[--preview-ips]
[--preview-locator]
[--stream-options {Default, LowLatency}]
[--streaming-policy-name]
[--subscription]
[--tags]
[--vanity-url {false, true}]

Required Parameters

--account-name -a

The name of the Azure Media Services account.

--ips

Space-separated IP addresses for access control. Allowed IP addresses can be specified as either a single IP address (e.g. "10.0.0.1") or as an IP range using an IP address and a CIDR subnet mask (e.g. "10.0.0.1/22"). Use "" to clear existing list. Use "AllowAll" to allow all IP addresses. Allowing all IPs is not recommended for production environments.

--name -n

The name of the live event.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--streaming-protocol

The streaming protocol for the live event. This value is specified at creation time and cannot be updated.

accepted values: FragmentedMP4, RTMP

Optional Parameters

--access-token

A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value.

--alternative-media-id

An Alternative Media Identifier associated with the StreamingLocator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field.

--auto-start

The flag indicates if the resource should be automatically started on creation.

--client-access-policy

Filepath to the clientaccesspolicy.xml used by Microsoft Silverlight and Adobe Flash. Use @{file} to load from a file.

--cross-domain-policy

Filepath to the crossdomain.xml used by Microsoft Silverlight and Adobe Flash. Use @{file} to load from a file.

--description

The live event description.

--encoding-type

The encoding type for live event. This value is specified at creation time and cannot be updated. Allowed values: Basic, None, Standard.

--key-frame-interval-duration

ISO 8601 timespan duration of the key frame interval duration in seconds. The value should be an interger in the range of 1 (PT1S or 00:00:01) to 30 (PT30S or 00:00:30) seconds.

--no-wait

Do not wait for the long-running operation to finish.

--preset-name

The encoding preset name. This value is specified at creation time and cannot be updated.

--preview-ips

Space-separated IP addresses for access control. Allowed IP addresses can be specified as either a single IP address (e.g. "10.0.0.1") or as an IP range using an IP address and a CIDR subnet mask (e.g. "10.0.0.1/22"). Use "" to clear existing list. Use "AllowAll" to allow all IP addresses. Allowing all IPs is not recommended for production environments.

--preview-locator

The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created.

--stream-options

The options to use for the LiveEvent. This value is specified at creation time and cannot be updated.

accepted values: Default, LowLatency
--streaming-policy-name

The name of streaming policy used for the live event preview. This can be specified at creation time but cannot be updated.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

--vanity-url

Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated.

accepted values: false, true

az ams live-event delete

Delete a live event.

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

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

The name of the live event.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az ams live-event list

List all the live events of an Azure Media Services account.

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

Examples

List all the live events by name and resourceState quickly.

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

Required Parameters

--account-name -a

The name of the Azure Media Services account.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az ams live-event reset

Reset a live event.

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

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

The name of the live event.

--no-wait

Do not wait for the long-running operation to finish.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az ams live-event show

Show the details of a live event.

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

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

The name of the live event.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az ams live-event start

Start a live event.

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

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

The name of the live event.

--no-wait

Do not wait for the long-running operation to finish.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az ams live-event stop

Stop a live event.

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

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

The name of the live event.

--no-wait

Do not wait for the long-running operation to finish.

--remove-outputs-on-stop

Remove live outputs on stop.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az ams live-event update

Update the details of a live event.

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]

Examples

Set a new allowed IP address and remove an existing IP address at index '0'.

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

Clear existing IP addresses and set new ones.

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

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--client-access-policy

Filepath to the clientaccesspolicy.xml used by Microsoft Silverlight and Adobe Flash. Use @{file} to load from a file.

--cross-domain-policy

Filepath to the crossdomain.xml used by Microsoft Silverlight and Adobe Flash. Use @{file} to load from a file.

--description

The live event description.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--ips

Space-separated IP addresses for access control. Allowed IP addresses can be specified as either a single IP address (e.g. "10.0.0.1") or as an IP range using an IP address and a CIDR subnet mask (e.g. "10.0.0.1/22"). Use "" to clear existing list. Use "AllowAll" to allow all IP addresses. Allowing all IPs is not recommended for production environments.

--key-frame-interval-duration

ISO 8601 timespan duration of the key frame interval duration in seconds. The value should be an interger in the range of 1 (PT1S or 00:00:01) to 30 (PT30S or 00:00:30) seconds.

--name -n

The name of the live event.

--preview-ips

Space-separated IP addresses for access control. Allowed IP addresses can be specified as either a single IP address (e.g. "10.0.0.1") or as an IP range using an IP address and a CIDR subnet mask (e.g. "10.0.0.1/22"). Use "" to clear existing list. Use "AllowAll" to allow all IP addresses. Allowing all IPs is not recommended for production environments.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

az ams live-event wait

Place the CLI in a waiting state until a condition of the live event is met.

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

Examples

Place the CLI in a waiting state until the live event is created.

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

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--interval

Polling interval in seconds.

default value: 30
--name -n

The name of the live event.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.