Get-PswaAuthorizationRule
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Get-PswaAuthorizationRule
Returns a set of the Windows PowerShell® Web Access authorization rules.
Syntax
Parameter Set: ID
Get-PswaAuthorizationRule [[-Id] <Int32> ] [ <CommonParameters>]
Parameter Set: Name
Get-PswaAuthorizationRule [-RuleName] <String> [ <CommonParameters>]
Detailed Description
The Get-PswaAuthorizationRule cmdlet returns a set of the Windows PowerShell® Web Access authorization rules.
If neither the Id parameter nor the RuleName parameter is specified, then this cmdlet lists all rules. The Id parameter can be used to filter the results.
Parameters
-Id<Int32>
Specifies the identifiers (IDs) of the rules that this cmdlet should get. If no IDs are specified, then this cmdlet returns all authorization rules.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
false |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-RuleName<String>
Specifies the names of authorization rules to retrieve.
This parameter returns any rules that exactly match the rule names of the strings in this array.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
false |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Management.PowerShellWebAccess.PswaAuthorizationRule
Examples
EXAMPLE 1
This example gets all of the rules.
PS C:\> Get-PswaAuthorizationRule
EXAMPLE 2
This example gets a rule with an ID of 2.
PS C:\> Get-PswaAuthorizationRule –Id 2
EXAMPLE 3
This example illustrates how the cmdlet takes a value from pipeline. A rule id and a rule name are passed in this cmdlet.
PS C:\> "rule1",0 | Get-PswaAuthorizationRule