[Index]

Model: device/exchangehybrid/OabVirtualDirectory

Model Details

Title Description Details
RequireSSL The RequireSSL parameter specifies whether to require Secure Sockets Layer (SSL) to access the OAB virtual directory. If set to $true, the RequireSSL parameter requires SSL to access the OAB virtual directory.
  • Field Name: RequireSSL
  • Type: Boolean
WhenCreatedUTC
  • Field Name: WhenCreatedUTC
  • Type: String
  • Format: date-time
Recovery The Recovery parameter specifies whether to support Setup recovery mode and is used implicitly by Setup when recovery is performed. It's never necessary to specify this parameter.
  • Field Name: Recovery
  • Type: Boolean
OrganizationId
  • Field Name: OrganizationId
  • Type: String
Role 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: FrontEnd Configure the virtual directory for use on a Client Access server. BackEnd Configure the virtual directory for use on a Mailbox server.
  • Field Name: Role
  • Type: String
WebSiteName The WebSiteName parameter specifies the name of the Internet Information Services (IIS) website under which to create the virtual directory.
  • Field Name: WebSiteName
  • Type: String
AdminDisplayName
  • Field Name: AdminDisplayName
  • Type: String
PSShowComputerName
  • Field Name: PSShowComputerName
  • Type: Boolean
Name
  • Field Name: Name
  • Type: String
ExternalAuthenticationMethods
  • Field Name: ExternalAuthenticationMethods
  • Type: String
ObjectClass
  • Field Name: ObjectClass.[n]
  • Type: Array
PSComputerName
  • Field Name: PSComputerName
  • Type: String
InternalUrl The InternalUrl parameter specifies the internal URL that the OAB virtual directory points to.
  • Field Name: InternalUrl
  • Type: String
WindowsAuthentication The WindowsAuthentication parameter specifies whether Integrated Windows authentication is permitted on the OAB virtual directory. This parameter can be used with the BasicAuthentication parameter.
  • Field Name: WindowsAuthentication
  • Type: Boolean
OfflineAddressBooks
  • Field Name: OfflineAddressBooks.[n]
  • Type: Array
Path The Path parameter specifies the path to the folder that hosts the OAB virtual directory.
  • Field Name: Path
  • Type: String
OAuthAuthentication This parameter is reserved for internal Microsoft use.
  • Field Name: OAuthAuthentication
  • Type: Boolean
PollInterval The PollInterval parameter specifies the time interval (in minutes) that the distribution service should poll the generation server for new updates.
  • Field Name: PollInterval
  • Type: Integer
ExtendedProtectionSPNList 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: Null This is the default value. Single SPN or comma delimited list of valid SPNs By default, you must specify the fully qualified domain name (FQDN) (for example mail.contoso.com) for each SPN. If you want to add an SPN that's not an FQDN (for example, ContosoMail), you must also use the ExtendedProtectionTokenChecking parameter with the AllowDotlessSPN value. You specify the domain in SPN format. The SPN format is <protocol>/<FQDN>. For example, a valid entry could be HTTP/mail.contoso.com.
  • Field Name: ExtendedProtectionSPNList.[n]
  • Type: Array
DistinguishedName
  • Field Name: DistinguishedName
  • Type: String
OriginatingServer
  • Field Name: OriginatingServer
  • Type: String
ExtendedProtectionTokenChecking 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: None Extended Protection for Authentication won't be used. Connections between the client and Exchange won't use Extended Protection for Authentication on this virtual directory. This is the default setting. Allow Extended Protection for Authentication will be used for connections between the client and Exchange on this virtual directory if both the client and server support Extended Protection for Authentication. Connections that don't support Extended Protection for Authentication on the client and server will work, but may not be as secure as a connection using Extended Protection for Authentication. If you have a proxy server between the client and the Client Access server that's configured to terminate the client-to-proxy SSL channel, you must also configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. Require Extended Protection for Authentication will be used for all connections between clients and Exchange servers for this virtual directory. If either the client or server doesn't support Extended Protection for Authentication, the connection between the client and server will fail. If you set this option, you must also set a value for the ExtendedProtectionSPNList parameter. If you have a proxy server between the client and the Client Access server that's configured to terminate the client-to-proxy SSL channel, you must also configure one or more SPNs using the parameter ExtendedProtectionSPNList.
  • Field Name: ExtendedProtectionTokenChecking
  • Type: String
Server The Server parameter specifies the name of the server to connect. Enter the Server parameter as a host name or an FQDN. If this parameter isn't used, the local server is queried.
  • Field Name: Server
  • Type: String
WhenCreated
  • Field Name: WhenCreated
  • Type: String
  • Format: date-time
InternalAuthenticationMethods
  • Field Name: InternalAuthenticationMethods
  • Type: String
AdminDisplayVersion
  • Field Name: AdminDisplayVersion
  • Type: String
MetabasePath
  • Field Name: MetabasePath
  • Type: String
ExchangeVersion
  • Field Name: ExchangeVersion
  • Type: String
ExternalUrl The ExternalUrl parameter specifies the external URL that the OAB virtual directory points to.
  • Field Name: ExternalUrl
  • Type: String
BasicAuthentication The BasicAuthentication parameter specifies whether Basic authentication is enabled on the OAB virtual directory. This parameter can be used with the WindowsAuthentication parameter.
  • Field Name: BasicAuthentication
  • Type: Boolean
DomainController The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.
  • Field Name: DomainController
  • Type: String
ObjectCategory
  • Field Name: ObjectCategory
  • Type: String
IsValid
  • Field Name: IsValid
  • Type: Boolean
ExtendedProtectionFlags The ExtendedProtectionFlags parameter is used to customize the options you use if you're using Extended Protection for Authentication. The possible values are: None Default setting. Proxy Specifies that a proxy is terminating the SSL channel. A Service Principal Name (SPN) must be registered in the ExtendedProtectionSPNList parameter if proxy mode is configured. ProxyCoHosting Specifies that both HTTP and HTTPS traffic may be accessing the Client Access server and that a proxy is located between at least some of the clients and the Client Access server. AllowDotlessSPN Specifies whether you want to support valid SPNs that aren't in the fully qualified domain name (FQDN) format, for example ContosoMail. You specify valid SPNs with the ExtendedProtectionSPNList parameter. This option makes extended protection less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. NoServiceNameCheck Specifies that the SPN list won't be checked to validate a channel binding token. This option makes Extended Protection for Authentication less secure. We generally don't recommend this setting.
  • Field Name: ExtendedProtectionFlags.[n]
  • Type: Array
AppPoolId The AppPoolId parameter specifies the pool of programs that can be used with the OAB virtual directory.
  • Field Name: AppPoolId
  • Type: String
WhenChanged
  • Field Name: WhenChanged
  • Type: String
  • Format: date-time
WhenChangedUTC
  • Field Name: WhenChangedUTC
  • Type: String
  • Format: date-time
ObjectState
  • Field Name: ObjectState
  • Type: String
Identity The Identity parameter specifies the GUID, distinguished name (DN), or OAB virtual directory name that represents a specific OAB virtual directory. You can also include the path using the format Server\OfflineAddressBookVirtualDirectoryName. You can omit the parameter label so that only the OAB virtual directory name, DN, or GUID is supplied. You can't use this parameter in conjunction with the Server parameter.
  • Field Name: Identity
  • Type: String
RunspaceId
  • Field Name: RunspaceId
  • Type: String
Guid
  • Field Name: Guid
  • Type: String
Id
  • Field Name: Id
  • Type: String
API reference for device/exchangehybrid/OabVirtualDirectory