Get-SqlLogin
SQL Serverのインスタンス内の Login オブジェクトを返します。
構文
Get-SqlLogin
[-LoginName <String>]
[-Disabled]
[-Locked]
[-PasswordExpired]
[-HasAccess]
[-RegEx]
[-Wildcard]
[-LoginType <LoginType>]
[[-Path] <String>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Get-SqlLogin
[-LoginName <String>]
[-Disabled]
[-Locked]
[-PasswordExpired]
[-HasAccess]
[-RegEx]
[-Wildcard]
[-LoginType <LoginType>]
[[-InputObject] <Server>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Get-SqlLogin
[-LoginName <String>]
[-Disabled]
[-Locked]
[-PasswordExpired]
[-HasAccess]
[-RegEx]
[-Wildcard]
[-LoginType <LoginType>]
[[-ServerInstance] <String[]>]
[-Credential <PSCredential>]
[-ConnectionTimeout <Int32>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
説明
Get-SqlLogin コマンドレットは、SQL Serverのインスタンス内の Login オブジェクトを返します。 Login オブジェクトの名前を指定すると、コマンドレットはその特定のオブジェクトを削除します。
例
例 1: インスタンスのすべての Login オブジェクトを取得する
PS C:\> Get-SqlLogin -ServerInstance "MyServerInstance"
Name Login Type Created
---- ---------- -------
##MS_PolicyEventProcessingLogin## SqlLogin 4/30/2016 12:46 AM
##MS_PolicyTsqlExecutionLogin## SqlLogin 4/30/2016 12:46 AM
NT AUTHORITY\SYSTEM WindowsUser 6/16/2016 10:29 AM
NT Service\MSSQLSERVER WindowsUser 6/16/2016 10:29 AM
NT SERVICE\SQLSERVERAGENT WindowsUser 6/16/2016 10:29 AM
NT SERVICE\SQLTELEMETRY WindowsUser 6/16/2016 10:29 AM
NT SERVICE\SQLWriter WindowsUser 6/16/2016 10:29 AM
NT SERVICE\Winmgmt WindowsUser 6/16/2016 10:29 AM
sa SqlLogin 4/8/2003 9:10 AM
このコマンドは、MyServerInstance という名前のSQL Serverのインスタンス内のすべての Login オブジェクトを返します。
例 2: 正規表現に一致するログイン オブジェクトを取得する
PS C:\> Get-SqlLogin -ServerInstance "MyServerInstance" -LoginName "\bNT.*" -RegEx
Name Login Type Created
---- ---------- -------
NT AUTHORITY\SYSTEM WindowsUser 6/16/2016 10:29 AM
NT Service\MSSQLSERVER WindowsUser 6/16/2016 10:29 AM
NT SERVICE\SQLSERVERAGENT WindowsUser 6/16/2016 10:29 AM
NT SERVICE\SQLTELEMETRY WindowsUser 6/16/2016 10:29 AM
NT SERVICE\SQLWriter WindowsUser 6/16/2016 10:29 AM
NT SERVICE\Winmgmt WindowsUser 6/16/2016 10:29 AM
このコマンドは、'MyServerInstance' という名前のSQL Serverのインスタンス内の正規表現 "\bNT.*" と一致する名前を持つ Login オブジェクトを返します。
例 3: 型のログイン オブジェクトを取得する
PS C:\> Get-SqlLogin -ServerInstance "MyServerInstance" -LoginType SqlLogin
Name Login Type Created
---- ---------- -------
##MS_PolicyEventProcessingLogin## SqlLogin 4/30/2016 12:46 AM
##MS_PolicyTsqlExecutionLogin## SqlLogin 4/30/2016 12:46 AM
sa SqlLogin 4/8/2003 9:10 AM
このコマンドは、'MyServerInstance' という名前のSQL Serverのインスタンス内の SqlLogin 型の Login オブジェクトを返します。
パラメーター
-AccessToken
ユーザー/パスワードまたは Windows 認証の代わりに、SQL Serverの認証に使用されるアクセス トークン。
これは、たとえば、 または Managed Identity
に接続SQL Azure DB
して SQL Azure Managed Instance
使用するために使用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 |
-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 |
-Disabled
このコマンドレットが無効になっている Login オブジェクトのみを取得することを示します。
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 |
-HasAccess
このコマンドレットは、SQL Serverのインスタンスにアクセスできる 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
このコマンドレットが Login オブジェクトを取得するSQL Server SQL Server管理オブジェクト (SMO) オブジェクトを指定します。
Type: | Server |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Locked
このコマンドレットがロックされた Login オブジェクトのみを取得することを示します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
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 |
-LoginType
このコマンドレットが取得する Login オブジェクトの種類を指定します。
Type: | LoginType |
Accepted values: | WindowsUser, WindowsGroup, SqlLogin, Certificate, AsymmetricKey, ExternalUser, ExternalGroup |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PasswordExpired
このコマンドレットは、パスワードの有効期限が切れた Login オブジェクトのみを取得することを示します。
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 |
-RegEx
このコマンドレットが LoginName パラメーターの値を正規表現として扱うことを示します。
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 |
-Wildcard
このコマンドレットが LoginName パラメーターの値でワイルドカード文字を解釈することを示します。
Type: | SwitchParameter |
Aliases: | Like |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
Microsoft.SqlServer.Management.Smo.Server
System.String[]