Connect-IPPSSession

このコマンドレットは、Exchange Online PowerShell モジュールでのみ使用できます。 詳細については、「Exchange Online PowerShell モジュールについて」を参照してください。

Exchange Online PowerShell モジュールの Connect-IPPSSession コマンドレットを使用して、先進認証を使用してセキュリティ & コンプライアンス PowerShell に接続します。 このコマンドレットは、MFA または MFA が有効になっていないアカウントに対して機能します。

: バージョン 3.2.0 以降のモジュールでは、事実上すべてのセキュリティ & コンプライアンス PowerShell コマンドレットに対して REST API モードがサポートされています (REST API モードには、ローカル コンピューター上の WinRM の基本認証は必要ありません)。 詳細については、「Exchange Online PowerShell モジュールの前提条件」を参照してください。

以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。

構文

Default (既定)

Connect-IPPSSession

    [[-ConnectionUri] <String>]
    [[-AzureADAuthorizationEndpointUri] <String>]
    [[-DelegatedOrganization] <String>]
    [[-PSSessionOption] <PSSessionOption>]
    [[-Prefix] <String>]
    [[-CommandName] <String[]>]
    [[-FormatTypeName] <String[]>]
    [-AccessToken <String>]
    [-AppId <String>]
    [-BypassMailboxAnchoring]
    [-Certificate <X509Certificate2>]
    [-CertificateFilePath <String>]
    [-CertificatePassword <SecureString>]
    [-CertificateThumbprint <String>]
    [-Credential <PSCredential>]
    [-DisableWAM]
    [-EnableErrorReporting]
    [-EnableSearchOnlySession]
    [-EXOModuleBasePath <String>]
    [-LogDirectoryPath <String>]
    [-LogLevel <LogLevel>]
    [-Organization <String>]
    [-ShowBanner]
    [-UserPrincipalName <String>]
    [-UseRPSSession]
    [<CommonParameters>]

説明

前提条件を含む接続手順の詳細については、「 Security & Compliance PowerShell への接続」を参照してください。

例 1

Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com

この例では、MFA の有無にかかわらず、指定されたアカウントと先進認証を使用してセキュリティ & コンプライアンス PowerShell に接続します。 v3.2.0 以降のモジュールでは、REST API モードで接続しているため、ローカル コンピューターでは WinRM の基本認証は必要ありません。

例 2

Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSession

この例では、MFA の有無にかかわらず、指定されたアカウントと先進認証を使用してセキュリティ & コンプライアンス PowerShell に接続します。 v3.2.0 以降のモジュールでは、リモート PowerShell モードで接続しているため、ローカル コンピューターでは WinRM の基本認証が必要です。

例 3

Connect-IPPSSession -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com"

この例では、証明書の拇印を使用して、無人スクリプト シナリオでセキュリティ & コンプライアンス PowerShell に接続します。

例 4

Connect-IPPSSession -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com"

この例では、証明書ファイルを使用して、無人スクリプト シナリオでセキュリティ & コンプライアンス PowerShell に接続します。 このメソッドは、証明書がリモート コンピューターに保存され、実行時にフェッチされるシナリオに最適です。 たとえば、証明書は Azure Key Vault に保存されます。

パラメーター

-AccessToken

適用対象: Exchange Online

: このパラメーターは、モジュール バージョン 3.8.0-Preview1 以降で使用できます。

AccessToken パラメーターは、セキュリティ/コンプライアンス PowerShell への接続に使用される 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

AzureADAuthorizationEndpointUri パラメーターは、OAuth2 アクセス トークンを発行できる Microsoft Entra 承認エンドポイントを指定します。 次の PowerShell 環境と関連する値がサポートされています。

  • Microsoft 365 または Microsoft 365 GCC のセキュリティ & コンプライアンス PowerShell: このパラメーターは使用しないでください。 必須値は https://login.microsoftonline.com/organizations ですが、これも既定値なので、このパラメーターを使用する必要はありません。
  • 21Vianet が運用するOffice 365のセキュリティ & コンプライアンス PowerShell:https://login.chinacloudapi.cn/organizations
  • Microsoft GCC High または Microsoft DoD のセキュリティ & コンプライアンス PowerShell: https://login.microsoftonline.us/organizations

/organizations で終わる URI 値は、職場または学校アカウントのみが許可されます。 /common で終わる古い URI 値は引き続き機能しますが、個人用アカウント アカウントと職場または学校アカウントのどちらかを選択するように求められる場合があります。 コンシューマー アカウントを除外する必要があるエンタープライズ シナリオでは、 /organizations URI 値をお勧めします。

