az ams content-key-policy option

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the Azure Media Services account.

Property	Value
Parameter group:	Resource Id Arguments

--alt-rsa-token-keys

Space-separated list of alternate rsa token keys.

Property	Value
Parameter group:	Token Restriction Arguments

--alt-symmetric-token-keys

Space-separated list of alternate symmetric token keys.

Property	Value
Parameter group:	Token Restriction Arguments

--alt-x509-token-keys

Space-separated list of alternate x509 certificate token keys.

Property	Value
Parameter group:	Token Restriction Arguments

--ask

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

Property	Value
Parameter group:	FairPlay Configuration Arguments

--audience

The audience for the token.

Property	Value
Parameter group:	Token Restriction Arguments

--clear-key-configuration

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

Property	Value
Parameter group:	Clear Key Configuration (AES Encryption) Arguments
Default value:	False

--fair-play-pfx

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

Property	Value
Parameter group:	FairPlay Configuration Arguments

--fair-play-pfx-password

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

Property	Value
Parameter group:	FairPlay Configuration Arguments

--fp-playback-duration-seconds

Playback duration.

Property	Value
Parameter group:	FairPlay Configuration Arguments

--fp-storage-duration-seconds

Storage duration.

Property	Value
Parameter group:	FairPlay Configuration Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--issuer

The token issuer.

Property	Value
Parameter group:	Token Restriction Arguments

--name -n

The content key policy name.

Property	Value
Parameter group:	Resource Id Arguments

--open-id-connect-discovery-document

The OpenID connect discovery document.

Property	Value
Parameter group:	Token Restriction Arguments

--open-restriction

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

Property	Value
Parameter group:	Open Restriction Arguments
Default value:	False

--play-ready-template

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

Property	Value
Parameter group:	PlayReady Configuration Arguments

--rental-and-lease-key-type

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

Property	Value
Parameter group:	FairPlay Configuration Arguments

--rental-duration

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

Property	Value
Parameter group:	FairPlay Configuration Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--token-claims

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

Property	Value
Parameter group:	Token Restriction Arguments

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

Property	Value
Parameter group:	Token Restriction Arguments

--token-key-type

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

Property	Value
Parameter group:	Token Restriction Arguments

--token-type

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

Property	Value
Parameter group:	Token Restriction Arguments

--widevine-template

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

Property	Value
Parameter group:	Widevine Configuration Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az ams content-key-policy option remove

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the Azure Media Services account.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The content key policy name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az ams content-key-policy option update

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the Azure Media Services account.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Token Restriction Arguments

--add-alt-token-key-type

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

Property	Value
Parameter group:	Token Restriction Arguments

--ask

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

Property	Value
Parameter group:	FairPlay Configuration Arguments

--audience

The audience for the token.

Property	Value
Parameter group:	Token Restriction Arguments

--fair-play-pfx

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

Property	Value
Parameter group:	FairPlay Configuration Arguments

--fair-play-pfx-password

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

Property	Value
Parameter group:	FairPlay Configuration Arguments

--fp-playback-duration-seconds

Playback duration.

Property	Value
Parameter group:	FairPlay Configuration Arguments

--fp-storage-duration-seconds

Storage duration.

Property	Value
Parameter group:	FairPlay Configuration Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--issuer

The token issuer.

Property	Value
Parameter group:	Token Restriction Arguments

--name -n

The content key policy name.

Property	Value
Parameter group:	Resource Id Arguments

--open-id-connect-discovery-document

The OpenID connect discovery document.

Property	Value
Parameter group:	Token Restriction Arguments

--play-ready-template

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

Property	Value
Parameter group:	PlayReady Configuration Arguments

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

Property	Value
Parameter group:	FairPlay Configuration Arguments

--rental-duration

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

Property	Value
Parameter group:	FairPlay Configuration Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--token-claims

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

Property	Value
Parameter group:	Token Restriction Arguments

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

Property	Value
Parameter group:	Token Restriction Arguments

--token-key-type

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

Property	Value
Parameter group:	Token Restriction Arguments

--token-type

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

Property	Value
Parameter group:	Token Restriction Arguments

--widevine-template

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

Property	Value
Parameter group:	Widevine Configuration Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False