Set-EcpVirtualDirectory

モジュール:
Exchange PowerShell

このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。

Set-EcpVirtualDirectory コマンドレットを使用して、Microsoft Exchange サーバー上のインターネット インフォメーション サービス (IIS) で使用される Exchange コントロール パネル (ECP) 仮想ディレクトリを変更します。 ECP 仮想ディレクトリは、Exchange 管理センターを管理します。

ECP Web 管理インターフェイスは、Exchange Server 2010 で導入されました。 Exchange Server 2013 および Exchange Server 2016 では、EAC 仮想ディレクトリと対応する管理コマンドレットは、名前に ECP を引き続き使用します。 これらのコマンドレットを使用して、Exchange 2010、Exchange 2013、および Exchange 2016 サーバー上の ECP 仮想ディレクトリを管理できます。

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

構文

Default (既定) 

Set-EcpVirtualDirectory
    [-Identity] <VirtualDirectoryIdParameter>
    [-AdfsAuthentication <Boolean>]
    [-AdminEnabled <Boolean>]
    [-BasicAuthentication <Boolean>]
    [-Confirm]
    [-DigestAuthentication <Boolean>]
    [-DomainController <Fqdn>]
    [-ExtendedProtectionFlags <MultiValuedProperty>]
    [-ExtendedProtectionSPNList <MultiValuedProperty>]
    [-ExtendedProtectionTokenChecking <ExtendedProtectionTokenCheckingMode>]
    [-ExternalAuthenticationMethods <MultiValuedProperty>]
    [-ExternalUrl <Uri>]
    [-FormsAuthentication <Boolean>]
    [-GzipLevel <GzipLevel>]
    [-InternalUrl <Uri>]
    [-OAuthAuthentication <Boolean>]
    [-OwaOptionsEnabled <Boolean>]
    [-WhatIf]
    [-WindowsAuthentication <Boolean>]
    [<CommonParameters>]

説明

このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事にはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。

例

例 1

Set-EcpVirtualDirectory -Identity "Server01\ecp (Default Web site)" -BasicAuthentication:$false

この例では、Server01 というサーバー上の既定の ECP 仮想ディレクトリで基本認証を無効にします。

例 2

Set-EcpVirtualDirectory -Identity "Server01\ecp (Default Web site)" -AdminEnabled $false

次の使用例は、Server01 というサーバー上の EAC へのインターネット アクセスをオフにします。

パラメーター

-AdfsAuthentication

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

AdfsAuthentication パラメーターは、ECP 仮想ディレクトリでユーザーがActive Directory フェデレーション サービス (AD FS) (AD FS) 認証を介して認証できるように指定します。 このパラメーターには $true または $false を指定できます。 既定値は $false です。

Set-OwaVirtualDirectory と Set-EcpVirtualDirectory の ADFS 認証の設定には関連があります。 Set-OwaVirtualDirectory の AdfsAuthentication パラメーターを $true に設定する前に、Set-EcpVirtualDirectory の AdfsAuthentication パラメーターを $true に設定する必要があります。 同様に、Set-EcpVirtualDirectory の AdfsAuthentication パラメーターを $false に設定する前に、Set-OwaVirtualDirectory の AdfsAuthentication パラメーターを $false に設定する必要があります。

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

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

パラメーター セット

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

-AdminEnabled

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

AdminEnabled パラメーターは、インターネットで EAC にアクセスできないようにすることを指定します。 詳細については、「Exchange 管理センターへのアクセスをオフにする」をご覧ください。 このパラメーターには $true または $false を指定できます。

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

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

パラメーター セット

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

-BasicAuthentication

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

BasicAuthentication パラメーターは、仮想ディレクトリで基本認証を有効にするかどうかを指定します。 有効な値は次のとおりです。

  • $true: 基本認証が有効になっています。 この値が既定値です。
  • $true: 基本認証を有効にします。これが既定値です。

このパラメーターを FormsAuthentication パラメーターや DigestAuthentication パラメーターおよび WindowsAuthentication パラメーターと一緒に使用することはできません。

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

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

