Test‑SqlDscIsLoginEnabled

SYNOPSIS

Returns whether the server login is enabled or disabled.

SYNTAX

ServerObject

Test-SqlDscIsLoginEnabled -ServerObject <Server> -Name <String> [-Refresh] 
 [<CommonParameters>]

LoginObject

Test-SqlDscIsLoginEnabled -LoginObject <Login> [<CommonParameters>]

DESCRIPTION

Tests the state of a SQL Server login and returns a Boolean result. When a Server object is provided, the login is resolved using Get-SqlDscLogin (optionally refreshing the server logins first). When a Login object is provided, its current state is evaluated directly.

EXAMPLES

EXAMPLE 1

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
Test-SqlDscIsLoginEnabled -ServerObject $serverObject -Name 'MyLogin'

Returns $true if the login is enabled, if not $false is returned.

EXAMPLE 2

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$loginObject = $serverObject | Get-SqlDscLogin -Name 'MyLogin'
Test-SqlDscIsLoginEnabled -LoginObject $loginObject

Returns $true if the login is enabled, if not $false is returned.

EXAMPLE 3

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$result = $serverObject | Test-SqlDscIsLoginEnabled -Name 'MyLogin'

Demonstrates pipeline usage with ServerObject. Returns $true if the login is enabled, if not $false is returned.

EXAMPLE 4

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$loginObject = $serverObject | Get-SqlDscLogin -Name 'MyLogin'
$result = $loginObject | Test-SqlDscIsLoginEnabled

Demonstrates pipeline usage with LoginObject. Returns $true if the login is enabled, if not $false is returned.

PARAMETERS

-LoginObject

Specifies a login object to test.

Type: Login
Parameter Sets: LoginObject
Aliases:

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

-Name

Specifies the name of the server login to test.

Type: String
Parameter Sets: ServerObject
Aliases:

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

-Refresh

Specifies that the ServerObject's logins should be refreshed before trying to test 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

-ServerObject

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

CommonParameters

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

INPUTS

Microsoft.SqlServer.Management.Smo.Server

Server object accepted from the pipeline.

Microsoft.SqlServer.Management.Smo.Login

Login object accepted from the pipeline.

OUTPUTS

System.Boolean

Returns $true if the login is enabled; otherwise $false.

NOTES

RELATED LINKS