注:
この記事で説明されている機能は現在プレビュー段階であり、すべての組織で利用できるわけではありません。変更される可能性があります。
Exchange Online 管理 API の DynamicDistributionGroupMember エンドポイントは、指定された動的配布グループのメンバーを取得します。 エンドポイントは、グループ メンバーシップと関連するディレクトリ情報を表す受信者オブジェクトのコレクションを返します。
一般的なユース ケースは次のとおりです。
- 動的配布グループのメンバーシップの拡張。
- 個々のグループ メンバーの詳細をフェッチする。
注:
このエンドポイントの応答には、アドレス一覧から非表示になっているメンバーが含まれます。
Exchange Online 管理 API は、従来の Exchange Web Services (EWS) シナリオを置き換えて、特定の PowerShell コマンドレットを実行するための REST ベースの方法を提供します。 詳細については、「Exchange Online 管理 API の概要」を参照してください。
エンドポイント URL
POST https://outlook.office365.com/adminapi/v2.0/<TenantID>/DynamicDistributionGroupMember
ヒント
「サポートされている環境と基本 URL」の説明に従って 、環境のベース URL を使用します。
要求モデル
ヘッダー
Authorization: Bearer <auth token>
Content-Type: application/json
X-AnchorMailbox: <routing hint>
X-AnchorMailbox の値については、「X-AnchorMailbox ルーティング ヒント」を参照してください。
Body
{
"CmdletInput": {
"CmdletName": "Get-DynamicDistributionGroupMember",
"Parameters": {
"Identity": "<dynamic distribution group email address>", // required
"ResultSize": <Integer | "Unlimited"> // optional (pagination)
}
}
}
改ページ
ResultSize パラメーターは改ページ位置を制御します。 既定では、最大 1,000 件の結果が返されます。
より多くの結果が使用可能な場合、応答には継続 URL を持つ @odata.nextLink プロパティが含まれます。 次のページをフェッチするには、同じ本文で @odata.nextLink の URL に新しい POST 要求を発行します。
プロパティの選択
このエンドポイントは、応答内の特定のプロパティのみを返すために、 $select クエリ パラメーターをサポートします。 以下に例を示します。
POST https://outlook.office365.com/adminapi/v2.0/<TenantID>/DynamicDistributionGroupMember?$select=DisplayName,PrimarySmtpAddress
サポートされているコマンドレットとパラメーター
このエンドポイントでサポートされているコマンドレットは Get-DynamicDistributionGroupMember です。 このエンドポイントの本文内の他のコマンドレットでは、エラーが発生します。
REST エンドポイントでは、次の表で説明されているパラメーターのみを使用できます。
| パラメーター | 必須 | 型 | 説明 |
|---|---|---|---|
| Identity | 必須 | 文字列 | メンバーシップ情報を取得する動的配布グループを指定します。 有効な値は、グループ名、電子メール アドレス、または GUID です。 ResultSize の対象となるコマンドレットは、非表示の受信者を含むすべてのグループ メンバーを返します。 |
| ResultSize | 省略可能 | 整数または無制限 | 返される結果の数を制限します。 有効な値は、整数 (10 など) または "Unlimited"値です。 |
応答の概要
注:
プレビュー中に、エンドポイントには、API 応答に Get-DynamicDistributionGroupMember コマンドレットの完全な出力が含まれます。 パブリック リリースへの移行中、応答は、このセクションに記載されているコア プロパティ (EWS と同等のシナリオに必要なプロパティ) に制限されます。 このセクションに記載されているプロパティのみを使用することをお勧めします。 使用可能なプロパティに対する変更を文書化します。
応答は、グループ メンバーの JSON 配列です。 各受信者オブジェクトには、詳細とメタデータ情報が含まれています。 次のプロパティが取得されます。
- ID: 受信者の正規 ID (管理操作に使用されます)。
- エイリアス: メール エイリアス (該当する場合)。
- EmailAddresses: 受信者のすべてのプロキシ アドレス (SMTP: と smtp: エントリを含む)。
- PrimarySmtpAddress: 受信者のプライマリ SMTP アドレス ( EmailAddresses の SMTP: 値に対応)。
- DisplayName: 受信者の表示名。
- FirstName
- LastName
- 名前: Exchange の表示名 (多くの場合、DisplayName を反映します)。
- RecipientType: 使用可能な値については、「 RecipientType」を参照してください。
- RecipientTypeDetails: 使用可能な値については、「 RecipientTypeDetails」を参照してください。
- HiddenFromAddressListsEnabled: 動的配布グループのメンバーシップから非表示になっている受信者です。
例
例 1: 動的配布グループのすべてのメンバーを取得します。
次の使用例は、 ResultSize パラメーターを使用していないため、指定した動的配布グループの最大 1,000 人のメンバーを取得します。
POST /adminapi/v2.0/<TenantID>/DynamicDistributionGroupMember HTTP/1.1 Host: outlook.office365.com Authorization: Bearer <auth token> Content-Type: application/json X-AnchorMailbox: <Routing Hint> { "CmdletInput": { "CmdletName": "Get-DynamicDistributionGroupMember", "Parameters": { "Identity": "sales@contoso.com" } } }例 2: ResultSize を使用して結果を制限する:
次の使用例は、 ResultSize パラメーターを値 10 に設定して、指定した動的配布グループの 10 メンバーに結果を制限します。
POST /adminapi/v2.0/<TenantID>/DynamicDistributionGroupMember HTTP/1.1 Host: outlook.office365.com Authorization: Bearer <auth token> Content-Type: application/json X-AnchorMailbox: <Routing Hint>> { "CmdletInput": { "CmdletName": "Get-DynamicDistributionGroupMember", "Parameters": { "Identity": "sales@contoso.com", "ResultSize": 10 } } }