New-WebServicesVirtualDirectory
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The New-WebServicesVirtualDirectory cmdlet lets you create a new virtual directory named EWS on the computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed.
Syntax
New-WebServicesVirtualDirectory [-ApplicationRoot <String>] [-AppPoolId <String>] [-BasicAuthentication <$true | $false>] [-Confirm [<SwitchParameter>]] [-DigestAuthentication <$true | $false>] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-InternalNLBBypassUrl <Uri>] [-InternalUrl <Uri>] [-Path <String>] [-TemplateInstance <PSObject>] [-WebSiteName <String>] [-WhatIf [<SwitchParameter>]] [-WindowsAuthentication <$true | $false>]
Detailed Description
The New-WebServicesVirtualDirectory cmdlet lets you create a new virtual directory named EWS on the Exchange 2007 Client Access server. You can create multiple virtual directories by using this cmdlet.
Note
You can only create one EWS virtual directory for each Web site.
To run the New-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 Exchange 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
ApplicationRoot |
Optional |
System.String |
This 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 |
This parameter sets the pool of programs that can be used with the virtual directory. |
BasicAuthentication |
Optional |
System.Boolean |
This parameter specifies whether Basic authentication is enabled on the EWS virtual directory. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter causes the command to pause processing and requires that you 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, when it is used, specifies the use of Digest Authentication the virtual directory. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on 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 perimeter network. |
InternalNLBBypassUrl |
Optional |
System.Uri |
This parameter specifies the URL of the Client Access server, regardless of whether it is behind a Network Load Balancing (NLB) array. Although the InternalUrl parameter will be set to the URL of the NLB, 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 will proxy incoming calls to a more appropriate Client Access server whenever possible. |
InternalUrl |
Optional |
System.Uri |
This parameter specifies the URL that is used to connect to the virtual directory from inside the network firewall. |
Path |
Optional |
System.String |
This parameter sets the path of the virtual directory in the metabase. |
TemplateInstance |
Optional |
System.Management.Automation.PSObject |
When an existing object is supplied to this parameter, the command will use the configuration of that object to create a copy of the object on a local or target server. |
WebSiteName |
Optional |
System.String |
This parameter specifies the name of the Web site under which to create the new virtual directory. This parameter should not be used when you are creating a new virtual directory under the default Web site. |
WindowsAuthentication |
Optional |
System.Boolean |
Use this parameter to specify whether Integrated Windows authentication is permitted on the new Exchange Web Services virtual directory. |
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 do not have to specify a value with the WhatIf parameter. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
This code example creates a new virtual directory named "contoso" with the external URL set to "https://www.contoso.com/webservices.aspx".
New-WebServicesVirtualDirectory -WebsiteName "www.contoso.com" -ExternalUrl "https://www.contoso.com/webservices.aspx"