New-ActiveSyncVirtualDirectory
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The New-ActiveSyncVirtualDirectory command enables you to create new Microsoft Exchange ActiveSync virtual directories on your specified Web sites.
Syntax
New-ActiveSyncVirtualDirectory [-ApplicationRoot <String>] [-AppPoolId <String>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ExternalAuthenticationMethods <MultiValuedProperty>] [-ExternalUrl <Uri>] [-InstallProxySubDirectory <$true | $false>] [-InternalAuthenticationMethods <MultiValuedProperty>] [-InternalUrl <Uri>] [-Path <String>] [-TemplateInstance <PSObject>] [-WebSiteName <String>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The New-ActiveSyncVirtualDirectory command causes a new Exchange ActiveSync virtual directory to be created on the specified server under the specified Web site. The Exchange ActiveSync virtual directory that is created will be named "Microsoft-ActiveSync-Server". Only one Exchange ActiveSync virtual directory can exist in each Exchange ActiveSync Web site.
To run the New-ActiveSyncVirtualDirectory cmdlet,the account you use must be delegated the 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 |
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 which can be used with the virtual directory. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter causes the command to pause processing and requires the administrator to acknowledge what the command will do before processing continues. The default value is $true. |
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. |
ExternalAuthenticationMethods |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
This parameter specifies the authentication methods supported by the server that contains the virtual directory when access is requested from outside the network's firewall. If this parameter is not set, all authentication methods can be used. |
ExternalUrl |
Optional |
System.Uri |
This parameter specifies the URL that is used to connect to the virtual directory from outside the network's firewall. |
InstallProxySubDirectory |
Optional |
System.Boolean |
The InstallProxySubDirectory parameter controls how to create the new Exchange ActiveSync subdirectory that is used as a proxy between Microsoft Exchange Server 2010 and Exchange Server 2007. |
InternalAuthenticationMethods |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
This parameter specifies the authentication methods supported by the server that contains the virtual directory when access is requested from inside the network's firewall. If this parameter is not set, all authentication methods can be used. |
InternalUrl |
Optional |
System.Uri |
This parameter specifies the URL that is used to connect to the virtual directory from inside the network's firewall. |
Path |
Optional |
System.String |
This parameter sets the directory that contains the virtual directory's system files. |
TemplateInstance |
Optional |
System.Management.Automation.PSObject |
This parameter specifies that the cmdlet will use the configuration of an existing object, when that object is supplied to this parameter, to duplicate that object on a local or target server. |
WebSiteName |
Optional |
System.String |
This parameter specifies the name of the Exchange ActiveSync Web site in which to create the new virtual directory. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, the administrator can view what changes would occur without having to apply any of those changes. The default value is $false. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
Exceptions
| Exceptions | Description |
|---|---|
Example
The following code example creates a new virtual directory on the server Contoso.
New-ActiveSyncVirtualDirectory -Server "Contoso" -WebSiteName "Default Web Site" -ExternalURL "https://www.contoso.com/Microsoft-Server-ActiveSync"