Set-WebServicesVirtualDirectory
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Set-WebServicesVirtualDirectory cmdlet lets you modify an existing Exchange Web Services virtual directory on an Exchange 2007 computer that has the Client Access server role installed.
Syntax
Set-WebServicesVirtualDirectory -Identity <VirtualDirectoryIdParameter> [-BasicAuthentication <$true | $false>] [-Confirm [<SwitchParameter>]] [-DigestAuthentication <$true | $false>] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-InternalNLBBypassUrl <Uri>] [-InternalUrl <Uri>] [-WhatIf [<SwitchParameter>]] [-WindowsAuthentication <$true | $false>]
Set-WebServicesVirtualDirectory [-BasicAuthentication <$true | $false>] [-Confirm [<SwitchParameter>]] [-DigestAuthentication <$true | $false>] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-Instance <ADWebServicesVirtualDirectory>] [-InternalNLBBypassUrl <Uri>] [-InternalUrl <Uri>] [-WhatIf [<SwitchParameter>]] [-WindowsAuthentication <$true | $false>]
Detailed Description
The Set-WebServicesVirtualDirectory cmdlet lets you modify an existing Exchange Web Services virtual directory on an Exchange 2007 Client Access server.
Note
If you have a load balanced set of Client Access servers, you do not have to specify the name of each server when you run the cmdlet. It is sufficient to use only the name of one of the networked load balanced servers.
To run the Set-WebServicesVirtualDirectory cmdlet, the account you use must be delegated the Exchange Server Administrator role and membership in the local Administrators group for the target server.
For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter |
This parameter specifies the name of the virtual directory. You can also specify a wildcard character instead of the Default Web site. |
BasicAuthentication |
Optional |
System.Boolean |
This parameter specifies whether Basic authentication is enabled on the Exchange Web Services virtual directory. This parameter can be used with FormsAuthentication or with DigestAuthentication and WindowsAuthentication. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You do not have to specify a value with the Confirm parameter. |
DigestAuthentication |
Optional |
System.Boolean |
This parameter specifies whether Digest authentication is enabled on the virtual directory. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from the Active Directory directory service, include the DomainController parameter in the cmdlet. |
ExternalUrl |
Optional |
System.Uri |
This parameter specifies the host name that will be used to connect to the Exchange server from outside the firewall. This setting is also important when Secure Sockets Layer (SSL) is used. |
Instance |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.ADWebServicesVirtualDirectory |
The Instance parameter enables you to pass an entire object to the cmdlet to be processed. |
InternalNLBBypassUrl |
Optional |
System.Uri |
This parameter specifies the URL of the Client Access server even if the Client Access server is behind a network load balancer (NLB). |
InternalUrl |
Optional |
System.Uri |
This parameter specifies the host name of the Exchange server for connection from inside the firewall. This setting is also important when SSL is used. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf parameter. |
WindowsAuthentication |
Optional |
System.Boolean |
This parameter specifies whether Integrated Windows authentication is permitted on the Exchange Web Services virtual directory. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The following code example sets the authentication method to Basic authentication for the virtual directory named "EWS" on the server named "Contoso". This code example also sets the external and internal URLs for this virtual directory.
The second code example uses a wildcard character instead of "default Web site".
Set-WebServicesVirtualDirectory -Identity Contoso\EWS(default web site)-ExternalUrl https://www.contoso.com/EWS/exchange.asmx - BasicAuthentication $true InternalUrl https://contoso.internal.com/EWS/webservices.asmx
Set-WebServicesVirtualDirectory -Identity Contoso\EWS* -ExternalUrl https://www.contoso.com/ews/exchange.asmx