Get-EntraContact

Modul:
Microsoft.Entra.DirectoryManagement Module v1.3

Ruft einen Kontakt von Microsoft Entra ID ab.

Syntax

GetQuery (Standard) 

Get-EntraContact

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

GetById 

Get-EntraContact

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

Beschreibung

Das Get-EntraContact Cmdlet ruft einen Kontakt von Microsoft Entra ID ab.

Für delegierte Szenarien mit Geschäfts-, Schul- oder Unikonten muss der angemeldete Benutzer über eine unterstützte Microsoft Entra Rolle oder eine benutzerdefinierte Rolle mit den erforderlichen Berechtigungen verfügen. Die folgenden am wenigsten privilegierten Rollen unterstützen diesen Vorgang:

  • Verzeichnisleser: Grundlegende Eigenschaften lesen
  • Globaler Leser
  • Verzeichnisautoren
  • Intune-Administrator
  • Benutzeradministrator

Beispiele

Beispiel 1: Abrufen aller Kontaktobjekte im Verzeichnis

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 diesem Beispiel werden alle Kontaktobjekte im Verzeichnis abgerufen.

Beispiel 2: Abrufen eines bestimmten Kontaktobjekts im Verzeichnis

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 diesem Beispiel wird der angegebene Kontakt im Verzeichnis abgerufen.

  • -OrgContactId der Parameter gibt die Kontakt-ID an.

Beispiel 3: Abrufen aller Kontakteobjekte im Verzeichnis

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 diesem Beispiel werden alle Kontakte im Verzeichnis abgerufen.

Beispiel 4: Abrufen der beiden wichtigsten Kontakteobjekte im Verzeichnis

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 diesem Beispiel werden die beiden ersten Kontakte im Verzeichnis abgerufen. Sie können -Limit als Alias für -Top verwenden.

Beispiel 5: Abrufen aller Kontakteobjekte im Verzeichnisfilter nach 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 diesem Beispiel werden Kontakte mit dem angegebenen Anzeigenamen abgerufen.

Beispiel 6: Abrufen von Kontakten mit Dienstbereitstellungsfehlern

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 diesem Beispiel werden nur Kontakte mit Dienstbereitstellungsfehlern abgerufen.

Parameter

-All

Alle Seiten auflisten.

Parametereigenschaften

Typ:System.Management.Automation.SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Filter

Gibt eine OData v4.0-Filter-Anweisung an. Dieser Parameter steuert, welche Objekte zurückgegeben werden.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

GetQuery
Position:Named
Obligatorisch:False
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-HasErrorsOnly

Gibt nur Kontakte mit Dienstbereitstellungsfehlern zurück.

Parametereigenschaften

Typ:System.Management.Automation.SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-OrgContactId

Gibt die ID eines Kontakts in Microsoft Entra ID an.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Objekt-ID

Parametersätze

GetById
Position:Named
Obligatorisch:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-Property

Gibt eigenschaften an, die zurückgegeben werden sollen.

Parametereigenschaften

Typ:

System.String[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Select

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Top

Gibt die maximale Anzahl der zurückzugebenden Datensätze an.

Parametereigenschaften

Typ:System.Int32
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Begrenzung

Parametersätze

GetQuery
Position:Named
Obligatorisch:False
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.