Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-EntraBetaDirectorySetting

Gets a directory setting.

Syntax

GetQuery (Default)

Get-EntraBetaDirectorySetting

 [-All]
 [-Top <Int32>]
 [-Property <String[]>]
 [<CommonParameters>]

GetById

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.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

-Id

Specifies the ID of a directory in Microsoft Entra ID.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Property

Specifies properties to be returned

Parameter properties

Type:

System.String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Select

Parameter sets

-Top

Specifies the maximum number of records to return.

Parameter properties

Type:System.Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Limit

Parameter sets

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.

Related Links


Feedback

Was this page helpful?