Connect-ExchangeOnline
このコマンドレットは、Exchange Online PowerShell モジュールでのみ使用できます。 詳細については、「Exchange Online PowerShell モジュールについて」を参照してください。
Exchange Online PowerShell モジュールの Connect-ExchangeOnline コマンドレットを使用して、最新の認証を使用して、オンプレミスの電子メール環境のクラウド保護のために PowerShell Exchange Onlineまたは powerShell Exchange Online Protectionに接続します。 このコマンドレットは、多要素認証 (MFA) の有無にかかわらずアカウントに対して機能します。
Security & Compliance PowerShell に接続するには、 Connect-IPPSSession コマンドレットを 使用します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Default (既定)
Connect-ExchangeOnline
[[-ConnectionUri] <String>]
[[-AzureADAuthorizationEndpointUri] <String>]
[[-ExchangeEnvironmentName] <ExchangeEnvironment>]
[[-PSSessionOption] <PSSessionOption>]
[[-DelegatedOrganization] <String>]
[[-Prefix] <String>]
[[-CommandName] <String[]>]
[[-FormatTypeName] <String[]>]
[-AccessToken <String>]
[-AppId <String>]
[-BypassMailboxAnchoring]
[-Certificate <X509Certificate2>]
[-CertificateFilePath <String>]
[-CertificatePassword <SecureString>]
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-Device]
[-DisableWAM]
[-EnableErrorReporting]
[-InlineCredential]
[-LoadCmdletHelp]
[-LogDirectoryPath <String>]
[-LogLevel <LogLevel>]
[-ManagedIdentity]
[-ManagedIdentityAccountId <String>]
[-Organization <String>]
[-PageSize <UInt32>]
[-ShowBanner]
[-ShowProgress <Boolean>]
[-SigningCertificate <X509Certificate2>]
[-SkipLoadingCmdletHelp]
[-SkipLoadingFormatData]
[-TrackPerformance <Boolean>]
[-UseMultithreading <Boolean>]
[-UserPrincipalName <String>]
[-UseRPSSession]
[<CommonParameters>]
説明
このコマンドレットは、Exchange Online organizationへの PowerShell 接続を作成します。
接続に使用したアカウントのプロファイル パスに特殊な PowerShell 文字 (たとえば、 $) が含まれている場合、接続コマンドは失敗する可能性があります。 回避策は、プロファイル パスに特殊文字を含まない別のアカウントを使用して接続することです。
例
例 1
Connect-ExchangeOnline -UserPrincipalName chris@contoso.com
次の使用例は、多要素認証 (MFA) の有無にかかわらず、先進認証を使用して Exchange Online PowerShell に接続します。 接続では REST API モードが使用され、ローカル コンピューターの WinRM で基本認証を有効にする必要はありません。
例 2
Connect-ExchangeOnline -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com"
この例では、証明書の拇印を使用して、無人スクリプトシナリオで powerShell Exchange Onlineに接続します。
例 3
Connect-ExchangeOnline -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com"
次の使用例は、証明書ファイルを使用して無人スクリプトシナリオで PowerShell Exchange Onlineに接続します。 この方法は、証明書がリモート マシンに格納され、実行時にフェッチされるシナリオに最適です。 たとえば、証明書は Azure Key Vaultに格納されます。
例 4
Connect-ExchangeOnline -Device
モジュールのバージョン 2.0.4 以降を使用する PowerShell 7.0.3 以降では、この例では、Web ブラウザーを持たないコンピューター上の対話型スクリプト シナリオで、Exchange Online PowerShell に接続します。
このコマンドは、セッションに関連付けられている URL と一意のコードを返します。 任意のコンピューターのブラウザーでその URL を開き、一意のコードを入力する必要があります。 Web ブラウザーでログインを完了すると、Powershell 7 ウィンドウのセッションは通常のMicrosoft Entra認証フローを介して認証され、Exchange Online コマンドレットは数秒後にインポートされます。
例 6
Connect-ExchangeOnline -InlineCredential
このモジュールのバージョン 2.0.4 以降を使用する PowerShell 7.0.3 以降では、この例では、PowerShell ウィンドウで資格情報を直接渡すことで、対話型のスクリプト シナリオで powerShell に Exchange Online接続します。
パラメーター
-AccessToken
適用対象: Exchange Online
注: このパラメーターは、モジュールのバージョン 3.1.0 以降で使用できます。
AccessToken パラメーターは、Exchange Onlineへの接続に使用される OAuth JSON Web トークン (JWT) を指定します。
アクセス トークンの種類に応じて、Organization、DelegatedOrganization、または UserPrincipalName パラメーターでこのパラメーターを使用する必要があります。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AppId
適用対象: Exchange Online
AppId パラメーターは、証明書ベースの認証 (CBA) で使用されるサービス プリンシパルのアプリケーション ID を指定します。 有効な値は、アプリケーション ID (サービス プリンシパル) の GUID です。 たとえば、「 36ee4c6c-0812-40a2-b820-b22ebd02bce3 」のように入力します。
詳細については、「Exchange Online PowerShell モジュールの無人スクリプトのアプリ専用認証」を参照してください。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AzureADAuthorizationEndpointUri
適用対象: Exchange Online
注: ExchangeEnvironmentName パラメーターを使用する場合は、AzureADAuthorizationEndpointUri パラメーターまたは ConnectionUri パラメーターを使用する必要はありません。
AzureADAuthorizationEndpointUri パラメーターは、OAuth2 アクセス トークンを発行できるMicrosoft Entra承認エンドポイントを指定します。 次のExchange Online PowerShell 環境と関連する値がサポートされています。
- Microsoft 365 または Microsoft 365 GCC: このパラメーターは使用しないでください。 必要な値は
https://login.microsoftonline.com/commonですが、これも既定値であるため、このパラメーターを使用する必要はありません。 - ドイツOffice 365:
https://login.microsoftonline.de/common - Microsoft 365 GCC High または Microsoft 365 DoD:
https://login.microsoftonline.us/common
UserPrincipalName パラメーターを使用する場合は、通常必要とする環境で MFA またはフェデレーション ユーザーに AzureADAuthorizationEndpointUri パラメーターを使用する必要はありません (UserPrincipalName または AzureADAuthorizationEndpointUri が必要です)。両方を使用する場合は OK)。
注: MFA 認証またはフェデレーション認証は、21Vianet が運営するOffice 365では使用できません。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-BypassMailboxAnchoring
適用対象: Exchange Online
BypassMailboxAnchoring スイッチは、メールボックス のアンカー ヒントの使用をバイパスします。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Certificate
適用対象: Exchange Online
Certificate パラメーターは、証明書ベースの認証 (CBA) に使用される証明書を指定します。 有効な値は、証明書の X509Certificate2 オブジェクト値です。
CertificateFilePath パラメーターまたは CertificateThumbprint パラメーターでは、このパラメーターを使用しないでください。
CBA の詳細については、「Exchange Online PowerShell モジュールの無人スクリプトのアプリ専用認証」を参照してください。
パラメーターのプロパティ
| 型: | X509Certificate2 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CertificateFilePath
適用対象: Exchange Online
CertificateFilePath パラメーターは、CBA に使用される証明書を指定します。 有効な値は、証明書ファイルへの完全なパブリック パスです。 このパラメーターで CertificatePassword パラメーターを使用します。
証明書パラメーターまたは CertificateThumbprint パラメーターでは、このパラメーターを使用しないでください。
CBA の詳細については、「Exchange Online PowerShell モジュールの無人スクリプトのアプリ専用認証」を参照してください。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CertificatePassword
適用対象: Exchange Online
CertificatePassword パラメーターは、CertificateFilePath パラメーターを使用して CBA に使用される証明書を識別するときに、証明書ファイルを開くために必要なパスワードを指定します。
このパラメーターの値として、次のメソッドを使用できます:
-
(ConvertTo-SecureString -String '<password>' -AsPlainText -Force). - または、このコマンドを実行する前に、パスワードを変数として保存し (たとえば、
$password = Read-Host "Enter password" -AsSecureString)、このパラメーターに変数名 ($password) を使用します。 - このコマンドを実行すると、パスワードの安全な入力を求める
(Get-Credential).passwordメッセージが表示されます。
CBA の詳細については、「Exchange Online PowerShell モジュールの無人スクリプトのアプリ専用認証」を参照してください。
注: ConvertTo-SecureString コマンドを使用して証明書のパスワードをローカルに格納すると、自動化シナリオのセキュリティで保護された接続方法の目的が破られます。 Get-Credential コマンドを使用して証明書のパスワードを安全に入力するように求めるのは、自動化シナリオには適していません。 つまり、ローカル証明書を使用して接続するための 自動化された安全 な方法はありません。
パラメーターのプロパティ
| 型: | SecureString |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CertificateThumbprint
適用対象: Exchange Online
CertificateThumbprint パラメーターは、CBA に使用される証明書を指定します。 有効な値は、証明書の拇印値です。 たとえば、「 83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1 」のように入力します。
Certificate パラメーターまたは CertificateFilePath パラメーターでは、このパラメーターを使用しないでください。
注: CertificateThumbprint パラメーターは、Microsoft Windows でのみサポートされています。
CBA の詳細については、「Exchange Online PowerShell モジュールの無人スクリプトのアプリ専用認証」を参照してください。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CommandName
適用対象: Exchange Online
CommandName パラメーターは、セッションにインポートするコマンドのコンマ区切りリストを指定します。 特定のコマンドレットセットを使用するアプリケーションまたはスクリプトには、このパラメーターを使用します。 セッション内のコマンドレットの数を減らすことは、パフォーマンスの向上に役立ち、アプリケーションまたはスクリプトのメモリ占有領域を減らします。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 6 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ConnectionUri
適用対象: Exchange Online
注: ExchangeEnvironmentName パラメーターを使用する場合は、AzureADAuthorizationEndpointUri パラメーターまたは ConnectionUri パラメーターを使用する必要はありません。
ConnectionUri パラメーターは、PowerShell セッションの接続エンドポイントを指定します。 次のExchange Online PowerShell 環境と関連する値がサポートされています。
- Microsoft 365 または Microsoft 365 GCC: このパラメーターは使用しないでください。 必要な値は
https://outlook.office365.com/powershell-liveid/ですが、これも既定値であるため、このパラメーターを使用する必要はありません。 - ドイツOffice 365:
https://outlook.office.de/PowerShell-LiveID - 21Vianet が運営するOffice 365:
https://partner.outlook.cn/PowerShell - Microsoft 365 GCC High:
https://outlook.office365.us/powershell-liveID - Microsoft 365 DoD:
https://webmail.apps.mil/powershell-liveID
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Credential
適用対象: Exchange Online
Credential パラメーターは、PowerShell への接続に使用するユーザー名とパスワードExchange Online指定します。 通常、このパラメーターはスクリプトや、必要なアクセス許可を持つ別の資格情報を入力する必要がある場合に使用します。 多要素認証 (MFA) を使用するアカウントには、このパラメーターを使用しないでください。
Connect-ExchangeOnline コマンドを実行する前に、ユーザー名とパスワードを変数 ( $UserCredential = Get-Credential など) に格納します。 次に、このパラメーターに変数名 ($UserCredential) を使用します。
Connect-ExchangeOnline コマンドが完了すると、変数のパスワード キーが空になります。
証明書ファイルのパスワードを指定するには、このパラメーターを使用しないでください。代わりに CertificatePassword パラメーターを使用してください。
パラメーターのプロパティ
| 型: | PSCredential |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DelegatedOrganization
適用対象: Exchange Online
DelegatedOrganization パラメーターは、管理する顧客organizationを指定します。 このパラメーターの有効な値は、顧客organizationのプライマリ .onmicrosoft.com ドメインまたはテナント ID です。
このパラメーターは、顧客organizationが CSP プログラムを介して委任された管理に同意した場合にのみ機能します。
認証が正常に完了すると、このセッションのコマンドレットが顧客organizationにマップされ、このセッションのすべての操作が顧客organizationで実行されます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 4 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Device
適用対象: Exchange Online
注: このパラメーターは、モジュールのバージョン 2.0.4 以降で使用でき、PowerShell 7 でのみ使用できます。
デバイス スイッチは、通常、Web ブラウザーのないコンピューターで使用されます。 このスイッチで値を指定する必要はありません。
このスイッチを使用すると、URL https://microsoft.com/devicelogin と一意のコードを含む画面上のメッセージが表示されます。 Web ブラウザーとインターネット にアクセスできるその他のデバイスで、URL を開き、一意のコードを入力し、以降のページで資格情報を入力します。
ログインに成功した場合、PowerShell 接続は続行されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DisableWAM
適用対象: Exchange Online
注: このパラメーターは、モジュールのバージョン 3.7.2-Preview1 以降で使用できます。
DisableWAM スイッチは、Web アカウント マネージャー (WAM) を無効にします。 このスイッチで値を指定する必要はありません。
バージョン 3.7.0 以降では、Exchange Onlineに接続するときに WAM が既定で有効になります。 サインイン中に WAM 関連の問題が発生した場合は、このスイッチを使用して WAM を無効にすることができます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-EnableErrorReporting
適用対象: Exchange Online
EnableErrorReporting スイッチは、エラー報告を有効にするかどうかを指定します。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ExchangeEnvironmentName
適用対象: Exchange Online
ExchangeEnvironmentName は、Exchange Online環境を指定し、AzureADAuthorizationEndpointUri パラメーターと ConnectionUri パラメーターを使用する必要がなくなります。 次のExchange Online PowerShell 環境がサポートされています。
- Microsoft 365 または Microsoft 365 GCC: このパラメーターは使用しないでください。 必要な値は
O365Defaultですが、これも既定値であるため、このパラメーターを使用する必要はありません。 - ドイツOffice 365:
O365GermanyCloud - 21Vianet が運営するOffice 365:
O365China - Microsoft 365 GCC High:
O365USGovGCCHigh - Microsoft 365 DoD:
O365USGovDoD
パラメーターのプロパティ
| 型: | ExchangeEnvironment |
| 規定値: | O365Default |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 2 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-FormatTypeName
適用対象: Exchange Online
FormatTypeName パラメーターは、コマンドレットの出力形式を指定します。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 7 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-InlineCredential
適用対象: Exchange Online
注: このパラメーターは、モジュールのバージョン 2.0.4 以降で使用でき、PowerShell 7 でのみ使用できます。
InlineCredential スイッチは、Windows PowerShell ウィンドウで資格情報を直接渡すかどうかを指定します。 このスイッチで値を指定する必要はありません。
このスイッチは Credential パラメーターに似ていますが、セキュリティが強化されています。 InlineCredential スイッチでは、資格情報をスクリプトにローカルに格納する必要はありません。また、対話型の PowerShell セッションで資格情報を直接入力できます。
このスイッチは、MFA を使用するアカウントでは機能しません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LoadCmdletHelp
適用対象: Exchange Online
注: このパラメーターは、モジュールのバージョン 3.7.0-Preview1 以降で使用できます。
LoadCmdletHelp スイッチは、REST API 接続の Get-Help コマンドレットのヘルプ ファイルをダウンロードします。 このスイッチで値を指定する必要はありません。
v3.7.0-Preview1 以降では、コマンド ラインのヘルプ ファイルは既定ではダウンロードされません。 コマンド ラインでコマンドレット ヘルプのファイルをダウンロードするには、このスイッチを使用します。
ヒント: このパラメーターは SkipLoadingCmdletHelp パラメーターに置き換えられます。 コマンドレット ヘルプ ファイルは既定でダウンロードされなくなったため、SkipLoadingCmdletHelp パラメーターは不要になり、機能しなくなりました。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LogDirectoryPath
適用対象: Exchange Online
LogDirectoryPath パラメーターは、ログ ファイルの場所を指定します。 既定の場所は %TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csvです。
スペースを含むカスタムの場所とファイル名を指定する場合は、値を引用符 (") で囲みます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LogLevel
適用対象: Exchange Online
LogLevel パラメーターは、ログ レベルを指定します。 有効な値は既定値とすべてです。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ManagedIdentity
適用対象: Exchange Online
ManagedIdentity スイッチは、マネージド ID を使用して接続することを指定します。 このスイッチで値を指定する必要はありません。
マネージド ID 接続は現在、次の種類の Azure リソースでサポートされています。
- Runbook のAzure Automation
- Azure Virtual Machines
- Azure Virtual Machine Scale Sets
- Azure Functions
このスイッチは、Organization パラメーターと共に使用する必要があります。
ユーザー割り当てマネージド ID の場合は、ManagedIdentityAccountId パラメーターでもこのスイッチを使用する必要があります。
マネージド ID との接続の詳細については、「Azure マネージド ID を使用して PowerShell に接続する」Exchange Online参照してください。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ManagedIdentityAccountId
適用対象: Exchange Online
ManagedIdentityAccountId パラメーターは、接続に使用するユーザー割り当てマネージド ID を指定します。 このパラメーターの有効な値は、Azure のユーザー割り当てマネージド ID に対応するサービス プリンシパルのアプリケーション ID (GUID) です。
このパラメーターは、Organization パラメーターと ManagedIdentity スイッチと共に使用する必要があります。
マネージド ID との接続の詳細については、「Azure マネージド ID を使用して PowerShell に接続する」Exchange Online参照してください。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Organization
適用対象: Exchange Online
Organization パラメーターは、CBA またはマネージド ID を使用して接続するときにorganizationを指定します。 このパラメーターの有効な値は、organizationのプライマリ .onmicrosoft.com ドメインまたはテナント ID です。
CBA との接続の詳細については、Exchange Online PowerShell モジュールの無人スクリプトのアプリ専用認証に関するページを参照してください。
マネージド ID との接続の詳細については、「Azure マネージド ID を使用して PowerShell に接続する」Exchange Online参照してください。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PageSize
適用対象: Exchange Online
PageSize パラメーターは、ページあたりのエントリの最大数を指定します。 このパラメーターの有効な入力値は、1 ～ 1000 の整数です。 既定値は 1,000 です。
パラメーターのプロパティ
| 型: | UInt32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Prefix
適用対象: Exchange Online
Prefix パラメーターは、接続時に PowerShell コマンドレットの名前Exchange Online追加するテキスト値を指定します。 たとえば、このパラメーターに Contoso という値を使用すると、Get-InboundConnector は Get-ContosoInboundConnector になります。
- Prefix 値には、アンダースコアやアスタリスクなどのスペースや特殊文字を含めることはできません。
- プレフィックス値 EXO は使用できません。 この値は、モジュールに組み込まれている 9 つの排他的 な Get-EXO* コマンドレット用に予約されています。
- Prefix パラメーターは、インポートされたExchange Onlineコマンドレット名にのみ影響します。 モジュールに組み込まれているコマンドレットの名前 (Disconnect-ExchangeOnline など) には影響しません。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 5 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PSSessionOption
適用対象: Exchange Online
注: このパラメーターは REST API 接続では機能しません。
PSSessionOption パラメーターは、Exchange Onlineへの接続で使用する PowerShell セッション オプションを指定します。 このパラメーターは、同じコマンドで UseRPSSession スイッチも使用する場合にのみ機能します。
New-PSSessionOption コマンドの出力を変数 (たとえば、$PSOptions = New-PSSessionOption <Settings>) に格納し、このパラメーターの値として変数名を使用します (たとえば、$PSOptions)。
パラメーターのプロパティ
| 型: | PSSessionOption |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 3 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ShowBanner
適用対象: Exchange Online
ShowBanner スイッチは、Connect-ExchangeOnline の実行時に表示されるバナー メッセージを表示または非表示にします。 このスイッチで値を指定する必要はありません。
- バナーを表示するには、このスイッチを使用する必要はありません (バナーは既定で表示されます)。
- バナーを非表示にするには、次の正確な構文を使用します:
-ShowBanner:$false。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | $true |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ShowProgress
適用対象: Exchange Online
ShowProgress パラメーターは、接続時にインポートされたコマンドレットの進行状況バーを表示または非表示にするかどうかを指定します。 有効な値は次のとおりです。
- $true: 進行状況バーが表示されます。 この値が既定値です。
- $false: 現在、この値は無効です。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SigningCertificate
適用対象: Exchange Online
注: このパラメーターは、モジュールのバージョン 3.2.0 以降で使用できます。
SigningCertificate パラメーターは、フォーマット ファイル (* の署名に使用されるクライアント証明書を指定します。format.ps1xml) またはスクリプト モジュール ファイル (.psm1) は、Connect-ExchangeOnline 作成される一時モジュール内にあります。
このパラメーターの有効な値は、証明書を含む変数、または証明書を取得するコマンドまたは式です。
証明書を見つけるには、Microsoft.PowerShell.Security モジュールの Get-PfxCertificate コマンドレットを使用するか、証明書 (Cert:) ドライブの Get-ChildItem コマンドレットを使用します。 証明書が有効でない場合、または十分な権限がない場合、コマンドは失敗します。
パラメーターのプロパティ
| 型: | X509Certificate2 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SkipLoadingCmdletHelp
適用対象: Exchange Online
注: このパラメーターは、モジュールのバージョン 3.3.0 以降で使用できます。
バージョン 3.7.0-Preview1 以降では、このパラメーターは LoadCmdletHelp パラメーターに置き換えられます。 コマンドレット ヘルプ ファイルは既定でダウンロードされなくなったため、SkipLoadingCmdletHelp パラメーターは不要になり、何も行われなくなりました。
SkipLoadingCmdletHelp スイッチを使用すると、REST API 接続で Get-Help コマンドレットのコマンドレット ヘルプ ファイルをダウンロードできなくなります。 このスイッチで値を指定する必要はありません。
このスイッチを使用すると、コマンド ラインでコマンドレットのローカル ヘルプ ファイルは取得されません。
このスイッチは UseRPSSession スイッチでは機能しません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SkipLoadingFormatData
適用対象: Exchange Online
SkipLoadingFormatData スイッチを使用すると、REST API 接続のフォーマット データをダウンロードできなくなります。 このスイッチで値を指定する必要はありません。
このスイッチを使用すると、Exchange コマンドレットの出力は書式設定されません。
このスイッチを使用して、Windows サービスまたは Windows PowerShell SDK 内から Exchange Online PowerShell に接続するときのエラーを回避します。
このスイッチは UseRPSSession スイッチでは機能しません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-TrackPerformance
適用対象: Exchange Online
TrackPerformance パラメーターは、追加のイベント (CPU の負荷や消費されたメモリなど) を測定します。 有効な値は次のとおりです。
- $true: パフォーマンスの追跡が有効になっています。
- $false: パフォーマンスの追跡が無効になっています。 この値が既定値です。
このパラメーターは、ログ記録が有効になっている場合にのみ機能します。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UseMultithreading
適用対象: Exchange Online
UseMultithreading パラメーターは、Exchange Online PowerShell モジュールでマルチスレッドを無効にするか有効にするかを指定します。 有効な値は次のとおりです。
- $true: マルチスレッドを有効にします。 この値が既定値です。
- $false: マルチスレッドを無効にします。 この値は、モジュール内の 9 つの排他的 な Get-EXO* コマンドレットのパフォーマンスを低下させます。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UserPrincipalName
適用対象: Exchange Online
UserPrincipalName パラメーターは、接続に使用するアカウント (たとえば、 navin@contoso.onmicrosoft.com) を指定します。 このパラメーターを使用すると、先進の認証資格情報プロンプトでユーザー名の入力をスキップできます (パスワードの入力を求められます)。
UserPrincipalName パラメーターを使用する場合は、通常必要とする環境で MFA またはフェデレーション ユーザーに AzureADAuthorizationEndpointUri パラメーターを使用する必要はありません (UserPrincipalName または AzureADAuthorizationEndpointUri が必要です)。両方を使用する場合は OK)。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UseRPSSession
適用対象: Exchange Online
注: Exchange Online PowerShell へのリモート PowerShell 接続は非推奨です。 詳細については、「Exchange Onlineでのリモート PowerShell の非推奨」を参照してください。
UseRPSSession スイッチを使用すると、すべてのコマンドレットへの従来のリモート PowerShell アクセスを使用して、Exchange Online PowerShell に接続できます。 このスイッチで値を指定する必要はありません。
このスイッチでは、ローカル コンピューターの WinRM で基本認証が有効になっている必要があります。 詳細については、「 WinRM で基本認証を有効にする」を参照してください。
このスイッチを使用しない場合、接続には REST API モードが使用されるため、WinRM での基本認証は必要ありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。