.png)
New-WebServicesVirtualDirectory
Applies to: Exchange Server 2010
Topic Last Modified: 2011-03-19
Use the New-WebServicesVirtualDirectory cmdlet to create an Exchange Web Services virtual directory on a server running Microsoft Exchange Server 2010 that has the Client Access server role installed.
New-WebServicesVirtualDirectory [-ApplicationRoot <String>] [-AppPoolId <String>] [-AppPoolIdForManagement <String>] [-BasicAuthentication <$true | $false>] [-Confirm [<SwitchParameter>]] [-DigestAuthentication <$true | $false>] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-Force <SwitchParameter>] [-GzipLevel <Off | Low | High | Error>] [-InternalNLBBypassUrl <Uri>] [-InternalUrl <Uri>] [-Path <String>] [-WebSiteName <String>] [-WhatIf [<SwitchParameter>]] [-WindowsAuthentication <$true | $false>] [-WSSecurityAuthentication <$true | $false>]
| Parameter | Required | Type | Description |
|---|---|---|---|
|
ApplicationRoot |
Optional |
System.String |
The ApplicationRoot parameter sets the metabase path of the virtual directory. By default, this path is the same as the Web site in which the virtual directory is created. |
|
AppPoolId |
Optional |
System.String |
The AppPoolId parameter sets the pool of programs that can be used with the virtual directory. |
|
AppPoolIdForManagement |
Optional |
System.String |
The AppPoolIdForManagement parameter specifies the pool of programs that manages the virtual directory. |
|
BasicAuthentication |
Optional |
System.Boolean |
The BasicAuthentication parameter specifies whether Basic authentication is enabled on the Exchange Web Services virtual directory. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
DigestAuthentication |
Optional |
System.Boolean |
The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
|
ExternalUrl |
Optional |
System.Uri |
The ExternalUrl parameter specifies the host name used to connect to the Exchange server from outside the firewall. This setting is also important when Secure Sockets Layer (SSL) is used. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
The Force parameter specifies whether to suppress the warning or confirmation messages that appear during specific configuration changes. |
|
GzipLevel |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.GzipLevel |
The GzipLevel parameter sets Gzip configuration information for the Exchange Web Services virtual directory. This parameter can be set to the following values:
|
|
InternalNLBBypassUrl |
Optional |
System.Uri |
The InternalNLBBypassUrl parameter specifies the URL of the Client Access server, regardless of whether it's behind a Network Load Balancing (NLB) array. Although the InternalUrl parameter is set to the URL of the NLB array, the InternalNLBBypassUrl parameter should always be set to the URL of the Client Access server. This is because certain Exchange Web Services calls require machine affinity, and Exchange Web Services proxy incoming calls to a more appropriate Client Access server whenever possible. |
|
InternalUrl |
Optional |
System.Uri |
The InternalUrl parameter specifies the host name of the Exchange server for a connection from inside the firewall. This setting is also important when SSL is used. |
|
Path |
Optional |
System.String |
The Path parameter sets the path of the virtual directory in the metabase. |
|
WebSiteName |
Optional |
System.String |
The WebSiteName parameter specifies the name of the Web site under which to create the virtual directory. This parameter shouldn't be used when you're creating a virtual directory under the default Web site. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, 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 switch. |
|
WindowsAuthentication |
Optional |
System.Boolean |
The WindowsAuthentication parameter specifies whether Integrated Windows authentication is permitted on the new Exchange Web Services virtual directory. |
|
WSSecurityAuthentication |
Optional |
System.Boolean |
The WSSecurityAuthentication parameter specifies whether Web Services Security authentication is enabled on the Exchange Web Services virtual directory. This parameter can be used with the BasicAuthentication, DigestAuthentication, and WindowsAuthentication parameters. |
You can create multiple virtual directories by using this cmdlet. However, you can only create one Exchange Web Services virtual directory for each Web site.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Exchange Web Services settings" entry in the Client Access Permissions topic.
| Error | Description |
|---|---|
|
|
|
This example creates a virtual directory under the non-default Web site www.contoso.com. It also sets the external URL to https://www.contoso.com/webservices.aspx.
New-WebServicesVirtualDirectory -WebSiteName "www.contoso.com" -ExternalUrl "https://www.contoso.com/webservices.aspx"
