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>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Get-SqlLogin
[-LoginName <String>]
[-Disabled]
[-Locked]
[-PasswordExpired]
[-HasAccess]
[-RegEx]
[-Wildcard]
[-LoginType <LoginType>]
[[-InputObject] <Server>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[<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>]
[-ProgressAction <ActionPreference>]
[<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: 正規表現に一致する Login オブジェクトを取得する
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: 型の Login オブジェクトを取得する
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 に対する認証に使用されるアクセス トークン。
これは、たとえば、Service Principal または Managed Identityを使用して SQL Azure DB と SQL Azure Managed Instance に接続するために使用できます。
使用するパラメーターには、トークンを表す文字列、または Get-AzAccessToken -ResourceUrl https://database.windows.netを実行して返される PSAccessToken オブジェクトを指定できます。
このパラメーターは、モジュールの v22 の新機能です。
| 型: | PSObject |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ConnectionTimeout
タイムアウトエラーが発生するまでのサーバー接続を待機する秒数を指定します。 タイムアウト値は、0 から 65534 までの整数である必要があります。 0 を指定した場合、接続試行はタイムアウトになりません。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Credential
SQL Server への接続の PSCredential オブジェクトを指定します。 資格情報オブジェクトを取得するには、Get-Credential コマンドレットを使用します。 詳細については、「Get-Credential」Get-Help 入力します。
| 型: | PSCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Disabled
このコマンドレットが無効になっている Login オブジェクトのみを取得することを示します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Encrypt
SQL Server に接続するときに使用する暗号化の種類。
この値は、Microsoft.Data.SqlClient ドライバーの SqlConnection オブジェクトの Encrypt プロパティ SqlConnectionEncryptOption にマップされます。
モジュールの v22 では、既定値は Optional です (v21 との互換性のため)。 モジュールの v23 以降では、既定値は "必須" になり、既存のスクリプトに重大な変更が生じる可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
| 型: | String |
| 指定可能な値: | Mandatory, Optional, Strict |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-HasAccess
このコマンドレットは、SQL Server のインスタンスにアクセスできる Login オブジェクトのみを取得することを示します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-HostNameInCertificate
SQL Server TLS/SSL 証明書の検証に使用するホスト名。 SQL Server インスタンスで Force Encryption が有効になっていて、ホスト名/短縮名を使用してインスタンスに接続する場合は、このパラメーターを渡す必要があります。 このパラメーターを省略した場合、強制暗号化が有効になっている SQL Server インスタンスに接続するには、完全修飾ドメイン名 (FQDN) を -ServerInstance に渡す必要があります。
このパラメーターは、モジュールの v22 の新機能です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InputObject
このコマンドレットが Login オブジェクトを取得する SQL Server の SQL Server 管理オブジェクト (SMO) オブジェクトを指定します。
| 型: | Server |
| 配置: | 1 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Locked
このコマンドレットは、ロックされた Login オブジェクトのみを取得することを示します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-LoginName
このコマンドレットが取得する Login オブジェクトの名前の配列を指定します。 大文字と小文字の区別は、SQL Server のインスタンスと同じです。
| 型: | String |
| Aliases: | Name |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-LoginType
このコマンドレットが取得する Login オブジェクトの種類を指定します。
| 型: | LoginType |
| 指定可能な値: | WindowsUser, WindowsGroup, SqlLogin, Certificate, AsymmetricKey, ExternalUser, ExternalGroup |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-PasswordExpired
このコマンドレットは、パスワードの有効期限が切れた Login オブジェクトのみを取得することを示します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Path
このコマンドレットが操作を実行する SQL Server のパスを指定します。 既定値は現在の作業ディレクトリです。
| 型: | String |
| 配置: | 1 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ProgressAction
スクリプト、コマンドレット、またはプロバイダーによって生成された進行状況の更新 (Write-Progress コマンドレットによって生成された進行状況バーなど) に対する PowerShell の応答方法を決定します。 Write-Progress コマンドレットは、コマンドの状態を示す進行状況バーを作成します。
| 型: | ActionPreference |
| Aliases: | proga |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-RegEx
このコマンドレットが LoginName パラメーターの値を正規表現として扱うことを示します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ServerInstance
SQL Server のインスタンスの名前を指定します。 既定のインスタンスには、コンピューター名を指定します。 名前付きインスタンスの場合は、ComputerName\InstanceName という形式を使用します。
| 型: | String[] |
| 配置: | 1 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-TrustServerCertificate
信頼を検証するために証明書チェーンのウォークをバイパスしながらチャネルを暗号化するかどうかを示します。
モジュールの v22 では、既定値は $true です (v21 との互換性のため)。 モジュールの v23 以降では、既定値は "$false" になり、既存のスクリプトに重大な変更が生じる可能性があります。
このパラメーターは、モジュールの v22 の新機能です。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Wildcard
このコマンドレットが LoginName パラメーターの値でワイルドカード文字を解釈することを示します。
| 型: | SwitchParameter |
| Aliases: | Like |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
Microsoft.SqlServer.Management.Smo.Server
System.String[]
関連リンク
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示