Share via


az ams account encryption

Manage encryption for an Azure Media Services account.

Commands

Name Description Type Status
az ams account encryption set

Set the encryption settings for an Azure Media Services account.

Core GA
az ams account encryption show

Show the details of encryption settings for an Azure Media Services account.

Core GA

az ams account encryption set

Set the encryption settings for an Azure Media Services account.

az ams account encryption set --key-type
                              [--account-name]
                              [--current-key-id]
                              [--ids]
                              [--key-identifier]
                              [--resource-group]
                              [--subscription]
                              [--system-assigned {false, true}]
                              [--user-assigned]

Examples

Set the media account's encryption to a customer managed key

az ams account encryption set -a myAmsAccount -g myRG --key-type CustomerKey --key-identifier keyVaultId

Set the media account's encryption to a system managed key

az ams account encryption set -a myAmsAccount -g myRG --key-type SystemKey

Required Parameters

--key-type

SystemKeyThe encryption key source (provider). Allowed values: , .CustomerKey.

Optional Parameters

--account-name -a

The name of the Azure Media Services account.

--current-key-id

The current key used to encrypt the Media Services account, including the key version.

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

--key-identifier

The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey).

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

--system-assigned

Set the system managed identity for account encryption.

Accepted values: false, true
--user-assigned

Set the user managed identity for account encryption.

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 account encryption show

Show the details of encryption settings for an Azure Media Services account.

az ams account encryption show [--account-name]
                               [--ids]
                               [--resource-group]
                               [--subscription]

Examples

Show the media account's encryption details

az ams account encryption show --account-name myAmsAccount -g myRG

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.

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