Share via

az ams streaming-policy

  • Reference

Manage streaming policies for an Azure Media Services account.

Commands

Name Description Type Status
az ams streaming-policy create

Create a streaming policy.

 Core GA
az ams streaming-policy delete

Delete a Streaming Policy.

 Core GA
az ams streaming-policy list

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

 Core GA
az ams streaming-policy show

Show the details of a streaming policy.

 Core GA

az ams streaming-policy create

Edit

Create a streaming policy.

az ams streaming-policy create --account-name
                               --name
                               --resource-group
                               [--cbcs-clear-tracks]
                               [--cbcs-default-key-label]
                               [--cbcs-default-key-policy-name]
                               [--cbcs-fair-play-allow-persistent-license {false, true}]
                               [--cbcs-fair-play-template]
                               [--cbcs-key-to-track-mappings]
                               [--cbcs-play-ready-attributes]
                               [--cbcs-play-ready-template]
                               [--cbcs-protocols]
                               [--cbcs-widevine-template]
                               [--cenc-clear-tracks]
                               [--cenc-default-key-label]
                               [--cenc-default-key-policy-name]
                               [--cenc-disable-play-ready {false, true}]
                               [--cenc-disable-widevine {false, true}]
                               [--cenc-key-to-track-mappings]
                               [--cenc-play-ready-attributes]
                               [--cenc-play-ready-template]
                               [--cenc-protocols]
                               [--cenc-widevine-template]
                               [--default-content-key-policy-name]
                               [--envelope-clear-tracks]
                               [--envelope-default-key-label]
                               [--envelope-default-key-policy-name]
                               [--envelope-key-to-track-mappings]
                               [--envelope-protocols]
                               [--envelope-template]
                               [--no-encryption-protocols]

Required Parameters

--account-name -a

The name of the Azure Media Services account.

--name -n

The name of the streaming policy.

--resource-group -g

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

Optional Parameters

--cbcs-clear-tracks

The JSON representing which tracks should not be encrypted. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/streamingpolicies/create#trackselection.

--cbcs-default-key-label

Label to specify Default Content Key for an encryption scheme.

--cbcs-default-key-policy-name

Policy used by Default Content Key.

--cbcs-fair-play-allow-persistent-license

Allows the license to be persistent or not.

Accepted values: false, true
Default value: False
--cbcs-fair-play-template

The custom license acquisition URL template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys.

--cbcs-key-to-track-mappings

The JSON representing a list of StreamingPolicyContentKey. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/streamingpolicies/create#streamingpolicycontentkey.

--cbcs-play-ready-attributes
Deprecated

Argument 'cbcs_play_ready_attributes' has been deprecated and will be removed in a future release.

Custom attributes for PlayReady.

--cbcs-play-ready-template
Deprecated

Argument 'cbcs_play_ready_template' has been deprecated and will be removed in a future release.

The custom license acquisition URL template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys.

--cbcs-protocols

Space-separated list of enabled protocols for Common Encryption CBCS. Allowed values: Download, Dash, HLS, SmoothStreaming.

--cbcs-widevine-template
Deprecated

Argument 'cbcs_widevine_template' has been deprecated and will be removed in a future release.

The custom license acquisition URL template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys.

--cenc-clear-tracks

The JSON representing which tracks should not be encrypted. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/streamingpolicies/create#trackselection.

--cenc-default-key-label

Label to specify Default Content Key for an encryption scheme.

--cenc-default-key-policy-name

Policy used by Default Content Key.

--cenc-disable-play-ready

If specified, no PlayReady cenc DRM will be configured. If --cenc-disable-play-ready is set, --cenc-disable-widevine cannot also be set.

Accepted values: false, true
--cenc-disable-widevine

If specified, no Widevine cenc DRM will be configured. If --cenc-disable-widevine is set, --cenc-disable-play-ready cannot also be set.

Accepted values: false, true
--cenc-key-to-track-mappings

The JSON representing a list of StreamingPolicyContentKey. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/streamingpolicies/create#streamingpolicycontentkey.

--cenc-play-ready-attributes

Custom attributes for PlayReady.

--cenc-play-ready-template

The custom license acquisition URL template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys.

--cenc-protocols

Space-separated list of enabled protocols for Common Encryption CENC. Allowed values: Download, Dash, HLS, SmoothStreaming.

--cenc-widevine-template

The custom license acquisition URL template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys.

--default-content-key-policy-name

Default Content Key used by current streaming policy.

--envelope-clear-tracks

The JSON representing which tracks should not be encrypted. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/streamingpolicies/create#trackselection.

--envelope-default-key-label

Label used to specify Content Key when creating a streaming locator.

--envelope-default-key-policy-name

Policy used by Default Key.

--envelope-key-to-track-mappings

The JSON representing a list of StreamingPolicyContentKey. Use @{file} to load from a file. For further information about the JSON structure please refer to swagger documentation on https://docs.microsoft.com/rest/api/media/streamingpolicies/create#streamingpolicycontentkey.

--envelope-protocols

Space-separated list of enabled protocols for Envelope Encryption. Allowed values: Download, Dash, HLS, SmoothStreaming.

--envelope-template

The KeyAcquistionUrlTemplate is used to point to user specified service to delivery content keys.

--no-encryption-protocols

Space-separated list of enabled protocols for NoEncryption. Allowed values: Download, Dash, HLS, SmoothStreaming.

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-policy delete

Edit

Delete a Streaming Policy.

Deletes a Streaming Policy in the Media Services account.

az ams streaming-policy 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 policy.

--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-policy list

Edit

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

az ams streaming-policy list --account-name
                             --resource-group
                             [--filter]
                             [--orderby]
                             [--top]

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

--filter

Restricts the set of items returned.

--orderby

Specifies the key by which the result collection should be ordered.

--top

Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.

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-policy show

Edit

Show the details of a streaming policy.

az ams streaming-policy 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 policy.

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