Get-SCSPFTenantUserRole
Get-SCSPFTenantUserRole
Gets one or more tenant user role objects.
Syntax
Parameter Set: FromRoleIdParameterSetName
Get-SCSPFTenantUserRole [-ID] <Guid[]> [ <CommonParameters>]
Parameter Set: FromRoleTenantParameterSetName
Get-SCSPFTenantUserRole [-Tenant] <Tenant> [[-Name] <String[]> ] [ <CommonParameters>]
Detailed Description
The Get-SCSPFTenantUserRole cmdlet gets one or more tenant role objects in Service Provider Foundation. To create a new tenant user role, use the New-SCSPFTenantUserRole cmdlet.
Parameters
-ID<Guid[]>
Specifies one or more identifiers (as a GUID) for a specific object.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies the name of one or more tenant user roles.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Tenant<Tenant>
Specifies a tenant for which this cmdlet will return associated tenant user roles. To obtain a tenant, use the Get-SCSPFTenant cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
1: Get all tenant user roles.
This command lists all tenant user roles.
PS C:\> Get-SCSPFTenantUserRole
2: Get a tenant user role by its ID.
This command gets a tenant user role by its ID.
PS C:\> $tur = Get-SCSPFTenantUserRole -ID e6f9f901-2883-4478-a64e-00c58a423516
3: Get the tenant user role that is associated with a tenant.
The first command gets a tenant.
The second command gets the tenant user roles associated with a tenant.
PS C:\> $tnnt = Get-SCSPFTenant -Name "Contoso"
PS C:\> $tur = Get-SCSPFTenantUserRole -Tenant $tnnt