Skip to content

Commit a71b591

Browse files
committed
Fix documentation in Test-SqlDscIsRole to clarify server principal role checks
1 parent 125203e commit a71b591

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

source/Public/Test-SqlDscIsRole.ps1

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
<#
22
.SYNOPSIS
3-
Returns whether the database principal exists and is a database role.
3+
Returns whether the server principal exists and is a server role.
44
55
.DESCRIPTION
6-
Returns whether the database principal exist and is a database role.
6+
Returns whether the server principal exist and is a server role.
77
88
.PARAMETER ServerObject
99
Specifies current server connection object.
1010
1111
.PARAMETER Name
12-
Specifies the name of the database principal.
12+
Specifies the name of the server principal.
1313
1414
.OUTPUTS
1515
[System.Boolean]
@@ -18,7 +18,7 @@
1818
$serverInstance = Connect-SqlDscDatabaseEngine
1919
Test-SqlDscIsRole -ServerObject $serverInstance -Name 'MyPrincipal'
2020
21-
Returns $true if the principal exist as role, if not $false is returned.
21+
Returns $true if the principal exist as a server role, if not $false is returned.
2222
#>
2323
function Test-SqlDscIsRole
2424
{

0 commit comments

Comments
 (0)