Set-SqlCredential

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

Задает свойства объекта Учетные данные SQL.

Синтаксис

Set-SqlCredential
   [-Identity] <String>
   [[-Secret] <SecureString>]
   [[-Path] <String>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-SqlCredential
   [-Identity] <String>
   [[-Secret] <SecureString>]
   [-InputObject] <Credential>
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Описание

Командлет Set-SqlCredential задает свойства идентификатора и пароля для объекта учетных данных SQL с помощью этого командлета. Данный командлет поддерживает следующие два режима работы:

  • Укажите путь или расположение учетных данных, включая имя учетных данных, в которых используется параметр Path.
  • Передайте объект Smo.Credential в объект, использующий параметр InputObject.

Примеры

Пример 1. Установка удостоверения объекта учетных данных SQL

PS C:\> Set-SqlCredential -Path SQLSERVER:\SQL\Computer\Instance\Credentials\MySqlCredential -Identity "MyStorageAccount"

Эта команда задает для удостоверения значение MySqlCredential , MyStorageAccount указав путь к учетным данным SQL.

Пример 2. Установка удостоверения объекта учетных данных SQL с помощью конвейера

PS C:\> $Cred = Get-SqlCredential -Name "MySqlCredential"
PS C:\> $Cred | Set-SqlCredential -Identity "MyStorageAccount"

Первая команда получает объект учетных данных из командлета Get-Credential и сохраняет результат в переменной с именем $Cred.

Пример 3. Установка удостоверения объекта учетных данных SQL с запросом пользователя

PS C:\> $Secret = Read-Host "Please enter the storage account access key"
PS C:\> Set-SqlCredential -Identity "MyStorageAccount" -Secret $Secret

Первая команда запрашивает сведения о ключе доступа к хранилищу и сохраняет результат в переменной с именем $Secret.

Параметры

-AccessToken

Маркер доступа, используемый для проверки подлинности для SQL Server в качестве альтернативы проверке подлинности пользователя или пароля или проверки подлинности Windows.

Это можно использовать, например, для подключения к SQL Azure DB и SQL Azure Managed Instance с помощью Service Principal или Managed Identity.

Используемый параметр может быть строкой, представляющей маркер, или объектом, PSAccessToken возвращенным при выполнении .Get-AzAccessToken -ResourceUrl https://database.windows.net

Этот параметр является новым в версии 22 модуля.

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

-Confirm

Запрос подтверждения перед выполнением командлета.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encrypt

Тип шифрования, используемый при подключении к SQL Server.

Это значение сопоставляется со свойством EncryptSqlConnectionEncryptOption объекта SqlConnection драйвера Microsoft.Data.SqlClient.

В версии 22 модуля по умолчанию используется Optional значение (для совместимости с версией 21). В версии 23+ модуля значением по умолчанию будет "Обязательно", что может привести к критическому изменению для существующих скриптов.

Этот параметр является новым в версии 22 модуля.

Type:String
Accepted values:Mandatory, Optional, Strict
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostNameInCertificate

Имя узла используется для проверки TLS/SSL-сертификата SQL Server. Этот параметр необходимо передать, если экземпляр SQL Server включен для принудительного шифрования и вы хотите подключиться к экземпляру с помощью hostname/shortname. Если этот параметр опущен, для подключения к экземпляру SQL Server, включенного для принудительного шифрования, необходимо передать полное доменное имя (FQDN) в параметр -ServerInstance.

Этот параметр является новым в версии 22 модуля.

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

-Identity

Указывает имя пользователя или учетной записи для ресурса, в котором SQL Server должна пройти проверку подлинности. Что касается службы хранилища Windows Azure, это имя учетной записи хранилища Windows Azure.

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

-InputObject

Указывает входной объект Credential. Чтобы получить этот объект, используйте командлет Get-SqlCredential .

Type:Credential
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

Указывает путь к учетным данным, с которыми этот командлет выполняет эту операцию. Например, SQLSERVER:\SQL\Computer\Instance\Credentials\Credential.

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

-Script

Указывает, что этот командлет возвращает скрипт Transact-SQL, который выполняет задачу, выполняемую этим командлетом.

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

-Secret

Указывает пароль для пользователя или учетной записи. Для службы хранилища Windows Azure это значение ключа доступа для учетной записи хранения Windows Azure.

Type:SecureString
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TrustServerCertificate

Указывает, будет ли канал зашифрован при обходе цепочки сертификатов для проверки доверия.

В версии 22 модуля по умолчанию используется $true значение (для совместимости с версией 21). В версии 23+ модуля значение по умолчанию будет "$false", что может привести к критическому изменению для существующих скриптов.

Этот параметр является новым в версии 22 модуля.

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

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Microsoft.SqlServer.Management.Smo.Credential