Edit

azdata bdc hdfs encryption-zone

  • Article

Applies to: Azure Data CLI (azdata)

The following article provides reference for the sql commands in the azdata tool. For more information about other azdata commands, see azdata reference

Commands

Command Description
azdata bdc hdfs encryption-zone create Converts an HDFS folder to an encryption zone.
azdata bdc hdfs encryption-zone list List all encryption zones and the keys associated with encryption zones.
azdata bdc hdfs encryption-zone get-file-encryption-info Get the encryption information for a given HDFS file path.
azdata bdc hdfs encryption-zone status Get the re-encryption status for the HDFS cluster.
azdata bdc hdfs encryption-zone reencrypt Controls the re-encryption of the encryption zone specified by the --path argument.

azdata bdc hdfs encryption-zone create

Converts an HDFS folder to an encryption zone by using the provided key to encrypt the files in the encryption zone.

azdata bdc hdfs encryption-zone create --path -p 
                                       --keyname -k

Examples

To convert an existing folder /user/securefolder to an encryption zone, using a key called securelake

azdata bdc hdfs encryption-zone create --path /home/securefolder --keyname securelake

Required Parameters

--path -p

Path of the HDFS folder to be converted to encryption zone.

--keyname -k

Hadoop KMS key to be used to protect the encryption zone.

Global Arguments

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--output -o

Output format. Allowed values: json, jsonc, table, tsv. Default: json.

--query -q

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

--verbose

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

azdata bdc hdfs encryption-zone list

List all encryption zones and the keys associated with encryption zones.

azdata bdc hdfs encryption-zone list

Examples

List all encryption zones.

azdata bdc hdfs encryption-zone list

Global Arguments

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--output -o

Output format. Allowed values: json, jsonc, table, tsv. Default: json.

--query -q

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

--verbose

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

azdata bdc hdfs encryption-zone get-file-encryption-info

Get the encryption information for a given HDFS file path.

azdata bdc hdfs encryption-zone get-file-encryption-info --path -p

Examples

Get the encryption information for a file at /user/securefolder/data.csv.

azdata bdc hdfs encryption-zone get-file-encryption-info --path /user/securefolder/data.csv

Required Parameters

--path -p

HDFS file path for which encryption information should be retrieved.

Global Arguments

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--output -o

Output format. Allowed values: json, jsonc, table, tsv. Default: json.

--query -q

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

--verbose

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

azdata bdc hdfs encryption-zone status

Get the re-encryption status for the HDFS cluster.

azdata bdc hdfs encryption-zone status

Global Arguments

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--output -o

Output format. Allowed values: json, jsonc, table, tsv. Default: json.

--query -q

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

--verbose

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

azdata bdc hdfs encryption-zone reencrypt

Controls the re-encryption of the encryption zone specified by the --path argument.

azdata bdc hdfs encryption-zone reencrypt --path -p 
                                          --action -a

Examples

Start the re-encryption of the encryption zone securelake.

azdata bdc hdfs encryption-zone reencrypt --path /securelake --action start

Cancel the re-encryption of the encryption zone securelake.

azdata bdc hdfs encryption-zone reencrypt --path /securelake --action cancel

Required Parameters

--path -p

Path of the HDFS encryption zone folder which should be re-encrypted

--action -a

Re-encryption action to be performed. Valid values are start and cancel

Global Arguments

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--output -o

Output format. Allowed values: json, jsonc, table, tsv. Default: json.

--query -q

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

--verbose

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

Next steps

For more information about other azdata commands, see azdata reference.

For more information about how to install the azdata tool, see Install azdata.