Connect-IPPSSession

構文

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>]
    [-Organization <String>]
    [-UserPrincipalName <String>]
    [-UseRPSSession]
    [<CommonParameters>]

説明

例

例 1

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

例 2

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

例 3

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

例 4

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

パラメーター

-AccessToken

適用対象: Exchange Online

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

AccessToken パラメーターは、セキュリティおよびコンプライアンス PowerShell への接続に使用される OAuth JSON Web トークン (JWT) を指定します。

アクセス トークンの種類に応じて、Organization、DelegatedOrganization、または UserPrincipalName パラメーターでこのパラメーターを使用する必要があります。

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

パラメーター セット

-AppId

適用対象: Exchange Online

AppId パラメーターは、証明書ベースの認証 (CBA) で使用されるサービス プリンシパルのアプリケーション ID を指定します。 有効な値は、アプリケーション ID (サービス プリンシパル) の GUID です。 たとえば、「 36ee4c6c-0812-40a2-b820-b22ebd02bce3 」のように入力します。

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

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

パラメーター セット

-AzureADAuthorizationEndpointUri

適用対象: Exchange Online

AzureADAuthorizationEndpointUri パラメーターは、OAuth2 アクセス トークンを発行できるMicrosoft Entra承認エンドポイントを指定します。 次の 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)。

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

パラメーター セット

-BypassMailboxAnchoring

適用対象: Exchange Online

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

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

パラメーター セット

-Certificate

適用対象: Exchange Online

Certificate パラメーターは、証明書ベースの認証 (CBA) に使用される証明書を指定します。 有効な値は、証明書の X509Certificate2 オブジェクト値です。

CertificateFilePath パラメーターまたは CertificateThumbprint パラメーターでは、このパラメーターを使用しないでください。

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

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

パラメーター セット

-CertificateFilePath

適用対象: Exchange Online

CertificateFilePath パラメーターは、CBA に使用される証明書を指定します。 有効な値は、証明書ファイルへの完全なパブリック パスです。 このパラメーターで CertificatePassword パラメーターを使用します。

証明書パラメーターまたは CertificateThumbprint パラメーターでは、このパラメーターを使用しないでください。

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

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

パラメーター セット

-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 コマンドを使用して証明書のパスワードを安全に入力するように求めるのは、自動化シナリオには適していません。 つまり、ローカル証明書を使用して接続するための 自動化された安全 な方法はありません。

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

パラメーター セット

-CertificateThumbprint

適用対象: Exchange Online

CertificateThumbprint パラメーターは、CBA に使用される証明書を指定します。 有効な値は、証明書の拇印値です。 たとえば、「 83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1 」のように入力します。

Certificate パラメーターまたは CertificateFilePath パラメーターでは、このパラメーターを使用しないでください。

注: CertificateThumbprint パラメーターは、Microsoft Windows でのみサポートされています。

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

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

パラメーター セット

-CommandName

適用対象: Exchange Online

CommandName パラメーターは、セッションにインポートするコマンドのコンマ区切りリストを指定します。 特定のコマンドレットセットを使用するアプリケーションまたはスクリプトには、このパラメーターを使用します。 セッション内のコマンドレットの数を減らすことは、パフォーマンスの向上に役立ち、アプリケーションまたはスクリプトのメモリ占有領域を減らします。

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

パラメーター セット

-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/

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

パラメーター セット

-Credential

適用対象: Exchange Online

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

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

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

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

パラメーター セット

-DelegatedOrganization

適用対象: Exchange Online

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

認証が正常に完了すると、このセッションのコマンドレットが顧客organizationにマップされ、このセッションのすべての操作が顧客organizationで実行されます。

注:

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

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

パラメーター セット

-FormatTypeName

適用対象: Exchange Online

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

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

パラメーター セット

-Organization

適用対象: Exchange Online

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

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

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

パラメーター セット

-Prefix

適用対象: Exchange Online

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

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

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

パラメーター セット

-PSSessionOption

適用対象: Exchange Online

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

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

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

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

パラメーター セット

-UserPrincipalName

適用対象: Exchange Online

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

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

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

パラメーター セット

-UseRPSSession

適用対象: Exchange Online

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

注: セキュリティ & コンプライアンスへのリモート PowerShell 接続は非推奨です。 詳細については、「 セキュリティとコンプライアンス PowerShell でのリモート PowerShell の廃止」を参照してください。

UseRPSSession スイッチを使用すると、すべてのコマンドレットへの従来のリモート PowerShell アクセスを使用して、Security & Compliance PowerShell に接続できます。 このスイッチで値を指定する必要はありません。

このスイッチでは、ローカル コンピューターの WinRM で基本認証が有効になっている必要があります。 詳細については、「 WinRM で基本認証を有効にする」を参照してください。

このスイッチを使用しない場合、WinRM での基本認証は必要ありません。

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

パラメーター セット

CommonParameters