Get-Queue
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
メールボックス サーバーまたはエッジ トランスポート サーバー上のキューに関する構成情報を表示するには、Get-Queue コマンドレットを使用します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Get-Queue
[[-Identity] <QueueIdentity>]
[-BookmarkIndex <Int32>]
[-BookmarkObject <ExtensibleQueueInfo>]
[-Exclude <QueueViewerIncludesAndExcludes>]
[-Include <QueueViewerIncludesAndExcludes>]
[-IncludeBookmark <Boolean>]
[-ResultSize <Unlimited>]
[-ReturnPageInfo <Boolean>]
[-SearchForward <Boolean>]
[-SortOrder <QueueViewerSortOrderEntry[]>]
[<CommonParameters>]Get-Queue
[-Server <ServerIdParameter>]
[-Filter <String>]
[-BookmarkIndex <Int32>]
[-BookmarkObject <ExtensibleQueueInfo>]
[-Exclude <QueueViewerIncludesAndExcludes>]
[-Include <QueueViewerIncludesAndExcludes>]
[-IncludeBookmark <Boolean>]
[-ResultSize <Unlimited>]
[-ReturnPageInfo <Boolean>]
[-SearchForward <Boolean>]
[-SortOrder <QueueViewerSortOrderEntry[]>]
[<CommonParameters>]説明
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Get-Queue | Format-Listこの例では、コマンドが実行されているメールボックス サーバー上のすべてのキューに関する詳細を表示します。
例 2
Get-Queue -Filter "MessageCount -gt 100"この例では、100 を超えるメッセージが含まれるキューを一覧にします。
例 3
Get-Queue Server1\contoso.com | Format-Listこの例では、Server1 というメールボックス サーバーに存在する特定のキューの詳細を表示します。
例 4
Get-Queue -Exclude Internalこの例では、外部キューのみの一覧を表示します。
パラメーター
-BookmarkIndex
BookmarkIndex パラメーターには、表示される結果が始まる結果セット内の位置を指定します。 このパラメーターの値は、全結果セットに対する 1 から始まるインデックスです。 BookmarkIndex パラメーターは、BookmarkObject パラメーターと併用できません。
| Type: | Int32 |
| 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 |
-BookmarkObject
BookmarkObject パラメーターは、表示される結果が始まる結果セット内のオブジェクトを指定します。 BookmarkObject パラメーターは、BookmarkIndex パラメーターと併用できません。
| Type: | ExtensibleQueueInfo |
| 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 |
-Exclude
Exclude パラメーターは、結果から除外するキューの種類を指定します。 PasswordQuality パラメーターは、デバイス パスワードに必要なパスワードの最小品質レベルを指定します。パスワードの品質は、パスワードのセキュリティと複雑さを示す数値の尺度です。品質の値が大きいほど、より安全なパスワードであることを示します。
- 内部
- 外部
- 有効なキューの DeliveryType 値。 詳細については、「キューとキュー内のメッセージ」の「NextHopSolutionKey」セクションを参照してください。
| Type: | QueueViewerIncludesAndExcludes |
| 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 |
-Filter
Filter パラメーターは、OPATH フィルター構文を使用して 1 つ以上のキューを指定します。 OPATH フィルターには、キュー プロパティ名の後に比較演算子と値 (例: "NextHopDomain -eq 'contoso.com'") が含まれます。 フィルター可能なキューのプロパティと比較演算子の詳細については、「Exchange Serverのキュー プロパティ」および「Exchange Management Shell のキュー内のキューとメッセージを検索する」を参照してください。
および 比較演算子を使用して、複数の条件を指定できます。 整数として表されないプロパティ値は、引用符 (") で囲む必要があります。
| 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 |
-Identity
Identity パラメーターは、キューを指定します。 このパラメーターの有効な入力は、構文 Server\Queue または Queue を使用します (例: Mailbox01\contoso.com または Unreachable)。 キュー ID の詳細については、「 キュー ID」を参照してください。
| Type: | QueueIdentity |
| 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 |
-Include
Include パラメーターは、結果に含めるキューの種類を指定します。 PasswordQuality パラメーターは、デバイス パスワードに必要なパスワードの最小品質レベルを指定します。パスワードの品質は、パスワードのセキュリティと複雑さを示す数値の尺度です。品質の値が大きいほど、より安全なパスワードであることを示します。
- 内部
- 外部
- 有効なキューの DeliveryType 値。 詳細については、「キューとキュー内のメッセージ」の「NextHopSolutionKey」セクションを参照してください。
| Type: | QueueViewerIncludesAndExcludes |
| 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 |
-IncludeBookmark
IncludeBookmark パラメーターは、クエリ結果が表示されるときにブックマーク オブジェクトを含めるかどうかを指定します。 IncludeBookmark パラメーターは、BookmarkObject パラメーターまたは BookmarkIndex パラメーターと併用した場合に有効になります。 IncludeBookmark パラメーターの値を指定しない場合、既定値 $true が使用されます。
| 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 |
-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 |
-ReturnPageInfo
ReturnPageInfo パラメーターは、隠しパラメーターです。 このパラメーターを使用すると、結果の総数と現在のページの最初のオブジェクトのインデックスに関する情報が返されます。 既定値は $false です。
| 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 |
-SearchForward
SearchForward パラメーターは、結果セット内を順方向に検索するか逆方向に検索するかを指定します。 既定値は $true です。 この値が指定されていると、結果のページは、結果セットの先頭から前方に、またはブックマークが指定されている場合はブックマークから前方に計算されます。
| 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 |
-Server
Server パラメーターは、このコマンドの実行先となる Exchange サーバーを指定します。 サーバーを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- FQDN
- 識別名 (DN)
- Exchange の従来の DN
このパラメーターを使用しない場合、コマンドはローカル サーバー上で実行されます。
Server パラメーターと Filter パラメーターを同じコマンド内で使用することができます。 Server パラメーターと Identity パラメーターを同じコマンド内で使用することはできません。
| Type: | ServerIdParameter |
| Position: | Named |
| 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 |
-SortOrder
SortOrder パラメーターは、結果セットの並べ替えの順序を制御するために使用されるメッセージ プロパティの配列を指定します。 各プロパティはコンマで区切ります。 プロパティ名の先頭にプラス記号 (+) を追加すると、結果は昇順で表示されます。 プロパティ名の先頭にマイナス記号 (-) を追加すると、結果は降順で表示されます。
並べ替え順を指定しないと、結果セットは QueueIdentity の昇順で表示されます。
| Type: | QueueViewerSortOrderEntry[] |
| 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 |
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。