Get-DSRoleAssignment

Synopsis

Get administrative role assignments at a scope.

Syntax

__AllParameterSets

Get-DSRoleAssignment [-ScopeType <AdministrativeRoleAssignmentScopeType>] [-ScopeID <guid>]
 [-RoleID <guid>] [-PrincipalId <guid>] [-Filter <string>] [<CommonParameters>]

Description

Get every administrative role holding an assignment at the given scope, with its assigned members. Replacement for Get-DSVaultPermission on servers managing vault access through administrative role assignments.

Examples

Example 1

PS C:\> Get-DSRoleAssignment -ScopeID $vaultID

Get every role assigned on the vault whose ID is $vaultID.

Example 2

PS C:\> Get-DSRoleAssignment

Get every role assignment on the server, across every scope type.

Parameters

-Filter

Free-text filter.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PrincipalId

ID of the user, user group, or application identity to filter on.

Type: System.Nullable`1[System.Guid]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-RoleID

Administrative role ID to filter on.

Type: System.Nullable`1[System.Guid]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ScopeID

Scope resource ID to filter on: a vault ID when -ScopeType is Repository, a gateway ID when Gateway, a PAM provider ID when PamProvider, or a business unit ID when OrganizationalUnit.

Type: System.Nullable`1[System.Guid]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ScopeType

Scope type to filter on. When omitted, assignments across every scope type are returned.

Type: System.Nullable`1[Devolutions.RemoteDesktopManager.AdministrativeRoleAssignmentScopeType]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

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

Outputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSRoleAssignmentScope

Notes

For more information, type "Get-Help Get-DSRoleAssignment -detailed". For technical information, type "Get-Help Get-DSRoleAssignment -full".