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
The content key policy option name.
Optional Parameters
The name of the Azure Media Services account.
Space-separated list of alternate rsa token keys.
Space-separated list of alternate symmetric token keys.
Space-separated list of alternate x509 certificate token keys.
The key that must be used as FairPlay Application Secret Key, which is a 32 character hex string.
The audience for the token.
Use Clear Key configuration, a.k.a AES encryption. It's intended for non-DRM keys.
The filepath to a FairPlay certificate file in PKCS 12 (pfx) format (including private key).
The password encrypting FairPlay certificate in PKCS 12 (pfx) format.
Playback duration.
Storage duration.
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.
The token issuer.
The content key policy name.
The OpenID connect discovery document.
Use open restriction. License or key will be delivered on every request. Not recommended for production environments.
JSON PlayReady license template. Use @{file} to load from a file.
The rental and lease key type. Available values: Undefined, DualExpiry, PersistentUnlimited, PersistentLimited.
The rental duration. Must be greater than or equal to 0.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Space-separated required token claims in '[key=value]' format.
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.
The type of the token key to be used for the primary verification key. Allowed values: Symmetric, RSA, X509.
The type of token. Allowed values: Jwt, Swt.
JSON Widevine license template. Use @{file} to load from a file.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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
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 name of the Azure Media Services account.
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.
The content key policy name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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 SymmetricRequired Parameters
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 name of the Azure Media Services account.
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.
The type of the token key to be used for the alternate verification key. Allowed values: Symmetric, RSA, X509.
The key that must be used as FairPlay Application Secret Key, which is a 32 character hex string.
The audience for the token.
The filepath to a FairPlay certificate file in PKCS 12 (pfx) format (including private key).
The password encrypting FairPlay certificate in PKCS 12 (pfx) format.
Playback duration.
Storage duration.
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.
The token issuer.
The content key policy name.
The OpenID connect discovery document.
JSON PlayReady license template. Use @{file} to load from a file.
The content key policy option name.
The rental and lease key type. Available values: Undefined, DualExpiry, PersistentUnlimited, PersistentLimited.
The rental duration. Must be greater than or equal to 0.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Space-separated required token claims in '[key=value]' format.
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.
The type of the token key to be used for the primary verification key. Allowed values: Symmetric, RSA, X509.
The type of token. Allowed values: Jwt, Swt.
JSON Widevine license template. Use @{file} to load from a file.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for