Applies to: Exchange Server 2013
Topic Last Modified: 2012-11-26
Use the New-WebServicesVirtualDirectory cmdlet to create an Exchange Web Services virtual directory on a server running Microsoft Exchange Server 2013.
You can use this cmdlet to create multiple virtual directories. However, you can create only one Exchange Web Services virtual directory organization.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
New-WebServicesVirtualDirectory [-ApplicationRoot
<String>] [-AppPoolId <String>]
[-AppPoolIdForManagement <String>] [-BasicAuthentication
<$true | $false>] [-Confirm [<SwitchParameter>]]
[-DigestAuthentication <$true | $false>] [-DomainController
<Fqdn>] [-ExtendedProtectionFlags
<MultiValuedProperty>] [-ExtendedProtectionSPNList
<MultiValuedProperty>] [-ExtendedProtectionTokenChecking
<None | Allow | Require>] [-ExternalUrl <Uri>] [-Force
<SwitchParameter>] [-GzipLevel <Off | Low | High |
Error>] [-InternalNLBBypassUrl <Uri>] [-InternalUrl
<Uri>] [-MRSProxyEnabled <$true | $false>]
[-OAuthAuthentication <$true | $false>] [-Path
<String>] [-Role <ClientAccess | Mailbox>] [-Server
<ServerIdParameter>] [-WebSiteName <String>] [-WhatIf
[<SwitchParameter>]] [-WindowsAuthentication <$true |
$false>] [-WSSecurityAuthentication <$true |
$false>]
|
Examples
EXAMPLE 1
This example creates a virtual directory under the non-default website www.contoso.com. It also sets the external URL to https://www.contoso.com/webservices.aspx.
Copy Code | |
---|---|
New-WebServicesVirtualDirectory -WebSiteName "www.contoso.com" -ExternalUrl "https://www.contoso.com/webservices.aspx" |
Detailed Description
You can create multiple virtual directories by using this cmdlet. However, you can only create one Exchange Web Services virtual directory for each website.
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 virtual directory settings" entry in the Clients and Mobile Devices Permissions topic.
Parameters
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 website 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. |
||||
ExtendedProtectionFlags |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ExtendedProtectionFlags parameter is used to customize the options you use if you're using Extended Protection for Authentication. The possible values are:
|
||||
ExtendedProtectionSPNList |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the specified virtual directory. The possible values are:
|
||||
ExtendedProtectionTokenChecking |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.ExtendedProtectionTokenCheckingMode |
The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the specified Exchange virtual directory. Extended Protection for Authentication isn't enabled by default. The available settings are:
|
||||
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 switch 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. |
||||
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. |
||||
MRSProxyEnabled |
Optional |
System.Boolean |
The MRSProxyEnabled parameter specifies whether to enable MRSProxy for the Client Access server. MRSProxy is a service that runs on Client Access servers in a remote forest and helps to proxy a mailbox move. For more information, see Mailbox Moves in Exchange 2013. |
||||
OAuthAuthentication |
Optional |
System.Boolean |
The OAuthAuthentication parameter specifies whether OAuth authentication is enabled. |
||||
Path |
Optional |
System.String |
The Path parameter sets the path of the virtual directory in the metabase. |
||||
Role |
Optional |
Microsoft.Exchange.Management.SystemConfigurationTasks.VirtualDirectoryRole |
The Role parameter specifies the configuration that should be used when the virtual directory is created. The following are the values that can be used with this parameter:
|
||||
Server |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The Server parameter specifies the Exchange server on which you want to create the virtual directory. You can use any value that uniquely identifies the server, for example:
If you don't use the Server parameter, the virtual directory is created on the server where the Remote PowerShell session is established This will always be a Mailbox server. If you want to create the virtual directory on a Client Access server or another Mailbox server, you must use the Server parameter. |
||||
WebSiteName |
Optional |
System.String |
The WebSiteName parameter specifies the name of the website under which to create the virtual directory. This parameter shouldn't be used when you're creating a virtual directory under the default website. |
||||
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. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.