Get-CmdletExtensionAgent
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
コマンドレット拡張エージェントを表示するには、Get-CmdletExtensionAgent コマンドレットを使用します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Filters
Get-CmdletExtensionAgent
[-Assembly <String>]
[-Enabled <Boolean>]
[-DomainController <Fqdn>]
[<CommonParameters>]
Identity
Get-CmdletExtensionAgent
[[-Identity] <CmdletExtensionAgentIdParameter>]
[-DomainController <Fqdn>]
[<CommonParameters>]
説明
コマンドレット拡張エージェントは、Exchange Server 2010 以降の Exchange コマンドレットによって使用されます。 他の Microsoft または Microsoft 以外の製品によって提供されるコマンドレットでは、コマンドレット拡張エージェントを使用できません。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事ではコマンドレットのすべてのパラメーターを一覧表示しますが、割り当てられたアクセス許可にパラメーターが含まれていない場合は、一部のパラメーターにアクセスできない可能性があります。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Get-CmdletExtensionAgent | Format-Table -Auto Name,Enabled,Priority
この例では、組織内のすべてのコマンドレット拡張エージェントの要約リストを表示します。
例 2
Get-CmdletExtensionAgent "Mailbox Creation Time Agent"
次の使用例は、メールボックス作成時間エージェントという名前の Exchange コマンドレット拡張機能エージェントの詳細情報を表示します。
パラメーター
-Assembly
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Assembly パラメーターは、指定した Assembly プロパティ値によって結果をフィルター処理します。 組み込みの Exchange コマンドレット拡張エージェントの値は Microsoft.Exchange.ProvisioningAgent.dll。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Filters
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DomainController
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
パラメーターのプロパティ
| 型: | Fqdn |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Enabled
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Enabled パラメーターは、有効または無効になっているコマンドレット拡張エージェントによって結果をフィルター処理します。 有効な値は次のとおりです。
- $true: 有効なエージェントのみが結果に含まれます。
- $false: 無効なエージェントのみが結果に含まれます。
このパラメーターを使用しない場合は、結果には有効なエージェントと無効なエージェントが含まれます。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Filters
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Identity パラメーターは、表示するコマンドレット拡張エージェントの名前を指定します。 エージェントを一意に識別する任意の値を使用できます。 たとえば、次のように入力します。
- 名前
- 識別名 (DN)
- GUID
パラメーターのプロパティ
| 型: | CmdletExtensionAgentIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。