az ams content-key-policy
Manage content key policies for an Azure Media Services account.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az ams content-key-policy create |
Create a new content key policy. |
Core | GA |
| az ams content-key-policy delete |
Delete a content key policy. |
Core | GA |
| az ams content-key-policy list |
List all the content key policies within an Azure Media Services account. |
Core | GA |
| az ams content-key-policy option |
Manage options for an existing content key policy. |
Core | GA |
| 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 show |
Show an existing content key policy. |
Core | GA |
| az ams content-key-policy update |
Update an existing content key policy. |
Core | GA |
az ams content-key-policy create
Create a new content key policy.
az ams content-key-policy create --account-name
--name
--policy-option-name
--resource-group
[--alt-rsa-token-keys]
[--alt-symmetric-token-keys]
[--alt-x509-token-keys]
[--ask]
[--audience]
[--clear-key-configuration]
[--description]
[--fair-play-pfx]
[--fair-play-pfx-password]
[--fp-playback-duration-seconds]
[--fp-storage-duration-seconds]
[--issuer]
[--open-id-connect-discovery-document]
[--open-restriction]
[--play-ready-template]
[--rental-and-lease-key-type]
[--rental-duration]
[--token-claims]
[--token-key]
[--token-key-type]
[--token-type]
[--widevine-template]Examples
Create an content-key-policy with a FairPlay Configuration.
az ams content-key-policy create -a amsAccount -g resourceGroup -n contentKeyPolicyName --policy-option-name policyOptionName --open-restriction --ask "ask-32-chars-hex-string" --fair-play-pfx pfxPath --fair-play-pfx-password "pfxPassword" --rental-and-lease-key-type PersistentUnlimited --rental-duration 5000Required Parameters
The name of the Azure Media Services account.
The content key policy name.
The content key policy option name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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 content key policy description.
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.
The token issuer.
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.
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 delete
Delete a content key policy.
az ams content-key-policy delete [--account-name]
[--ids]
[--name]
[--resource-group]
[--subscription]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 list
List all the content key policies within an Azure Media Services account.
az ams content-key-policy list --account-name
--resource-group
[--filter]
[--orderby]
[--top]Examples
list the content key policies within an Azure Media Services account with a filter clause.
az ams content-key-policy list -a amsAccount -g resourceGroup --filter "properties/lastModified gt 2022-08-16 or properties/created lt 2022-08-17"Required Parameters
The name of the Azure Media Services account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Restricts the set of items returned.
Specifies the key by which the result collection should be ordered.
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
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 show
Show an existing content key policy.
az ams content-key-policy show [--account-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--with-secrets]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.
Include secret values of the content key policy.
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 update
Update an existing content key policy.
az ams content-key-policy update [--account-name]
[--add]
[--description]
[--force-string]
[--ids]
[--name]
[--remove]
[--resource-group]
[--set]
[--subscription]Examples
Update an existing content-key-policy, set a new description and edit its first option setting a new issuer and audience.
az ams content-key-policy update -n contentKeyPolicyName -a amsAccount --description newDescription --set options[0].restriction.issuer=newIssuer --set options[0].restriction.audience=newAudienceOptional Parameters
The name of the Azure Media Services account.
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>.
The content key policy description.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.
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.
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