UserPrincipalName パラメーターを使用する場合は、MFA または通常それを必要とする環境のフェデレーション ユーザーに AzureADAuthorizationEndpointUri パラメーターを使用する必要はありません (UserPrincipalName または AzureADAuthorizationEndpointUri が必要です。両方を使用しても問題ありません)。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:1
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-BypassMailboxAnchoring

適用対象: Exchange Online

BypassMailboxAnchoring スイッチは、メールボックス アンカー ヒントの使用をバイパスします。 このスイッチで値を指定する必要はありません。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Certificate

適用対象: Exchange Online

証明書パラメーターは、証明書ベースの認証 (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 パラメーターを使用します。

このパラメーターと Certificate または 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)
配置:5
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ConnectionUri

適用対象: Exchange Online

ConnectionUri パラメーターは、PowerShell セッションの接続エンドポイントを指定します。 次の PowerShell 環境と関連する値がサポートされています。

  • Microsoft 365 または Microsoft 365 GCC のセキュリティ & コンプライアンス PowerShell: このパラメーターは使用しないでください。 必須値は https://ps.compliance.protection.outlook.com/powershell-liveid/ ですが、これも既定値なので、このパラメーターを使用する必要はありません。
  • 21Vianet が運用するOffice 365のセキュリティ & コンプライアンス PowerShell:https://ps.compliance.protection.partner.outlook.cn/powershell-liveid
  • Microsoft GCC High のセキュリティ & コンプライアンス PowerShell: https://ps.compliance.protection.office365.us/powershell-liveid/
  • Microsoft DoD のセキュリティ & コンプライアンス PowerShell: https://l5.ps.compliance.protection.office365.us/powershell-liveid/

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:0
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Credential

適用対象: Exchange Online

資格情報パラメーターは、Exchange Online PowerShell への接続に使用するユーザー名とパスワードを指定します。 通常、このパラメーターはスクリプトや、必要なアクセス許可を持つ別の資格情報を入力する必要がある場合に使用します。 多要素認証 (MFA) を使用するアカウントには、このパラメーターを使用しないでください。

Connect-IPPSSession コマンドを実行する前に、ユーザー名とパスワードを変数 ( $UserCredential = Get-Credential など) に格納します。 次に、このパラメーターに変数名 ($UserCredential) を使用します。

Connect-IPPSSession コマンドが完了すると、変数内のパスワード キーが空になります。

パラメーターのプロパティ

型:PSCredential
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DelegatedOrganization

適用対象: Exchange Online

DelegatedOrganization パラメータは、管理する顧客organizationを指定します (contosoelectronics.onmicrosoft.com など)。 このパラメータは、顧客organizationがCSPプログラムを介して委任された管理に同意した場合にのみ機能します。

認証に成功すると、このセッションのコマンドレットは customer organization にマッピングされ、このセッションのすべての操作は customer organization で実行されます。

:

  • このパラメーターの値には、委任されたorganizationのプライマリ .onmicrosoft.com ドメインを使用します。
  • このパラメーターと共に AzureADAuthorizationEndpointUri パラメーターを使用する必要があります。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:2
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DisableWAM

適用対象: Exchange Online

: このパラメーターは、モジュール バージョン 3.7.2-Preview1 以降で使用できます。

DisableWAM スイッチは、Web アカウント マネージャー (WAM) を無効にします。 このスイッチで値を指定する必要はありません。

サインイン中に WAM 関連の問題が発生した場合は、このスイッチを使用して WAM を無効にできます。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-EnableErrorReporting

適用対象: Exchange Online

: このパラメーターは、モジュール バージョン 3.8.1-Preview1 以降で使用できます。

EnableErrorReporting スイッチは、エラー報告を有効にするかどうかを指定します。 このスイッチで値を指定する必要はありません。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-EnableSearchOnlySession

適用対象: Exchange Online

: このパラメーターは、モジュール バージョン 3.9.0-Preview1 以降で使用できます。

EnableSearchOnlySession スイッチは、他の Microsoft 365 サービスに接続する特定の電子情報開示および関連コマンドレットを有効にするかどうかを指定します。 このスイッチで値を指定する必要はありません。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-EXOModuleBasePath

適用対象: Exchange Online

: このパラメーターは、モジュール バージョン 3.9.1-Preview1 以降で使用できます。

