New-UMVirtualDirectory (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 New-UMVirtualDirectory cmdlet lets you create a new virtual directory on the computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed.
Syntax
New-UMVirtualDirectory [-ApplicationRoot <String>] [-AppPoolId <String>] [-BasicAuthentication <$true | $false>] [-DigestAuthentication <$true | $false>] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-InternalUrl <Uri>] [-Path <String>] [-TemplateInstance <PSObject>] [-WebSiteName <String>] [-WindowsAuthentication <$true | $false>]
Detailed Description
The New-UMVirtualDirectory cmdlet lets you create a new Unified Messaging virtual directory on the Exchange 2007 Client Access server. You can create a single or multiple UM virtual directories.
To run the New-UMVirtualDirectory 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 Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
ApplicationRoot |
Optional |
System.String |
Use this parameter to specify the Web site path that is defined in the Internet Information Service (IIS) metabase. By default, it is set to /W3SVC/1/ROOT, where 1= the default Web site. |
AppPoolId |
Optional |
System.String |
Use this parameter to specify the IIS application pool name. This setting can be configured in <SERVERNAME>\Application Pools on the Web site in IIS Manager. By default, it is set to MSExchangeUMAppPool. |
BasicAuthentication |
Optional |
System.Boolean |
Use this parameter to specify whether to enable Basic authentication on the virtual directory. |
DigestAuthentication |
Optional |
System.Boolean |
Use this parameter to specify whether to enable Digest authentication on 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 |
Use this parameter to specify the host name that will be used to connect to the Exchange server from outside the perimeter network. |
InternalUrl |
Optional |
System.Uri |
Use this parameter to specify the host name of the Exchange server host for connection from inside the perimeter network. |
Path |
Optional |
System.String |
Use this parameter to specify the local path on the Client Access server where the UMWebservice files are located. The default location is %ExchangeInstallDir%\UnifiedMessaging\WebService. |
TemplateInstance |
Optional |
System.Management.Automation.PSObject |
If an existing object is supplied to this parameter, the command will use the configuration of that object to create an identical copy of the object on a local or target server |
WebSiteName |
Optional |
System.String |
Use this parameter to specify 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 to enable Windows Integrated authentication on the virtual directory. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
This code example creates a new Unified Messaging virtual directory named MyUMWeb.
New-UMVirtualDirectory -MyUMWeb -WebsiteName "www.contoso.com" -ExternalUrl "https://www.contoso.com/UMwebservices.aspx"