Get-DistributionGroup
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。
Get-DistributionGroup コマンドレットは、既存の配布グループ、またはメールが有効なセキュリティ グループを確認するために使用します。 グループのメンバーを表示するには、Get-DistributionGroupMember コマンドレットを使用します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Get-DistributionGroup
[-Anr <String>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>] Get-DistributionGroup
[[-Identity] <DistributionGroupIdParameter>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>] Get-DistributionGroup
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-ManagedBy <GeneralRecipientIdParameter>]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>] 説明
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Get-DistributionGroupこの例では、組織内のすべての配布グループとメールが有効なセキュリティ グループの要約リストを返します。
例 2
Get-DistributionGroup -Identity "Marketing Reports" | Format-Listこの例では、Marketing Reports という名前の配布グループに関する詳細情報を返します。
例 3
Get-DistributionGroup -Anr marketing | Format-Table Name, ManagedBy -Autoこの例では、名前に文字列 "marketing" が含まれるすべての配布グループとメールが有効なセキュリティ グループを返して、グループ所有者を表示します。
パラメーター
-Anr
Anr パラメーターには、あいまいな名前を解決 (ANR) するための検索を実行する際に使用する文字列を指定します。 部分的な文字列を指定して、その文字列に一致する属性を持つオブジェクトを検索することができます。 既定で検索対象となっているのは、以下の属性です。
- CommonName (CN)
- DisplayName
- FirstName
- LastName
- Alias
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-Credential
Credential パラメーターは、このコマンドの実行に使用されるユーザー名とパスワードを指定します。 通常、このパラメーターはスクリプトや、必要なアクセス許可を持つ別の資格情報を入力する必要がある場合に使用します。
このパラメーターの値には、Get-Credential コマンドレットが必要です。 このコマンドを一時停止し、資格情報の入力を求めるメッセージを表示するには、値(Get-Credential)を使用します。 または、このコマンドを実行する前に、資格情報を変数 (たとえば、$cred = Get-Credential) に保存し、このパラメーターに変数名 ($cred) を使用します。 詳細については、Get-Credentialに関するページをご覧ください。
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-DomainController
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Filter
Filter パラメーターは、OPATH 構文を使用して、指定したプロパティと値で結果をフィルター処理します。 検索条件は構文"Property -ComparisonOperator 'Value'"を使用します。
- OPATH フィルター全体を二重引用符 " " で囲みます。 フィルターにシステム値 (例えば、
$true、$false、または$null) が含まれている場合は、代わりに単一引用符 ' ' を使用します。 このパラメーターは文字列 (システム ブロックではありません) ですが、波かっこ { } を使用することもできますが、これはフィルターに変数が含まれていない場合のみです。 - Property はフィルタリング可能なプロパティです。 フィルター可能なプロパティの詳細については、「Filter パラメーターのフィルター可能なプロパティ」を参照してください。
- ComparisonOperator は OPATH 比較演算子です (たとえば
-eq、等しい場合や-like文字列比較の場合)。 比較演算子の詳細については、「about_Comparison_Operators」を参照してください。 - Value は、検索するプロパティ値です。 テキスト値と変数を一重引用符 (
'Value'または'$Variable') で囲みます。 変数値に一重引用符が含まれている場合、変数を正しく展開するには、一重引用符を識別する (エスケープする) 必要があります。 たとえば、'$User'の代わりに'$($User -Replace "'","''")'を使用します。 整数またはシステム値を引用符で囲まないでください (代わりに、500、$true、$falseなど$null)。
論理演算子 -and および -or を使用すると、複数の検索条件を連結することができます。 たとえば、"Criteria1 -and Criteria2" または "(Criteria1 -and Criteria2) -or Criteria3" です。
Exchange の OPATH フィルターの詳細については、「 その他の OPATH 構文情報」を参照してください。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-Identity
Identity パラメーターは、表示する配布グループまたはメールが有効なセキュリティ グループを指定します。 グループを一意に識別する任意の値を使用できます。 例:
- 名前
- Alias
- 識別名 (DN)
- 正規 DN
- 電子メール アドレス
- GUID
| Type: | DistributionGroupIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-IgnoreDefaultScope
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
IgnoreDefaultScope スイッチは、Exchange PowerShell セッションに対する受信者の範囲の既定の設定を無視し、フォレスト全体を範囲として使用するようにコマンドに指示します。 このスイッチで値を指定する必要はありません。
このスイッチを使用すると、コマンドは、既定の範囲では現在使用できない Active Directory オブジェクトにアクセスできますが、次の制限もあります。
- DomainController パラメーターは使用できません。 このコマンドは、適切なグローバル カタログ サーバーを自動的に使用します。
- Identity パラメーターの DN しか使用できません。 エイリアスや GUID などの他の形式の ID は使用できません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-ManagedBy
ManagedBy パラメーターは、グループの所有者によって結果をフィルター処理します。 所有者を一意に識別する、任意の値を使用できます。 以下に例を示します。
- 名前
- Alias
- 識別名 (DN)
- 正規 DN
- 電子メール アドレス
- GUID
| Type: | GeneralRecipientIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-OrganizationalUnit
OrganizationalUnit パラメーターは、Active Directory 内のオブジェクトの場所に基づいて結果をフィルタリングします。 指定された場所に存在するオブジェクトのみが返されます。 このパラメーターの有効な入力値は、Get-OrganizationalUnit コマンドレットによって返される組織単位 (OU) またはドメインです。 OU またはドメインを一意に識別する、任意の値を使用できます。 以下に例を示します。
- 名前
- 識別名 (DN)
- 識別名 (DN)
- GUID
| Type: | OrganizationalUnitIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-ReadFromDomainController
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
ReadFromDomainController スイッチは、情報がユーザーのドメインのドメイン コントローラーから読み取られることを指定します。 このスイッチで値を指定する必要はありません。
コマンド: Set-AdServerSettings -ViewEntireForest $true フォレスト内のすべてのオブジェクトを含めるには、ReadFromDomainController スイッチが必要です。 それ以外の場合、コマンドは、古い情報を含むグローバル カタログを使用する可能性があります。 また、情報を取得するには、ReadFromDomainController スイッチを使用してコマンドの繰り返しを複数回実行する必要がある場合があります。
既定では、受信者の範囲は、Exchange サーバーをホストするドメインに設定されています。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-RecipientTypeDetails
RecipientTypeDetails パラメーターは、指定された配布グループ サブタイプによって結果をフィルター処理します。 有効な値は次のとおりです。
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- RoomList
複数の値をコンマで区切って指定できます。
| Type: | RecipientTypeDetails[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-ResultSize
ResultSize パラメーターは、返される結果の最大数を指定します。 クエリに一致するすべてのリクエストを返す場合は、このパラメーターの値に unlimited を使用します。 既定値は 1,000 です。
| Type: | Unlimited |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-SortBy
SortBy パラメーターは、結果を並べ替えるためのプロパティを指定します。 並べ替えの基準にできるのは、一度に 1 つのプロパティのみです。 結果は昇順で並べ替えられます。
既定のビューに並べ替えるプロパティが含まれていない場合は、 コマンドを で | Format-Table -Auto Property1,Property2,...PropertyX追加できます。 をクリックして、表示するすべてのプロパティを含む新しいビューを作成します。 プロパティ名にはワイルドカード (*) がサポートされています。
以下のプロパティで並べ替えることができます。
- 名前
- DisplayName
- Alias
- 都市
- FirstName
- LastName
- Office
- ServerLegacyDN
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。