Disable-CmdletExtensionAgent
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
Disable-CmdletExtensionAgent コマンドレットを使用して、既存のコマンドレット拡張エージェントを無効にします。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Disable-CmdletExtensionAgent
[-Identity] <CmdletExtensionAgentIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-WhatIf]
[<CommonParameters>] 説明
コマンドレット拡張エージェントは、Exchange Server 2010 以降のExchangeコマンドレットによって使用されます。 他の Microsoft またはサード パーティ製品によって提供されるコマンドレットでは、コマンドレット拡張エージェントを使用できません。
コマンドレット拡張エージェントを無効にすると、組織全体でエージェントが無効になります。 エージェントが無効の場合、コマンドレットがエージェントを使用できなくなります。 コマンドレットは、追加の操作を行うために、エージェントを使用できなくなります。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。組織内のコマンドレットまたはパラメーターの実行に必要なアクセス許可を検索するには、「Exchange コマンドレットを実行するために必要なパーミッションを検索する」 をご覧ください。
例
例 1
Disable-CmdletExtensionAgent "Scripting Agent"この例では、Scripting Agent という名前のコマンドレット拡張エージェントを無効にします。
パラメーター
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- データを破壊するコマンドレット (たとえば、Remove-* コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
| Type: | SwitchParameter |
| Aliases: | cf |
| 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 |
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 |
Identity パラメーターは、無効にする有効なコマンドレット拡張エージェントを指定します。 エージェントを一意に識別する任意の値を使用できます。 以下に例を示します。
- 名前
- 識別名 (DN)
- GUID
| Type: | CmdletExtensionAgentIdParameter |
| 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 |
WhatIf スイッチは、コマンドの操作をシミュレートします。このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。このスイッチに値を指定する必要はありません。
| Type: | SwitchParameter |
| Aliases: | wi |
| 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 |
入力
入力の種類
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
出力の種類
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。