[Index]

Model: device/exchange/ActiveSyncVirtualDirectory

Model Details

Title Description Details
WhenCreatedUTC
  • Field Name: WhenCreatedUTC
  • Type: String
  • Format: date-time
OrganizationId
  • Field Name: OrganizationId
  • Type: String
AdminDisplayVersion
  • Field Name: AdminDisplayVersion
  • 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 Exchange ActiveSync website in which to create the virtual directory.
  • Field Name: WebSiteName
  • Type: String
PSShowComputerName
  • Field Name: PSShowComputerName
  • Type: Boolean
ExchangeVersion
  • Field Name: ExchangeVersion
  • Type: String
CompressionEnabled The CompressionEnabled parameter is a Boolean value that identifies the compression applied to the specified Exchange ActiveSync virtual directory. The default setting is $true.
  • Field Name: CompressionEnabled
  • Type: Boolean
ApplicationRoot 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.
  • Field Name: ApplicationRoot
  • Type: String
ExternalUrl The ExternalUrl parameter specifies the URL used to connect to the virtual directory from outside the network's firewall.
  • Field Name: ExternalUrl
  • Type: String
ExternalAuthenticationMethods The ExternalAuthenticationMethods parameter specifies the authentication methods supported by the server that contains the virtual directory when access is requested from outside the network's firewall. If this parameter isn't set, all authentication methods can be used.
  • Field Name: ExternalAuthenticationMethods.[n]
  • Type: Array
ObjectClass
  • Field Name: ObjectClass.[n]
  • Type: Array
PSComputerName
  • Field Name: PSComputerName
  • Type: String
MobileClientCertTemplateName The MobileClientCertTemplateName parameter specifies the template name for the client certificate.
  • Field Name: MobileClientCertTemplateName
  • Type: String
ObjectState
  • Field Name: ObjectState
  • Type: String
MobileClientCertificateAuthorityURL The MobileClientCertificateAuthorityURL parameter specifies the URL for the certification authority (CA) used by the mobile phone.
  • Field Name: MobileClientCertificateAuthorityURL
  • 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
MobileClientCertificateProvisioningEnabled The MobileClientCertificateProvisioningEnabled parameter specifies whether the Autodiscover service returns the Certificate Services server URL in the XML file.
  • Field Name: MobileClientCertificateProvisioningEnabled
  • Type: Boolean
Path The Path parameter sets the directory that contains the virtual directory's system files.
  • Field Name: Path
  • Type: String
VirtualDirectoryName
  • Field Name: VirtualDirectoryName
  • Type: String
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
Name The Name parameter specifies the name of the Exchange ActiveSync virtual directory.
  • Field Name: Name
  • Type: String
WindowsAuthEnabled The WindowsAuthEnabled parameter specifies whether Integrated Windows authentication is enabled. The default value is $false.
  • Field Name: WindowsAuthEnabled
  • Type: Boolean
RemoteDocumentsInternalDomainSuffixList The RemoteDocumentsInternalDomainSuffixList parameter is used in organizations that don't run Windows Internet Name Service (WINS) in their network. In these environments, you can specify one or more FQDNs that Exchange ActiveSync treats as internal when a request for remote file access is received.
  • Field Name: RemoteDocumentsInternalDomainSuffixList.[n]
  • Type: Array
BasicAuthEnabled The BasicAuthEnabled parameter enables or disables Basic authentication. The default setting is $true.
  • Field Name: BasicAuthEnabled
  • Type: Boolean
MobileClientFlags
  • Field Name: MobileClientFlags
  • Type: String
ActiveSyncServer The ActiveSyncServer parameter specifies the URL of the Client Access server. This value is in the following format: https://servername/Microsoft-Server-ActiveSync.
  • Field Name: ActiveSyncServer
  • Type: String
WhenCreated
  • Field Name: WhenCreated
  • Type: String
  • Format: date-time
InternalAuthenticationMethods The InternalAuthenticationMethods parameter specifies the authentication methods supported by the server that contains the virtual directory when access is requested from inside the network's firewall. If this parameter isn't set, all authentication methods can be used.
  • Field Name: InternalAuthenticationMethods.[n]
  • Type: Array
InstallProxySubDirectory The InstallProxySubDirectory parameter controls the creation of the new Exchange ActiveSync subdirectory used for proxying between Microsoft Exchange Server 2013 and previous versions of Exchange.
  • Field Name: InstallProxySubDirectory
  • Type: Boolean
MetabasePath
  • Field Name: MetabasePath
  • Type: String
BadItemReportingEnabled The BadItemReportingEnabled parameter specifies whether items that can't be synchronized should be reported to the user. If set to $true, the user receives a notification when an item can't be synchronized to the mobile phone.
  • Field Name: BadItemReportingEnabled
  • Type: Boolean
ClientCertAuth The ClientCertAuth parameter specifies the status of client certificate authentication. By default, client certificate authentication is disabled. The default setting is Ignore.
  • Field Name: ClientCertAuth
  • Type: String
InternalUrl The InternalUrl parameter specifies the URL used to connect to the virtual directory from inside the network's firewall.
  • Field Name: InternalUrl
  • Type: String
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
RemoteDocumentsBlockedServers The RemoteDocumentsBlockedServers parameter is a multivalued property that lists all the blocked servers for remote document access.
  • Field Name: RemoteDocumentsBlockedServers.[n]
  • Type: Array
ObjectCategory
  • Field Name: ObjectCategory
  • Type: String
IsValid
  • Field Name: IsValid
  • Type: Boolean
RemoteDocumentsActionForUnknownServers The RemoteDocumentsActionForUnknownServers parameter specifies the action that occurs when a Microsoft Windows SharePoint Services or Microsoft Windows file share request comes in via Exchange ActiveSync. When a request arrives, Exchange ActiveSync looks for the requested host name in the Allow and Block lists. If the host name isn't found in either list, the action specified in this parameter, either Block or Allow, is performed.
  • Field Name: RemoteDocumentsActionForUnknownServers
  • Type: String
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 virtual directory.
  • Field Name: AppPoolId
  • Type: String
Server 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: Name FQDN Distinguished name (DN) Exchange Legacy DN 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.
  • Field Name: Server
  • Type: String
WhenChanged
  • Field Name: WhenChanged
  • Type: String
  • Format: date-time
WhenChangedUTC
  • Field Name: WhenChangedUTC
  • Type: String
  • Format: date-time
SendWatsonReport The SendWatsonReport parameter specifies whether a Watson report is sent for errors and events.
  • Field Name: SendWatsonReport
  • Type: Boolean
WebSiteSSLEnabled
  • Field Name: WebSiteSSLEnabled
  • Type: Boolean
Identity The Identity parameter uniquely identifies an Exchange ActiveSync virtual directory on a physical server. If this value isn't set, this command returns information configured on all Exchange ActiveSync websites available across all Client Access servers in the Exchange organization.
  • Field Name: Identity
  • Type: String
AdminDisplayName
  • Field Name: AdminDisplayName
  • Type: String
WebsiteName
  • Field Name: WebsiteName
  • Type: String
RunspaceId
  • Field Name: RunspaceId
  • Type: String
Guid
  • Field Name: Guid
  • Type: String
RemoteDocumentsAllowedServers The RemoteDocumentsAllowedServers parameter is a multivalued property that lists all the allowed servers for remote document access.
  • Field Name: RemoteDocumentsAllowedServers.[n]
  • Type: Array
API reference for device/exchange/ActiveSyncVirtualDirectory