New-SqlAzureKeyVaultColumnMasterKeySettings

  • Ссылка
Модуль:
SQLServer

Создает объект SqlColumnMasterKeySettings, описывающий асимметричный ключ, хранящийся в Azure Key Vault.

Синтаксис

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

Описание

Создает объект SqlColumnMasterKeySettings, описывающий главный ключ столбца, хранящийся в хранилище ключей или управляемом HSM в Azure Key Vault.

Если вы используете командлет для подписи метаданных ключа, необходимо указать действительный маркер проверки подлинности для хранилищ ключей или управляемых HSM. Кроме того, вы можете пройти проверку подлинности в Azure с помощью Add-SqlAzureAuthenticationContext перед вызовом этого командлета.

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'

Эта команда создает объект sqlColumnMasterKeySettings, который ссылается на ключ в Azure Key Vault и сохраняет результат в переменной с именем $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

Эта команда создает объект sqlColumnMasterKeySettings, который ссылается на ключ в хранилище ключей и сохраняет результат в переменной с именем $cmkSettings. Ключ разрешает вычисления анклава. Так как параметр подписи не указан, командлет автоматически вычисляет подпись и заполняет свойство Signature объекта SqlColumnMasterKeySettings.

В этом примере показано получение маркера проверки подлинности для хранилищ ключей в 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

Эта команда создает объект sqlColumnMasterKeySettings, который ссылается на ключ в хранилище ключей и сохраняет результат в переменной с именем $cmkSettings. Ключ разрешает вычисления анклава. Подпись ключевых свойств указывается в параметре сигнатуры .

Параметры

-AllowEnclaveComputations

Указывает, разрешает ли главный ключ столбца вычисления анклава. Если параметр указан, то серверные безопасные анклава будут разрешены для выполнения вычислений по данным, защищенным с помощью главного ключа столбца. Недопустимо для SQL Server 2017 и более ранних версий.

Тип:SwitchParameter
Position:1
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-KeyUrl

Указывает ссылку в качестве URL-адреса ключа в Azure Key Vault или управляемого устройства HSM.

Тип:String
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-KeyVaultAccessToken

Указывает маркер доступа для хранилищ ключей в Azure Key Vault. Используйте этот параметр, если указанный главный ключ столбца хранится в хранилище ключей в Azure Key Vault, и командлет, как ожидается, подписывает метаданные ключа.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ManagedHsmAccessToken

Указывает маркер доступа для управляемых HSM в Azure Key Vault. Используйте этот параметр, если указанный главный ключ столбца хранится в управляемом HSM в Azure Key Vault, и командлет должен подписать метаданные ключа.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ProgressAction

Определяет, как PowerShell реагирует на обновления хода выполнения, созданные скриптом, командлетом или поставщиком, например индикаторами хода выполнения, созданными командлетом Write-Progress. Командлет Write-Progress создает индикаторы хода выполнения, показывающие состояние команды.

Тип:ActionPreference
Aliases:proga
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Signature

Указывает шестнадцатеричную строку, которая является цифровой подписью свойств главного ключа столбца. Драйвер клиента может проверить подпись, чтобы убедиться, что свойства главного ключа столбца не были изменены.

Этот параметр разрешен только в том случае, если указан AllowEnclaveComputations. Если указан AllowEnclaveComputations, но сигнатуры нет, командлет автоматически вычисляет подпись и заполняет свойство signature нового объекта SqlColumnMasterKeySettings.

Тип:String
Position:2
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Выходные данные

SqlColumnMasterKeySettings