Get-CASMailbox

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

メールボックス上で構成されたクライアント アクセス設定を確認するために Get-CASMailbox コマンドレットを使用します。

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

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

構文

Get-CASMailbox
   [-Anr <String>]
   [-ActiveSyncDebugLogging]
   [-ActiveSyncSuppressReadReceipt]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-Monitoring]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-ProtocolSettings]
   [-ReadFromDomainController]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-ReadIsOptimizedForAccessibility]
   [-RecalculateHasActiveSyncDevicePartnership]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [<CommonParameters>]
Get-CASMailbox
   [[-Identity] <MailboxIdParameter>]
   [-ActiveSyncDebugLogging]
   [-ActiveSyncSuppressReadReceipt]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-Monitoring]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-ProtocolSettings]
   [-ReadFromDomainController]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-ReadIsOptimizedForAccessibility]
   [-RecalculateHasActiveSyncDevicePartnership]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [<CommonParameters>]

説明

このコマンドレットは、1 つ以上のメールボックスのさまざまなクライアント アクセス設定を返します。 これらの設定には、ユーザー、Outlook on the web、POP3、IMAP4 Exchange ActiveSyncオプションが含まれます。

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

例 1

Get-CASMailbox "Jeff Hay"

次の例は、Jeff Hay というユーザーの以下のクライアント アクセス設定値を返します。

  • ActiveSyncEnabled
  • OWAEnabled
  • PopEnabled
  • ImapEnabled
  • MapiEnabled

例 2

Get-CASMailbox tony@contoso.com | Format-List Imap*

次の例は、tony@contoso.com ユーザーのすべての IMAP4 設定を返します。

例 3

Get-CASMailbox chris@contoso.com | Format-List Ews*

次の使用例は、Exchangeの Web サービス設定を返 chris@contoso.com。

例 4

Get-CASMailbox -RecipientTypeDetails SharedMailbox | Select *

このExchange Onlineでは、共有メールボックスのみを含めるコマンドレット出力をフィルター処理します。

パラメーター

-ActiveSyncDebugLogging

ActiveSyncDebugLogging スイッチは、メールボックスの ActiveSyncDebugLogging プロパティの実際の値を表示します。このスイッチを使用しないと、値は常に $false として表示されます。

この値を表示するには、書式設定コマンドレットを使用する必要があります。たとえば、Get-CasMailbox laura@contoso.com -ActiveSyncDebugLogging | Format-List などです。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-ActiveSyncSuppressReadReceipt

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Exchange Online
-Anr

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

  • CommonName (CN)
  • DisplayName
  • FirstName
  • LastName
  • エイリアス
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-Credential

Credential パラメーターは、このコマンドの実行に使用するユーザー名とパスワードを指定します。 通常、このパラメーターはスクリプトや、必要なアクセス許可を持つ別の資格情報を入力する必要がある場合に使用します。

このパラメーターには、資格情報オブジェクトの作成および指定が必要です。 この資格情報オブジェクトは Get-Credential コマンドレットを使用して作成されます。 詳細については、Get-Credentialに関するページをご覧ください。

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-DomainController

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

DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。

Type:Fqdn
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-Identity

Identity パラメーターは、表示するメールボックスを指定します。 メールボックスを一意に識別する任意の値を使用できます。 次に例を示します。

  • 名前
  • Alias
  • 識別名 (DN)
  • 正規 DN
  • ドメイン\ユーザー名
  • 電子メール アドレス
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • ユーザー ID またはユーザー プリンシパル名 (UPN)
Type:MailboxIdParameter
Position:1
Default value:None
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

IgnoreDefaultScope スイッチは、Exchange 管理シェル セッションに対する受信者の範囲の既定の設定を無視し、フォレスト全体を範囲として使用するようにコマンドに指示します。 このスイッチによって、コマンドは、既定の範囲では現在使用できない Active Directory オブジェクトにアクセスできます。

IgnoreDefaultScope スイッチを使用すると、次の制限が発生します。

  • IgnoreDefaultScope スイッチを使用すると、次の制限が発生します。
  • DomainController パラメーターは使用できません。このコマンドは、適切なグローバル カタログ サーバーを自動的に使用します。
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-Monitoring

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

結果でモニタリング メールボックスを返すには、モニタリング スイッチが必要です。 このスイッチで値を指定する必要はありません。

監視メールボックスは、可用性管理および Exchange Health Manager サービスに関連付けられており、MonitoringMailbox の RecipientTypeDetails プロパティ値を持っています。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
-OrganizationalUnit

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

  • 名前
  • 識別名 (DN)
  • 識別名 (DN)
  • GUID
Type:OrganizationalUnitIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-ProtocolSettings

ProtocolSettings スイッチは、以下の設定のサーバー名、TCP ポート、および暗号化方法を返します。

  • ExternalImapSettings
  • InternalImapSettings
  • ExternalPopSettings
  • InternalPopSettings
  • ExternalSmtpSettings
  • InternalSmtpSettings

これらの値を表示するには、書式設定コマンドレットを使用する必要があります。たとえば、Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List などです。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-ReadFromDomainController

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

ReadFromDomainController スイッチは、情報がユーザーのドメインのドメイン コントローラーから読み取られることを指定します。フォレスト内のすべてのオブジェクトを含めるためにコマンド Set-AdServerSettings -ViewEntireForest $true を実行し、ReadFromDomainController スイッチを使用しない場合は、情報が古いグローバル カタログから情報が読み取られる可能性があります。ReadFromDomainController スイッチを使用する場合は、情報を取得するために読み取りが数回必要になる場合があります。このスイッチに値を指定する必要はありません。

既定では、受信者スコープは、ユーザーのサーバーをホストするドメインExchangeされます。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
-ReadIsOptimizedForAccessibility

ReadIsOptimizedForAccessibility スイッチは、メールボックスの IsOptimizedForAccessibility プロパティの値を読み取るかどうかを指定します (メールボックスがライト バージョンの Outlook on the web を使用するように構成されているかどうかを指定します。 このスイッチで値を指定する必要はありません。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Exchange Online
-RecalculateHasActiveSyncDevicePartnership

RecalculateHasActiveSyncDevicePartnership スイッチは、メールボックス上の HasActiveSyncDevicePartnership プロパティの値を再計算します。この値は、間違いが見つかった場合に自動的に更新されます。このスイッチに値を指定する必要はありません。

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-RecipientTypeDetails

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

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

  • DiscoveryMailbox
  • EquipmentMailbox
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox
  • MailUser
  • RoomMailbox
  • SharedMailbox
  • TeamMailbox
  • UserMailbox

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

Type:RecipientTypeDetails[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online, Exchange Online Protection
-ResultSize

ResultSize パラメーターは、返される結果の最大件数を指定します。クエリに一致する要求がすべて返されるようにする場合は、このパラメーターの値に unlimited を使用します。既定値は 1000 です。

Type:Unlimited
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-SortBy

SortBy パラメーターは、結果の並べ替えのプロパティを指定します。並べ替えの基準にできるのは、一度に 1 つのプロパティのみです。結果は昇順で並べ替えられます。

既定のビューに並べ替えのプロパティが含まれる場合は、コマンドを追加できます | Format-Table -Auto Property1,Property2,...PropertyX 。 をクリックして、表示するすべてのプロパティを含む新しいビューを作成します。 プロパティ名にはワイルドカード (*) がサポートされています。

以下のプロパティで並べ替えることができます。

  • 名前
  • DisplayName
  • ServerLegacyDN
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

入力

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

出力

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