Edit

Share via

Get-EntraBetaPrivilegedRoleSetting

  • Reference
Module:
Microsoft.Entra.Beta

Get role settings.

Syntax

Get-EntraBetaPrivilegedRoleSetting
   -ProviderId <String>
   [-Top <Int32>]
   [-Filter <String>]
   [-Property <String[]>]
   [<CommonParameters>]
Get-EntraBetaPrivilegedRoleSetting
   -Id <String>
   -ProviderId <String>
   [-Property <String[]>]
   [<CommonParameters>]

Description

The Get-EntraBetaPrivilegedRoleSetting cmdlet gets role settings from Microsoft Entra ID.

Examples

Example 1: Get role settings for a specific provider and resource

Connect-Entra -Scopes 'PrivilegedAccess.Read.AzureAD', 'PrivilegedAccess.Read.AzureResources' 'PrivilegedAccess.Read.AzureADGroup'
$params = @{
    ProviderId = 'aadRoles'
    Filter = "ResourceId eq 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'"
}
Get-EntraBetaPrivilegedRoleSetting @params

Id                                   IsDefault LastUpdatedBy     LastUpdatedDateTime ResourceId                           RoleDefinitionId
--                                   --------- -------------     ------------------- ----------                           ----------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb False     MG_graph_auth     06/08/2024 05:12:08 22223333-cccc-4444-dddd-5555eeee6666 44445555-eeee-6666-ffff-7777aaaa8888
bbbbbbbb-1111-2222-3333-cccccccccccc False     MG_graph_auth     26/07/2024 12:28:15 11112222-bbbb-3333-cccc-4444dddd5555 55556666-ffff-7777-aaaa-8888bbbb9999

This example retrieves role settings for a specific provider and resource.

  • -ProviderId Parameter specifies the ID of the specific provider.
  • In, -Filter parameter ResourceId specifies the ID of the specific resource.

Example 2: Get a role setting for a specific provider and Id

Connect-Entra -Scopes 'PrivilegedAccess.Read.AzureAD', 'PrivilegedAccess.Read.AzureResources' 'PrivilegedAccess.Read.AzureADGroup'
$params = @{
    ProviderId = 'aadRoles'
    Id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'
}
Get-EntraBetaPrivilegedRoleSetting @params

Id                                   IsDefault LastUpdatedBy     LastUpdatedDateTime ResourceId                           RoleDefinitionId
--                                   --------- -------------     ------------------- ----------                           ----------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb False     MG_graph_auth     06/08/2024 05:12:08 22223333-cccc-4444-dddd-5555eeee6666 44445555-eeee-6666-ffff-7777aaaa8888

This example retrieves role settings for a specific provider and Id.

  • -ProviderId Parameter specifies the ID of the specific provider.
  • -Id Parameter specifies the ID of the specific role setting.

Example 3: Get role settings for a specific provider and resource

Connect-Entra -Scopes 'PrivilegedAccess.Read.AzureAD', 'PrivilegedAccess.Read.AzureResources' 'PrivilegedAccess.Read.AzureADGroup'
$params = @{
    ProviderId = 'aadRoles'
    Filter = "ResourceId eq 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'"
}
Get-EntraBetaPrivilegedRoleSetting @params -Top 1

Id                                   IsDefault LastUpdatedBy     LastUpdatedDateTime ResourceId                           RoleDefinitionId
--                                   --------- -------------     ------------------- ----------                           ----------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb False     MG_graph_auth     06/08/2024 05:12:08 22223333-cccc-4444-dddd-5555eeee6666 44445555-eeee-6666-ffff-7777aaaa8888

This example retrieves a top one specific role setting. You can use -Limit as an alias for -Top.

  • -ProviderId Parameter specifies the ID of the specific provider.

Example 4: Get role settings with Filter query

Connect-Entra -Scopes 'PrivilegedAccess.Read.AzureAD', 'PrivilegedAccess.Read.AzureResources' 'PrivilegedAccess.Read.AzureADGroup'
$params = @{
    ProviderId = 'aadRoles'
    Filter = "ResourceId eq 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' and LastUpdatedBy  eq 'MOD Administrator'"
}
Get-EntraBetaPrivilegedRoleSetting @params

Id                                   IsDefault LastUpdatedBy     LastUpdatedDateTime ResourceId                           RoleDefinitionId
--                                   --------- -------------     ------------------- ----------                           ----------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb False     MG_graph_auth     06/08/2024 05:12:08 22223333-cccc-4444-dddd-5555eeee6666 44445555-eeee-6666-ffff-7777aaaa8888

This example retrieves role settings for a specific provider and resource.

  • -ProviderId Parameter specifies the ID of the specific provider.

Parameters

-Filter

Specifies an OData v4.0 filter statement. This parameter controls which objects are returned.

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

-Id

The unique identifier of the specific role setting.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Property

Specifies properties to be returned.

Type:System.String[]
Aliases:Select
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProviderId

The unique identifier of the specific provider.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Top

The top result count.

Type:System.Int32
Aliases:Limit
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

System.String

System. Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Outputs

System.Object