Get-SCSpfTenantUserRole

Gets one or more tenant user roles.

Syntax

Get-SCSpfTenantUserRole [-ID] <Guid[]> [<CommonParameters>]
Get-SCSpfTenantUserRole [-Tenant] <Tenant> [[-Name] <String[]>] [<CommonParameters>]

Description

The Get-SCSPFTenantUserRole cmdlet gets one or more tenant user roles in Service Provider Foundation.
To create a new user role for a tenant, use the New-SCSPFTenantUserRole cmdlet.

Examples

Example 1: Get all tenant user roles

PS C:\>Get-SCSPFTenantUserRole
This command gets all tenant user roles.

Example 2: Get a tenant user role by ID

PS C:\>$TenantUserRoles = Get-SCSPFTenantUserRole -ID e6f9f901-2883-4478-a64e-00c58a423516
This command gets a tenant user role by its ID.

Example 3: Get the tenant user roles associated with a tenant

PS C:\>$Tenant = Get-SCSPFTenant -Name "Contoso"
PS C:\> $TenantUserRoles = Get-SCSPFTenantUserRole -Tenant $Tenant
The first command gets a tenant. The second command gets the tenant user roles associated with the tenant.

Parameters

-ID

Specifies one or more GUIDs for a specific object.

Type:Guid[]
Required:True
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

-Name

Specifies the name of one or more tenant user roles.

Type:String[]
Required:False
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

-Tenant

Specifies a tenant for which this cmdlet returns associated tenant user roles.
To obtain a tenant, use the Get-SCSPFTenant cmdlet.

Type:Tenant
Required:True
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False