Share via

az ams content-key-policy option

  • Reference

Manage options for an existing content key policy.

Commands

Name Description Type Status
az ams content-key-policy option add

Add a new option to an existing content key policy.

 Core GA
az ams content-key-policy option remove

Remove an option from an existing content key policy.

 Core GA
az ams content-key-policy option update

Update an option from an existing content key policy.

 Core GA

az ams content-key-policy option add

Edit

Add a new option to an existing content key policy.

az ams content-key-policy option add --policy-option-name
                                     [--account-name]
                                     [--alt-rsa-token-keys]
                                     [--alt-symmetric-token-keys]
                                     [--alt-x509-token-keys]
                                     [--ask]
                                     [--audience]
                                     [--clear-key-configuration]
                                     [--fair-play-pfx]
                                     [--fair-play-pfx-password]
                                     [--fp-playback-duration-seconds]
                                     [--fp-storage-duration-seconds]
                                     [--ids]
                                     [--issuer]
                                     [--name]
                                     [--open-id-connect-discovery-document]
                                     [--open-restriction]
                                     [--play-ready-template]
                                     [--rental-and-lease-key-type]
                                     [--rental-duration]
                                     [--resource-group]
                                     [--subscription]
                                     [--token-claims]
                                     [--token-key]
                                     [--token-key-type]
                                     [--token-type]
                                     [--widevine-template]

Required Parameters

--policy-option-name

The content key policy option name.

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--alt-rsa-token-keys

Space-separated list of alternate rsa token keys.

--alt-symmetric-token-keys

Space-separated list of alternate symmetric token keys.

--alt-x509-token-keys

Space-separated list of alternate x509 certificate token keys.

--ask

The key that must be used as FairPlay Application Secret Key, which is a 32 character hex string.

--audience

The audience for the token.

--clear-key-configuration

Use Clear Key configuration, a.k.a AES encryption. It's intended for non-DRM keys.

Default value: False
--fair-play-pfx

The filepath to a FairPlay certificate file in PKCS 12 (pfx) format (including private key).

--fair-play-pfx-password

The password encrypting FairPlay certificate in PKCS 12 (pfx) format.

--fp-playback-duration-seconds

Playback duration.

--fp-storage-duration-seconds

Storage duration.

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

--issuer

The token issuer.

--name -n

The content key policy name.

--open-id-connect-discovery-document

The OpenID connect discovery document.

--open-restriction

Use open restriction. License or key will be delivered on every request. Not recommended for production environments.

Default value: False
--play-ready-template

JSON PlayReady license template. Use @{file} to load from a file.

--rental-and-lease-key-type

The rental and lease key type. Available values: Undefined, DualExpiry, PersistentUnlimited, PersistentLimited.

--rental-duration

The rental duration. Must be greater than or equal to 0.

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

--token-claims

Space-separated required token claims in '[key=value]' format.

--token-key

Either a string (for symmetric key) or a filepath to a certificate (x509) or public key (rsa). Must be used in conjunction with --token-key-type.

--token-key-type

The type of the token key to be used for the primary verification key. Allowed values: Symmetric, RSA, X509.

--token-type

The type of token. Allowed values: Jwt, Swt.

--widevine-template

JSON Widevine license template. Use @{file} to load from a file.

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 content-key-policy option remove

Edit

Remove an option from an existing content key policy.

az ams content-key-policy option remove --policy-option-id
                                        [--account-name]
                                        [--ids]
                                        [--name]
                                        [--resource-group]
                                        [--subscription]

Required Parameters

--policy-option-id

The content key policy option identifier. This value can be obtained from "policyOptionId" property by running a show operation on a content key policy resource.

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 content key policy name.

--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 content-key-policy option update

Edit

Update an option from an existing content key policy.

az ams content-key-policy option update --policy-option-id
                                        [--account-name]
                                        [--add-alt-token-key]
                                        [--add-alt-token-key-type]
                                        [--ask]
                                        [--audience]
                                        [--fair-play-pfx]
                                        [--fair-play-pfx-password]
                                        [--fp-playback-duration-seconds]
                                        [--fp-storage-duration-seconds]
                                        [--ids]
                                        [--issuer]
                                        [--name]
                                        [--open-id-connect-discovery-document]
                                        [--play-ready-template]
                                        [--policy-option-name]
                                        [--rental-and-lease-key-type]
                                        [--rental-duration]
                                        [--resource-group]
                                        [--subscription]
                                        [--token-claims]
                                        [--token-key]
                                        [--token-key-type]
                                        [--token-type]
                                        [--widevine-template]

Examples

Update an existing content-key-policy by adding an alternate token key to an existing option.

az ams content-key-policy option update -n contentKeyPolicyName -g resourceGroup -a amsAccount --policy-option-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx --add-alt-token-key tokenKey --add-alt-token-key-type Symmetric

Required Parameters

--policy-option-id

The content key policy option identifier. This value can be obtained from "policyOptionId" property by running a show operation on a content key policy resource.

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--add-alt-token-key

Creates an alternate token key with either a string (for symmetric key) or a filepath to a certificate (x509) or public key (rsa). Must be used in conjunction with --add-alt-token-key-type.

--add-alt-token-key-type

The type of the token key to be used for the alternate verification key. Allowed values: Symmetric, RSA, X509.

--ask

The key that must be used as FairPlay Application Secret Key, which is a 32 character hex string.

--audience

The audience for the token.

--fair-play-pfx

The filepath to a FairPlay certificate file in PKCS 12 (pfx) format (including private key).

--fair-play-pfx-password

The password encrypting FairPlay certificate in PKCS 12 (pfx) format.

--fp-playback-duration-seconds

Playback duration.

--fp-storage-duration-seconds

Storage duration.

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

--issuer

The token issuer.

--name -n

The content key policy name.

--open-id-connect-discovery-document

The OpenID connect discovery document.

--play-ready-template

JSON PlayReady license template. Use @{file} to load from a file.

--policy-option-name

The content key policy option name.

--rental-and-lease-key-type

The rental and lease key type. Available values: Undefined, DualExpiry, PersistentUnlimited, PersistentLimited.

--rental-duration

The rental duration. Must be greater than or equal to 0.

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

--token-claims

Space-separated required token claims in '[key=value]' format.

--token-key

Either a string (for symmetric key) or a filepath to a certificate (x509) or public key (rsa). Must be used in conjunction with --token-key-type.

--token-key-type

The type of the token key to be used for the primary verification key. Allowed values: Symmetric, RSA, X509.

--token-type

The type of token. Allowed values: Jwt, Swt.

--widevine-template

JSON Widevine license template. Use @{file} to load from a file.

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.