Disable‑SqlDscLogin - dsccommunity/SqlServerDsc GitHub Wiki

Disables a SQL Server login.

Disable-SqlDscLogin -ServerObject <Server> -Name <String> [-Force] [-Refresh]
 [-WhatIf] [-Confirm] [<CommonParameters>]

Disable-SqlDscLogin -LoginObject <Login> [-Force] [-WhatIf] [-Confirm]
 [<CommonParameters>]

This command disables a SQL Server login in a SQL Server Database Engine instance.

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$loginObject = $serverObject | Get-SqlDscLogin -Name 'MyLogin'
$loginObject | Disable-SqlDscLogin

Disables the login named MyLogin.

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$serverObject | Disable-SqlDscLogin -Name 'MyLogin'

Disables the login named MyLogin.

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$serverObject | Disable-SqlDscLogin -Name 'MyLogin' -Force

Disables the login without confirmation using -Force.

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$serverObject | Disable-SqlDscLogin -Name 'MyLogin' -Refresh

Refreshes the server logins collection before disabling MyLogin.

Specifies that the login should be disabled without any confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Specifies a login object to disable.

Type: Login
Parameter Sets: LoginObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Specifies the name of the server login to be disabled.

Type: String
Parameter Sets: ServerObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Specifies that the ServerObject's logins should be refreshed before trying to disable the login object. This is helpful when logins could have been modified outside of the ServerObject, for example through T-SQL. But on instances with a large amount of logins it might be better to make sure the ServerObject is recent enough, or pass in LoginObject.

Type: SwitchParameter
Parameter Sets: ServerObject
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Specifies current server connection object.

Type: Server
Parameter Sets: ServerObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.