Test‑SqlDscIsDatabasePrincipal - dsccommunity/SqlServerDsc GitHub Wiki

Returns whether the database principal exist.

Test-SqlDscIsDatabasePrincipal [-ServerObject] <Server> [-DatabaseName] <String> [-Name] <String>
 [-ExcludeUsers] [-ExcludeRoles] [-ExcludeFixedRoles] [-ExcludeApplicationRoles] [-Refresh]
 [<CommonParameters>]

Returns whether the database principal exist.

$serverInstance = Connect-SqlDscDatabaseEngine
Test-SqlDscIsDatabasePrincipal -ServerObject $serverInstance -DatabaseName 'MyDatabase' -Name 'MyPrincipal'

Returns $true if the principal exist in the database, if not $false is returned.

$serverInstance = Connect-SqlDscDatabaseEngine
Test-SqlDscIsDatabasePrincipal -ServerObject $serverInstance -DatabaseName 'MyDatabase' -Name 'MyPrincipal' -ExcludeUsers

Returns $true if the principal exist in the database and is not a user, if not $false is returned.

$serverInstance = Connect-SqlDscDatabaseEngine
Test-SqlDscIsDatabasePrincipal -ServerObject $serverInstance -DatabaseName 'MyDatabase' -Name 'MyPrincipal' -ExcludeRoles

Returns $true if the principal exist in the database and is not a role, if not $false is returned.

$serverInstance = Connect-SqlDscDatabaseEngine
Test-SqlDscIsDatabasePrincipal -ServerObject $serverInstance -DatabaseName 'MyDatabase' -Name 'MyPrincipal' -ExcludeFixedRoles

Returns $true if the principal exist in the database and is not a fixed role, if not $false is returned.

$serverInstance = Connect-SqlDscDatabaseEngine
Test-SqlDscIsDatabasePrincipal -ServerObject $serverInstance -DatabaseName 'MyDatabase' -Name 'MyPrincipal' -ExcludeApplicationRoles

Returns $true if the principal exist in the database and is not a application role, if not $false is returned.

$serverInstance = Connect-SqlDscDatabaseEngine
Test-SqlDscIsDatabasePrincipal -ServerObject $serverInstance -DatabaseName 'MyDatabase' -Name 'MyPrincipal' -Refresh

Returns $true if the principal exist in the database, if not $false is returned. The database's principal collections are refreshed before testing.

Specifies the SQL database name.

Type: String
Parameter Sets: (All)
Aliases:

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

Specifies that fixed application roles should not be evaluated for the specified name.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

Specifies that fixed roles should not be evaluated for the specified name.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

Specifies that database roles should not be evaluated for the specified name. This will also exclude fixed roles.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

Specifies that database users should not be evaluated.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

Specifies the name of the database principal.

Type: String
Parameter Sets: (All)
Aliases:

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

Specifies that the database's principal collections (Users, Roles, and ApplicationRoles) should be refreshed before testing if the principal exists. This is helpful when principals could have been modified outside of the ServerObject, for example through T-SQL. But on databases with a large amount of principals it might be better to make sure the ServerObject is recent enough. When exclude parameters are specified (e.g., ExcludeUsers, ExcludeRoles, ExcludeApplicationRoles), only the collections that will be used are refreshed to improve performance.

Type: SwitchParameter
Parameter Sets: (All)
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: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
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.