パラメーター セット

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

-Confirm

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 この切り替えがコマンドレットにどのように影響するかは、続行する前にコマンドレットで確認が必要かどうかによって異なります。

  • データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文-Confirm:$falseを使用して、確認プロンプトを省略できます。
  • 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットでは、値を指定せずに [確認] スイッチを指定すると、続行する前にコマンドの確認を強制する一時停止が発生します。

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

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

パラメーター セット

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

-DigestAuthentication

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

DigestAuthentication パラメーターは、仮想ディレクトリでダイジェスト認証を有効にするかどうかを指定します。 有効な値は次のとおりです。

  • $true: ダイジェスト認証が有効になっています。
  • $false: ダイジェスト認証が無効になっています。 この値が既定値です。

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

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

パラメーター セット

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

-DomainController

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。

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

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

パラメーター セット

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

-ExtendedProtectionFlags

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

ExtendedProtectionFlags パラメーターは、仮想ディレクトリでの認証の拡張保護のカスタム設定を指定します。 有効な値は次のとおりです。

  • [なし] : 既定の設定です。
  • AllowDotlessSPN: FQDN を含まないサービス プリンシパル名 (SPN) 値 (HTTP/mail.contoso.com ではなく HTTP/ContosoMail など) を使用する場合は必須です。 SPN は ExtendedProtectionSPNList パラメーターで指定します。 この設定では、ドットレス証明書が一意ではないので、セキュリティで保護されたチャネル経由でクライアントとプロキシの接続が確立されたことを確認できないため、認証の拡張保護のセキュリティが低下します。
  • NoServiceNameCheck: SPN リストは、チャネル バインド トークンを検証するためにチェックされません。 この設定により、認証の拡張保護のセキュリティが低下します。 通常、この設定はお勧めしません。
  • プロキシ: プロキシ サーバーは、TLS チャネルの終了を担当します。 この設定を使用するには、ExtendedProtectionSPNList パラメーターを使用して SPN を登録する必要があります。
  • ProxyCoHosting: HTTP トラフィックと HTTPS トラフィックが仮想ディレクトリにアクセスしている可能性があり、プロキシ サーバーは少なくとも一部のクライアントと Exchange サーバー上のクライアント アクセス サービスの間にあります。

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

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

パラメーター セット

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

-ExtendedProtectionSPNList

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

ExtendedProtectionSPNList パラメーターは、仮想ディレクトリで認証に拡張保護を使用している場合に、有効なサービス プリンシパル名 (SPN) の一覧を指定します。 有効な値は次のとおりです。

  • $null: この値が既定値です。
  • 有効な SPN の単一 SPN またはコンマ区切りリスト: SPN 値の形式が Protocol\FQDN。 たとえば、HTTP/mail.contoso.com。 FQDN ではない SPN (HTTP/ContosoMail など) を追加するには、ExtendedProtectionFlags パラメーターに AllowDotlessSPN 値も使用する必要があります。

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

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

パラメーター セット

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

-ExtendedProtectionTokenChecking

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

ExtendedProtectionTokenChecking パラメーターは、認証の拡張保護を仮想ディレクトリへのクライアント接続に使用するかどうかを指定します。 有効な値は次のとおりです。

  • なし: 認証の拡張保護は、仮想ディレクトリへのクライアント接続には使用されません。 この値が既定値です。
  • 許可: 認証の拡張保護は、クライアントとサーバーの両方で仮想ディレクトリがサポートされている場合に、仮想ディレクトリへのクライアント接続に使用されます。
  • 必須: 仮想ディレクトリへのクライアント接続には、認証の拡張保護が必要です。 クライアントまたはサーバーがサポートしていない場合、接続は失敗します。 この値には、ExtendedProtectionSPNList パラメーターのサービス プリンシパル名 (SPN) 値も必要です。

