[Index]
Model ref.: device/exchangehybrid/MailboxServer
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"SharePointSignalStoreWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "SharePointSignalStoreWorkCycleCheckpoint",
"title": "SharePointSignalStoreWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"MigrationLogLoggingLevel": {
"__type_requested": "System.String",
"required": true,
"name": "MigrationLogLoggingLevel",
"title": "MigrationLogLoggingLevel",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"MailboxProcessorWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "MailboxProcessorWorkCycle",
"title": "MailboxProcessorWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The MailboxProcessorWorkCycle parameter specifies how often to scan for locked mailboxes. The default value is 1 day."
},
"MigrationLogMaxDirectorySize": {
"__type_requested": "System.String",
"required": true,
"name": "MigrationLogMaxDirectorySize",
"title": "MigrationLogMaxDirectorySize",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"PublicFolderWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "PublicFolderWorkCycle",
"title": "PublicFolderWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The PublicFolderWorkCycle parameter is used by the public folder assistant to determine how often the mailboxes in a database are processed by the assistant."
},
"SiteMailboxWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "SiteMailboxWorkCycle",
"title": "SiteMailboxWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The SiteMailboxWorkCycle parameter specifies the time span in which the site mailbox information on the specified server will be processed.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 7 days for this parameter, use 07.00:00:00."
},
"PSShowComputerName": {
"__type_requested": "System.Boolean",
"required": false,
"name": "PSShowComputerName",
"title": "PSShowComputerName",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"TransportSyncMailboxHealthLogEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "TransportSyncMailboxHealthLogEnabled",
"title": "TransportSyncMailboxHealthLogEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "This parameter is reserved for internal Microsoft use."
},
"AutoDatabaseMountDial": {
"__type_requested": "System.String",
"required": true,
"name": "AutoDatabaseMountDial",
"title": "AutoDatabaseMountDial",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The AutoDatabaseMountDial parameter specifies the automatic database mount behavior for a continuous replication environment after a database failover. You can use the following values:\nBestAvailability If you specify this value, the database automatically mounts immediately after a failover if the copy queue length is less than or equal to 12. The copy queue length is the number of logs recognized by the passive copy that needs to be replicated. If the copy queue length is more than 12, the database doesn't automatically mount. When the copy queue length is less than or equal to 12, Exchange attempts to replicate the remaining logs to the passive copy and mounts the database.\nGoodAvailability If you specify this value, the database automatically mounts immediately after a failover if the copy queue length is less than or equal to six. The copy queue length is the number of logs recognized by the passive copy that needs to be replicated. If the copy queue length is more than six, the database doesn't automatically mount. When the copy queue length is less than or equal to six, Exchange attempts to replicate the remaining logs to the passive copy and mounts the database.\nLossless If you specify this value, the database doesn't automatically mount until all logs that were generated on the active copy have been copied to the passive copy. This setting also causes Active Manager's best copy selection algorithm to sort potential candidates for activation based on the database copy's activation preference value and not its copy queue length.\nThe default value is GoodAvailability. If you specify either BestAvailability or GoodAvailability, and all of the logs from the active copy haven't been replicated to the passive copy, you may lose some mailbox data. However, the transport dumpster feature, (which is enabled by default) helps protect against data loss by resubmitting messages that are in the transport dumpster queue."
},
"SharingPolicyWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "SharingPolicyWorkCycleCheckpoint",
"title": "SharingPolicyWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The SharingPolicyWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes so that new mailboxes that have been created or moved will be part of the work queue. Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 1 day for this parameter, use 1.00:00:00. The Sharing Policy Assistant will process all mailboxes on this server every day."
},
"MaximumActiveDatabases": {
"__type_requested": "Int32",
"required": true,
"name": "MaximumActiveDatabases",
"title": "MaximumActiveDatabases",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"description": "The MaximumActiveDatabases parameter specifies the number of databases that can be mounted on this Mailbox server. This parameter accepts numeric values.\nWhen the maximum number is reached, the database copies on the server won't be activated if a failover or switchover occurs. If the copies are already active on a server, the Information Store on the server won't allow databases to be mounted."
},
"ExchangeLegacyServerRole": {
"__type_requested": "System.Int32",
"required": true,
"name": "ExchangeLegacyServerRole",
"title": "ExchangeLegacyServerRole",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer"
},
"MAPIEncryptionRequired": {
"__type_requested": "System.Boolean",
"required": true,
"name": "MAPIEncryptionRequired",
"title": "MAPIEncryptionRequired",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The MAPIEncryptionRequired parameter specifies whether Exchange blocks MAPI clients that don't use encrypted remote procedure calls (RPCs). The two possible values for this parameter are $true or $false."
},
"TransportSyncDispatchEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "TransportSyncDispatchEnabled",
"title": "TransportSyncDispatchEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "This parameter is reserved for internal Microsoft use."
},
"MailboxAssociationReplicationWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "MailboxAssociationReplicationWorkCycleCheckpoint",
"title": "MailboxAssociationReplicationWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"StoreIntegrityCheckWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "StoreIntegrityCheckWorkCycle",
"title": "StoreIntegrityCheckWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"InferenceTrainingWorkCycleCheckpoint": {
"__type_requested": "EnhancedTimeSpan",
"required": true,
"description": "This parameter is reserved for internal Microsoft use.",
"title": "InferenceTrainingWorkCycleCheckpoint",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "InferenceTrainingWorkCycleCheckpoint"
},
"SharingSyncWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "SharingSyncWorkCycle",
"title": "SharingSyncWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The SharingSyncWorkCycle parameter specifies the time span in which all mailboxes on the specified server will be synced to the cloud-based service by the Sharing Sync Assistant. Mailboxes that require syncing will be synced according to the interval specified by the SharingSyncWorkCycleCheckpoint parameter.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 7 days for this parameter, use 07.00:00:00. The Sharing Sync Assistant will process all mailboxes on this server every 7 days."
},
"OriginatingServer": {
"__type_requested": "System.String",
"required": true,
"name": "OriginatingServer",
"title": "OriginatingServer",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"TransportSyncLogMaxDirectorySize": {
"__type_requested": "System.String",
"required": true,
"name": "TransportSyncLogMaxDirectorySize",
"title": "TransportSyncLogMaxDirectorySize",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"FolderLogForManagedFoldersEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "FolderLogForManagedFoldersEnabled",
"title": "FolderLogForManagedFoldersEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The FolderLogForManagedFoldersEnabled parameter specifies whether the folder log for managed folders is enabled for messages that were moved to managed folders. The two possible values for this parameter are $true or $false. If you specify $true, information about folders that have managed folder mailbox policies applied to them is logged."
},
"OABGeneratorWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "OABGeneratorWorkCycleCheckpoint",
"title": "OABGeneratorWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The OABGeneratorWorkCycleCheckpoint parameter specifies the time span at which to run OAB generation.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 24 hours for this parameter, use 24:00:00."
},
"InferenceDataCollectionWorkCycle": {
"__type_requested": "EnhancedTimeSpan",
"required": true,
"description": "This parameter is reserved for internal Microsoft use.",
"title": "InferenceDataCollectionWorkCycle",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "InferenceDataCollectionWorkCycle"
},
"ProbeTimeBasedAssistantWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "ProbeTimeBasedAssistantWorkCycle",
"title": "ProbeTimeBasedAssistantWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"CalendarRepairMissingItemFixDisabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "CalendarRepairMissingItemFixDisabled",
"title": "CalendarRepairMissingItemFixDisabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The CalendarRepairMissingItemFixDisabled parameter specifies that the Calendar Repair Assistant won't fix missing attendee calendar items for mailboxes homed on this Mailbox server. The default value is $false."
},
"AdminDisplayVersion": {
"__type_requested": "System.String",
"required": true,
"name": "AdminDisplayVersion",
"title": "AdminDisplayVersion",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"ExchangeVersion": {
"__type_requested": "System.String",
"required": true,
"name": "ExchangeVersion",
"title": "ExchangeVersion",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"CalendarRepairWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "CalendarRepairWorkCycleCheckpoint",
"title": "CalendarRepairWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The CalendarRepairWorkCycleCheckpoint parameter specifies the time span at which all mailboxes will be identified as needing work completed on them.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 1 day for this parameter, use 1.00:00:00. The Calendar Repair Assistant will process all mailboxes on this server every day."
},
"TransportSyncLogLoggingLevel": {
"__type_requested": "System.String",
"required": true,
"name": "TransportSyncLogLoggingLevel",
"title": "TransportSyncLogLoggingLevel",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"StoreDsMaintenanceWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "StoreDsMaintenanceWorkCycle",
"title": "StoreDsMaintenanceWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"IsPhoneticSupportEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "IsPhoneticSupportEnabled",
"title": "IsPhoneticSupportEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean"
},
"OABGeneratorWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "OABGeneratorWorkCycle",
"title": "OABGeneratorWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The OABGeneratorWorkCycle parameter specifies the time span in which the OAB generation on the specified server will be processed.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 7 days for this parameter, use 07.00:00:00."
},
"RunspaceId": {
"__type_requested": "System.Guid",
"required": false,
"name": "RunspaceId",
"title": "RunspaceId",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"Guid": {
"__type_requested": "System.Guid",
"required": true,
"name": "Guid",
"title": "Guid",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"InferenceDataCollectionWorkCycleCheckpoint": {
"__type_requested": "EnhancedTimeSpan",
"required": true,
"description": "This parameter is reserved for internal Microsoft use.",
"title": "InferenceDataCollectionWorkCycleCheckpoint",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "InferenceDataCollectionWorkCycleCheckpoint"
},
"GroupMailboxWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "GroupMailboxWorkCycle",
"title": "GroupMailboxWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"SharePointSignalStoreWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "SharePointSignalStoreWorkCycle",
"title": "SharePointSignalStoreWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"OrganizationId": {
"__type_requested": "System.String",
"required": true,
"name": "OrganizationId",
"title": "OrganizationId",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"ManagedFolderAssistantSchedule": {
"__type_requested": "ScheduleInterval[]",
"required": true,
"description": "The ManagedFolderAssistantSchedule parameter specifies the intervals each week during which the Managed Folder Assistant applies messaging records management (MRM) settings to managed folders. The format is StartDay.Time-EndDay.Time. You can use the following values for the start and end days:\nFull name of the day\nAbbreviated name of the day\nInteger from 0 through 6, where 0 = Sunday\nThe start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval.\nThe following are examples:\n\"Sun.11:30 PM-Mon.1:30 AM\"\n6.22:00-6.22:15 (The assistant will run from Saturday at 10:00 PM until Saturday at 10:15 PM.)\n\"Monday.4:30 AM-Monday.5:30 AM\",\"Wednesday.4:30 AM-Wednesday.5:30 AM\" (The assistant will run on Monday and Wednesday mornings from 4:30 until 5:30.)\n\"Sun.1:15 AM-Monday.23:00\"\nIf the Managed Folder Assistant doesn't finish processing the mailboxes on the server during the time that you've scheduled, it automatically resumes processing where it left off the next time it runs.",
"title": "ManagedFolderAssistantSchedule",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "ManagedFolderAssistantSchedule"
},
"LogFileAgeLimitForManagedFolders": {
"__type_requested": "System.String",
"required": true,
"name": "LogFileAgeLimitForManagedFolders",
"title": "LogFileAgeLimitForManagedFolders",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The LogFileAgeLimitForManagedFolders parameter specifies how long to retain managed folder logs. Log files that exceed the maximum retention period are deleted.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify a 30-day interval, enter 30.00:00:00. The default value is 00.00:00:00, which specifies that there's no limit on file retention (and not that files are overwritten immediately)."
},
"PeopleCentricTriageWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "PeopleCentricTriageWorkCycleCheckpoint",
"title": "PeopleCentricTriageWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"TransportSyncLogMaxAge": {
"__type_requested": "System.String",
"required": true,
"name": "TransportSyncLogMaxAge",
"title": "TransportSyncLogMaxAge",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"LogFileSizeLimitForManagedFolders": {
"__type_requested": "System.String",
"required": true,
"name": "LogFileSizeLimitForManagedFolders",
"title": "LogFileSizeLimitForManagedFolders",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The LogFileSizeLimitForManagedFolders parameter specifies the maximum size for each managed folder log file. When the log file size limit is reached, a new log file is created. The default value is 10 megabytes (MB). When you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes."
},
"DatabaseCopyAutoActivationPolicy": {
"__type_requested": "System.String",
"required": true,
"name": "DatabaseCopyAutoActivationPolicy",
"title": "DatabaseCopyAutoActivationPolicy",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The DatabaseCopyAutoActivationPolicy parameter specifies the type of automatic activation available for mailbox database copies on the specified Mailbox server(s). Values for this parameter are:\nBlocked Databases can't be automatically activated on the specified Mailbox server(s). In addition, this stops server locator requests to the specified server, which prevents access to manually activated databases on the server if all DAG members are configured with a value of blocked.\nIntrasiteOnlyThe database copy is allowed to be activated on Mailbox servers in the same Active Directory site. This prevents cross-site failover and activation.\nUnrestricted There are no special restrictions on activating mailbox database copies on the specified Mailbox server(s)."
},
"TransportSyncMailboxHealthLogMaxFileSize": {
"__type_requested": "System.String",
"required": true,
"name": "TransportSyncMailboxHealthLogMaxFileSize",
"title": "TransportSyncMailboxHealthLogMaxFileSize",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"CalendarRepairLogEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "CalendarRepairLogEnabled",
"title": "CalendarRepairLogEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The CalendarRepairLogEnabled parameter specifies whether the Calendar Repair Attendant logs items that it repairs. The repair log doesn't contain failed repair attempts.\nThe default value is $true."
},
"DistinguishedName": {
"__type_requested": "System.String",
"required": true,
"name": "DistinguishedName",
"title": "DistinguishedName",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"CalendarRepairIntervalEndWindow": {
"__type_requested": "System.Int32",
"required": true,
"name": "CalendarRepairIntervalEndWindow",
"title": "CalendarRepairIntervalEndWindow",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"description": "The CalendarRepairIntervalEndWindow parameter specifies the number of days into the future to repair calendars. For example, if this parameter is set to 90, the Calendar Repair Assistant repairs calendars on this Mailbox server 90 days from now. The default value is 30 days."
},
"AutoDagServerConfigured": {
"__type_requested": "System.Boolean",
"required": true,
"name": "AutoDagServerConfigured",
"title": "AutoDagServerConfigured",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "This parameter is reserved for internal Microsoft use."
},
"PublicFolderWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "PublicFolderWorkCycleCheckpoint",
"title": "PublicFolderWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The PublicFolderWorkCycleCheckpoint determines how often the mailbox list for a database is evaluated. The processing speed is also calculated."
},
"InferenceTrainingWorkCycle": {
"__type_requested": "EnhancedTimeSpan",
"required": true,
"description": "This parameter is reserved for internal Microsoft use.",
"title": "InferenceTrainingWorkCycle",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "InferenceTrainingWorkCycle"
},
"TransportSyncLogMaxFileSize": {
"__type_requested": "System.String",
"required": true,
"name": "TransportSyncLogMaxFileSize",
"title": "TransportSyncLogMaxFileSize",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"ProbeTimeBasedAssistantWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "ProbeTimeBasedAssistantWorkCycleCheckpoint",
"title": "ProbeTimeBasedAssistantWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"StoreMaintenanceWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "StoreMaintenanceWorkCycle",
"title": "StoreMaintenanceWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"ObjectCategory": {
"__type_requested": "System.String",
"required": true,
"name": "ObjectCategory",
"title": "ObjectCategory",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"CalendarRepairLogFileAgeLimit": {
"__type_requested": "System.String",
"required": true,
"name": "CalendarRepairLogFileAgeLimit",
"title": "CalendarRepairLogFileAgeLimit",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The CalendarRepairLogFileAgeLimit parameter specifies how long to retain calendar repair logs. Log files that exceed the maximum retention period are deleted.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify a 30-day interval, enter 30.00:00:00. The default value is 00.00:00:00, which specifies that there's no limit on file retention (and not that files are overwritten immediately)."
},
"IsValid": {
"__type_requested": "System.Boolean",
"required": true,
"name": "IsValid",
"title": "IsValid",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean"
},
"WhenChanged": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenChanged",
"title": "WhenChanged",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"ObjectState": {
"__type_requested": "System.String",
"required": true,
"name": "ObjectState",
"title": "ObjectState",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"ManagedFolderWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "ManagedFolderWorkCycleCheckpoint",
"title": "ManagedFolderWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The ManagedFolderWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes so that new mailboxes that have been created or moved will be part of the work queue. Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 24 hours for this parameter, use 24:00:00."
},
"StoreDsMaintenanceWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "StoreDsMaintenanceWorkCycleCheckpoint",
"title": "StoreDsMaintenanceWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"DarTaskStoreTimeBasedAssistantWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "DarTaskStoreTimeBasedAssistantWorkCycle",
"title": "DarTaskStoreTimeBasedAssistantWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"PeopleCentricTriageWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "PeopleCentricTriageWorkCycle",
"title": "PeopleCentricTriageWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"IsExcludedFromProvisioning": {
"__type_requested": "System.Boolean",
"required": true,
"name": "IsExcludedFromProvisioning",
"title": "IsExcludedFromProvisioning",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The IsExcludedFromProvisioning parameter specifies that the Mailbox server isn't considered by the OAB provisioning load balancer. If the IsExcludedFromProvisioning parameter is set to $true, the server won't be used for provisioning a new OAB or for moving existing OABs."
},
"SearchIndexRepairTimeBasedAssistantWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "SearchIndexRepairTimeBasedAssistantWorkCycle",
"title": "SearchIndexRepairTimeBasedAssistantWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"StoreUrgentMaintenanceWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "StoreUrgentMaintenanceWorkCycle",
"title": "StoreUrgentMaintenanceWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"SubmissionServerOverrideList": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,",
"required": true,
"name": "SubmissionServerOverrideList",
"title": "SubmissionServerOverrideList",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"description": "This parameter is reserved for internal Microsoft use."
},
"StoreUrgentMaintenanceWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "StoreUrgentMaintenanceWorkCycleCheckpoint",
"title": "StoreUrgentMaintenanceWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"CalendarRepairLogPath": {
"__type_requested": "System.String",
"required": true,
"name": "CalendarRepairLogPath",
"title": "CalendarRepairLogPath",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The CalendarRepairLogPath parameter specifies the path to the directory that stores the calendar repair log files. The default value is <Exchange installation path>v15\\Logging\\Calendar Repair Assistant."
},
"StoreScheduledIntegrityCheckWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "StoreScheduledIntegrityCheckWorkCycleCheckpoint",
"title": "StoreScheduledIntegrityCheckWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"MigrationLogFilePath": {
"__type_requested": "LocalLongFullPath",
"required": true,
"description": "This parameter is reserved for internal Microsoft use.",
"title": "MigrationLogFilePath",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "MigrationLogFilePath"
},
"LogPathForManagedFolders": {
"__type_requested": "System.String",
"required": true,
"name": "LogPathForManagedFolders",
"title": "LogPathForManagedFolders",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The LogPathForManagedFolders parameter specifies the path to the directory that stores the managed folder log files. The default value is <Exchange installation path>v15\\Logging\\ Managed Folder Assistant."
},
"GroupMailboxWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "GroupMailboxWorkCycleCheckpoint",
"title": "GroupMailboxWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"UMReportingWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "UMReportingWorkCycle",
"title": "UMReportingWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The UMReportingWorkCycle parameter specifies the time span in which the arbitration mailbox named SystemMailbox{e0dc1c29-89c3-4034-b678-e6c29d823ed9} on the specified server will be scanned by the Unified Messaging Reporting Assistant. The Unified Messaging Reporting Assistant updates the Call Statistics reports by reading Unified Messaging call data records for an organization on a regular basis. By default, it's scheduled to run once every 24 hours.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 7 days for this parameter, use 07.00:00:00. The Unified Messaging Reporting Assistant will process all mailboxes that have Unified Messaging enabled on this server every 7 days.\nChanging the default work cycle for this assistant might impact the performance of the Mailbox server for your organization."
},
"ManagedFolderWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "ManagedFolderWorkCycle",
"title": "ManagedFolderWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The ManagedFolderWorkCycle parameter specifies the time span in which all mailboxes on the specified server will be processed by the Managed Folder Assistant. The Managed Folder Assistant applies retention policies according to the ManagedFolderWorkCycleCheckpoint interval.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 7 days for this parameter, use 07.00:00:00. The Managed Folder Assistant will process all mailboxes on this server every 7 days."
},
"SubjectLogForManagedFoldersEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "SubjectLogForManagedFoldersEnabled",
"title": "SubjectLogForManagedFoldersEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The SubjectLogForManagedFoldersEnabled parameter specifies whether the subject of messages is displayed in managed folder logs. The two possible values for this parameter are $true or $false. If you specify $false, the subject of messages is blank in the managed folder logs. The default value is $false."
},
"PSComputerName": {
"__type_requested": "System.String",
"required": false,
"name": "PSComputerName",
"title": "PSComputerName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"MigrationLogMaxFileSize": {
"__type_requested": "System.String",
"required": true,
"name": "MigrationLogMaxFileSize",
"title": "MigrationLogMaxFileSize",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"DirectoryProcessorWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "DirectoryProcessorWorkCycle",
"title": "DirectoryProcessorWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"DatabaseAvailabilityGroup": {
"__type_requested": "",
"required": true,
"name": "DatabaseAvailabilityGroup",
"title": "DatabaseAvailabilityGroup",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"SiteMailboxWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "SiteMailboxWorkCycleCheckpoint",
"title": "SiteMailboxWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The SiteMailboxWorkCycleCheckpoint parameter specifies the time span at which to refresh the site mailbox workcycle.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 24 hours for this parameter, use 24:00:00."
},
"Identity": {
"__type_requested": "System.String",
"required": true,
"name": "Identity",
"title": "Identity",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The Identity parameter specifies the Mailbox server. You can use the following values:\nName\nGUID\nDistinguished name (DN)"
},
"RetentionLogForManagedFoldersEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "RetentionLogForManagedFoldersEnabled",
"title": "RetentionLogForManagedFoldersEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The RetentionLogForManagedFoldersEnabled parameter specifies whether the Managed Folder Assistant logs information about messages that have reached their retention limits. The two possible values for this parameter are $true or $false. If you specify $true, information about messages that have been processed because they have reached their retention limits is logged."
},
"CalendarRepairLogSubjectLoggingEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "CalendarRepairLogSubjectLoggingEnabled",
"title": "CalendarRepairLogSubjectLoggingEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The CalendarRepairLogSubjectLoggingEnabled parameter specifies that the subject of the repaired calendar item is logged in the calendar repair log. The default value is $true."
},
"MigrationLogMaxAge": {
"__type_requested": "System.String",
"required": true,
"name": "MigrationLogMaxAge",
"title": "MigrationLogMaxAge",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"TransportSyncLogFilePath": {
"__type_requested": "LocalLongFullPath",
"required": true,
"description": "This parameter is reserved for internal Microsoft use.",
"title": "TransportSyncLogFilePath",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "TransportSyncLogFilePath"
},
"SharingSyncWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "SharingSyncWorkCycleCheckpoint",
"title": "SharingSyncWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The SharingSyncWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes so that new mailboxes that have been created or moved will be part of the work queue. Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 1 day for this parameter, use 1.00:00:00. The Sharing Sync Assistant will process all mailboxes on this server every day."
},
"CalendarRepairLogDirectorySizeLimit": {
"__type_requested": "System.String",
"required": true,
"name": "CalendarRepairLogDirectorySizeLimit",
"title": "CalendarRepairLogDirectorySizeLimit",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The CalendarRepairLogDirectorySizeLimit parameter specifies the size limit for all log files for the Calendar Repair Assistant. After the limit is reached, the oldest files are deleted.\nThe maximum size of the calendar repair log directory is calculated as the total size of all log files that have the same name prefix. Other files that don't follow the name prefix convention aren't counted in the total directory size calculation. Renaming old log files or copying other files into the calendar repair log directory could cause the directory to exceed its specified maximum size.\nCalendar repair log files for the Mailbox server role begin with the name prefix CRA.\nThe default value is unlimited. When you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes."
},
"FaultZone": {
"__type_requested": "System.String",
"required": true,
"name": "FaultZone",
"title": "FaultZone",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"MaxTransportSyncDispatchers": {
"__type_requested": "System.Int32",
"required": true,
"name": "MaxTransportSyncDispatchers",
"title": "MaxTransportSyncDispatchers",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"description": "This parameter is reserved for internal Microsoft use."
},
"PeopleRelevanceWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "PeopleRelevanceWorkCycleCheckpoint",
"title": "PeopleRelevanceWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"WhenChangedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenChangedUTC",
"title": "WhenChangedUTC",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"MailboxAssociationReplicationWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "MailboxAssociationReplicationWorkCycle",
"title": "MailboxAssociationReplicationWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"StoreScheduledIntegrityCheckWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "StoreScheduledIntegrityCheckWorkCycle",
"title": "StoreScheduledIntegrityCheckWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"ServerRole": {
"__type_requested": "System.String",
"required": true,
"name": "ServerRole",
"title": "ServerRole",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"WhenCreatedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreatedUTC",
"title": "WhenCreatedUTC",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"TransportSyncMailboxHealthLogFilePath": {
"__type_requested": "LocalLongFullPath",
"required": true,
"description": "This parameter is reserved for internal Microsoft use.",
"title": "TransportSyncMailboxHealthLogFilePath",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "TransportSyncMailboxHealthLogFilePath"
},
"TransportSyncMailboxHealthLogMaxDirectorySize": {
"__type_requested": "System.String",
"required": true,
"name": "TransportSyncMailboxHealthLogMaxDirectorySize",
"title": "TransportSyncMailboxHealthLogMaxDirectorySize",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"MaximumPreferredActiveDatabases": {
"__type_requested": "Int32",
"required": true,
"name": "MaximumPreferredActiveDatabases",
"title": "MaximumPreferredActiveDatabases",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"description": "The MaximumPreferredActiveDatabases parameter specifies a preferred maximum number of databases that a server should have. This value is different from the actual maximum, which is configured using the MaximumActiveDatabases parameter. The value of MaximumPreferredActiveDatabases is only honored during best copy and server selection, database and server switchovers, and when rebalancing the DAG."
},
"JunkEmailOptionsCommitterWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "JunkEmailOptionsCommitterWorkCycle",
"title": "JunkEmailOptionsCommitterWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"ForceGroupMetricsGeneration": {
"__type_requested": "System.Boolean",
"required": true,
"name": "ForceGroupMetricsGeneration",
"title": "ForceGroupMetricsGeneration",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The ForceGroupMetricsGeneration parameter specifies that group metrics information must be generated on the Mailbox server regardless of whether that server generates an offline address book (OAB). By default, group metrics are generated only on servers that generate OABs. Group metrics information is used by MailTips to inform senders about how many recipients their messages will be sent to. You need to use this parameter if your organization doesn't generate OABs and you want the group metrics data to be available."
},
"ObjectClass": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,",
"required": true,
"name": "ObjectClass",
"title": "ObjectClass",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array"
},
"UMReportingWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "UMReportingWorkCycleCheckpoint",
"title": "UMReportingWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The UMReportingWorkCycleCheckpoint parameter specifies the time span at which the arbitration mailbox named SystemMailbox{e0dc1c29-89c3-4034-b678-e6c29d823ed9} will be marked by processing.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 1 day for this parameter, use 1.00:00:00."
},
"DataPath": {
"__type_requested": "System.String",
"required": true,
"name": "DataPath",
"title": "DataPath",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"StoreMaintenanceWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "StoreMaintenanceWorkCycleCheckpoint",
"title": "StoreMaintenanceWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"DarTaskStoreTimeBasedAssistantWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "DarTaskStoreTimeBasedAssistantWorkCycleCheckpoint",
"title": "DarTaskStoreTimeBasedAssistantWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"SharingPolicySchedule": {
"__type_requested": "ScheduleInterval[]",
"required": true,
"description": "The SharingPolicySchedule parameter specifies the intervals each week during which the sharing policy runs. The Sharing Policy Assistant checks permissions on shared calendar items and contact folders in users' mailboxes against the assigned sharing policy. The assistant lowers or removes permissions according to the policy. The format is StartDay.Time-EndDay.Time. You can use the following values for the start and end days:\nFull name of the day\nAbbreviated name of the day\nInteger from 0 through 6, where 0 = Sunday\nThe start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval.\nThe following are examples:\n\"Sun.11:30 PM-Mon.1:30 AM\"\n6.22:00-6.22:15 (The assistant will run from Saturday at 10:00 PM until Saturday 10:15 PM.)",
"title": "SharingPolicySchedule",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "SharingPolicySchedule"
},
"TopNWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "TopNWorkCycleCheckpoint",
"title": "TopNWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The TopNWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes so that new mailboxes that have been created or moved will be part of the work queue. Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 1 day for this parameter, use 1.00:00:00. The TopN Words Assistant will process all mailboxes on this server every day."
},
"TransportSyncMailboxHealthLogMaxAge": {
"__type_requested": "System.String",
"required": true,
"name": "TransportSyncMailboxHealthLogMaxAge",
"title": "TransportSyncMailboxHealthLogMaxAge",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"JournalingLogForManagedFoldersEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "JournalingLogForManagedFoldersEnabled",
"title": "JournalingLogForManagedFoldersEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The JournalingLogForManagedFoldersEnabled parameter specifies whether the log for managed folders is enabled for journaling. The two possible values for this parameter are $true or $false. If you specify $true, information about messages that were journaled is logged. The logs are located at the location you specify with the LogPathForManagedFolders parameter."
},
"Name": {
"__type_requested": "System.String",
"required": true,
"name": "Name",
"title": "Name",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"PeopleRelevanceWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "PeopleRelevanceWorkCycle",
"title": "PeopleRelevanceWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"LogDirectorySizeLimitForManagedFolders": {
"__type_requested": "System.String",
"required": true,
"name": "LogDirectorySizeLimitForManagedFolders",
"title": "LogDirectorySizeLimitForManagedFolders",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The LogDirectorySizeLimitForManagedFolders parameter specifies the size limit for all managed folder log files from a single message database. After the limit is reached for a set of managed folder log files from a message database, the oldest files are deleted to make space for new files.\nThe size of the managed folder log files is calculated as the total size of all log files that have the same name prefix. For example, for a file with the name Managed_Folder_Assistant[Mailbox Database 01]20061018-1.log, the prefix is Managed_Folder_Assistant[Mailbox Database 01]. If you rename log files or copy other files into the managed folder log directory, these files aren't counted in the log files size calculation. The managed folder log files for each message database have a unique name prefix. Therefore, this limit applies to the log files for each message database, and not to all the log files in the directory. If you have more than one message database, the maximum size of the managed folder log directory isn't the size specified in the LogDirectorySizeLimitForManagedFolders parameter because the managed folder log files generated by different databases have different name prefixes. The maximum size of the managed folder log directory is X times the specified value if you have X message databases.\nYou must specify either an integer or unlimited. The default value is unlimited. When you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes."
},
"CalendarRepairMode": {
"__type_requested": "System.String",
"required": true,
"name": "CalendarRepairMode",
"title": "CalendarRepairMode",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The CalendarRepairMode parameter specifies the mode that the Calendar Repair Assistant will run in."
},
"TopNWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "TopNWorkCycle",
"title": "TopNWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The TopNWorkCycle parameter specifies the time span in which all mailboxes that have Unified Messaging on the specified server will be scanned by the TopN Words Assistant. The TopN Words Assistant scans voice mail for the most frequently used words to aid in transcription. The most common words are then indexed according to the interval specified by the TopNWorkCycleCheckpoint parameter.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 7 days for this parameter, use 07.00:00:00. The TopN Words Assistant will process all mailboxes on which Unified Messaging is enabled on this server every 7 days."
},
"DirectoryProcessorWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "DirectoryProcessorWorkCycleCheckpoint",
"title": "DirectoryProcessorWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"StoreIntegrityCheckWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "StoreIntegrityCheckWorkCycleCheckpoint",
"title": "StoreIntegrityCheckWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"Locale": {
"__type_requested": "MultiValuedProperty",
"required": true,
"name": "Locale",
"title": "Locale",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"description": "The Locale parameter specifies the locale. A locale is a collection of language-related user preferences such as writing system, calendar, and date format. The following are examples:\nen-US (English - United States)\nde-AT (German - Austria)\nes-CL (Spanish - Chile)\nFor more information, see CultureInfo Class (http://go.microsoft.com/fwlink/p/?linkId=68806)."
},
"SharingPolicyWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "SharingPolicyWorkCycle",
"title": "SharingPolicyWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The SharingPolicyWorkCycle parameter specifies the time span in which all mailboxes on the specified server will be scanned by the Sharing Policy Assistant. The Sharing Policy Assistant scans all mailboxes and enables or disables sharing polices according to the interval specified by the SharingPolicyWorkCycle.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 7 days for this parameter, use 07.00:00:00. The Sharing Policy Assistant will process all mailboxes on this server every 7 days."
},
"CalendarRepairWorkCycle": {
"__type_requested": "System.String",
"required": true,
"name": "CalendarRepairWorkCycle",
"title": "CalendarRepairWorkCycle",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The CalendarRepairWorkCycle parameter specifies the time span in which all mailboxes on the specified server will be scanned by the Calendar Repair Assistant. Calendars that have inconsistencies will be flagged and repaired according to the interval specified by the CalendarRepairWorkCycleCheckpoint parameter.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, if you specify 7 days for this parameter, use 07.00:00:00. The Calendar Repair Assistant will process all mailboxes on this server every 7 days."
},
"WhenCreated": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreated",
"title": "WhenCreated",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"DatabaseCopyActivationDisabledAndMoveNow": {
"__type_requested": "System.Boolean",
"required": true,
"name": "DatabaseCopyActivationDisabledAndMoveNow",
"title": "DatabaseCopyActivationDisabledAndMoveNow",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The DatabaseCopyActivationDisabledAndMoveNow parameter specifies whether to prevent databases from being mounted on this server if there are other healthy copies of the databases on other servers. It will also immediately move any mounted databases on the server to other servers if copies exist and are healthy. Setting this parameter won't cause databases to move to a server that has the DatabaseCopyAutoActivationPolicy parameter set to Blocked."
},
"SearchIndexRepairTimeBasedAssistantWorkCycleCheckpoint": {
"__type_requested": "System.String",
"required": true,
"name": "SearchIndexRepairTimeBasedAssistantWorkCycleCheckpoint",
"title": "SearchIndexRepairTimeBasedAssistantWorkCycleCheckpoint",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"TransportSyncLogEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "TransportSyncLogEnabled",
"title": "TransportSyncLogEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "This parameter is reserved for internal Microsoft use."
},
"Id": {
"__type_requested": "System.String",
"required": true,
"name": "Id",
"title": "Id",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
}
},
"schema_version": "15312"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/exchangehybrid/MailboxServer/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/exchangehybrid/MailboxServer/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/MailboxServer/[pkid1]", "/api/v0/device/exchangehybrid/MailboxServer/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/MailboxServer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/MailboxServer |
|
{"hrefs": ["/api/device/exchangehybrid/MailboxServer/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/MailboxServer |
|
{"hrefs": ["/api/device/exchangehybrid/MailboxServer/[pkid1]", "/api/device/exchangehybrid/MailboxServer/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/MailboxServer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/MailboxServer/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/MailboxServer/[pkid1]", "/api/device/exchangehybrid/MailboxServer/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/exchangehybrid/MailboxServer and the JSON format can be used to import instances of device/exchangehybrid/MailboxServer.
GET http://[host-proxy]/api/device/exchangehybrid/MailboxServer/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/MailboxServer | POST | /api/device/exchangehybrid/MailboxServer/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/exchangehybrid/MailboxServer/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/exchangehybrid/MailboxServer/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/exchangehybrid/MailboxServer/ |
|
The device/exchangehybrid/MailboxServer schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/MailboxServer instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "Name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/exchangehybrid/MailboxServer/?skip=0&limit=3&order_by=Name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "15312",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/exchangehybrid/MailboxServer/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchangehybrid/MailboxServer",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/exchangehybrid/MailboxServer/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/exchangehybrid/MailboxServer/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/exchangehybrid/MailboxServer/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/exchangehybrid/MailboxServer/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/exchangehybrid/MailboxServer/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/exchangehybrid/MailboxServer/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/exchangehybrid/MailboxServer/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/exchangehybrid/MailboxServer",
"model_specific_actions": [
"get",
"list",
"update",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "Name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/exchangehybrid/MailboxServer. | GET | /api/device/exchangehybrid/MailboxServer/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/MailboxServer as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/exchangehybrid/MailboxServer/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangehybrid/MailboxServer/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/MailboxServer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/MailboxServer | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/exchangehybrid/MailboxServer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/MailboxServer/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/exchangehybrid/MailboxServer and the JSON format can be used to import instances of device/exchangehybrid/MailboxServer.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/exchangehybrid/MailboxServer/[pkid] | hierarchy=[hierarchy] | The device/exchangehybrid/MailboxServer instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/exchangehybrid/MailboxServer/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/MailboxServer. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/exchangehybrid/MailboxServer/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |