SYMKEYPROPERTY (Transact-SQL)

Applies to: yesSQL Server (all supported versions) YesAzure SQL Database YesAzure SQL Managed Instance

Returns the algorithm of a symmetric key created from an EKM module.

Topic link icon Transact-SQL Syntax Conventions

Syntax

SYMKEYPROPERTY ( Key_ID , 'algorithm_desc' | 'string_sid' | 'sid' )  

Note

To view Transact-SQL syntax for SQL Server 2014 and earlier, see Previous versions documentation.

Arguments

Key_ID
Is the Key_ID of a symmetric key in the database. To find the Key_ID when you only know the key name, use SYMKEY_ID. Key_ID is data type int.

'algorithm_desc'
Specifies that the output returns the algorithm description of the symmetric key. Only available for symmetric keys created from an EKM module.

Return Types

sql_variant

Permissions

Requires some permission on the symmetric key and that the caller has not been denied VIEW permission on the symmetric key.

Examples

The following example returns the algorithm of the symmetric key with Key_ID 256.

SELECT SYMKEYPROPERTY(256, 'algorithm_desc') AS Algorithm ;  
GO  

See Also

ASYMKEY_ID (Transact-SQL)
ALTER SYMMETRIC KEY (Transact-SQL)
DROP SYMMETRIC KEY (Transact-SQL)
Encryption Hierarchy
sys.symmetric_keys (Transact-SQL)
Security Catalog Views (Transact-SQL)
KEY_ID (Transact-SQL)
ASYMKEYPROPERTY (Transact-SQL)