Commands › Exchange Online

New-OabVirtualDirectory

Exchange Online ExchangeOnlineManagement New-*

Create offline address book (OAB) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. The OAB virtual directory configures the server as a web distribution point for an offline address book (OAB). Typically, you create virtual directories on Exchange servers that have the Client Access server role installed.

Quick start script

# New-OabVirtualDirectory — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-OabVirtualDirectory
$before | Format-List

# 3. Make the change (dry run first)
New-OabVirtualDirectory  -WhatIf
New-OabVirtualDirectory

# 4. Verify and diff
$after = Get-OabVirtualDirectory
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

New-OabVirtualDirectory [-Confirm]
 [-DomainController <Fqdn>]
 [-ExtendedProtectionFlags <MultiValuedProperty>]
 [-ExtendedProtectionSPNList <MultiValuedProperty>]
 [-ExtendedProtectionTokenChecking <ExtendedProtectionTokenCheckingMode>]
 [-ExternalUrl <Uri>]
 [-InternalUrl <Uri>]
 [-Path <String>]
 [-PollInterval <Int32>]
 [-Recovery]
 [-RequireSSL <Boolean>]
 [-Role <VirtualDirectoryRole>]
 [-Server <ServerIdParameter>]
 [-WebSiteName <String>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (15)

Parameter	Type	What it controls
-Confirm	SwitchParameter	The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-DomainController	Fqdn	The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name...
-ExtendedProtectionFlags	MultiValuedProperty	The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are:
-ExtendedProtectionSPNList	MultiValuedProperty	The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are:
-ExtendedProtectionTokenChecking	ExtendedProtectionTokenCheckingMode	The ExtendedProtectionTokenChecking parameter specifies whether Extended Protection for Authentication is used for client connections to the virtual directory. Valid values are:
-ExternalUrl	Uri	The ExternalURL parameter specifies the URL that connects to the virtual directory from outside the firewall.
-InternalUrl	Uri	The InternalURL parameter specifies the URL that connects to the virtual directory from inside the firewall.
-Path	String	The Path parameter specifies the file system path of the virtual directory. We recommend using this parameter only when you need to use a custom location for the virtual directory files. The default value is blank...
-PollInterval	Int32	The PollInterval parameter specifies the time interval in minutes that the distribution service polls the offline address book generation server for updates. The default value is 480 minutes (8 hours).
-Recovery	SwitchParameter	This parameter is reserved for internal Microsoft use.
-RequireSSL	Boolean	The RequireSSL parameter specifies whether client connections to the virtual directory require Transport Layer Security (TLS) encryption. Valid values are:
-Role	VirtualDirectoryRole	The Role parameter species the configuration for the virtual directory. Valid values are:
-Server	ServerIdParameter	The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example:
-WebSiteName	String	The WebSiteName parameter specifies the name of the IIS website under which the virtual directory is created. You don't need to use this parameter to create the virtual directory under the default website.
-WhatIf	SwitchParameter	The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.