Add-SqlLogin

Модуль:

SqlServer Module

Создает объект Login в экземпляре SQL Server.

Синтаксис

ByPath (по умолчанию)

Add-SqlLogin
    [[-Path] <String>]
    -LoginType <LoginType>
    [-LoginName <String>]
    [-DefaultDatabase <String>]
    [-EnforcePasswordPolicy]
    [-EnforcePasswordExpiration]
    [-MustChangePasswordAtNextLogin]
    [-Certificate <String>]
    [-AsymmetricKey <String>]
    [-CredentialName <String>]
    [-LoginPSCredential <PSCredential>]
    [-Enable]
    [-GrantConnectSql]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [<CommonParameters>]

ByObject

Add-SqlLogin
    [[-InputObject] <Server>]
    -LoginType <LoginType>
    [-LoginName <String>]
    [-DefaultDatabase <String>]
    [-EnforcePasswordPolicy]
    [-EnforcePasswordExpiration]
    [-MustChangePasswordAtNextLogin]
    [-Certificate <String>]
    [-AsymmetricKey <String>]
    [-CredentialName <String>]
    [-LoginPSCredential <PSCredential>]
    [-Enable]
    [-GrantConnectSql]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [<CommonParameters>]

ByName

Add-SqlLogin
    [[-ServerInstance] <String[]>]
    -LoginType <LoginType>
    [-LoginName <String>]
    [-DefaultDatabase <String>]
    [-EnforcePasswordPolicy]
    [-EnforcePasswordExpiration]
    [-MustChangePasswordAtNextLogin]
    [-Certificate <String>]
    [-AsymmetricKey <String>]
    [-CredentialName <String>]
    [-LoginPSCredential <PSCredential>]
    [-Enable]
    [-GrantConnectSql]
    [-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 или aService PrincipalManaged Identity.

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

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

Свойства параметра

Тип:	PSObject
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-AsymmetricKey

Укажите имя асимметричного ключа для объекта Login. Если параметр LoginType имеет значение AsymmetricKey, укажите асимметричный ключ.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Certificate

Укажите имя сертификата для объекта Login. Если LoginType имеет сертификат значения, укажите сертификат.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-ConnectionTimeout

Указывает количество секунд ожидания подключения к серверу до сбоя времени ожидания. Значение времени ожидания должно быть целым числом от 0 до 65534. Если задано значение 0, попытки подключения не истекает.

Свойства параметра

Тип:	Int32
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ByName

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Credential

Указывает объект PSCredential для подключения к SQL Server. Чтобы получить объект учетных данных, используйте командлет Get-Credential. Для получения дополнительных сведений введите Get-Help Get-Credential.

Свойства параметра

Тип:	PSCredential
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ByName

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-CredentialName

Укажите имя учетных данных для объекта Login.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-DefaultDatabase

Укажите базу данных по умолчанию для объекта Login. Значение по умолчанию — master.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Enable

Указывает, что объект Login включен. По умолчанию объекты входа отключены.

Объекты типов WindowsGroup всегда включены. Этот параметр не влияет на них.

Свойства параметра

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Encrypt

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

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

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

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

Свойства параметра

Тип:	String
Default value:	None
Допустимые значения:	Mandatory, Optional, Strict
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-EnforcePasswordExpiration

Указывает, что политика истечения срока действия пароля применяется для объекта Login. Этот параметр применяет только объекты типа SqlLogin. Этот параметр подразумевает параметр EnforcePasswordPolicy. Вам не нужно указывать оба.

Свойства параметра

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-EnforcePasswordPolicy

Указывает, что политика паролей применяется для объекта Login. Этот параметр применяет только объекты типа SqlLogin.

Свойства параметра

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-GrantConnectSql

Указывает, что объект Login не запрещает разрешения на подключение к ядру СУБД. По умолчанию объекты входа запрещены для подключения к ядру СУБД, если целевой сервер не является SQL Azure.

Свойства параметра

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-HostNameInCertificate

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

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

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-InputObject

Указывает объект объектов управления SQL Server (SMO) SQL Server, на котором работает этот командлет.

Свойства параметра

Тип:	Server
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ByObject

Position:	1
Обязательно:	False
Значение из конвейера:	True
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-LoginName

Указывает имя объекта Login. Конфиденциальность регистра совпадает с чувствительностью экземпляра SQL Server.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	Имя

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-LoginPSCredential

Указывает объект PSCredential, позволяющий объекту Login предоставлять имя и пароль без запроса.

Свойства параметра

Тип:	PSCredential
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-LoginType

Указывает тип объекта Login в качестве значения Microsoft.SqlServer.Management.Smo.LoginType. Допустимые значения для этого параметра:

• Асимметричный ключ
• Сертификат
• SqlLogin
• WindowsGroup
• WindowsUser

В настоящее время командлет не поддерживает ExternalUser или ExternalGroup.

Свойства параметра

Тип:	LoginType
Default value:	None
Допустимые значения:	WindowsUser, WindowsGroup, SqlLogin, Certificate, AsymmetricKey, ExternalUser, ExternalGroup
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-MustChangePasswordAtNextLogin

Указывает, что пользователь должен изменить пароль при следующем входе. Этот параметр применяет только объекты типа SqlLogin. Этот параметр подразумевает параметр EnforcePasswordExpiration. Вам не нужно указывать оба.

Свойства параметра

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Path

Указывает путь к SQL Server, на котором выполняется эта операция. Значением по умолчанию является текущий рабочий каталог.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ByPath

Position:	1
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Script

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

Свойства параметра

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-ServerInstance

Указывает имя экземпляра SQL Server. Для экземпляра по умолчанию укажите имя компьютера. Для именованных экземпляров используйте формат ComputerName\InstanceName.

Свойства параметра

Тип:	String[]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ByName

Position:	1
Обязательно:	False
Значение из конвейера:	True
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-TrustServerCertificate

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

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

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

Свойства параметра

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

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

Microsoft.SqlServer.Management.Smo.Server

System.String[]

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

System.Object

Связанные ссылки

• Get-SqlLogin
• Remove-SqlLogin