NAME
Get-DcsUserRoleRelation
SYNOPSIS
Returns the relationship between a user and the roles assigned to the user.
SYNTAX
Get-DcsUserRoleRelation [ -User <Object> ] [ -Role <Object> ] [ -Connection <String> ] [ -PipelineVariable <String> ]
Get-DcsUserRoleRelation -UserRole <Object> [ -Connection <String> ] [ -PipelineVariable <String> ]
DESCRIPTION
Returns the relationship between a user and the roles assigned to the user. Filtering parameters may be specified to narrow the scope of the data returned. User-role relationship data can be returned for a specific user, a specific role, or a specific user-role relationship. If no parameters are specified, data is returned for all user-role relationships in the server group.
PARAMETERS
- -User<Object>
- UserData object, name, or ID that identifies a user. If specified, only data for that user will be returned.
-
- Required: false
- Position: 1
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -Role<Object>
- RoleData object, Alias, or ID that identifies a role. If specified, only data for that role will be returned.
-
- Required: false
- Position: 2
- Default value:
- Accept pipeline input: true (ByValue)
- Accept wildcard characters: false
-
- -Connection<String>
- Alias of the connection to the server group. If not specified, the default connection is used.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -PipelineVariable<String>
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -UserRole<Object>
- UserRoleRelationData object, ID, or caption that identifies a user-role relationship. If specified, only data for that relationship will be returned. The caption is the name of the user followed by the name of the role in this format: "Clark Kent | Networking".
-
- Required: true
- Position: 1
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
INPUTS
RoleData : Object that identifies the role.
OUTPUTS
UserRoleRelationData : Object that identifies the relationship between a user and his/her assigned roles.
NOTES
EXAMPLES
Get-DcsUserRole -User "Clark Kent" | Get-DcsUserRoleRelation
The cmdlet Get-DcsUserRole is invoked to get the RoleData object for the user named "Clark Kent". The object is piped to the cmdlet Get-DcsUserRoleRelation and the object that shows the relationship between the user "Clark Kent" and the role "Networking" is returned.
| UserId | : | 8a1f9129-363b-446e-965f-a91098da3995 |
| RoleId | : | 68b11804-1575-4ab1-8945-95b0ff37a526 |
| Sequencenumber | : | 10977 |
| Id | : | 39345c73-4e73-48ca-a9b8-6c3ab27d8aab |
| Caption | : | Clark Kent | Networking |
| ExtendedCaption | : | Clark Kent | Networking |
| Internal | : | False |
Get-DcsUserRoleRelation -UserRole "Networking"
The cmdlet is invoked to get the UserRoleRelationData object for the user role named "Networking".
| UserId | : | 8a1f9129-363b-446e-965f-a91098da3995 |
| RoleId | : | 68b11804-1575-4ab1-8945-95b0ff37a526 |
| Sequencenumber | : | 10977 |
| Id | : | 39345c73-4e73-48ca-a9b8-6c3ab27d8aab |
| Caption | : | Clark Kent | Networking |
| ExtendedCaption | : | Clark Kent | Networking |
| Internal | : | False |
Get-DcsUserRoleRelation -UserRole 39345c73-4e73-48ca-a9b8-6c3ab27d8aab
The cmdlet is invoked using the ID to identify the user-role relationship. The returned object shows the relationship between the user "Clark Kent" and the role assigned to the user "Networking".
| UserId | : | 8a1f9129-363b-446e-965f-a91098da3995 |
| RoleId | : | 68b11804-1575-4ab1-8945-95b0ff37a526 |
| Sequencenumber | : | 10977 |
| Id | : | 39345c73-4e73-48ca-a9b8-6c3ab27d8aab |
| Caption | : | Clark Kent | Networking |
| ExtendedCaption | : | Clark Kent | Networking |
| Internal | : | False |