Remove-​Sql​Login

Removes Login objects from an instance of SQL Server.

Syntax

Remove-SqlLogin
      [[-Path] <String>]
      [-LoginName <String[]>]
      [-RemoveAssociatedUsers]
      [-Force]
      [-Script]
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-SqlLogin
      [-InputObject] <Login>
      [-LoginName <String[]>]
      [-RemoveAssociatedUsers]
      [-Force]
      [-Script]
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-SqlLogin
      [[-ServerInstance] <String[]>]
      [-LoginName <String[]>]
      [-RemoveAssociatedUsers]
      [-Force]
      [-Script]
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [-WhatIf]
      [-Confirm]
      [-Credential <PSCredential>]
      [-ConnectionTimeout <Int32>]
      [<CommonParameters>]

Description

The Remove-SqlLogin cmdlet removes Login objects form an instance of SQL Server. If you specify the name of the Login object, the cmdlet removes that specific object.

Examples

Example 1: Remove a Login object by name

PS C:\> Get-SqlLogin -ServerInstance "MyServerInstance" -LoginName "Login01" | Remove-SqlLogin

This command gets the Login object named Login01 on the specified instance by using the Get-SqlLogin cmdlet. The command passes it to the current cmdlet by using the pipeline operator. That cmdlet removes the Login object.

Example 2: Remove objects that match a string

PS C:\> Get-SqlLogin -ServerInstance "MyServerInstance" -LoginName 'Login.*' -Regex | Remove-SqlLogin -RemoveAssociatedUsers

This command gets the Login objects that contain the string Login.* as a regular expression on the specified instance by using Get-SqlLogin. The command passes it to the current cmdlet. That cmdlet removes the Login objects. The command removes associated users.

Example 3: Remove several Login objects

PS C:\> Remove-Login -ServerInstance "MyServerInstance" -LoginName "login01","login02","login03"

This command removes the Login objects named login01, login02, and login03.

Required Parameters

-InputObject

Specifies an SQL Server Management Objects (SMO) object that represents the Login object that this cmdlet removes.

Type:Login
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-ConnectionTimeout

Specifies the number of seconds to wait for a server connection before a time-out failure. The time-out value must be an integer between 0 and 65534. If 0 is specified, connection attempts do not time out.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies a PSCredential object for the connection to SQL Server. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LoginName

Specifies an array of names of Login objects that this cmdlet removes. The case sensitivity is the same as that of the instance of SQL Server.

Type:String[]
Aliases:Name
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Path

Specifies the path of the SQL Server on which this cmdlet runs the operation. The default value is the current working directory.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RemoveAssociatedUsers

Indicates that this cmdlet removes the users that are associated with the Login object.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Script

Indicates that this cmdlet returns a Transact-SQL script that performs the task that this cmdlet performs.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ServerInstance

Specifies the name of an instance of SQL Server. For the default instance, specify the computer name. For named instances, use the format ComputerName\InstanceName.

Type:String[]
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False