key-id-transact-sql.md

title	KEY_ID (Transact-SQL) | Microsoft Docs
ms.custom
ms.date	03/06/2017
ms.prod	sql-non-specified
ms.reviewer
ms.suite
ms.technology	database-engine
ms.tgt_pltfrm
ms.topic	language-reference
f1_keywords	Key_ID Key_ID_TSQL
dev_langs	TSQL
helpviewer_keywords	identification numbers [SQL Server], symmetric keys KEY_ID function symmetric keys [SQL Server], IDs IDs [SQL Server], symmetric keys
ms.assetid	d7309542-dbbe-41dc-b42e-5d9a1c8b4838
caps.latest.revision	27
author	BYHAM
ms.author	rickbyh
manager	jhubbard
ms.workload	Inactive

KEY_ID (Transact-SQL)

[!INCLUDEtsql-appliesto-ss2008-asdb-xxxx-xxx_md]

Returns the ID of a symmetric key in the current database.

Transact-SQL Syntax Conventions

Syntax

  
Key_ID ( 'Key_Name' )  

Arguments

' Key_Name '
The name of a symmetric key in the database.

Return Types

int

Remarks

The name of a temporary key must start with a number sign (#).

Permissions

Because temporary keys are only available in the session in which they are created, no permissions are required to access them. To access a key that is not temporary, the caller needs some permission on the key and must not have been denied VIEW permission on the key.

Examples

A. Returning the ID of a symmetric key

The following example returns the ID of a key called ABerglundKey1.

SELECT KEY_ID('ABerglundKey1');  

B. Returning the ID of a temporary symmetric key

The following example returns the ID of a temporary symmetric key. Note that # is prepended to the key name.

SELECT KEY_ID('#ABerglundKey2');  

See Also

KEY_GUID (Transact-SQL)
CREATE SYMMETRIC KEY (Transact-SQL)
sys.symmetric_keys (Transact-SQL)
sys.key_encryptions (Transact-SQL)
Encryption Hierarchy