次の方法で共有


Get-Recipient

このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。

Get-Recipient コマンドレットを使用して、組織内の既存の受信者オブジェクトを表示します。 このコマンドレットは、メールが有効なすべてのオブジェクト (メールボックス、メール ユーザー、メール連絡先、配布グループなど) を返します。

: PowerShell Exchange Onlineでは、このコマンドレットの代わりに Get-EXORecipient コマンドレットを使用することをお勧めします。 詳細については、「Exchange Online PowerShell への接続」を参照してください。

クラウド環境では、Microsoft 365 グループを返すには、RecipientTypeDetails パラメーターと GroupMailbox の値を使用する必要があります。

以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。

構文

Get-Recipient
   [-Anr <String>]
   [-AuthenticationType <AuthenticationType>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-Capabilities <MultiValuedProperty>]
   [-Database <DatabaseIdParameter>]
   [-Properties <String[]>]
   [-IncludeSoftDeletedRecipients]
   [<CommonParameters>]
Get-Recipient
   [[-Identity] <RecipientIdParameter>]
   [-AuthenticationType <AuthenticationType>]
   [-BookmarkDisplayName <String>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-IncludeBookmarkObject <Boolean>]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-Capabilities <MultiValuedProperty>]
   [-Properties <String[]>]
   [-IncludeSoftDeletedRecipients]
   [<CommonParameters>]
Get-Recipient
   [-Database <DatabaseIdParameter>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-Properties <String[]>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-IncludeSoftDeletedRecipients] [<CommonParameters>]
   [<CommonParameters>]
Get-Recipient
   [-RecipientPreviewFilter <String>]
   [-AuthenticationType <AuthenticationType>]
   [-Capabilities <MultiValuedProperty>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-IncludeSoftDeletedRecipients]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-Properties <String[]>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [<CommonParameters>]

説明

Get-Recipient コマンドレットは、受信者のオブジェクト固有のプロパティすべてを返さない場合があります。 受信者のオブジェクト固有のプロパティを表示するには、オブジェクト タイプに基づいて、対応するコマンドレットを使用する必要があります (例: Get-Mailbox、Get-MailUser、Get-DistributionGroup など)。

このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。

例 1

Get-Recipient -ResultSize unlimited

この例では、組織内のすべての受信者の要約リストとして取得します。

例 2

Get-Recipient -Identity "Marketing Department" | Format-List

次の使用例は、マーケティング部門という名前の受信者の詳細情報を返します。

例 3

Get-Recipient -RecipientType MailContact -SortBy Office | Format-Table -Auto Office,Name

この例は、組織内のすべてのメール連絡先に関する情報を取得し、事業所を基準として並べ替えます。

パラメーター

-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, Security & Compliance, Exchange Online Protection

-AuthenticationType

このパラメーターは、クラウドベースのサービスでのみ使用できます。

AuthenticationType パラメーターには、受信者を認証の種類別に指定します。 次のいずれかの値を使用します。

  • フェデレーション
  • 管理対象
Type:AuthenticationType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online, Security & Compliance, Exchange Online Protection

-BookmarkDisplayName

このパラメーターは、Microsoft の内部使用のために予約されています。

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, Security & Compliance, Exchange Online Protection

-Capabilities

このパラメーターは、クラウドベースのサービスでのみ使用できます。

このパラメーターは、Microsoft の内部使用のために予約されています。

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online, Security & Compliance, Exchange Online Protection

-Credential

このパラメーターは、オンプレミスの Exchange でのみ使用できます。

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

-Database

このパラメーターは、オンプレミスの Exchange でのみ使用できます。

Database パラメーターは、指定したメールボックス データベースに格納されているすべての受信者を返します。 データベースを一意に識別する、任意の値を使用できます。 以下に例を示します。

  • 名前
  • 識別名 (DN)
  • GUID
