Set-UMVirtualDirectory
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Set-UMVirtualDirectory cmdlet to modify an existing Exchange Unified Messaging virtual directory on a computer that has the Client Access server role installed.
Syntax
Set-UMVirtualDirectory -Identity <VirtualDirectoryIdParameter> [-BasicAuthentication <$true | $false>] [-Confirm [<SwitchParameter>]] [-DigestAuthentication <$true | $false>] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-InternalUrl <Uri>] [-WhatIf [<SwitchParameter>]] [-WindowsAuthentication <$true | $false>]
Set-UMVirtualDirectory [-BasicAuthentication <$true | $false>] [-Confirm [<SwitchParameter>]] [-DigestAuthentication <$true | $false>] [-DomainController <Fqdn>] [-ExternalUrl <Uri>] [-Instance <ADUMVirtualDirectory>] [-InternalUrl <Uri>] [-WhatIf [<SwitchParameter>]] [-WindowsAuthentication <$true | $false>]
Detailed Description
The Set-UMVirtualDirectory cmdlet lets you modify an existing Exchange Web Services virtual directory on an Exchange 2007 Client Access server.
To run the Set-UMVirtualDirectory 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 |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter |
This parameter specifies the name of the virtual directory. You can also specify a wildcard character instead of the default Web site. |
BasicAuthentication |
Optional |
System.Boolean |
This parameter specifies whether Basic authentication is enabled on the Exchange Web Services virtual directory. This parameter can be used with the FormsAuthentication parameter or with the DigestAuthentication and WindowsAuthentication parameters. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
This parameter causes the command to pause processing. The administrator must acknowledge what the command will do before processing can continue. The default value is |
DigestAuthentication |
Optional |
System.Boolean |
This parameter specifies whether Digest authentication is enabled on the virtual directory. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from the Active Directory directory service. Include the DomainController parameter in the cmdlet. |
ExternalUrl |
Optional |
System.Uri |
This parameter specifies the host name that will be used to connect to the Client Access server from outside the firewall. This setting is also important when Secure Sockets Layer (SSL) is used. |
Instance |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.ADUMVirtualDirectory |
This parameter specifies whether to pass a whole object to the cmdlet to be processed. It is mainly used in scripts where a whole object must be passed to the cmdlet. |
InternalUrl |
Optional |
System.Uri |
This parameter specifies the host name of the Client Access server for connections from inside the firewall. This setting is important when SSL is used. |
WindowsAuthentication |
Optional |
System.Boolean |
This parameter specifies whether Integrated Windows authentication is permitted on the Unified Messaging virtual directory. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
This parameter makes the command simulate the actions that it would take on the object. An administrator can use the WhatIf parameter, to view what changes would occur without having to apply any of those changes. The default value is |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The first code example sets the authentication method to Digest authentication for the Unified Messaging virtual directory on the server named UMserver1. This code example also sets the external and internal URLs for this virtual directory.
The second code example uses a wildcard character instead of "default Web site."
Set-UMVirtualDirectory -Identity UMServer1\UnifiedMessaging -ExternalUrl https://www.contoso.com/UnifiedMessaging/service.asmx -ExternalAuthenticationMethods Digest -InternalUrl https://contoso.internal.com/UnifiedMessaging/service.asmx
Set-UMVirtualDirectory -Identity UMServer1\UnifiedMessaging* -ExternalUrl https://www.contoso.com/UnifiedMessaging/service.asmx