Database.SymmetricKeys Property

Gets a collection of SymmetricKey objects. Each SymmetricKey object represents a symmetric key defined on the database.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny,  _
    GetType(SymmetricKey))> _
Public ReadOnly Property SymmetricKeys As SymmetricKeyCollection 
    Get
'Usage
Dim instance As Database 
Dim value As SymmetricKeyCollection 

value = instance.SymmetricKeys

[SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny, 
    typeof(SymmetricKey))]
public SymmetricKeyCollection SymmetricKeys { get; }

[SfcObjectAttribute(SfcContainerRelationship::ObjectContainer, SfcContainerCardinality::ZeroToAny, 
    typeof(SymmetricKey))]
public:
property SymmetricKeyCollection^ SymmetricKeys {
    SymmetricKeyCollection^ get ();
}

[<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny, 
    typeof(SymmetricKey))>]
member SymmetricKeys : SymmetricKeyCollection

function get SymmetricKeys () : SymmetricKeyCollection

Property Value

Type: Microsoft.SqlServer.Management.Smo.SymmetricKeyCollection
A SymmetricKeyCollection object that represents all the symmetric keys defined on the database.

Remarks

Specific symmetric keys can be referenced by using this collection by specifying the name of the symmetric key. To add a new symmetric key to the collection, call the symmetric key constructor SymmetricKey, or its overload.

Examples

VB

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server

'Reference the AdventureWorks2012 database.
Dim db As Database
db = srv.Databases("AdventureWorks2012")

'Display all the symmetric keys in the database.
Dim sk As SymmetricKey
For Each sk In db.SymmetricKeys
   Console.WriteLine(sk.Name)
Next

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2012")

Foreach ($sk in $db.SymmetricKeys)
{
   Write-Host $sk.Name
}

See Also

Reference

Database Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Working with Database Objects

CREATE SYMMETRIC KEY (Transact-SQL)

Using Encryption

CREATE ASYMMETRIC KEY (Transact-SQL)

Creating, Altering, and Removing Databases

CREATE DATABASE (Transact-SQL)