Remove-SCSPFTenantUserRole
Removes one or more tenant user roles.
Syntax
Default (Default)
Remove-SCSPFTenantUserRole
-UserRole <Role[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-SCSPFTenantUserRole cmdlet removes one or more tenant user roles from the Service Provider Foundation database.
Examples
Example 1: Remove a tenant user role
PS C:\>$TenantUserRole = Get-SCSPFTenantUserRole -ID 9adb708d-f47e-4dda-9e56-91e1eb2808df
PS C:\> Remove-SCSPFTenantUserRole -UserRole $TenantUserRole
The first command gets the tenant user role by its ID and stores the object in the $TenantUserRole variable.
The second command removes the tenant user role.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserRole
Specifies the name of one or more tenant user roles. To obtain a tenant user role, use the Get-SCSPFTenantUserRole cmdlet.
Parameter properties
| Type: | Microsoft.SystemCenter.Foundation.SPFData.Types.Role[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
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.