Share via

Get-SCSPFTenantUserRole

  • Reference
Module:
spfadmin

Gets one or more tenant user roles.

Syntax

Get-SCSpfTenantUserRole []
Get-SCSPFTenantUserRole
   [-Tenant] <Tenant>
   [[-Name] <String[]>]
   [<CommonParameters>]
Get-SCSPFTenantUserRole
   [-ID] <Guid[]>
   [<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:System.Guid[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of one or more tenant user roles.

Type:System.String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
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:Microsoft.SystemCenter.Foundation.SPFData.Types.Tenant
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

Microsoft.SystemCenter.Foundation.SPFData.Types.Tenant

System.String[]

System.Guid[]

Outputs

System.Object