Get-EntraContact

模組:
Microsoft.Entra.DirectoryManagement Module v1.3

從 Microsoft Entra ID 取得聯絡人。

語法

GetQuery (預設值) 

Get-EntraContact

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

GetById 

Get-EntraContact

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

Description

指令長Get-EntraContact會收到 Microsoft Entra ID 的聯絡方式。

對於涉及工作或學校帳號的委派情境，登入使用者必須擁有支援的 Microsoft Entra 角色或具備所需權限的自訂角色。 以下最低權限角色支援此操作：

  • 目錄讀取器：讀取基本屬性
  • 全球閱讀器
  • 目錄編輯者
  • Intune 管理員
  • 使用者管理員

範例

範例 1：檢索目錄中的所有聯絡物件

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

此範例會擷取目錄中的所有聯絡物件。

範例 2：在目錄中擷取特定聯絡物件

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

此範例取回目錄中指定的聯絡人。

  • -OrgContactId 參數指定聯絡 ID。

範例 3：擷取目錄中的所有聯絡物件

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

此範例會取得目錄中的所有聯絡人。

範例 4：在目錄中取回最頂端的兩個聯絡物件

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

此範例會取得目錄中最頂端的兩個聯絡人。 您可以使用 -Limit 作為 -Top的別名。

範例 5：透過 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

此範例取回具有指定顯示名稱的聯絡點。

範例 6：檢索有服務配置錯誤的聯絡人

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

此範例僅檢索有服務配置錯誤的聯絡人。

參數

-All

列出所有頁面。

參數屬性

類型:System.Management.Automation.SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Filter

指定 OData v4.0 濾波語句。 此參數控制回傳哪些物件。

參數屬性

類型:System.String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

GetQuery
Position:Named
必要:False
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-HasErrorsOnly

只回傳有服務配置錯誤的聯絡人。

參數屬性

類型:System.Management.Automation.SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-OrgContactId

指定 Microsoft Entra ID 中聯絡人的 ID。

參數屬性

類型:System.String
預設值:None
支援萬用字元:False
不要顯示:False
別名:ObjectId (物件識別碼)

參數集

GetById
Position:Named
必要:True
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Property

指定要回傳的屬性。

參數屬性

類型:

System.String[]

預設值:None
支援萬用字元:False
不要顯示:False
別名:選取

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Top

指定回傳的最大紀錄數量。

參數屬性

類型:System.Int32
預設值:None
支援萬用字元:False
不要顯示:False
別名:極限

參數集

GetQuery
Position:Named
必要:False
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。