Get-EXORecipient

リファレンス

モジュール:: ExchangePowerShell

適用対象:: Exchange Online

このコマンドレットは、Exchange Online PowerShell モジュールでのみ使用できます。詳細については、「Exchange Online PowerShell モジュールについて」を参照してください。

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

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

構文

Get-EXORecipient
   [[-Identity] <String>]
   [-ExternalDirectoryObjectId <Guid>]
   [-Filter <String>]
   [-IncludeSoftDeletedRecipients]
   [-OrganizationalUnit <String>]
   [-PrimarySmtpAddress <String>]
   [-Properties <String[]>]
   [-PropertySets <PropertySet[]>]
   [-RecipientPreviewFilter <String>]
   [-RecipientType <String[]>]
   [-RecipientTypeDetails <String[]>]
   [-ResultSize <Unlimited>]
   [-UserPrincipalName <String>]
   [<CommonParameters>]

Get-EXORecipient
   [-Anr <String>]
   [-Filter <String>]
   [-IncludeSoftDeletedRecipients]
   [-OrganizationalUnit <String>]
   [-Properties <String[]>]
   [-PropertySets <PropertySet[]>]
   [-RecipientPreviewFilter <String>]
   [-RecipientType <String[]>]
   [-RecipientTypeDetails <String[]>]
   [-ResultSize <Unlimited>]
   [<CommonParameters>]

説明

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

例

例 1

Get-EXORecipient -ResultSize 100

次の使用例は、名前の並べ替えられた順序で最初の 100 個の受信者オブジェクトを返します。

例 2

Get-EXORecipient -Identity john@contosot.com

この例では、ユーザーの受信者属性の詳細を返します john@contoso.com

パラメーター

-Anr

Anr パラメーターには、あいまいな名前を解決 (ANR) するための検索を実行する際に使用する文字列を指定します。部分的な文字列を指定して、その文字列に一致する属性を持つオブジェクトを検索することができます。既定で検索対象となっているのは、以下の属性です。

CommonName (CN)
DisplayName
FirstName
LastName
Alias

このパラメーターは、ExternalDirectoryObjectId、Identity、PrimarySmtpAddress、または UserPrincipalName パラメーターでは使用できません。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-ExternalDirectoryObjectId

ExternalDirectoryObjectId パラメーターは、Azure Active Directory の ObjectId によって表示する受信者を識別します。

このパラメーターは、Anr、Identity、PrimarySmtpAddress、または UserPrincipalName パラメーターでは使用できません。

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Online

-Filter

Filter パラメーターは、OPATH 構文を使用して、指定したプロパティと値で結果をフィルター処理します。検索条件は構文"Property -ComparisonOperator 'Value'"を使用します。

OPATH フィルター全体を二重引用符 " " で囲みます。フィルターにシステム値 (例えば、$true、$false、または $null) が含まれている場合は、代わりに単一引用符 ' ' を使用します。このパラメーターは文字列 (システムブロックではありません) ですが、波かっこ { } を使用することもできますが、これはフィルターに変数が含まれていない場合のみです。
Property はフィルタリング可能なプロパティです。フィルター可能なプロパティの詳細については、Filter パラメーターの Get-EXORecipient プロパティセットと Filterable プロパティに関するページを参照してください。
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 Online

-Identity

Identity パラメーターは、表示する受信者オブジェクトを指定します。最適なパフォーマンスを得るには、次の値を使用して受信者を識別することをお勧めします。

ユーザー ID またはユーザープリンシパル名 (UPN)
GUID

それ以外の場合は、受信者を一意に識別する任意の値を使用できます。例:

名前
Alias
識別名 (DN)
Domain\Username
電子メールアドレス
LegacyExchangeDN
SamAccountName

このパラメーターは、Anr、ExternalDirectoryObjectId、PrimarySmtpAddress、または UserPrincipalName パラメーターでは使用できません。

Type:	String
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Online

-IncludeSoftDeletedRecipients

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

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-OrganizationalUnit

OrganizationalUnit パラメーターは、Active Directory 内のオブジェクトの場所に基づいて結果をフィルタリングします。指定された場所に存在するオブジェクトのみが返されます。このパラメーターの有効な入力値は、Get-OrganizationalUnit コマンドレットを使用して表示される組織単位 (OU) またはドメインです。 OU またはドメインを一意に識別する、任意の値を使用できます。以下に例を示します。

名前
識別名 (DN)
識別名 (DN)
GUID

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-PrimarySmtpAddress

PrimarySmtpAddress は、プライマリ SMTP メールアドレス (など navin@contoso.com) で表示する受信者を識別します。

このパラメーターは、Anr、ExternalDirectoryObjectId、Identity、または UserPrincipalName パラメーターでは使用できません。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Online

-Properties

Properties パラメーターは、このコマンドレットの出力で返されるプロパティを指定します。複数の値をコンマで区切って指定できます。

使用可能なプロパティの詳細については、「 Get-EXORecipient プロパティセット」を参照してください。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-PropertySets

PropertySets パラメーターは、このコマンドレットの出力で返されるプロパティの論理グループを指定します。有効な値は次のとおりです。

最小値 (既定値)
アーカイブ
Custom
MailboxMove
ポリシー

各プロパティセットに含まれるプロパティの詳細については、「 Get-EXORecipient プロパティセット」を参照してください。

Type:	PropertySet[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-RecipientPreviewFilter

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-RecipientType

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

DynamicDistributionGroup
MailContact
MailNonUniversalGroup
MailUniversalDistributionGroup
MailUniversalSecurityGroup
MailUser
PublicFolder
UserMailbox

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-RecipientTypeDetails

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

DiscoveryMailbox
DynamicDistributionGroup
EquipmentMailbox
GroupMailbox
GuestMailUser
LegacyMailbox
LinkedMailbox
LinkedRoomMailbox
MailContact
MailForestContact
MailNonUniversalGroup
MailUniversalDistributionGroup
MailUniversalSecurityGroup
MailUser
PublicFolder
PublicFolderMailbox
RemoteEquipmentMailbox
RemoteRoomMailbox
RemoteSharedMailbox
RemoteTeamMailbox
RemoteUserMailbox
RoomList
RoomMailbox
SchedulingMailbox
SharedMailbox
SharedWithMailUser
TeamMailbox
UserMailbox

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

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-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 Online

-UserPrincipalName

UserPrincipalName パラメーターは、 navin@contoso.onmicrosoft.comUPN で表示する受信者を識別します (例: )。

Anr、ExternalDirectoryObjectId、Identity、PrimarySmtpAddress パラメーターでは、このパラメーターを使用できません。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Online