Applies to: Exchange Server 2013
Topic Last Modified: 2012-12-10
Use the New-AutodiscoverVirtualDirectory cmdlet to create an Autodiscover virtual directory on a server running Microsoft Exchange Server 2013.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
New-AutodiscoverVirtualDirectory [-ApplicationRoot
<String>] [-AppPoolId <String>] [-BasicAuthentication
<$true | $false>] [-Confirm [<SwitchParameter>]]
[-DigestAuthentication <$true | $false>] [-DomainController
<Fqdn>] [-ExtendedProtectionFlags
<MultiValuedProperty>] [-ExtendedProtectionSPNList
<MultiValuedProperty>] [-ExtendedProtectionTokenChecking
<None | Allow | Require>] [-ExternalUrl <Uri>]
[-InternalUrl <Uri>] [-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 the virtual directory autodiscover under the website autodiscover.contoso.com and requires that the user connect using Integrated Windows authentication or Digest authentication.
Copy Code | |
---|---|
New-AutodiscoverVirtualDirectory -WebSiteName "autodiscover.contoso.com" -WindowsAuthentication $true -DigestAuthentication $true |
Detailed Description
If your organization has multiple email domains and each requires its own Autodiscover site and corresponding virtual directory, use the New-AutodiscoverVirtualDirectory cmdlet to create an Autodiscover virtual directory under a new website.
Note: |
---|
When you're creating an Autodiscover virtual directory, we recommend that you enable Secure Sockets Layer (SSL) for the Autodiscover service. |
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 "Autodiscover virtual directory settings" entry in the Clients and Mobile Devices Permissions topic.
Parameters
Parameter | Required | Type | Description | ||||
---|---|---|---|---|---|---|---|
ApplicationRoot |
Optional |
System.String |
The ApplicationRoot parameter specifies 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 specifies the pool of programs that can be used with the virtual directory. |
||||
BasicAuthentication |
Optional |
System.Boolean |
The BasicAuthentication parameter specifies whether Basic authentication is enabled on the Autodiscover 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 Autodiscover 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 URL used to connect to the virtual directory from outside the network firewall. |
||||
InternalUrl |
Optional |
System.Uri |
The InternalUrl parameter specifies the URL used to connect to the virtual directory from inside the network firewall. |
||||
OAuthAuthentication |
Optional |
System.Boolean |
The OAuthAuthentication parameter specifies whether OAuth authentication is enabled. |
||||
Path |
Optional |
System.String |
The Path parameter specifies the directory that contains the system files for the virtual directory. |
||||
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 will be 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 Internet Information Services (IIS) website under which to create the virtual directory. |
||||
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 enabled on the Autodiscover virtual directory. |
||||
WSSecurityAuthentication |
Optional |
System.Boolean |
The WSSecurityAuthentication parameter enables or
disables the Web Services Security (WS-Security) endpoint element
in the Autodiscover Web.config file. The value can be set to
|
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.