Get PpacSecurityRole

---

external help file: d365bap.tools-help.xml Module Name: d365bap.tools online version: schema: 2.0.0

Get-PpacSecurityRole

SYNOPSIS

Get information about Power Platform security roles in a given environment.

SYNTAX

Get-PpacSecurityRole [-EnvironmentId] <String> [[-Name] <String>] [-IncludeAll] [-AsExcelOutput]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This cmdlet retrieves information about Power Platform security roles in a given environment. It allows filtering by role name or ID, including all roles, and exporting the results to Excel.

EXAMPLES

EXAMPLE 1

Get-PpacSecurityRole -EnvironmentId "ContosoEnv"

This command retrieves all Power Platform security roles from the environment "ContosoEnv" and displays their information in the console.

EXAMPLE 2

Get-PpacSecurityRole -EnvironmentId "ContosoEnv" -Name "System Customizer"

This command retrieves the Power Platform security role with the name "System Customizer" from the environment "ContosoEnv" and displays its information in the console.

EXAMPLE 3

Get-PpacSecurityRole -EnvironmentId "ContosoEnv" -Name "*system*"

This command retrieves all Power Platform security roles with names matching "system" from the environment "ContosoEnv" and displays their information in the console.

EXAMPLE 4

Get-PpacSecurityRole -EnvironmentId "ContosoEnv" -IncludeAll

This command retrieves all Power Platform security roles, including both environment-level and business unit-level roles, from the environment "ContosoEnv" and displays their information in the console.

EXAMPLE 5

Get-PpacSecurityRole -EnvironmentId "ContosoEnv" -AsExcelOutput

This command retrieves all Power Platform security roles from the environment "ContosoEnv". It will export the information to an Excel file.

PARAMETERS

-EnvironmentId

The ID of the environment to retrieve security roles from.

Can be either the environment name, the environment GUID (PPAC) or the LCS environment ID.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

The name or ID of the security role to filter the roles by.

Can be either the role name or role ID.

Supports wildcard characters for flexible matching.

Type: String
Parameter Sets: (All)
Aliases: Role

Required: False
Position: 2
Default value: *
Accept pipeline input: False
Accept wildcard characters: False

-IncludeAll

Instructs the cmdlet to include all security roles in the results, including both environment-level and business unit-level roles.

By default, only environment-level roles are included.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AsExcelOutput

Instructs the cmdlet to export the retrieved security role information to an Excel file.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Object[]

NOTES

Author: Mötz Jensen (@Splaxi)

RELATED LINKS