Get-EntraContact

Moduł:
Microsoft.Entra.DirectoryManagement Module v1.3

Pobiera kontakt z Microsoft Entra ID.

Składnia

GetQuery (domyślnie) 

Get-EntraContact

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

GetById 

Get-EntraContact

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

Opis

Polecenie Get-EntraContact cmdlet pobiera kontakt z Microsoft Entra ID.

W przypadku scenariuszy delegowanych obejmujących konta służbowe zalogowany użytkownik musi mieć obsługiwaną rolę Microsoft Entra lub rolę niestandardową z wymaganymi uprawnieniami. Następujące najmniej uprzywilejowane role obsługują tę operację:

  • Czytelnicy katalogu: odczytywanie podstawowych właściwości
  • Globalny czytnik
  • Autorzy katalogów
  • Administrator usługi Intune
  • Administrator użytkowników

Przykłady

Przykład 1. Pobieranie wszystkich obiektów kontaktów w katalogu

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

Ten przykład pobiera wszystkie obiekty kontaktowe w katalogu.

Przykład 2. Pobieranie określonego obiektu kontaktu w katalogu

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

Ten przykład pobiera określony kontakt w katalogu.

  • -OrgContactId parametr określa identyfikator kontaktu.

Przykład 3. Pobieranie wszystkich obiektów kontaktów w katalogu

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

Ten przykład pobiera wszystkie kontakty w katalogu.

Przykład 4. Pobieranie dwóch pierwszych obiektów kontaktów w katalogu

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

Ten przykład pobiera dwa pierwsze kontakty w katalogu. Możesz użyć -Limit jako aliasu dla -Top.

Przykład 5. Pobieranie wszystkich obiektów kontaktów w filtrze katalogu według 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

W tym przykładzie są pobierane kontakty o określonej nazwie wyświetlanej.

Przykład 6. Pobieranie kontaktów z błędami aprowizacji usług

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=...}}

W tym przykładzie są pobierane tylko kontakty, które mają błędy aprowizacji usług.

Parametry

-All

Wyświetl listę wszystkich stron.

Właściwości parametru

Typ:System.Management.Automation.SwitchParameter
Domyślna wartość:False
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Filter

Określa instrukcję filtru OData w wersji 4.0. Ten parametr określa, które obiekty są zwracane.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

GetQuery
Position:Named
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-HasErrorsOnly

Zwraca tylko kontakty, które mają błędy aprowizacji usług.

Właściwości parametru

Typ:System.Management.Automation.SwitchParameter
Domyślna wartość:False
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-OrgContactId

Określa identyfikator kontaktu w Microsoft Entra ID.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Identyfikator Obiektu

Zestawy parametrów

GetById
Position:Named
Obowiązkowe:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-Property

Określa właściwości, które mają być zwracane.

Właściwości parametru

Typ:

System.String[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Select

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Top

Określa maksymalną liczbę rekordów do zwrócenia.

Właściwości parametru

Typ:System.Int32
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Ograniczenie

Zestawy parametrów

GetQuery
Position:Named
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.