Edit

Share via

Get-EntraBetaDirectorySetting

  • Reference
Module:
Microsoft.Entra.Beta

Gets a directory setting.

Syntax

Get-EntraBetaDirectorySetting
   [-All]
   [-Top <Int32>]
   [-Property <String[]>]
   [<CommonParameters>]
Get-EntraBetaDirectorySetting
   -Id <String>
   [-All]
   [-Property <String[]>]
   [<CommonParameters>]

Description

The Get-EntraBetaDirectorySetting cmdlet gets a directory setting from Microsoft Entra ID. Specify Id parameter to get a directory setting.

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported:

  • Microsoft Entra Joined Device Local Administrator (Read basic properties on setting templates and settings)
  • Directory Readers (Read basic properties on setting templates and settings)
  • Global Reader (Read basic properties on setting templates and settings)
  • Groups Administrator (Manage all group settings)
  • Directory Writers (Manage all group settings)
  • Authentication Policy Administrator (Update Password Rule Settings)
  • User Administrator (Read basic properties on setting templates and settings)

Examples

Example 1: Get a directory setting

Connect-Entra -Scopes 'Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All'
Get-EntraBetaDirectorySetting -Id 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'

Id                                   DisplayName            TemplateId
--                                   -----------            ----------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Application            00001111-aaaa-2222-bbbb-3333cccc4444

This example gets a directory setting.

  • -Id parameter specifies the ID of a directory.

Example 2: Get all directory setting

Connect-Entra -Scopes 'Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All'
Get-EntraBetaDirectorySetting -All

Id                                   DisplayName            TemplateId
--                                   -----------            ----------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Application            00001111-aaaa-2222-bbbb-3333cccc4444
bbbbbbbb-1111-2222-3333-cccccccccccc Password Rule Settings 11112222-bbbb-3333-cccc-4444dddd5555

This example gets all directory setting.

Example 3: Get top n directory setting

Connect-Entra -Scopes 'Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All'
Get-EntraBetaDirectorySetting -Top 2

Id                                   DisplayName            TemplateId
--                                   -----------            ----------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Application            00001111-aaaa-2222-bbbb-3333cccc4444
bbbbbbbb-1111-2222-3333-cccccccccccc Password Rule Settings 11112222-bbbb-3333-cccc-4444dddd5555

This example gets top two directory setting. You can use -Limit as an alias for -Top.

Parameters

-All

List all pages.

Type:System.Management.Automation.SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Specifies the ID of a directory in Microsoft Entra ID.

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

-Top

Specifies the maximum number of records to return.

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