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
この例では、Exchange Online PowerShell またはセキュリティ & コンプライアンスの PowerShell から切断する前に確認を求めます。
例 2
Disconnect-ExchangeOnline -Confirm:$false
この例では、確認プロンプトや通知テキストなしで、Exchange Online PowerShell またはセキュリティ & コンプライアンス PowerShell から自動的に切断します。
例 3
Disconnect-ExchangeOnline -ConnectionId 1a9e45e8-e7ec-498f-9ac3-0504e987fa85
この例では、指定された ConnectionId 値を持つ REST ベースの Exchange Online PowerShell 接続を切断します。 同じWindows PowerShell ウィンドウ内の Exchange Online PowerShell またはセキュリティ & コンプライアンス PowerShell への他のリモート PowerShell 接続も切断されます。
例 4
Disconnect-ExchangeOnline -ModulePrefix Contoso,Fabrikam
この例では、指定されたプレフィックス値を使用している REST ベースの Exchange Online PowerShell 接続を切断します。 同じWindows PowerShell ウィンドウ内の Exchange Online PowerShell またはセキュリティ & コンプライアンス 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 |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ModulePrefix
適用対象: Exchange Online
注: このパラメータは、モジュール バージョン 3.2.0-Preview2 以降で使用できます。
ModulePrefix パラメーターは、ModulePrefix によって切断する REST API 接続を指定します。 Connect-ExchangeOnline コマンドレットでプレフィックス パラメーターを使用すると、指定されたテキストがすべての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: | wi |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、「about_CommonParameters」を参照してください。