Set-WebServicesVirtualDirectory (RTM)
Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.
Applies to: Exchange Server 2007
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>] [-DigestAuthentication <$true | $false>] [-DomainController <Fqdn>] [-ExternalUrl <Url>] [-InternalUrl <Url>] [-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 servers in the networked load balanced servers.
To run the Set-WebServicesVirtualDirectory cmdlet, the account you use must be delegated the following:
- Exchange Server Administrator role and 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. |
DigestAuthentication |
Optional |
System.Boolean |
This parameter specifies whether Digest authentication is enabled on the virtual directory. |
DomainController |
Optional |
System.String |
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. |
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. |
WindowsAuthentication |
Optional |
System.Boolean |
This parameter specifies whether Windows Integrated 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.aspx -ExternalAuthenticationMethods Basic -InternalUrl https://contoso.internal.com/EWS/webservices.aspx
Set-WebServicesVirtualDirectory -Identity Contoso\EWS* -ExternalUrl https://www.contoso.com/ews/exchange.aspx