az ams streaming-endpoint

  • Reference

Manage streaming endpoints for an Azure Media Service account.

Commands

Name Description Type Status
az ams streaming-endpoint akamai

Manage AkamaiAccessControl objects to be used on streaming endpoints.

 Core GA
az ams streaming-endpoint akamai add

Add an AkamaiAccessControl to an existing streaming endpoint.

 Core GA
az ams streaming-endpoint akamai remove

Remove an AkamaiAccessControl from an existing streaming endpoint.

 Core GA
az ams streaming-endpoint create

Create a streaming endpoint.

 Core GA
az ams streaming-endpoint delete

Delete a streaming endpoint.

 Core GA
az ams streaming-endpoint get-skus

Get the sku details for a streaming endpoint.

 Core GA
az ams streaming-endpoint list

List all the streaming endpoints within an Azure Media Services account.

 Core GA
az ams streaming-endpoint scale

Set the scale of a streaming endpoint.

 Core GA
az ams streaming-endpoint show

Show the details of a streaming endpoint.

 Core GA
az ams streaming-endpoint start

Start a streaming endpoint.

 Core GA
az ams streaming-endpoint stop

Stop a streaming endpoint.

 Core GA
az ams streaming-endpoint update

Update the details of a streaming endpoint.

 Core GA
az ams streaming-endpoint wait

Place the CLI in a waiting state until a condition of the streaming endpoint is met.

 Core GA

az ams streaming-endpoint create

Edit

Create a streaming endpoint.

az ams streaming-endpoint create --account-name
                                 --name
                                 --resource-group
                                 --scale-units
                                 [--auto-start]
                                 [--availability-set-name]
                                 [--cdn-profile]
                                 [--cdn-provider]
                                 [--client-access-policy]
                                 [--cross-domain-policy]
                                 [--custom-host-names]
                                 [--description]
                                 [--ips]
                                 [--max-cache-age]
                                 [--no-wait]
                                 [--tags]

Required Parameters

--account-name -a

The name of the Azure Media Services account.

--name -n

The name of the streaming endpoint.

--resource-group -g

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

--scale-units

The number of scale units for Premium StreamingEndpoints. For Standard StreamingEndpoints, set this value to 0. Use the Scale operation to adjust this value for Premium StreamingEndpoints.

Optional Parameters

--auto-start

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

--availability-set-name

The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time.

--cdn-profile

The CDN profile name.

--cdn-provider

The CDN provider name. Allowed values: StandardVerizon, PremiumVerizon, StandardAkamai.

--client-access-policy

The XML representing the clientaccesspolicy data used by Microsoft Silverlight and Adobe Flash. Use @{file} to load from a file. For further information about the XML structure please refer to documentation on https://docs.microsoft.com/rest/api/media/operations/crosssiteaccesspolicies.

--cross-domain-policy

The XML representing the crossdomain data used by Silverlight. Use @{file} to load from a file. For further information about the XML structure please refer to documentation on https://docs.microsoft.com/rest/api/media/operations/crosssiteaccesspolicies.

--custom-host-names

Space-separated list of custom host names for the streaming endpoint. Use "" to clear existing list.

--description

The streaming endpoint description.

--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. If no IP addresses are specified any IP address will be allowed.

--max-cache-age

Max cache age.

--no-wait

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

default value: False
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ams streaming-endpoint delete

Edit

Delete a streaming endpoint.

az ams streaming-endpoint 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). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the streaming endpoint.

--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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ams streaming-endpoint get-skus

Edit

Get the sku details for a streaming endpoint.

az ams streaming-endpoint get-skus [--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). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the streaming endpoint.

--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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ams streaming-endpoint list

Edit

List all the streaming endpoints within an Azure Media Services account.

az ams streaming-endpoint list --account-name
                               --resource-group

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>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ams streaming-endpoint scale

Edit

Set the scale of a streaming endpoint.

az ams streaming-endpoint scale --scale-units
                                [--account-name]
                                [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

Required Parameters

--scale-units

The number of scale units for Premium StreamingEndpoints. For Standard StreamingEndpoints, set this value to 0. Use the Scale operation to adjust this value for Premium StreamingEndpoints.

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the streaming endpoint.

--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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ams streaming-endpoint show

Edit

Show the details of a streaming endpoint.

az ams streaming-endpoint 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). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the streaming endpoint.

--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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ams streaming-endpoint start

Edit

Start a streaming endpoint.

az ams streaming-endpoint 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). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the streaming endpoint.

--no-wait

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

default value: False
--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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ams streaming-endpoint stop

Edit

Stop a streaming endpoint.

az ams streaming-endpoint stop [--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). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the streaming endpoint.

--no-wait

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

default value: False
--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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ams streaming-endpoint update

Edit

Update the details of a streaming endpoint.

az ams streaming-endpoint update [--account-name]
                                 [--add]
                                 [--cdn-profile]
                                 [--cdn-provider]
                                 [--client-access-policy]
                                 [--cross-domain-policy]
                                 [--custom-host-names]
                                 [--description]
                                 [--disable-cdn]
                                 [--force-string]
                                 [--ids]
                                 [--ips]
                                 [--max-cache-age]
                                 [--name]
                                 [--no-wait]
                                 [--remove]
                                 [--resource-group]
                                 [--set]
                                 [--subscription]
                                 [--tags]

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>.

default value: []
--cdn-profile

The CDN profile name.

--cdn-provider

The CDN provider name. Allowed values: StandardVerizon, PremiumVerizon, StandardAkamai.

--client-access-policy

The XML representing the clientaccesspolicy data used by Microsoft Silverlight and Adobe Flash. Use @{file} to load from a file. For further information about the XML structure please refer to documentation on https://docs.microsoft.com/rest/api/media/operations/crosssiteaccesspolicies.

--cross-domain-policy

The XML representing the crossdomain data used by Silverlight. Use @{file} to load from a file. For further information about the XML structure please refer to documentation on https://docs.microsoft.com/rest/api/media/operations/crosssiteaccesspolicies.

--custom-host-names

Space-separated list of custom host names for the streaming endpoint. Use "" to clear existing list.

--description

The streaming endpoint description.

--disable-cdn

Use this flag to disable CDN for the streaming endpoint.

--force-string

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

default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--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. If no IP addresses are specified any IP address will be allowed.

--max-cache-age

Max cache age.

--name -n

The name of the streaming endpoint.

--no-wait

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

default value: False
--remove

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

default value: []
--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=<value>.

default value: []
--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az ams streaming-endpoint wait

Edit

Place the CLI in a waiting state until a condition of the streaming endpoint is met.

az ams streaming-endpoint 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 streaming endpoint is created.

az ams streaming-endpoint wait -g MyResourceGroup -a MyAmsAccount -n MyStreamingEndpoint --created

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--created

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

default value: False
--custom

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

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30
--name -n

The name of the streaming endpoint.

--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'.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.