Get-EXOMailbox

  • リファレンス
モジュール:
ExchangePowerShell
適用対象:
Exchange Online

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

Get-EXOMailbox コマンドレットを使用して、メールボックス オブジェクトと属性の表示、プロパティ ページの設定、または他のタスクへのメールボックス情報の提供を行います。

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

構文

Get-EXOMailbox
   [[-Identity] <String>]
   [-Archive]
   [-Async]
   [-ExternalDirectoryObjectId <Guid>]
   [-Filter <String>]
   [-GroupMailbox]
   [-InactiveMailboxOnly]
   [-IncludeInactiveMailbox]
   [-MailboxPlan <String>]
   [-Migration]
   [-OrganizationalUnit <String>]
   [-PrimarySmtpAddress <String>]
   [-Properties <String[]>]
   [-PropertySets <PropertySet[]>]
   [-PublicFolder]
   [-RecipientTypeDetails <String[]>]
   [-ResultSize <Unlimited>]
   [-SoftDeletedMailbox]
   [-UserPrincipalName <String>]
   [<CommonParameters>]
Get-EXOMailbox
   [-Anr <String>]
   [-Archive]
   [-Async]
   [-Filter <String>]
   [-GroupMailbox]
   [-InactiveMailboxOnly]
   [-IncludeInactiveMailbox]
   [-MailboxPlan <String>]
   [-Migration]
   [-OrganizationalUnit <String>]
   [-Properties <String[]>]
   [-PropertySets <PropertySet[]>]
   [-PublicFolder]
   [-RecipientTypeDetails <String[]>]
   [-ResultSize <Unlimited>]
   [-SoftDeletedMailbox]
   [<CommonParameters>]

説明

既定では、このコマンドレットは組織内のすべてのメールボックスの概要リスト (プロパティの最小セット) を返します。

例

例 1

Get-EXOMailbox -ResultSize unlimited

次の使用例は、組織内のすべてのメールボックスの概要リストを返し、既定の最小出力プロパティのセットを含みます。 追加のプロパティを返すには、Properties パラメーターまたは PropertySets パラメーターを使用します。

例 2

Get-EXOMailbox -PropertySets Archive

次の使用例は、Archive プロパティ セットで定義されているプロパティを返します。 これらのプロパティの完全な一覧については、「 Get-EXOMailbox プロパティ セット」を参照してください。

例 3

Get-EXOMailbox -Properties Name,DistinguishedName,Guid -PropertySets Archive,Audit

次の使用例は、組織内のすべてのメールボックスの概要リストを返し、次のプロパティを含みます。

  • Archive プロパティ セットと Audit プロパティ セットのプロパティ。
  • Name プロパティと DistinguishedName プロパティ。

例 4

Get-EXOMailbox -Identity John@contoso.com -Properties DisplayName,EmailAddresses,Alias

次の使用例は、メールボックスの指定したプロパティを返します 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

-Archive

[アーカイブ] スイッチは、アーカイブが有効になっているメールボックスによって結果をフィルター処理します (アーカイブ メールボックスを持つメールボックスのみが返されます)。 このスイッチで値を指定する必要はありません。

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

-Async

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

Type:SwitchParameter
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-EXOMailbox プロパティ セット と 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

-GroupMailbox

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

Type:SwitchParameter
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

-InactiveMailboxOnly

InactiveMailboxOnly スイッチは、結果に非アクティブなメールボックスのみを返すかどうかを指定します。 このスイッチで値を指定する必要はありません。

非アクティブなメールボックスとは、回復可能な方法で削除される前の訴訟ホールドまたはインプレース ホールド状態にあるメールボックスのことです。 非アクティブなメールボックスの内容は、ホールドが削除されるまで保持されます。

結果にアクティブなメールボックスと非アクティブなメールボックスの両方を返すには、このスイッチを使用しないでください。 代わりに、IncludeInactiveMailbox スイッチを使用します。

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

-IncludeInactiveMailbox

IncludeInactiveMailbox スイッチは、非アクティブなメールボックスを結果に含めるかどうかを指定します。 このスイッチで値を指定する必要はありません。

非アクティブなメールボックスとは、回復可能な方法で削除される前の訴訟ホールドまたはインプレース ホールド状態にあるメールボックスのことです。 非アクティブなメールボックスの内容は、ホールドが削除されるまで保持されます。

結果に非アクティブなメールボックスのみを返すには、このスイッチを使用しないでください。 代わりに、InactiveMailboxOnly スイッチを使用します。

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

-MailboxPlan

MailboxPlan パラメーターは、メールボックス プランによって結果をフィルター処理します。 このパラメーターを使用した場合は、指定されたメールボックス プランが割り当てられたメールボックスだけが結果で返されます。 メールボックス プランを一意に識別する任意の値を使用することができます。 次に例を示します。

  • 名前
  • Alias
  • 表示名
  • 識別名 (DN)
  • GUID

メールボックス プランは、クラウドベースの組織内のメールボックス ユーザーが使用可能なアクセス許可と機能を指定します。 使用可能なメールボックス プランは Get-MailboxPlan コマンドレットを使用して確認することができます。

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

-Migration

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

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-EXOMailbox プロパティ セット」を参照してください。

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

-PropertySets

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

  • すべて
  • 最小値 (既定値)
  • AddressList
  • アーカイブ
  • 監査
  • Custom
  • 配信
  • Hold
  • モデレート
  • Move
  • ポリシー
  • PublicFolder
  • Quota
  • リソース
  • 保持
  • SCL
  • SoftDelete
  • StatisticsSeed

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

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

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

-PublicFolder

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

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

-RecipientTypeDetails

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

  • DiscoveryMailbox
  • EquipmentMailbox
  • GroupMailbox
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox
  • RoomMailbox
  • SchedulingMailbox
  • SharedMailbox
  • TeamMailbox
  • UserMailbox

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

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

-SoftDeletedMailbox

結果で論理的に削除されたメールボックスを返すには、SoftDeletedMailbox スイッチが必要です。 このスイッチで値を指定する必要はありません。

回復可能な削除が行われたメールボックスとは、まだ回復できる削除済みメールボックスのことです。

Type:SwitchParameter
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

入力

Input types

Get-EXOMailbox では、次のGet-Mailbox パラメーターは使用できません。

  • Async
  • GroupMailbox
  • 移行
  • PublicFolder
  • SortBy

出力

Output types

Get-EXOMailbox の出力には、次のプロパティは含まれません。

  • RunspaceId
  • Servername
  • AdminDisplayVersion
  • DelayReleaseHoldApplied
  • EnforcedTimestamps
  • 説明
  • OriginatingServer
  • IsValid
  • ObjectState