Add-SqlLogin
SQL Serverのインスタンスに Login オブジェクトを作成します。
構文
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 コマンドレットは、SQL Serverのインスタンスに Login オブジェクトを作成します。
例
例 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このコマンドは、SqlLogin 型の 'MyLogin' という名前の Login オブジェクトを作成します。 コマンドは、既定のデータベースを 'MyServerInstance' という名前のサーバー インスタンスの 'OtherDatabase' として指定します。 このコマンドを実行すると、ログインのパスワードの入力を求められます。
例 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このコマンドは、種類 AsymmetricKey の MyLogin という名前の Login オブジェクトを作成します。 MyKey という名前の非対称キーを指定します。 また、MyCredential という資格情報を新しい Login オブジェクトにマップします。 このコマンドは、MyServerInstance という名前のサーバー インスタンスで動作します。
パラメーター
-AccessToken
ユーザー/パスワードまたは Windows 認証の代わりに、SQL Serverに対する認証に使用されるアクセス トークン。
これは、たとえば、 または を使用して にSQL Azure DB接続したりSQL Azure Managed Instance、 を使用したりManaged Identityするために使用Service Principalできます。
使用するパラメーターには、 を実行Get-AzAccessToken -ResourceUrl https://database.windows.netして返されるトークンまたはオブジェクトをPSAccessToken表す文字列を指定できます。
このパラメーターは、モジュールの v22 の新機能です。
| Type: | PSObject |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AsymmetricKey
Login オブジェクトの非対称キーの名前を指定します。 LoginType パラメーターの値が AsymmetricKey の場合は、非対称キーを指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Certificate
Login オブジェクトの証明書の名前を指定します。 LoginType の値が Certificate の場合は、証明書を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConnectionTimeout
タイムアウトエラーが発生するまでのサーバー接続を待機する秒数を指定します。 タイムアウト値には、0 ～ 65,534 の範囲の整数値を指定する必要があります。 0 を指定した場合、接続の試行はタイムアウトしません。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
SQL Serverへの接続の PSCredential オブジェクトを指定します。 資格情報オブジェクトを取得するには、Get-Credential コマンドレットを使用します。 詳細については、「Get-Help Get-Credential」と入力してください。
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CredentialName
Login オブジェクトの資格情報の名前を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultDatabase
Login オブジェクトの既定のデータベースを指定します。 既定値は master です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Enable
Login オブジェクトが有効になっていることを示します。 既定では、Login オブジェクトは無効になっています。
WindowsGroup 型オブジェクトは常に有効です。 このパラメーターは影響を受けません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Encrypt
SQL Serverに接続するときに使用する暗号化の種類。
この値は、 Encrypt Microsoft.Data.SqlClient ドライバーの SqlConnection オブジェクトの プロパティ SqlConnectionEncryptOption にマップされます。
モジュールの v22 では、既定値は Optional (v21 との互換性のために) です。 モジュールの v23 以降では、既定値は "必須" になります。これにより、既存のスクリプトに破壊的変更が発生する可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
| Type: | String |
| Accepted values: | Mandatory, Optional, Strict |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnforcePasswordExpiration
Login オブジェクトにパスワードの有効期限ポリシーが適用されることを示します。 このパラメーターは、SqlLogin 型オブジェクトのみを適用します。 このパラメーターは、EnforcePasswordPolicy パラメーターを意味します。 両方を指定する必要はありません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnforcePasswordPolicy
Login オブジェクトにパスワード ポリシーが適用されることを示します。 このパラメーターは、SqlLogin 型オブジェクトのみを適用します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GrantConnectSql
Login オブジェクトがデータベース エンジンに接続するためのアクセス許可を拒否されていないことを示します。 既定では、Login オブジェクトはデータベース エンジンに接続するためのアクセス許可が拒否されます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HostNameInCertificate
SQL Server TLS/SSL 証明書の検証に使われるホスト名。 SQL Server インスタンスで Force Encryption が有効になっており、hostname/shortname を使用してインスタンスに接続する場合は、このパラメーターを渡す必要があります。 このパラメーターを省略した場合、強制暗号化が有効になっているSQL Server インスタンスに接続するには、完全修飾ドメイン名 (FQDN) を -ServerInstance に渡す必要があります。
このパラメーターは、モジュールの v22 の新機能です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
このコマンドレットが動作するSQL Server SQL Server管理オブジェクト (SMO) オブジェクトを指定します。
| Type: | Server |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LoginName
Login オブジェクトの名前を指定します。 大文字と小文字の区別は、SQL Serverのインスタンスと同じです。
| Type: | String |
| Aliases: | Name |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoginPSCredential
Login オブジェクトがプロンプトなしで名前とパスワードを指定できるようにする PSCredential オブジェクトを指定します。
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoginType
Login オブジェクトの型を Microsoft.SqlServer.Management.Smo.LoginType 値として指定します。 このパラメーターの有効値は、次のとおりです。
- AsymmetricKey
- Certificate
- SqlLogin
- WindowsGroup
- WindowsUser
現時点では、このコマンドレットは ExternalUser または ExternalGroup をサポートしていません。
| Type: | LoginType |
| Accepted values: | WindowsUser, WindowsGroup, SqlLogin, Certificate, AsymmetricKey, ExternalUser, ExternalGroup |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MustChangePasswordAtNextLogin
ユーザーが次のログイン時にパスワードを変更する必要があることを示します。 このパラメーターは、SqlLogin 型オブジェクトのみを適用します。 このパラメーターは、EnforcePasswordExpiration パラメーターを意味します。 両方を指定する必要はありません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
このコマンドレットが操作を実行するSQL Serverのパスを指定します。 既定値は現在の作業ディレクトリです。
| 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 |
-ServerInstance
SQL Serverのインスタンスの名前を指定します。 既定のインスタンスには、コンピューター名を指定します。 名前付きインスタンスの場合は、ComputerName\InstanceName という形式を使用します。
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TrustServerCertificate
信頼を検証するために証明書チェーンの歩き方をバイパスしながらチャネルを暗号化するかどうかを示します。
モジュールの v22 では、既定値は $true (v21 との互換性のために) です。 モジュールの v23 以降では、既定値は "$false" になります。これにより、既存のスクリプトに破壊的変更が発生する可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
Microsoft.SqlServer.Management.Smo.Server
System.String[]
出力
System.Object