注: Exchange サーバーの前にあるプロキシ サーバーがクライアントからプロキシへのトランスポート層セキュリティ (TLS) チャネルを終了する場合、[許可] または [必要] の値には ExtendedProtectionSPNList パラメーターに 1 つ以上の SPN 値が必要です。

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

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

パラメーター セット

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

-ExternalAuthenticationMethods

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

ExternalAuthenticationMethods パラメーターは、ファイアウォールの外部から Exchange サーバーでサポートされる認証方法を指定します。

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

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

パラメーター セット

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

-ExternalUrl

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

ExternalURL パラメーターは、ファイアウォールの外部から仮想ディレクトリに接続する URL を指定します。

このパラメーターの値は、接続がトランスポート層セキュリティ (TLS) によって暗号化される場合に重要です。

自動検出サービスが ECP 仮想ディレクトリの URL を返せるようにするには、このパラメーターの値を指定する必要があります。

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

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

パラメーター セット

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

-FormsAuthentication

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

FormsAuthentication パラメーターは、ECP 仮想ディレクトリに対してフォームベース認証を有効にするかどうかを指定します。 有効な値は次のとおりです。

  • $true: フォーム認証が有効になっています。 BasicAuthentication パラメーターは $true に設定され、DigestAuthentication パラメーターと WindowsAuthentication パラメーターは $false に設定されます。
  • $false: フォーム認証が無効になっています。

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

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

パラメーター セット

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

-GzipLevel

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

GzipLevel パラメーターは、ECP 仮想ディレクトリの Gzip 構成情報を設定します。

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

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

パラメーター セット

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

-Identity

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

Identity パラメーターは、変更する ECP 仮想ディレクトリを指定します。 仮想ディレクトリを一意に識別する任意の値を使用できます。 例:

  • 名前またはサーバー\Name
  • 識別名 (DN)
  • GUID

Name 値は、仮想ディレクトリのプロパティから "VirtualDirectoryName (WebsiteName)" 構文を使用します。 構文 VirtualDirectoryName*を使用して、既定の Web サイトではなくワイルドカード文字 (*) を指定できます。

Exchange organizationで作成された最初の ECP 仮想ディレクトリを管理するには、最初の ECP 仮想ディレクトリを含むコンピューターでこのコマンドレットを使用する必要があります。 追加の ECP 仮想ディレクトリを作成した場合、それらをリモートから管理できます。

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

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

パラメーター セット

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

-InternalUrl

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

InternalURL パラメーターは、ファイアウォール内から仮想ディレクトリに接続する URL を指定します。

このパラメーターの値は、接続がトランスポート層セキュリティ (TLS) によって暗号化される場合に重要です。

自動検出サービスが ECP 仮想ディレクトリの URL を返せるようにするには、このパラメーターの値を指定する必要があります。

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

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

パラメーター セット

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

-OAuthAuthentication

適用対象: Exchange Server 2019、Exchange Server SE

{{ Fill OAuthAuthentication Description }}

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

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

パラメーター セット

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

-OwaOptionsEnabled

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

OwaOptionsEnabled パラメーターは、エンド ユーザーに対して Outlook on the web オプションが有効になっていることを指定します。 このパラメーターが $false に設定されている場合、ユーザーは Outlook on the web オプションにアクセスできません。 organizationが Microsoft 以外のプロバイダー ツールを使用している場合は、アクセスを無効にすることができます。 このパラメーターには $true または $false を指定できます。

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

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

パラメーター セット

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

-WhatIf

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

WhatIf スイッチは、変更を加えずにコマンドの動作を示します。 このスイッチで値を指定する必要はありません。

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

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

パラメーター セット

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

-WindowsAuthentication

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE

WindowsAuthentication パラメーターは、仮想ディレクトリで統合Windows 認証を有効にするかどうかを指定します。 有効な値は次のとおりです。

  • $true: 統合Windows 認証が有効になっています。 この値が既定値です。
  • $false: 統合Windows 認証が無効になっています。

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

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

パラメーター セット

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

CommonParameters

このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、「about_CommonParameters」を参照してください。

入力

Input types

このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。

出力

Output types

このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。