注意事項
本文所述的功能目前處於預覽階段，並非所有組織都能提供，且可能會有所變動。
Exchange Online 管理員 API 中的 DistributionGroupMember 端點會取得指定的分發群組成員。 端點會回傳一組代表群組成員及相關目錄資訊的接收物件集合。
典型的使用情境包括：
- 擴充郵件分發清單以進行郵件路由。
- 展開房間列表以顯示所有成員的列表。
注意事項
此端點的回應包含了隱藏於地址清單中的成員。
Exchange Online 管理員 API 提供基於 REST 的方式來執行特定的 PowerShell 指令集，取代舊有的 Exchange Web Services (EWS) 情境。 欲了解更多資訊，請參閱 Exchange Online 管理員 API 概述。
端點網址
POST https://outlook.office365.com/adminapi/v2.0/<TenantID>/DistributionGroupMember
提示
請依照 支援環境和基礎網址描述，使用你環境的基礎網址。
請求模型
標頭
Authorization: Bearer <auth token>
Content-Type: application/json
X-AnchorMailbox: <routing hint>
關於 X-AnchorMailbox 的值，請參見 X-AnchorMailbox 路由提示。
內文
{
"CmdletInput": {
"CmdletName": "Get-DistributionGroupMember",
"Parameters": {
"Identity": "<distribution group identity>", // required
"ResultSize": <Integer | "Unlimited"> // optional (pagination)
}
}
}
Pagination
ResultSize 參數控制分頁。 預設情況下，最多可回傳 1,000 筆結果。
若有更多結果，回應會包含 @odata.nextLink 帶有延續網址的屬性。 要取得下一頁，向包含相同主體的 URL @odata.nextLink 發出新的 POST 請求。
物業選擇
此端點支援 $select 查詢參數，僅回傳回應中的特定屬性。 例如：
POST https://outlook.office365.com/adminapi/v2.0/<TenantID>/DistributionGroupMember?$select=DisplayName,PrimarySmtpAddress
支援的指令集與參數
此端點支援的 cmdlet 為 Get-DistributionGroupMember。 若該端點主體中有任何其他指令檔，則會導致錯誤。
只有下表描述的參數可透過 REST 端點取得：
| 參數 | 必要項目 | 類型 | 描述 |
|---|---|---|---|
| [身分識別] | 必要 | 字串 | 指定以取得成員資訊的分發群組。 有效的數值包括群組名稱、電子郵件地址或 GUID。 受 ResultSize 限制後，指令小程式會回傳所有群組成員，包括隱藏的接收者。 |
| 結果大小 | 選用 | 整數還是無限 | 限制回傳的結果數量。 有效的值為整數 (，例如10) 或值 "Unlimited"。 |
回應概述
注意事項
在預覽階段，端點會將完整的 Get-DistributionGroupMember 指令碼輸出納入 API 回應中。 在轉為公開釋放期間，回應將限於本節列出的核心物業 (符合EWS等效情境) 所需的物業。 我們建議您僅使用本節列出的物業。 我們會記錄任何可用物業的變更。
回應是一個由群組成員組成的 JSON 陣列。 每個接收物件都包含詳細資訊與元資料資訊。 會傳回下列屬性：
- 身份：用於管理營運) 的接收者 (標準身份。
- 別名：如適用，郵寄別名 () 。
- 電子郵件地址：收件人所有代理地址 (包括 SMTP： 和 smtp： 條目) 。
- PrimarySmtpAddress：收件人的主要 SMTP 位址 (對應於 EmailAddresses) 中的 SMTP： 值。
- 顯示名稱：收件人顯示名稱。
- FirstName
- LastName
- 名稱：交換顯示名稱 (經常會像顯示名稱) 。
- RecipientType：關於可能的值，請參見 RecipientType。
- RecipientTypeDetails：關於可能的值，請參見 RecipientTypeDetails。
- HiddenFromAddressListsEnabled：收件人是否被分發群組成員隱藏。
範例
範例 1：取得分配群的所有成員：
這個範例最多可取得指定分布群組的 1,000 個成員，因為我們沒有使用 ResultSize 參數。
POST /adminapi/v2.0/<TenantID>/DistributionGroupMember HTTP/1.1 Host: outlook.office365.com Authorization: Bearer <auth token> Content-Type: application/json X-AnchorMailbox: <Routing Hint> { "CmdletInput": { "CmdletName": "Get-DistributionGroupMember", "Parameters": { "Identity": "marketing@contoso.com" } } }範例 2：使用 ResultSize 限制結果：
此範例透過將 ResultSize 參數設為 10，限制結果為指定分布群組的 10 個成員。
POST /adminapi/v2.0/<TenantID>/DistributionGroupMember HTTP/1.1 Host: outlook.office365.com Authorization: Bearer <auth token> Content-Type: application/json X-AnchorMailbox: <Routing Hint>> { "CmdletInput": { "CmdletName": "Get-DistributionGroupMember", "Parameters": { "Identity": "marketing@contoso.com", "ResultSize": 10 } } }