Remove-SqlLogin

从 SQL Server 实例中删除 Login 对象。

语法

Remove-SqlLogin
      [-LoginName <String[]>]
      [-RemoveAssociatedUsers]
      [-Force]
      [[-Path] <String>]
      [-Script]
      [-AccessToken <PSObject>]
      [-TrustServerCertificate]
      [-HostNameInCertificate <String>]
      [-Encrypt <String>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-SqlLogin
      [-LoginName <String[]>]
      [-RemoveAssociatedUsers]
      [-Force]
      [-InputObject] <Login>
      [-Script]
      [-AccessToken <PSObject>]
      [-TrustServerCertificate]
      [-HostNameInCertificate <String>]
      [-Encrypt <String>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-SqlLogin
      [-LoginName <String[]>]
      [-RemoveAssociatedUsers]
      [-Force]
      [[-ServerInstance] <String[]>]
      [-Credential <PSCredential>]
      [-ConnectionTimeout <Int32>]
      [-Script]
      [-AccessToken <PSObject>]
      [-TrustServerCertificate]
      [-HostNameInCertificate <String>]
      [-Encrypt <String>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

说明

Remove-SqlLogin cmdlet 将删除 Login 对象作为 SQL Server 的实例。 如果指定 Login 对象的名称,则 cmdlet 将删除该特定对象。

示例

示例 1:按名称删除 Login 对象

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

此命令使用 Get-SqlLogin cmdlet 获取指定实例上名为 Login01 的 Login 对象。 该命令使用管道运算符将其传递给当前 cmdlet。 该 cmdlet 删除 Login 对象。

示例 2:删除与字符串匹配的对象

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

此命令使用 Get-SqlLogin获取包含字符串 Login.* 作为指定实例的正则表达式的 Login 对象。 该命令将它传递给当前 cmdlet。 该 cmdlet 删除 Login 对象。 该命令将删除关联的用户。

示例 3:删除多个 Login 对象

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

此命令删除名为 login01login02login03的 3 个登录对象。

参数

-AccessToken

用于向 SQL Server 进行身份验证的访问令牌,作为用户/密码或 Windows 身份验证的替代方法。

例如,这可用于使用 Service PrincipalManaged Identity连接到 SQL Azure DBSQL Azure Managed Instance

要使用的参数可以是表示令牌的字符串,也可以是运行 Get-AzAccessToken -ResourceUrl https://database.windows.net返回的 PSAccessToken 对象。

此参数是模块 v22 中的新增参数。

类型:PSObject
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Confirm

在运行 cmdlet 之前,提示你进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

-ConnectionTimeout

指定在超时失败之前等待服务器连接的秒数。 超时值必须是介于 0 和 65534 之间的整数。 如果指定了 0,则连接尝试不会超时。

类型:Int32
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Credential

指定连接到 SQL Server 的 PSCredential 对象。 若要获取凭据对象,请使用 Get-Credential cmdlet。 有关详细信息,请键入 Get-Help Get-Credential。

类型:PSCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Encrypt

连接到 SQL Server 时要使用的加密类型。

此值映射到 Microsoft.Data.SqlClient 驱动程序的 SqlConnection 对象的 Encrypt 属性 SqlConnectionEncryptOption

在模块的 v22 中,默认为 Optional(为了与 v21 兼容)。 在模块的 v23+ 中,默认值为“必需”,这可能会为现有脚本创建中断性变更。

此参数是模块 v22 中的新增参数。

类型:String
接受的值:Mandatory, Optional, Strict
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Force

强制命令运行而不要求用户确认。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-HostNameInCertificate

用于验证 SQL Server TLS/SSL 证书的主机名。 如果为强制加密启用了 SQL Server 实例,并且想要使用主机名/shortname 连接到实例,则必须传递此参数。 如果省略此参数,则必须将完全限定域名(FQDN)传递给 -ServerInstance 才能连接到为强制加密启用的 SQL Server 实例。

此参数是模块 v22 中的新增参数。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-InputObject

指定一个 SQL Server 管理对象 (SMO) 对象,该对象表示此 cmdlet 删除的 Login 对象。

类型:Login
Position:1
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-LoginName

指定此 cmdlet 删除的 Login 对象的名称数组。

注意:区分大小写与 SQL Server 实例的区分大小写相同。

类型:String[]
别名:Name
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Path

指定运行此 cmdlet 的 SQL Server 的路径。 默认值为当前工作目录。

类型:String
Position:1
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ProgressAction

确定 PowerShell 如何响应脚本、cmdlet 或提供程序生成的进度更新,例如由 Write-Progress cmdlet 生成的进度栏。 Write-Progress cmdlet 创建显示命令状态的进度栏。

类型:ActionPreference
别名:proga
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-RemoveAssociatedUsers

指示此 cmdlet 删除与 Login 对象关联的用户。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Script

指示此 cmdlet 返回执行此 cmdlet 执行的任务的 Transact-SQL 脚本。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ServerInstance

指定 SQL Server 实例的名称。 对于默认实例,请指定计算机名称。 对于命名实例,请使用 ComputerName\InstanceName格式。

类型:String[]
Position:1
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-TrustServerCertificate

指示通道是否在绕过证书链以验证信任的同时进行加密。

在模块的 v22 中,默认为 $true(为了与 v21 兼容)。 在模块的 v23+ 中,默认值将为“$false”,这可能会为现有脚本创建中断性变更。

此参数是模块 v22 中的新增参数。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

输入

Microsoft.SqlServer.Management.Smo.Login

System.String[]