Get-EntraContact

Module:
Microsoft.Entra.DirectoryManagement Module v1.3

Hiermee wordt een contactpersoon opgehaald uit Microsoft Entra ID.

Syntax

GetQuery (Standaard) 

Get-EntraContact

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

GetById 

Get-EntraContact

    -OrgContactId <String>
    [-All]
    [-Property <String[]>]
    [-HasErrorsOnly]
    [<CommonParameters>]

Description

De Get-EntraContact cmdlet haalt een contactpersoon op uit Microsoft Entra ID.

Voor gedelegeerde scenario's met betrekking tot werk- of schoolaccounts moet de aangemelde gebruiker beschikken over een ondersteunde Microsoft Entra-rol of een aangepaste rol met de vereiste machtigingen. De volgende rollen met minimale bevoegdheden ondersteunen deze bewerking:

  • Adreslijstlezers: basiseigenschappen lezen
  • Globale lezer
  • Adreslijstschrijvers
  • Intune-beheerder
  • Gebruikersbeheerder

Voorbeelden

Voorbeeld 1: Alle contactobjecten in de map ophalen

Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact

DisplayName          Id                                   Mail                         MailNickname
-----------          --                                   ----                         ------------
Contoso Contact     aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com         Contoso Contact
Contoso Contact1    bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com        Contoso Contact 1
Contoso Contact2    cccccccc-2222-3333-4444-dddddddddddd contact2@contoso.com        Contoso Contact 2
Contoso Contact3    dddddddd-3333-4444-5555-eeeeeeeeeeee contact3@contoso.com        Contoso Contact 3

In dit voorbeeld worden alle contactobjecten in de map opgehaald.

Voorbeeld 2: Specifiek contactobject ophalen in de directory

Connect-Entra -Scopes 'OrgContact.Read.All'
$contact = Get-EntraContact -Filter "displayName eq 'Contoso Contact'"
Get-EntraContact -OrgContactId $contact.Id

DisplayName          Id                                   Mail                         MailNickname
-----------          --                                   ----                         ------------
Contoso Contact     aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com         Contoso Contact

In dit voorbeeld wordt de opgegeven contactpersoon opgehaald in de adreslijst.

  • -OrgContactId parameter geeft de contact-id.

Voorbeeld 3: Alle contactpersonenobjecten in de map ophalen

Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact -All

DisplayName          Id                                   Mail                         MailNickname
-----------          --                                   ----                         ------------
Contoso Contact     aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com         Contoso Contact
Contoso Contact1    bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com        Contoso Contact 1
Contoso Contact2    cccccccc-2222-3333-4444-dddddddddddd contact2@contoso.com        Contoso Contact 2
Contoso Contact3    dddddddd-3333-4444-5555-eeeeeeeeeeee contact3@contoso.com        Contoso Contact 3

In dit voorbeeld worden alle contactpersonen in de adreslijst opgehaald.

Voorbeeld 4: de twee belangrijkste contactpersonenobjecten ophalen in de map

Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact -Top 2

DisplayName          Id                                   Mail                         MailNickname
-----------          --                                   ----                         ------------
Contoso Contact     aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com         Contoso Contact
Contoso Contact1    bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com        Contoso Contact 1

In dit voorbeeld worden de twee belangrijkste contactpersonen in de map opgehaald. U kunt -Limit gebruiken als alias voor -Top.

Voorbeeld 5: Alle contactpersonenobjecten in het mapfilter ophalen op DisplayName

Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact -Filter "displayName eq 'Contoso Contact'"

DisplayName          Id                                   Mail                         MailNickname
-----------          --                                   ----                         ------------
Contoso Contact     aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com         Contoso Contact
Contoso Contact1    bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com        Contoso Contact 1
Contoso Contact2    cccccccc-2222-3333-4444-dddddddddddd contact2@contoso.com        Contoso Contact 2
Contoso Contact3    dddddddd-3333-4444-5555-eeeeeeeeeeee contact3@contoso.com        Contoso Contact 3

In dit voorbeeld worden contactpersonen met de opgegeven weergavenaam opgehaald.

Voorbeeld 6: Contactpersonen met serviceinrichtingsfouten ophalen

Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact -HasErrorsOnly

DisplayName          Id                                   Mail                         ServiceProvisioningErrors
-----------          --                                   ----                         -------------------------
Failed Contact       eeeeeeee-4444-5555-6666-ffffffffffff contact-error@contoso.com    {@{ErrorDetail=...}}

In dit voorbeeld worden alleen contactpersonen opgehaald met serviceinrichtingsfouten.

Parameters

-All

Alle pagina's weergeven.

Parametereigenschappen

Type:System.Management.Automation.SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Filter

Hiermee geeft u een OData v4.0-filterinstructie op. Met deze parameter bepaalt u welke objecten worden geretourneerd.

Parametereigenschappen

Type:System.String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

GetQuery
Position:Named
Verplicht:False
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-HasErrorsOnly

Retourneert alleen contactpersonen met serviceinrichtingsfouten.

Parametereigenschappen

Type:System.Management.Automation.SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-OrgContactId

Hiermee geeft u de id van een contactpersoon in Microsoft Entra ID.

Parametereigenschappen

Type:System.String
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:ObjectId

Parametersets

GetById
Position:Named
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-Property

Hiermee geeft u eigenschappen die moeten worden geretourneerd.

Parametereigenschappen

Type:

System.String[]

Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Selecteren

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Top

Hiermee geeft u het maximum aantal records dat moet worden geretourneerd.

Parametereigenschappen

Type:System.Int32
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Limit

Parametersets

GetQuery
Position:Named
Verplicht:False
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.