Get-Recipient (RTM)

  • [アーティクル]

 

適用先: Exchange Server 2007

トピックの最終更新日: 2008-04-16

Active Directory ディレクトリ サービスから受信者オブジェクトの一覧を取得するには、Get-Recipient コマンドレットを使用します。

構文

get-Recipient [-Identity <RecipientIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

get-Recipient [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

get-Recipient [-Anr <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

解説

Get-Recipient コマンドレットは、指定した受信者の属性を取得します。必須パラメータはありません。パラメータを指定せずにこのコマンドレットを実行すると、組織の全受信者一覧が返されます。

Get-Recipient コマンドレットを実行するには、使用するアカウントに次の権限が委任されている必要があります。

  • Exchange 表示専用管理者の役割

Exchange Server 2007 を管理するために必要なアクセス許可、役割の委任、および権限の詳細については、「アクセス許可に関する考慮事項」を参照してください。

パラメータ

パラメータ 必須かどうか 種類 説明

Anr

省略可能

System.String

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

  • CommonName (CN)
  • DisplayName (displayName)
  • FirstName (givenName)
  • LastName (sn)
  • Alias (mailNickname)

Credential

省略可能

System.Management.Automation.PSCredential

Credential パラメータには、Active Directory へのアクセスに使用するユーザー名とパスワードを指定します。

Credential パラメータを使用した場合は、続行するためにアカウントのパスワードの入力を求められます。

DomainController

省略可能

Microsoft.Exchange.Data.Fqdn

この構成の変更を Active Directory に書き込むドメイン コントローラの完全修飾ドメイン名 (FQDN) を指定するには、コマンドに DomainController パラメータを含めます。

Filter

省略可能

System.String

クエリによって返される受信者を限定するために使用する属性を 1 つ以上指定する場合は、Filter パラメータを使用します。このパラメータは、Identity パラメータまたは Anr パラメータと組み合わせて使用することはできません。

フィルタ可能なプロパティの詳細については、「-Filter パラメータのフィルタ可能なプロパティ」を参照してください。

Identity

省略可能

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

Identity パラメータは、受信者を識別します。次のいずれかの値を使用できます。

  • GUID
  • ドメイン\アカウント
  • ユーザー プリンシパル名 (UPN)
  • LegacyExchangeDN
  • SMTP (簡易メール転送プロトコル) アドレス
  • 名前
  • エイリアス

OrganizationalUnit

省略可能

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

OrganizationalUnit パラメータには、組織単位 (OU) またはドメインの正規名を指定します。このパラメータは、結果を限定するために使用されます。このパラメータを使用すると、指定するコンテナに含まれる受信者のみが返されます。以下に例を示します。

  • OU: westcoast.contoso.com/users
  • ドメイン : westcoast.contoso.com

ReadFromDomainController

省略可能

System.Management.Automation.SwitchParameter

ReadFromDomainController パラメータには、ユーザー情報がユーザーのドメインのドメイン コントローラから読み取られることを指定します。フォレスト内のすべての受信者を含めるように受信者の範囲を設定した場合、このパラメータを使用しないと、情報が古いグローバル カタログからユーザー情報が読み取られる可能性があります。このパラメータを使用する場合は、情報を取得するために読み取りが数回必要になる場合があります。

note注 :
既定では、受信者の範囲は、Exchange サーバーをホストするドメインに設定されています。

RecipientType

省略可能

Microsoft.Exchange.Data.Directory.Recipient.RecipientType[]

RecipientType パラメータは、アドレス一覧に含める受信者の種類を指定するためのフィルタです。以下の種類から 1 つ以上を使用できます。

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

RecipientTypeDetails

省略可能

Microsoft.Exchange.Data.Directory.Recipient.RecipientTypeDetails[]

RecipientTypeDetails パラメータには、返される受信者の種類を指定します。Microsoft Exchange Server 2007 の受信者の種類は、受信者の種類とサブタイプに分かれています。各受信者の種類には、すべてのサブタイプに共通するすべてのプロパティが含まれています。たとえば、UserMailbox は、関連付けられたメールボックスを持つ Active Directory のユーザー アカウントを表します。メールボックスには種類が複数あるため、各メールボックスの種類は RecipientTypeDetails パラメータによって識別されます。たとえば、会議室メールボックスは RecipientTypeDetails が ConferenceRoomMailbox に設定され、ユーザー メールボックスは RecipientTypeDetails が UserMailbox に設定されます。

このコマンドで使用できる受信者の種類の詳細を次に示します。

  • ConferenceRoomMailbox
  • EquipmentMailbox
  • LegacyMailbox
  • LinkedMailbox
  • UserMailbox
  • MailContact
  • DynamicDistributionGroup
  • MailForestContact
  • MailNonUniversalGroup
  • MailUniversalDistributionGroup
  • MailUniversalSecurityGroup
  • MailUser
  • PublicFolder
  • SharedMailbox

ResultSize

省略可能

Microsoft.Exchange.Data.Unlimited

ResultSize パラメータには、返される結果の最大件数を指定します。フィルタに一致するすべての受信者を取得するには、このパラメータの値として "unlimited" を使用します。既定値は 1,000 です。

SortBy

省略可能

System.String

SortBy パラメータには、結果の並べ替えに使用する属性を指定します。並べ替えることができるのは、一度に 1 つの属性のみです。次の属性で並べ替えることができます。

  • Alias
  • DisplayName
  • Name

結果は昇順で並べ替えられます。

入力の種類

戻り値の種類

エラー

エラー 説明

   

 

例外

例外 説明

  

 

例

最初の例は、組織内のすべての受信者についての情報を取得する方法を示しています。

2 番目の例は、組織内のすべての受信者についての情報を取得し、名前で並べ替える方法を示しています。

Get-Recipient -ResultSize unlimited
Get-Recipient -RecipientType DynamicDistributionGroup -SortBy Name

参照している情報が最新であることを確認したり、他の Exchange Server 2007 ドキュメントを見つけたりするには、Exchange Server TechCenter を参照してください。