Type:DatabaseIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-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 はフィルタリング可能なプロパティです。 Exchange サーバーとExchange Onlineのフィルター可能なプロパティの詳細については、「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, Security & Compliance, Exchange Online Protection

-Identity

Identity パラメーターは、表示する受信者オブジェクトを指定します。 受信者を一意に識別する任意の値を使用できます。 たとえば、次の値を使用できます。

  • 名前
  • Alias
  • 識別名 (DN)
  • 正規 DN
  • 電子メール アドレス
  • GUID
Type:RecipientIdParameter
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, Security & Compliance, 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

-IncludeBookmarkObject

このパラメーターは、Microsoft の内部使用のために予約されています。

Type:Boolean
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, Security & Compliance, Exchange Online Protection

-IncludeSoftDeletedRecipients

IncludeSoftDeletedRecipients スイッチは、論理的に削除された受信者を結果に含めるかどうかを指定します。 このスイッチで値を指定する必要はありません。

論理的に削除された受信者とは、削除されたものの、回復可能な受信者のことです。

: このスイッチを Identity パラメーターまたは RecipientTypeDetails パラメーターと共に使用して、SoftDeletedRecipients を取得します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to: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

-Properties

このパラメーターは、Microsoft の内部使用のために予約されています。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-PropertySet

このパラメーターは、Microsoft の内部使用のために予約されています。

Type:PropertySet
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, Security & Compliance, 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

-RecipientPreviewFilter

RecipientPreviewFilter パラメーターは、動的配布グループ、アドレス一覧、または電子メール アドレス ポリシーで使用する受信者フィルターをテストします。 このパラメーターは、LDAP フィルター構文を使用します。

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, Security & Compliance, Exchange Online Protection

-RecipientType

RecipientType パラメーターは、指定した受信者の種類で結果をフィルター処理します。 有効な値は次のとおりです。

  • DynamicDistributionGroup
  • MailContact
  • MailNonUniversalGroup
  • MailUniversalDistributionGroup
  • MailUniversalSecurityGroup
  • MailUser
  • PublicFolder
  • UserMailbox

複数の値をコンマで区切って指定できます。

Type:RecipientType[]
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, Security & Compliance, Exchange Online Protection

-RecipientTypeDetails

RecipientTypeDetails パラメーターは、指定された受信者サブタイプによって結果をフィルター処理します。 有効な値は次のとおりです。

  • DiscoveryMailbox
  • DynamicDistributionGroup
  • EquipmentMailbox
  • GroupMailbox (Exchange 2013 以降およびクラウド)
  • GuestMailUser (Exchange 2016 以降およびクラウド)
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox (Exchange 2013 以降およびクラウド)
  • MailContact
  • MailForestContact
  • MailNonUniversalGroup
  • MailUniversalDistributionGroup
  • MailUniversalSecurityGroup
  • MailUser
  • PublicFolder
  • PublicFolderMailbox (Exchange 2013 以降およびクラウド)
  • RemoteEquipmentMailbox
  • RemoteRoomMailbox
  • RemoteSharedMailbox
  • RemoteTeamMailbox (Exchange 2013 以降およびクラウド)
  • RemoteUserMailbox
  • RoomList
  • RoomMailbox
  • SchedulingMailbox (Exchange 2016 以降およびクラウド)
  • SharedMailbox
  • SharedWithMailUser (クラウドのみ)
  • TeamMailbox (Exchange 2013 以降とクラウド)
  • UserMailbox

複数の値をコンマで区切って指定できます。

RecipientType パラメーターの値は、このパラメーターに使用できる値に影響します。 たとえば、RecipientType の値として MailContact を使用する場合、このパラメーターに値 UserMailbox は使用できません。 エラー: None of the specified RecipientTypeDetails are included in any specified recipient type が表示されます。

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, Security & Compliance, 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, Security & Compliance, 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, Security & Compliance, Exchange Online Protection

入力

Input types

このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。

出力

Output types

このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。