New-SqlAzureKeyVaultColumnMasterKeySettings

リファレンス

モジュール:: SQLServer

Azure Key Vault に格納されている非対称キーを記述する SqlColumnMasterKeySettings オブジェクトを作成します。

構文

New-SqlAzureKeyVaultColumnMasterKeySettings
   [-KeyUrl] <String>
   [[-Signature] <String>]
   [-KeyVaultAccessToken <String>]
   [-ManagedHsmAccessToken <String>]
   [-AllowEnclaveComputations]
   [<CommonParameters>]

説明

キーコンテナーまたは Azure Key Vaultのマネージド HSM に格納されている列マスターキーを記述する SqlColumnMasterKeySettings オブジェクトを作成します。

コマンドレットを使用してキーメタデータに署名する場合は、キーコンテナーまたはマネージド HSM の有効な認証トークンを指定する必要があります。または、このコマンドレットを呼び出す前に、Add-SqlAzureAuthenticationContextを使用して Azure に対して認証を行うことができます。

Module requirements: version 21+ on PowerShell 5.1; version 22+ on PowerShell 7.x.

例

例 1: 単純な SqlColumnMasterKeySettings オブジェクトを作成する

$CMKSettings = New-SqlAzureKeyVaultColumnMasterKeySettings -KeyUrl 'https://myvault.vault.contoso.net/keys/CMK/4c05f1a41b12488f9cba2ea964b6a700'

このコマンドは、Azure Key Vaultのキーを参照し、その結果をという名前の変数に格納する SqlColumnMasterKeySettings オブジェクトを作成$CMKSettings

例 2: エンクレーブ計算を可能にする自動署名プロパティを使用して SqlColumnMasterKeySettings を作成する

# Obtain an access token for key vaults.
$keyVaultAccessToken = (Get-AzAccessToken -ResourceUrl https://vault.azure.net).Token

# Pass the token to the cmdlet. It will use the token to communicate with the key vault containing the column master key to sign the column master key metadata properties.
$cmkSettings = New-SqlAzureKeyVaultColumnMasterKeySettings -KeyUrl 'https://myvault.vault.azure.net/keys/CMK/4c05f1a41b12488f9cba2ea964b6a700' -AllowEnclaveComputations -keyVaultAccessToken $keyVaultAccessToken

このコマンドは、キーコンテナー内のキーを参照し、その結果を $cmkSettings という名前の変数に格納する SqlColumnMasterKeySettings オブジェクトを作成します。キーを使用すると、エンクレーブ計算が可能になります。 signature パラメーターが指定されていないため、コマンドレットは自動的に署名を計算し、SqlColumnMasterKeySettings オブジェクトの Signature プロパティを設定します。

この例では、Azure Key Vault のキーコンテナーの認証トークンを取得し、コマンドレットに渡す方法を示します。

例 3: エンクレーブ計算を許可する SqlColumnMasterKeySettings オブジェクトを作成する

# Note: actual signature truncated for brevity
$signature = "0x19BEB4F27F582F...89D5433CE9266C6F867334654BE12"
$cmkSettings = New-SqlAzureKeyVaultColumnMasterKeySettings -KeyUrl 'https://myvault.vault.contoso.net/keys/CMK/4c05f1a41b12488f9cba2ea964b6a700' -AllowEnclaveComputations -Signature $signature

このコマンドは、キーコンテナー内のキーを参照し、その結果を $cmkSettings という名前の変数に格納する SqlColumnMasterKeySettings オブジェクトを作成します。キーを使用すると、エンクレーブ計算が可能になります。キープロパティのシグネチャは、 Signature パラメーターで指定します。

パラメーター

-AllowEnclaveComputations

列マスターキーでエンクレーブ計算を許可するかどうかを指定します。パラメーターを指定した場合、サーバー側のセキュリティで保護されたエンクレーブは、列マスターキーで保護されたデータに対して計算を実行できます。 SQL Server 2017 以前のバージョンでは無効です。

Type:	SwitchParameter
Position:	1
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyUrl

Azure Key Vault またはマネージド HSM のキーのリンクを URL として指定します。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyVaultAccessToken

Azure Key Vaultのキーコンテナーのアクセストークンを指定します。指定した列マスターキーが Azure Key Vault のキーコンテナーに格納されており、コマンドレットがキーメタデータに署名することが予想される場合は、このパラメーターを使用します。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagedHsmAccessToken

Azure Key Vaultのマネージド HSM のアクセストークンを指定します。指定した列マスターキーが Azure Key Vault のマネージド HSM に格納され、コマンドレットがキーメタデータに署名することが予想される場合は、このパラメーターを使用します。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Signature

列マスターキープロパティのデジタル署名である 16 進文字列を指定します。クライアントドライバーは、署名を確認して、列マスターキーのプロパティが改ざんされていないことを確認できます。

このパラメーターは、 AllowEnclaveComputations が指定されている場合にのみ許可されます。 AllowEnclaveComputations が指定されているが、Signature が指定されていない場合、コマンドレットは自動的に署名を計算し、新しい SqlColumnMasterKeySettings オブジェクトの Signature プロパティを設定します。

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

出力

SqlColumnMasterKeySettings

SQLServer_Cmdlets