EXOModuleBasePath パラメーターは、Exchange Online PowerShell モジュールのローカル一時コピーが保存されているフォルダーを指定します。 値にスペースが含まれている場合は、値を二重引用符 (") で囲んでください。

Connect-ExchangeOnline コマンドは、セッション接続のために、Exchange Online モジュールの一時コピーをクライアントのローカルに保存します。 既定では、モジュールの一時コピーは %TMP% フォルダー (既定では C:\Users\<UserName>\AppData\Local\Temp) に保存されます。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-FormatTypeName

適用対象: Exchange Online

FormatTypeName パラメーターは、コマンドレットの出力形式を指定します。

パラメーターのプロパティ

型:

String[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:6
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-LogDirectoryPath

適用対象: Exchange Online

: このパラメーターは、モジュール バージョン 3.8.1-Preview1 以降で使用できます。

LogDirectoryPath パラメーターでは、ログ ファイルの場所を指定します。 既定の場所は %TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv です。

スペースを含むカスタム ロケーションとファイル名を指定する場合は、値を引用符 (") で囲みます。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-LogLevel

適用対象: Exchange Online

: このパラメーターは、モジュール バージョン 3.8.1-Preview1 以降で使用できます。

LogLevel パラメーターは、ログ レベルを指定します。 有効な値は、Default と All です。

パラメーターのプロパティ

型:LogLevel
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Organization

適用対象: Exchange Online

Organization パラメーターは、CBA を使用して接続するときに organization を指定します。 このパラメーターの値には、organizationのプライマリ .onmicrosoft.com ドメインを使用する必要があります。

CBA の詳細については、「Exchange Online PowerShell モジュールの無人スクリプトのアプリのみの認証」を参照してください。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Prefix

適用対象: Exchange Online

Prefix パラメーターは、接続時にセキュリティ & コンプライアンスの PowerShell コマンドレットの名前に追加するテキスト値を指定します。 たとえば、このパラメーターに値 Contoso を使用すると、Get-ComplianceCase は Get-ContosoComplianceCase になります。

  • プレフィックスの値には、スペースや、アンダースコアやアスタリスクなどの特殊文字を含めることはできません。
  • プレフィックス値 EXO は使用できません。 この値は、モジュールに組み込まれている 9 つの排他的 Get-EXO* コマンドレット用に予約されています。
  • Prefix パラメーターは、インポートされたセキュリティ & コンプライアンスのコマンドレット名にのみ影響します。 モジュールに組み込まれているコマンドレットの名前 (Disconnect-ExchangeOnline など) には影響しません。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:4
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-PSSessionOption

適用対象: Exchange Online

: このパラメーターは REST API 接続では機能しません。

PSSessionOption パラメーターは、セキュリティ & コンプライアンス PowerShell への接続で使用するリモート PowerShell セッション オプションを指定します。 このパラメータは、同じコマンドで UseRPSSession スイッチも使用する場合にのみ機能します。

New-PSSessionOption コマンドの出力を変数 ($PSOptions = New-PSSessionOption <Settings> など) に格納し、変数名をこのパラメーターの値 ($PSOptions など) として使用します。

パラメーターのプロパティ

型:PSSessionOption
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:3
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ShowBanner

適用対象: Exchange Online

: このパラメータは、モジュール バージョン 3.2.0 以降で使用できます。

ShowBanner スイッチは、Connect-IPPSSession の実行時に表示されるバナー メッセージを表示または非表示にします。 このスイッチで値を指定する必要はありません。

  • バナーを表示するために、このスイッチを使用する必要はありません (バナーは既定で表示されます)。
  • バナーを非表示にするには、次の正確な構文を使用します。 -ShowBanner:$false

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-UserPrincipalName

適用対象: Exchange Online

UserPrincipalName パラメーターには、接続に使用するアカウントを指定します ( navin@contoso.onmicrosoft.com など)。 このパラメーターを使用すると、先進認証の資格情報プロンプトでのユーザー名の入力をスキップできます (パスワードの入力が求められます)。

UserPrincipalName パラメーターを使用する場合は、MFA または通常それを必要とする環境のフェデレーション ユーザーに AzureADAuthorizationEndpointUri パラメーターを使用する必要はありません (UserPrincipalName または AzureADAuthorizationEndpointUri が必要です。両方を使用しても問題ありません)。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-UseRPSSession

適用対象: Exchange Online

: このパラメーターは、モジュール バージョン 3.9.2 以降では非推奨です。 セキュリティ & コンプライアンス PowerShell へのリモート PowerShell 接続は、2023 年 10 月に非推奨となりました。 詳細については、「 セキュリティとコンプライアンスの PowerShell でのリモート PowerShell の廃止」を参照してください。

パラメーターのプロパティ

型: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」を参照してください。