Disconnect-ExchangeOnline
このコマンドレットは、Exchange Online PowerShell モジュールでのみ使用できます。 詳細については、「Exchange Online PowerShell モジュールについて」を参照してください。
Exchange Online PowerShell モジュールの Disconnect-ExchangeOnline コマンドレットを使用して、Connect-ExchangeOnline または Connect-IPPSSession コマンドレットを使用して作成した接続を切断します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
DefaultParameterSet (既定)
Disconnect-ExchangeOnline
[-Confirm]
[-WhatIf]
[<CommonParameters>]
ConnectionId
Disconnect-ExchangeOnline
-ConnectionId <String[]>
[-Confirm]
[-WhatIf]
[<CommonParameters>]
ModulePrefix
Disconnect-ExchangeOnline
-ModulePrefix <String[]>
[-Confirm]
[-WhatIf]
[<CommonParameters>]
説明
このコマンドレットは、Connect-ExchangeOnline および Connect-IPPSSession コマンドレットに対応します。
このコマンドレットは、接続を切断し、キャッシュをクリアします。 切断が成功した後は、organizationのコマンドレットを正常に実行できません。
接続に使用したアカウントのプロファイル パスに特殊な PowerShell 文字 (たとえば、 $) が含まれている場合、切断コマンドは失敗する可能性があります。 回避策は、プロファイル パスに特殊文字を含まない別のアカウントを使用して接続することです。
例
例 1
Disconnect-ExchangeOnline
この例では、PowerShell またはセキュリティ & コンプライアンス PowerShell から切断する前Exchange Online確認を求めます。
例 2
Disconnect-ExchangeOnline -Confirm:$false
この例では、確認プロンプトや通知テキストなしで、PowerShell またはセキュリティ & コンプライアンス PowerShell Exchange Onlineからサイレントに切断します。
例 3
Disconnect-ExchangeOnline -ConnectionId 1a9e45e8-e7ec-498f-9ac3-0504e987fa85
次の使用例は、REST ベースの Exchange Online PowerShell 接続を指定された ConnectionId 値で切断します。 同じWindows PowerShellウィンドウ内Exchange Online PowerShell または Security & Compliance PowerShell へのその他のリモート PowerShell 接続も切断されます。
例 4
Disconnect-ExchangeOnline -ModulePrefix Contoso,Fabrikam
次の使用例は、指定したプレフィックス値を使用している REST ベースの Exchange Online PowerShell 接続を切断します。 同じWindows PowerShellウィンドウ内Exchange Online PowerShell または Security & Compliance PowerShell へのその他のリモート PowerShell 接続も切断されます。
パラメーター
-Confirm
適用対象: Exchange Online
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ConnectionId
適用対象: Exchange Online
注: このパラメーターは、モジュール バージョン 3.2.0-Preview2 以降で使用できます。
ConnectionId パラメーターは、ConnectionId によって切断する REST API 接続を指定します。 ConnectionId は、複数の接続を開いている場合でも、接続を一意に識別する Get-ConnectionInformation コマンドレットの出力の GUID 値です。 複数の ConnectionId 値をコンマで区切って指定できます。
ModulePrefix パラメーターでは、このパラメーターを使用しないでください。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ConnectionId
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ModulePrefix
適用対象: Exchange Online
注: このパラメーターは、モジュール バージョン 3.2.0-Preview2 以降で使用できます。
ModulePrefix パラメーターは、ModulePrefix によって切断する REST API 接続を指定します。 Connect-ExchangeOnline コマンドレットで Prefix パラメーターを使用すると、指定したテキストがすべてのExchange Onlineコマンドレットの名前に追加されます (たとえば、Get-InboundConnector は Get-ContosoInboundConnector になります)。 ModulePrefix 値は、Get-ConnectionInformation コマンドレットの出力に表示されます。 複数の ModulePrefix 値をコンマで区切って指定できます。
ConnectionId パラメーターでこのパラメーターを使用しないでください。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ModulePrefix
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
適用対象: Exchange Online
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。