New-SqlAzureKeyVaultColumnMasterKeySettings

SYNOPSIS

Creates a SqlColumnMasterKeySettings object describing an asymmetric key stored in Azure Key Vault.

SYNTAX

New-SqlAzureKeyVaultColumnMasterKeySettings [-KeyUrl] <String> [-InformationAction <ActionPreference>]
 [-InformationVariable <String>] [<CommonParameters>]

DESCRIPTION

The New-SqlAzureKeyVaultColumnMasterKeySettings cmdlet creates a SqlColumnMasterKeySettings object. The SqlColumnMasterKeySettings object references a key, stored in Azure Key Vault, which is intended to be used as a column master key for the Always Encrypted feature. The SqlColumnMasterKeySettings object has two properties: KeyStoreProviderName and KeyPath. This cmdlet sets the KeyStoreProviderName property to contain the name of column master key store provider for AzureKey Vault, and it sets the value of the KeyPath property to the specified key URL.

EXAMPLES

Example 1: Create a SqlColumnMasterKey object

PS C:\> $CMKSettings = New-SqlAzureKeyVaultColumnMasterKeySettings -KeyUrl "https://myvault.vault.contoso.net:443/keys/CMK/4c05f1a41b12488f9cba2ea964b6a700"

This command creates a SqlColumnMasterKeySettings object that references a key in Azure Key Vault and stores the result in the variable named CMKSettings.

PARAMETERS

-KeyUrl

Specifies the link, as a URL, of the key in Azure Key Vault.

Type: String
Parameter Sets: (All)
Aliases: 

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

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa

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

-InformationVariable

Specifies an information variable.

Type: String
Parameter Sets: (All)
Aliases: iv

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

SqlColumnMasterKeySettings

NOTES

Configure Always Encrypted using PowerShell

SQL Server Cmdlets