Connect-IPPSSession
このコマンドレットは、Exchange Online PowerShell モジュールでのみ使用できます。 詳細については、「Exchange Online PowerShell モジュールについて」を参照してください。
Exchange Online PowerShell モジュールの Connect-IPPSSession コマンドレットを使用して、先進認証を使用してセキュリティ & コンプライアンス PowerShell PowerShell に接続します。 このコマンドレットは、MFA または MFA が有効でないアカウントに対して機能します。
注: モジュールのバージョン 3.2.0 以降では、ほとんどのセキュリティ & コンプライアンス PowerShell コマンドレットで REST API モードがサポートされています (ローカル コンピューターの WinRM での基本認証は REST API モードでは必要ありません)。 詳細については、「Exchange Online PowerShell モジュールの前提条件」を参照してください。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Connect-IPPSSession
[[-ConnectionUri] <String>]
[[-AzureADAuthorizationEndpointUri] <String>]
[[-DelegatedOrganization] <String>]
[[-PSSessionOption] <PSSessionOption>]
[[-Prefix] <String>]
[[-CommandName] <String[]>]
[[-FormatTypeName] <String[]>]
[-AppId <String>]
[-BypassMailboxAnchoring]
[-Certificate <X509Certificate2>]
[-CertificateFilePath <String>]
[-CertificatePassword <SecureString>]
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-Organization <String>]
[-UserPrincipalName <String>]
[-UseRPSSession]
[<CommonParameters>]説明
前提条件を含む詳細な接続手順については、「 セキュリティ & コンプライアンス 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に格納されます。
パラメーター
-AppId
AppId パラメーターは、証明書ベースの認証 (CBA) で使用されるサービス プリンシパルのアプリケーション ID を指定します。 有効な値は、アプリケーション ID (サービス プリンシパル) の GUID です。 たとえば、「 36ee4c6c-0812-40a2-b820-b22ebd02bce3 」のように入力します。
詳細については、「Exchange Online PowerShell モジュールの無人スクリプトのアプリ専用認証」を参照してください。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-AzureADAuthorizationEndpointUri
AzureADAuthorizationEndpointUri パラメーターは、OAuth2 アクセス トークンを発行できる Azure AD 承認エンドポイントを指定します。 次の PowerShell 環境と関連する値がサポートされています。
- Microsoft 365 または Microsoft 365 GCC のセキュリティ & コンプライアンス PowerShell: このパラメーターは使用しないでください。 必要な値は
https://login.microsoftonline.com/commonですが、これも既定値であるため、このパラメーターを使用する必要はありません。 - 21Vianet が運営するOffice 365のセキュリティ & コンプライアンス PowerShell:
https://login.chinacloudapi.cn/common - Microsoft GCC High または Microsoft DoD のセキュリティ & コンプライアンス PowerShell:
https://login.microsoftonline.us/common
UserPrincipalName パラメーターを使用する場合は、通常必要とする環境で MFA またはフェデレーション ユーザーに AzureADAuthorizationEndpointUri パラメーターを使用する必要はありません (UserPrincipalName または AzureADAuthorizationEndpointUri が必要です)。両方を使用する場合は OK)。
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-BypassMailboxAnchoring
BypassMailboxAnchoring スイッチは、メールボックス のアンカー ヒントの使用をバイパスします。 このスイッチで値を指定する必要はありません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Certificate
Certificate パラメーターは、証明書ベースの認証 (CBA) に使用される証明書を指定します。 有効な値は、証明書の X509Certificate2 オブジェクト値です。
CertificateFilePath パラメーターまたは CertificateThumbprint パラメーターでは、このパラメーターを使用しないでください。
CBA の詳細については、「Exchange Online PowerShell モジュールの無人スクリプトのアプリ専用認証」を参照してください。
| Type: | X509Certificate2 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-CertificateFilePath
CertificateFilePath パラメーターは、CBA に使用される証明書を指定します。 有効な値は、証明書ファイルへの完全なパブリック パスです。 このパラメーターで CertificatePassword パラメーターを使用します。
証明書パラメーターまたは CertificateThumbprint パラメーターでは、このパラメーターを使用しないでください。
CBA の詳細については、「Exchange Online PowerShell モジュールの無人スクリプトのアプリ専用認証」を参照してください。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-CertificatePassword
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 コマンドを使用して証明書のパスワードを安全に入力するように求めるのは、自動化シナリオには適していません。 つまり、ローカル証明書を使用して接続するための 自動化された安全 な方法はありません。
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-CertificateThumbprint
CertificateThumbprint パラメーターは、CBA に使用される証明書を指定します。 有効な値は、証明書の拇印値です。 たとえば、「 83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1 」のように入力します。
Certificate パラメーターまたは CertificateFilePath パラメーターでは、このパラメーターを使用しないでください。
注: CertificateThumbprint パラメーターは、Microsoft Windows でのみサポートされています。
CBA の詳細については、「Exchange Online PowerShell モジュールの無人スクリプトのアプリ専用認証」を参照してください。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-CommandName
CommandName パラメーターは、セッションにインポートするコマンドのコンマ区切りリストを指定します。 特定のコマンドレットセットを使用するアプリケーションまたはスクリプトには、このパラメーターを使用します。 セッション内のコマンドレットの数を減らすことは、パフォーマンスの向上に役立ち、アプリケーションまたはスクリプトのメモリ占有領域を減らします。
| Type: | String[] |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-ConnectionUri
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/
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Credential
Credential パラメーターは、PowerShell への接続に使用するユーザー名とパスワードExchange Online指定します。 通常、このパラメーターはスクリプトや、必要なアクセス許可を持つ別の資格情報を入力する必要がある場合に使用します。 多要素認証 (MFA) を使用するアカウントには、このパラメーターを使用しないでください。
Connect-IPPSSession コマンドを実行する前に、ユーザー名とパスワードを変数 (例: $UserCredential = Get-Credential) に格納します。 次に、このパラメーターに変数名 ($UserCredential) を使用します。
Connect-IPPSSession コマンドが完了すると、変数のパスワード キーが空になります。
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-DelegatedOrganization
DelegatedOrganization パラメーターは、管理する顧客organizationを指定します (たとえば、contosoelectronics.onmicrosoft.com)。 このパラメーターは、顧客organizationが CSP プログラムを介して委任された管理に同意した場合にのみ機能します。
認証が正常に完了すると、このセッションのコマンドレットが顧客organizationにマップされ、このセッションのすべての操作が顧客organizationで実行されます。
注:
- このパラメーターの値には、委任されたorganizationのプライマリ .onmicrosoft.com ドメインを使用します。
- このパラメーターで AzureADAuthorizationEndpointUri パラメーターを使用する必要があります。
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-FormatTypeName
FormatTypeName パラメーターは、コマンドレットの出力形式を指定します。
| Type: | String[] |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Organization
Organization パラメーターは、CBA を使用して接続するときにorganizationを指定します。 このパラメーターの値には、organizationのプライマリ .onmicrosoft.com ドメインを使用する必要があります。
CBA の詳細については、「Exchange Online PowerShell モジュールの無人スクリプトのアプリ専用認証」を参照してください。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Prefix
Prefix パラメーターは、接続時にセキュリティ & コンプライアンス PowerShell コマンドレットの名前に追加するテキスト値を指定します。 たとえば、このパラメーターに Contoso という値を使用すると、Get-ComplianceCaseはGet-ContosoComplianceCaseになります。
- Prefix 値には、アンダースコアやアスタリスクなどのスペースや特殊文字を含めることはできません。
- プレフィックス値 EXO は使用できません。 この値は、モジュールに組み込まれている 9 つの排他的 な Get-EXO* コマンドレット用に予約されています。
- Prefix パラメーターは、インポートされたセキュリティ & コンプライアンス コマンドレット名にのみ影響します。 モジュールに組み込まれているコマンドレットの名前 (Disconnect-ExchangeOnline など) には影響しません。
| Type: | String |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-PSSessionOption
PSSessionOption パラメーターは、セキュリティ & コンプライアンス PowerShell への接続で使用するリモート PowerShell セッション オプションを指定します。
New-PSSessionOption コマンドの出力を変数 (たとえば) に格納し、$PSOptions = New-PSSessionOption <Settings>このパラメーターの値として変数名を使用します (例: $PSOptions)。
| Type: | PSSessionOption |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-UserPrincipalName
UserPrincipalName パラメーターは、 navin@contoso.onmicrosoft.com接続に使用するアカウントを指定します (例: )。 このパラメーターを使用すると、先進の認証資格情報プロンプトでユーザー名の入力をスキップできます (パスワードの入力を求められます)。
UserPrincipalName パラメーターを使用する場合は、通常必要とする環境で MFA またはフェデレーション ユーザーに AzureADAuthorizationEndpointUri パラメーターを使用する必要はありません (UserPrincipalName または AzureADAuthorizationEndpointUri が必要です)。両方を使用する場合は OK)。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-UseRPSSession
このパラメーターは、モジュールのバージョン 3.2.0 以降で使用できます。
UseRPSSession スイッチを使用すると、すべてのコマンドレットへの従来のリモート PowerShell アクセスを使用して、セキュリティ & コンプライアンス PowerShell に接続できます。 このスイッチで値を指定する必要はありません。
このスイッチでは、ローカル コンピューターの WinRM で基本認証が有効になっている必要があります。 詳細については、「 WinRM で基本認証を有効にする」を参照してください。
このスイッチを使用しない場合、WinRM での基本認証は必要ありません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |