Get-SqlColumnEncryptionKey

構文

ByObject

Get-SqlColumnEncryptionKey
    [[-Name] <String>]
    [-InputObject] <Database>
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [<CommonParameters>]

ByPath

Get-SqlColumnEncryptionKey
    [[-Name] <String>]
    [[-Path] <String>]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [<CommonParameters>]

説明

例

Example 1: Get all column encryption keys from a database

PS C:\> Get-SqlColumnEncryptionKey

Example 2: Get a column encryption key from a specified

PS C:\> Get-SqlColumnEncryptionKey -Name "CEK1"

パラメーター

-AccessToken

The access token used to authenticate to SQL Server, as an alternative to user/password or Windows Authentication.

This can be used, for example, to connect to SQL Azure DB and SQL Azure Managed Instance using a Service Principal or a Managed Identity.

The parameter to use can be either a string representing the token or a PSAccessToken object as returned by running Get-AzAccessToken -ResourceUrl https://database.windows.net.

This parameter is new in v22 of the module.

パラメーターのプロパティ

パラメーター セット

-Encrypt

The encryption type to use when connecting to SQL Server.

This value maps to the Encrypt property SqlConnectionEncryptOption on the SqlConnection object of the Microsoft.Data.SqlClient driver.

In v22 of the module, the default is Optional (for compatibility with v21). In v23+ of the module, the default value will be 'Mandatory', which may create a breaking change for existing scripts.

This parameter is new in v22 of the module.

パラメーターのプロパティ

パラメーター セット

-HostNameInCertificate

The host name to be used in validating the SQL Server TLS/SSL certificate. You must pass this parameter if your SQL Server instance is enabled for Force Encryption and you want to connect to an instance using hostname/shortname. If this parameter is omitted then passing the Fully Qualified Domain Name (FQDN) to -ServerInstance is necessary to connect to a SQL Server instance enabled for Force Encryption.

This parameter is new in v22 of the module.

パラメーターのプロパティ

パラメーター セット

-InputObject

Specifies the SQL database object for which this cmdlet runs the operation.

パラメーターのプロパティ

パラメーター セット

-Name

Specifies the name of the column encryption key object.

パラメーターのプロパティ

パラメーター セット

-Path

Specifies the path of the SQL database for which this cmdlet runs the operation. If you do not specify a value for this parameter, the cmdlet uses the current working location.

パラメーターのプロパティ

パラメーター セット

-Script

Indicates that this cmdlet runs a script to get the SQL column encryption key value.

パラメーターのプロパティ

パラメーター セット

-TrustServerCertificate

Indicates whether the channel will be encrypted while bypassing walking the certificate chain to validate trust.

In v22 of the module, the default is $true (for compatibility with v21). In v23+ of the module, the default value will be '$false', which may create a breaking change for existing scripts.

This parameter is new in v22 of the module.

パラメーターのプロパティ

パラメーター セット

CommonParameters

入力

Microsoft.SqlServer.Management.Smo.Database

出力

SqlColumnEncryptionKey

SqlColumnEncryptionKey

関連リンク

• New-SqlColumnEncryptionKey
• Remove-SqlColumnEncryptionKey