Commands › Exchange Online

Set-WebServicesVirtualDirectory

Exchange Online ExchangeOnlineManagement Set-*

Modify existing Exchange Web Services virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers.

Quick start script

# Set-WebServicesVirtualDirectory — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-WebServicesVirtualDirectory
$before | Format-List

# 3. Make the change (dry run first)
Set-WebServicesVirtualDirectory -Identity <VirtualDirectoryIdParameter> -WhatIf
Set-WebServicesVirtualDirectory -Identity <VirtualDirectoryIdParameter>

# 4. Verify and diff
$after = Get-WebServicesVirtualDirectory
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-WebServicesVirtualDirectory [-Identity] <VirtualDirectoryIdParameter>
 [-BasicAuthentication <Boolean>]
 [-CertificateAuthentication <Boolean>]
 [-Confirm]
 [-DigestAuthentication <Boolean>]
 [-DomainController <Fqdn>]
 [-ExtendedProtectionFlags <MultiValuedProperty>]
 [-ExtendedProtectionSPNList <MultiValuedProperty>]
 [-ExtendedProtectionTokenChecking <ExtendedProtectionTokenCheckingMode>]
 [-ExternalUrl <Uri>]
 [-Force]
 [-GzipLevel <GzipLevel>]
 [-InternalNLBBypassUrl <Uri>]
 [-InternalUrl <Uri>]
 [-MRSProxyEnabled <Boolean>]
 [-MRSProxyMaxConnections <Unlimited>]
 [-OAuthAuthentication <Boolean>]
 [-WhatIf]
 [-WindowsAuthentication <Boolean>]
 [-WSSecurityAuthentication <Boolean>]
 [<CommonParameters>]

Parameters (20)

Parameter	Type	Required	What it controls
-Identity	VirtualDirectoryIdParameter	yes	The Identity parameter specifies the EWS virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example:
-BasicAuthentication	Boolean		The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory. Valid values are:
-CertificateAuthentication	Boolean		The CertificateAuthentication parameter specifies whether certificate authentication is enabled. This parameter affects the `<Servername>/ews/management/` virtual directory. It doesn't affect the `<Servername>/ews/`...
-Confirm	SwitchParameter		The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-DigestAuthentication	Boolean		The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. Valid values are:
-DomainController	Fqdn		The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name...
-ExtendedProtectionFlags	MultiValuedProperty		The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are:
-ExtendedProtectionSPNList	MultiValuedProperty		The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are:
-ExtendedProtectionTokenChecking	ExtendedProtectionTokenCheckingMode		The ExtendedProtectionTokenChecking parameter specifies whether Extended Protection for Authentication is used for client connections to the virtual directory. Valid values are:
-ExternalUrl	Uri		The ExternalURL parameter specifies the URL that connects to the virtual directory from outside the firewall.
-Force	SwitchParameter		The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch.
-GzipLevel	GzipLevel		The GzipLevel parameter sets the Gzip configuration for the Exchange Web Services virtual directory. Valid values are:
-InternalNLBBypassUrl	Uri		Note: This parameter applies only to Exchange 2010. By default, Exchange 2013 or later already has the InternalNLBBypassUrl value configured on the backend Exchange Web Services (EWS) virtual directory on Mailbox servers.
-InternalUrl	Uri		The InternalURL parameter specifies the URL that connects to the virtual directory from inside the firewall.
-MRSProxyEnabled	Boolean		The MRSProxyEnabled parameter specifies whether to enable MRSProxy for the Exchange Web Services virtual directory on Exchange servers that have the Client Access server role installed. MRSProxy helps to proxy...
-MRSProxyMaxConnections	Unlimited		The MRSProxyMaxConnections parameter specifies the maximum number of simultaneous move sessions that an instance of MRSProxy accepts. This setting accepts values from 0 to unlimited. The default value is 100. For...
-OAuthAuthentication	Boolean		The OAuthAuthentication parameter specifies whether OAuth authentication is enabled on the virtual directory. Valid values are:
-WhatIf	SwitchParameter		The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.
-WindowsAuthentication	Boolean		The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory. Valid values are:
-WSSecurityAuthentication	Boolean		The WSSecurityAuthentication parameter specifies whether WS-Security (Web Services Security) authentication is enabled on the virtual directory. Valid values are:

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.