Get-SCSPFTenantUserRole
Gets one or more tenant user roles.
Syntax
Empty (Default)
Get-SCSPFTenantUserRole
[<CommonParameters>]
FromRoleTenantParameterSetName
Get-SCSPFTenantUserRole
[-Tenant] <Tenant>
[[-Name] <String[]>]
[<CommonParameters>]
FromRoleIdParameterSetName
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.
Parameter properties
| Type: | System.Guid[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromRoleIdParameterSetName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of one or more tenant user roles.
Parameter properties
| Type: | System.String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromRoleTenantParameterSetName
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Tenant
Specifies a tenant for which this cmdlet returns associated tenant user roles. To obtain a tenant, use the Get-SCSPFTenant cmdlet.
Parameter properties
| Type: | Microsoft.SystemCenter.Foundation.SPFData.Types.Tenant |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromRoleTenantParameterSetName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| 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.