Add-SqlLogin
Создает объект Login в экземпляре SQL Server.
Синтаксис
Add-SqlLogin
[-LoginName <String>]
-LoginType <LoginType>
[-DefaultDatabase <String>]
[-EnforcePasswordPolicy]
[-EnforcePasswordExpiration]
[-MustChangePasswordAtNextLogin]
[-Certificate <String>]
[-AsymmetricKey <String>]
[-CredentialName <String>]
[-LoginPSCredential <PSCredential>]
[-Enable]
[-GrantConnectSql]
[[-Path] <String>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Add-SqlLogin
[-LoginName <String>]
-LoginType <LoginType>
[-DefaultDatabase <String>]
[-EnforcePasswordPolicy]
[-EnforcePasswordExpiration]
[-MustChangePasswordAtNextLogin]
[-Certificate <String>]
[-AsymmetricKey <String>]
[-CredentialName <String>]
[-LoginPSCredential <PSCredential>]
[-Enable]
[-GrantConnectSql]
[[-InputObject] <Server>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Add-SqlLogin
[-LoginName <String>]
-LoginType <LoginType>
[-DefaultDatabase <String>]
[-EnforcePasswordPolicy]
[-EnforcePasswordExpiration]
[-MustChangePasswordAtNextLogin]
[-Certificate <String>]
[-AsymmetricKey <String>]
[-CredentialName <String>]
[-LoginPSCredential <PSCredential>]
[-Enable]
[-GrantConnectSql]
[[-ServerInstance] <String[]>]
[-Credential <PSCredential>]
[-ConnectionTimeout <Int32>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Описание
Командлет Add-SqlLogin создает объект Login в экземпляре SQL Server.
Примеры
Пример 1. Создание типа SqlLogin
PS C:\> Add-SqlLogin -ServerInstance "MyServerInstance" -LoginName "MyLogin" -LoginType "SqlLogin" -DefaultDatabase "OtherDatabase"
Name Login Type Created
---- ---------- -------
MyLogin SqlLogin 8/11/2016 3:19 PM
Эта команда создает объект Login с именем MyLogin типа SqlLogin. Команда задает базу данных по умолчанию как OtherDatabase в экземпляре сервера с именем MyServerInstance. Эта команда запрашивает пароль для входа.
Пример 2. Создание типа асимметричного ключа
PS C:\> Add-SqlLogin -ServerInstance "MyServerInstance" -LoginName "MyLogin" -LoginType "AsymmetricKey" -AsymmetricKey "MyKey" -CredentialName "MyCredential"
Name Login Type Created
---- ---------- -------
MyLogin AsymmetricKey 8/11/2016 4:08 PM
Эта команда создает объект Login с именем MyLogin типа AsymmetricKey. Он задает асимметричный ключ с именем MyKey. Кроме того, он сопоставляет учетные данные с именем MyCredential с новым объектом Login. Команда работает в экземпляре сервера с именем MyServerInstance.
Параметры
-AccessToken
Маркер доступа, используемый для проверки подлинности для SQL Server в качестве альтернативы проверке подлинности пользователя или пароля или проверки подлинности Windows.
Это можно использовать, например, для подключения к SQL Azure DB
и SQL Azure Managed Instance
с помощью Service Principal
или Managed Identity
.
Используемый параметр может быть строкой, представляющей маркер, или объектом, PSAccessToken
возвращенным при выполнении .Get-AzAccessToken -ResourceUrl https://database.windows.net
Этот параметр является новым в версии 22 модуля.
Тип: | PSObject |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-AsymmetricKey
Укажите имя асимметричного ключа для объекта Login. Если параметр LoginType имеет значение AsymmetricKey, укажите асимметричный ключ.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Certificate
Укажите имя сертификата для объекта Login. Если LoginType имеет значение Сертификат, укажите сертификат.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ConnectionTimeout
Указывает время ожидания подключения к серверу в секундах до сбоя времени ожидания. Значение времени ожидания должно быть целым числом от 0 до 65 534. Если указано значение 0, попытки соединения не прекращаются.
Тип: | Int32 |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Credential
Указывает объект PSCredential для подключения к SQL Server. Чтобы получить объект учетных данных, используйте командлет Get-Credential. Для получения дополнительных сведений введите Get-Help Get-Credential.
Тип: | PSCredential |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-CredentialName
Укажите имя учетных данных для объекта Login.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-DefaultDatabase
Укажите базу данных по умолчанию для объекта Login. Значение по умолчанию — master.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Enable
Указывает, что объект Login включен. По умолчанию объекты login отключены.
Объекты типа WindowsGroup всегда включены. Этот параметр не влияет на них.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Encrypt
Тип шифрования, используемый при подключении к SQL Server.
Это значение сопоставляется со свойством Encrypt
SqlConnectionEncryptOption
объекта SqlConnection драйвера Microsoft.Data.SqlClient.
В версии 22 модуля по умолчанию используется Optional
значение (для совместимости с версией 21). В версии 23+ модуля значением по умолчанию будет "Обязательно", что может привести к критическому изменению для существующих скриптов.
Этот параметр является новым в версии 22 модуля.
Тип: | String |
Допустимые значения: | Mandatory, Optional, Strict |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-EnforcePasswordExpiration
Указывает, что для объекта Login применяется политика истечения срока действия пароля. Этот параметр применяет только объекты типа SqlLogin. Этот параметр подразумевает параметр EnforcePasswordPolicy. Вам не нужно указывать оба варианта.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-EnforcePasswordPolicy
Указывает, что политика паролей применяется для объекта Login. Этот параметр применяет только объекты типа SqlLogin.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-GrantConnectSql
Указывает, что объекту Login не отказано в разрешениях на подключение к ядру СУБД. По умолчанию объектам входа отказано в разрешениях на подключение к ядру СУБД.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-HostNameInCertificate
Имя узла используется для проверки TLS/SSL-сертификата SQL Server. Этот параметр необходимо передать, если экземпляр SQL Server включен для принудительного шифрования и вы хотите подключиться к экземпляру с помощью hostname/shortname. Если этот параметр опущен, для подключения к экземпляру SQL Server, включенного для принудительного шифрования, необходимо передать полное доменное имя (FQDN) в параметр -ServerInstance.
Этот параметр является новым в версии 22 модуля.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-InputObject
Указывает объект SQL Server management Objects (SMO) SQL Server, с которым работает этот командлет.
Тип: | Server |
Position: | 1 |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-LoginName
Задает имя объекта Login. Учет регистра совпадает с учетом регистра экземпляра SQL Server.
Тип: | String |
Aliases: | Name |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-LoginPSCredential
Указывает объект PSCredential, который позволяет объекту Login указать имя и пароль без запроса.
Тип: | PSCredential |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-LoginType
Указывает тип объекта Login в виде значения Microsoft.SqlServer.Management.Smo.LoginType. Допустимые значения для этого параметра:
- AsymmetricKey
- Сертификат
- SqlLogin
- WindowsGroup
- WindowsUser
В настоящее время командлет не поддерживает ExternalUser или ExternalGroup.
Тип: | LoginType |
Допустимые значения: | WindowsUser, WindowsGroup, SqlLogin, Certificate, AsymmetricKey, ExternalUser, ExternalGroup |
Position: | Named |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-MustChangePasswordAtNextLogin
Указывает, что пользователь должен изменить пароль при следующем входе. Этот параметр применяет только объекты типа SqlLogin. Этот параметр подразумевает параметр EnforcePasswordExpiration. Вам не нужно указывать оба варианта.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Path
Указывает путь к SQL Server, по которому этот командлет выполняет операцию. Значением по умолчанию является текущий рабочий каталог.
Тип: | String |
Position: | 1 |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Script
Указывает, что этот командлет возвращает скрипт Transact-SQL, который выполняет задачу, выполняемую этим командлетом.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ServerInstance
Указывает имя экземпляра SQL Server. Для экземпляра по умолчанию укажите имя компьютера. Для именованных экземпляров используйте формат ComputerName\InstanceName.
Тип: | String[] |
Position: | 1 |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-TrustServerCertificate
Указывает, будет ли канал зашифрован при обходе цепочки сертификатов для проверки доверия.
В версии 22 модуля по умолчанию используется $true
значение (для совместимости с версией 21). В версии 23+ модуля значение по умолчанию будет "$false", что может привести к критическому изменению для существующих скриптов.
Этот параметр является новым в версии 22 модуля.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
Входные данные
Microsoft.SqlServer.Management.Smo.Server
System.String[]
Выходные данные
System.Object
Связанные ссылки
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по