Remove-SCSPFTenantUserRole

  • Reference
Module:
spfadmin

Removes one or more tenant user roles.

Syntax

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.

Type:System.Management.Automation.SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserRole

Specifies the name of one or more tenant user roles. To obtain a tenant user role, use the Get-SCSPFTenantUserRole cmdlet.

Type:Microsoft.SystemCenter.Foundation.SPFData.Types.Role[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:System.Management.Automation.SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.SystemCenter.Foundation.SPFData.Types.Role[]

Outputs

System.Object