Edit

Share via


Get-EntraDomainNameReference

Retrieves the objects that are referenced by a given domain name.

Syntax

Default (Default)

Get-EntraDomainNameReference

    -Name <String>
    [-Property <String[]>]
    [<CommonParameters>]

Description

The Get-EntraDomainNameReference cmdlet retrieves the objects that are referenced with a given domain name. Specify Name parameter retrieve the objects.

In delegated scenarios, the signed-in user must have either a supported Microsoft Entra role or a custom role with the necessary permissions. The minimum roles required for this operation are:

  • Domain Name Administrator
  • Global Reader

Examples

Example 1: Retrieve the domain name reference objects for a domain

Connect-Entra -Scopes 'Domain.Read.All'
Get-EntraDomainNameReference -Name contoso.com | Select-Object Id, DisplayName, '@odata.type'
Id                                   DisplayName              @odata.type
--                                   -------------             ------------------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Sawyer MIller            #microsoft.graph.user
bbbbbbbb-1111-2222-3333-cccccccccccc Adele Vance              #microsoft.graph.user
ffffffff-4444-5555-6666-gggggggggggg Contoso marketing        #microsoft.graph.group
hhhhhhhh-5555-6666-7777-iiiiiiiiiiii Contoso App              #microsoft.graph.application

This example shows how to retrieve the domain name reference objects for a domain that is specified through the -Name parameter.

  • -Name parameter specifies the name of the domain name for which the referenced objects are retrieved.

Parameters

-Name

The name of the domain name for which the referenced objects are retrieved.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-Property

Specifies properties to be returned.

Parameter properties

Type:

System.String[]

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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.

Inputs

System.String

Outputs

System.Object