[Index]
Model ref.: device/exchangehybrid/TransportConfig
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": {
"LegacyArchiveJournalingEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "LegacyArchiveJournalingEnabled",
"title": "LegacyArchiveJournalingEnabled",
"required": true,
"type": "boolean",
"description": "This parameter is reserved for internal Microsoft use."
},
"InternalSMTPServers": {
"__type_requested": "MultiValuedProperty",
"__type_mapping_type": "String[]",
"name": "InternalSMTPServers",
"title": "InternalSMTPServers",
"items": {
"type": "string"
},
"required": true,
"readonly": false,
"type": "array",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe InternalSMTPServers parameter specifies a list of internal SMTP server IP addresses or IP address ranges that should be ignored by Sender ID and connection filtering.\nTo enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: \"<value1>\",\"<value2>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}."
},
"PSShowComputerName": {
"__type_requested": "System.Boolean",
"readonly": true,
"__type_mapping_type": "Boolean",
"name": "PSShowComputerName",
"title": "PSShowComputerName",
"required": false,
"type": "boolean"
},
"ShadowMessagePreferenceSetting": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ShadowMessagePreferenceSetting",
"title": "ShadowMessagePreferenceSetting",
"required": true,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe ShadowMessagePreferenceSetting parameter specifies the preferred location for making a shadow copy of a message. Valid values are:\nLocalOnly: A shadow copy of the message should only be made on a server in the local Active Directory site.\nRemoteOnly: A shadow copy of the message should only be made on a server in a different Active Directory site.\nPreferRemote: Try to make a shadow copy of the message in a different Active Directory site. If the operation fails, try make a shadow copy of the message on a server in the local Active Directory site.\nThe default value is PreferRemote."
},
"InternalDelayDsnEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "InternalDelayDsnEnabled",
"title": "InternalDelayDsnEnabled",
"required": true,
"type": "boolean",
"description": "The InternalDelayDsnEnabled parameter specifies whether a delay DSN message should be created for messages sent to or from recipients or senders in the same Exchange organization that couldn't be immediately delivered. Valid input for this parameter is $true or $false. The default value is $true."
},
"VerifySecureSubmitEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "VerifySecureSubmitEnabled",
"title": "VerifySecureSubmitEnabled",
"required": true,
"type": "boolean",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe VerifySecureSubmitEnabled parameter verifies that email clients submitting messages from mailboxes on Mailbox servers are using encrypted MAPI submission. The valid values for this parameter are $true or $false. The default value is $false\nIf the VerifySecureSubmitEnabled parameter is set to $true, and Outlook 2010 or later is used to submit the message, the message is marked as secure. If a previous version of Outlook is used to submit the message, the message is marked as anonymous.\nIf the VerifySecureSubmitEnabled parameter is set to $false, all MAPI message submissions are marked as secure. Messages submitted from mailboxes on the Mailbox server by using any MAPI client aren't checked for encrypted MAPI submission. If you use previous Outlook versions in your Exchange organization, you should set the VerifySecureSubmitEnabled parameter to $false."
},
"AnonymousSenderToRecipientRatePerHour": {
"__type_requested": "System.Int32",
"readonly": false,
"__type_mapping_type": "Integer",
"name": "AnonymousSenderToRecipientRatePerHour",
"title": "AnonymousSenderToRecipientRatePerHour",
"required": true,
"type": "integer",
"description": "This parameter is reserved for internal Microsoft use."
},
"ShadowMessageAutoDiscardInterval": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ShadowMessageAutoDiscardInterval",
"title": "ShadowMessageAutoDiscardInterval",
"required": true,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe ShadowMessageAutoDiscardInterval parameter specifies how long a server retains discard events for shadow messages. A primary server queues discard events until queried by the shadow server. However, if the shadow server doesn't query the primary server for the duration specified in this parameter, the primary server deletes the queued discard events.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nValid input for this parameter is 00:00:05 to 90.00:00:00. The default value is 2.00:00:00 or 2 days."
},
"OriginatingServer": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "OriginatingServer",
"title": "OriginatingServer",
"required": true,
"type": "string"
},
"MaxAllowedAgentGeneratedMessageDepthPerAgent": {
"__type_requested": "UInt32",
"readonly": false,
"__type_mapping_type": "Integer",
"name": "MaxAllowedAgentGeneratedMessageDepthPerAgent",
"title": "MaxAllowedAgentGeneratedMessageDepthPerAgent",
"required": true,
"type": "integer",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe MaxAllowedAgentGeneratedMessageDepthPerAgent parameter specifies how many times a single agent can process any resulting copies of the same message. The default value is 2.\nThe value of the MaxAllowedAgentGeneratedMessageDepth parameter should be larger than the value of the MaxAllowedAgentGeneratedMessageDepthPerAgent parameter."
},
"InternalDsnLanguageDetectionEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "InternalDsnLanguageDetectionEnabled",
"title": "InternalDsnLanguageDetectionEnabled",
"required": true,
"type": "boolean",
"description": "The InternalDsnLanguageDetectionEnabled parameter specifies whether the server should try to send an internal DSN message in the same language as the original message that generated the notification. Valid input for this parameter is $true or $false. The default value is $true."
},
"ConvertReportToMessage": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "ConvertReportToMessage",
"title": "ConvertReportToMessage",
"required": true,
"type": "boolean"
},
"InternalDsnDefaultLanguage": {
"__type_requested": "CultureInfo",
"__type_mapping_type": "Unknown",
"name": "InternalDsnDefaultLanguage",
"title": "InternalDsnDefaultLanguage",
"description": "The InternalDsnDefaultLanguage parameter specifies which Exchange server language should be used by default when you create internal DSN messages. The default value is the default Windows server language.",
"required": true,
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"WhenCreated": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreated",
"title": "WhenCreated",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"ExchangeVersion": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ExchangeVersion",
"title": "ExchangeVersion",
"required": true,
"type": "string"
},
"OrganizationFederatedMailbox": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "OrganizationFederatedMailbox",
"title": "OrganizationFederatedMailbox",
"required": true,
"type": "string",
"description": "The OrganizationFederatedMailbox parameter specifies the SMTP address of the federated mailbox used for federated delivery with other organizations."
},
"TransportRuleRegexValidationTimeout": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "TransportRuleRegexValidationTimeout",
"title": "TransportRuleRegexValidationTimeout",
"required": true,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"RunspaceId": {
"__type_requested": "System.Guid",
"readonly": true,
"__type_mapping_type": "String",
"name": "RunspaceId",
"title": "RunspaceId",
"required": false,
"type": "string"
},
"Guid": {
"__type_requested": "System.Guid",
"readonly": false,
"__type_mapping_type": "String",
"name": "Guid",
"title": "Guid",
"required": true,
"type": "string"
},
"MaxRetriesForLocalSiteShadow": {
"__type_requested": "System.Int32",
"readonly": false,
"__type_mapping_type": "Integer",
"name": "MaxRetriesForLocalSiteShadow",
"title": "MaxRetriesForLocalSiteShadow",
"required": true,
"type": "integer",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe MaxRetriesForLocalSiteShadow parameter specifies the maximum number of attempts to make a shadow copy of the message in the local Active Directory site. Valid input for this parameter is an integer between 0 and 255. The default value is 2. The total number of attempts to create a shadow copy of the message is controlled by the ShadowMessagePreferenceSetting parameter:\nIf ShadowMessagePreferenceSetting is set to LocalOnly, the total number of attempts to make a shadow copy of the message is the value of the MaxRetriesForLocalSiteShadow parameter.\nIf ShadowMessagePreferenceSetting is set to PreferRemote, the total number of attempts to make a shadow copy of the message is the value of the MaxRetriesForLocalSiteShadow and MaxRetriesForRemoteSiteShadow parameters added together.\nIf ShadowMessagePreferenceSetting is set to RemoteOnly, the value of MaxRetriesForLocalSiteShadow is 0, and the MaxRetriesForLocalSiteShadow parameter has no effect on the total number of attempts to create a shadow copy of the message.\nIf a shadow copy of the message isn't created after the specified number of attempts, accepting or rejecting the message is controlled by the RejectMessageOnShadowFailure parameter."
},
"TransportRuleCollectionRegexCharsLimit": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "TransportRuleCollectionRegexCharsLimit",
"title": "TransportRuleCollectionRegexCharsLimit",
"required": true,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"OrganizationId": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "OrganizationId",
"title": "OrganizationId",
"required": true,
"type": "string"
},
"AddressBookPolicyRoutingEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "AddressBookPolicyRoutingEnabled",
"title": "AddressBookPolicyRoutingEnabled",
"required": true,
"type": "boolean",
"description": "The AddressBookPolicyRoutingEnabled parameter controls how recipients are resolved in an organization that uses address book policies to create separate virtual organizations within the same Exchange organization. Specifically, the global address list (GAL) that's specified in the user's address book policy controls how recipients are resolved. When the value of this parameter is $true, users that are assigned different GALs appear as external recipients. When the value of this parameter is $false, users that are assigned different GALs appear as internal recipients.\nThe default value is $false. Note that this parameter has no effect if your organization doesn't use address book policies, or if the address book policy routing agent isn't installed and enabled. Also note that changing the value of this parameter may take up to 30 minutes to take effect. For more information about address book policies, see Address book policies."
},
"LegacyJournalingMigrationEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "LegacyJournalingMigrationEnabled",
"title": "LegacyJournalingMigrationEnabled",
"required": true,
"type": "boolean",
"description": "The LegacyJournalingMigrationEnabled parameter specifies whether journal messages generated in Microsoft Exchange Server 2003 will be reformatted by the current version of Exchange.\nValid input for this parameter is $true or $false. The default value is $false."
},
"OtherWellKnownObjects": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[Microsoft.Exchange.Data.DNWithBinary,",
"__type_mapping_type": "Unknown",
"name": "OtherWellKnownObjects",
"title": "OtherWellKnownObjects",
"required": true,
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"MaxSendSize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MaxSendSize",
"title": "MaxSendSize",
"required": true,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe MaxSendSize parameter specifies the maximum message size that can be sent by senders in the organization. The default value is 10 MB.\nWhen 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.\nThe valid input range for this parameter is from 0 through 2097151 KB. If you enter a value of Unlimited, no limit is imposed on the message size that can be sent by senders in the organization."
},
"ExternalDsnDefaultLanguage": {
"__type_requested": "CultureInfo",
"__type_mapping_type": "Unknown",
"name": "ExternalDsnDefaultLanguage",
"title": "ExternalDsnDefaultLanguage",
"description": "The ExternalDsnDefaultLanguage parameter specifies which Exchange server language should be used by default when you create external DSN messages. The default value is the default Windows server language.",
"required": true,
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"Xexch50Enabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "Xexch50Enabled",
"title": "Xexch50Enabled",
"required": true,
"type": "boolean",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe Xexch50Enabled parameter specifies whether Xexch50 authentication should be enabled for backward compatibility with computers running Exchange 2003. Valid input for this parameter is $true or $false. The default value is $true."
},
"TransportRuleLimit": {
"__type_requested": "System.Int32",
"readonly": false,
"__type_mapping_type": "Integer",
"name": "TransportRuleLimit",
"title": "TransportRuleLimit",
"required": true,
"type": "integer",
"description": "This parameter is reserved for internal Microsoft use."
},
"PreserveReportBodypart": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "PreserveReportBodypart",
"title": "PreserveReportBodypart",
"required": true,
"type": "boolean"
},
"ShadowHeartbeatFrequency": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ShadowHeartbeatFrequency",
"title": "ShadowHeartbeatFrequency",
"required": true,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe ShadowHeartbeatFrequency parameter specifies the amount of time a server waits before establishing a connection to a primary server to query the discard status of shadow messages.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nValid input for this parameter is 00:00:01 to 1.00:00:00. The default value is 00:02:00 or 2 minutes."
},
"DistinguishedName": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "DistinguishedName",
"title": "DistinguishedName",
"required": true,
"type": "string"
},
"ExternalDsnMaxMessageAttachSize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ExternalDsnMaxMessageAttachSize",
"title": "ExternalDsnMaxMessageAttachSize",
"required": true,
"type": "string",
"description": "The ExternalDsnMaxMessageAttachSize parameter specifies the maximum size of the original message attached to an external DSN message. If the original message exceeds this size, only the headers of the original message are included in the DSN message. The default value is 10 megabytes (MB).\nWhen 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.\nThe valid input range for this parameter is from 0 through 2147483647 bytes. If you specify a value of 0, only the original message headers are included in the external DSN message."
},
"MaxReceiveSize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MaxReceiveSize",
"title": "MaxReceiveSize",
"required": true,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe MaxReceiveSize parameter specifies the maximum message size that can be received by recipients in the organization. The default value is 10 MB.\nWhen 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.\nThe valid input range for this parameter is from 0 through 2097151 KB. If you enter a value of Unlimited, no limit is imposed on the message size that can be received by recipients in the organization."
},
"DiagnosticsAggregationServicePort": {
"__type_requested": "System.Int32",
"readonly": false,
"__type_mapping_type": "Integer",
"name": "DiagnosticsAggregationServicePort",
"title": "DiagnosticsAggregationServicePort",
"required": true,
"type": "integer",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe DiagnosticsAggregationServicePort parameter specifies the TCP port that's used to collect message queue diagnostic information. The default value is 9710."
},
"ObjectCategory": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ObjectCategory",
"title": "ObjectCategory",
"required": true,
"type": "string"
},
"IsValid": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "IsValid",
"title": "IsValid",
"required": true,
"type": "boolean"
},
"WhenChanged": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenChanged",
"title": "WhenChanged",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"TLSSendDomainSecureList": {
"__type_requested": "MultiValuedProperty",
"__type_mapping_type": "String[]",
"name": "TLSSendDomainSecureList",
"title": "TLSSendDomainSecureList",
"items": {
"type": "string"
},
"required": true,
"readonly": false,
"type": "array",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe TLSSendDomainSecureList parameter specifies the domains from which you want to send domain secured email by using mutual TLS authentication. To fully support mutual TLS authentication, you must also perform the following steps:\nEnable Domain Security (Mutual Auth TLS) on the Send connectors that send messages to the domains that you specified in the TLSSendDomainSecureList parameter.\nSpecify the domains from which you want to receive domain secured email by using the TLSReceiveDomainSecureList parameter.\nEnable Domain Security (Mutual Auth TLS) and the TLS authentication method on the Receive connectors that receive messages from the domains that you specified in the TLSReceiveDomainSecureList parameter.\nTo enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: \"<value1>\",\"<value2>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}.\nMultiple domains may be separated by commas. The wildcard character (*) isn't supported in the domains listed in the TLSSendDomainSecureList parameter or in the TLSReceiveSecureList parameter. The default values for both parameters are an empty list ({})."
},
"ObjectState": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ObjectState",
"title": "ObjectState",
"required": true,
"type": "string"
},
"GenerateCopyOfDSNFor": {
"__type_requested": "MultiValuedProperty",
"__type_mapping_type": "String[]",
"name": "GenerateCopyOfDSNFor",
"title": "GenerateCopyOfDSNFor",
"items": {
"type": "string"
},
"required": true,
"readonly": false,
"type": "array",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe GenerateCopyOfDSNFor parameter controls the non-delivery reports (NDRs) that are copied to a mailbox by specifying the DSN codes that you want to monitor. You must configure the list of monitored DSNs on one Mailbox server and locally on each Edge Transport server in your Exchange organization.\nOn a Mailbox server, NDRs are copied to the mailbox assigned to the Exchange recipient. On Edge Transport servers, NDRs are copied to the mailbox assigned to the external postmaster address.\nDSN codes are entered as x.y.z and are separated by commas. By default, the following DSN codes are monitored:\n5.4.8\n5.4.6\n5.4.4\n5.2.4\n5.2.0\n5.1.4\nTo enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: \"<value1>\",\"<value2>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}.\nAlthough these DSN codes are monitored by default, the associated NDRs aren't copied to the Exchange recipient or to the external postmaster address if no mailbox is assigned to the Exchange recipient or to the external postmaster address. By default, no mailbox is assigned to the Exchange recipient or to the external postmaster address.\nTo assign a mailbox to the Exchange recipient, use the Set-OrganizationConfig cmdlet with the MicrosoftExchangeRecipientReplyRecipient parameter. To assign a mailbox to the external postmaster address, create a new mailbox postmaster. The default email address policy of the Exchange organization should automatically add an SMTP address of postmaster@<Authoritative domain> to the mailbox."
},
"MaxAllowedAgentGeneratedMessageDepth": {
"__type_requested": "UInt32",
"readonly": false,
"__type_mapping_type": "Integer",
"name": "MaxAllowedAgentGeneratedMessageDepth",
"title": "MaxAllowedAgentGeneratedMessageDepth",
"required": true,
"type": "integer",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe MaxAllowedAgentGeneratedMessageDepth parameter specifies how many times all agents can process any resulting copies of the same message. The default value is 3. Valid input for this parameter is an integer."
},
"ExternalDelayDsnEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "ExternalDelayDsnEnabled",
"title": "ExternalDelayDsnEnabled",
"required": true,
"type": "boolean",
"description": "The ExternalDelayDsnEnabled parameter specifies whether a delay delivery status notification (DSN) message should be created for external messages that couldn't be immediately delivered. Valid input for this parameter is $true or $false. The default value is $true."
},
"AdminDisplayName": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "AdminDisplayName",
"title": "AdminDisplayName",
"required": true,
"type": "string"
},
"OpenDomainRoutingEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "OpenDomainRoutingEnabled",
"title": "OpenDomainRoutingEnabled",
"required": true,
"type": "boolean",
"description": "This parameter is reserved for internal Microsoft use."
},
"JournalReportDLMemberSubstitutionEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "JournalReportDLMemberSubstitutionEnabled",
"title": "JournalReportDLMemberSubstitutionEnabled",
"required": true,
"type": "boolean",
"description": "This parameter is reserved for internal Microsoft use."
},
"DSNConversionMode": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "DSNConversionMode",
"title": "DSNConversionMode",
"required": true,
"type": "string",
"description": "The DSNConversionMode parameter controls how Exchange handles delivery status notifications (DSNs) that are generated by earlier versions of Exchange or non-Exchange messaging systems. You can specify one of the following values for this parameter:\nUseExchangeDSNs\nPreserveDSNBody\nDoNotConvert\nBy default, this parameter is set to UseExchangeDSNs and Exchange converts the DSNs to the Exchange 2013 DSN format, which is the same as the Exchange 2010 DSN format. Any customized text or attachments that were associated with the original DSN are overwritten.\nIf you set this parameter to PreserveDSNBody, Exchange converts the DSNs to Exchange 2013 DSN format. However, the text in the body of the DSN message is retained.\nIf you set this parameter to DoNotConvert, Exchange does not modify the DSN message. Instead, Exchange delivers the message as a standard message."
},
"RedirectDLMessagesForLegacyArchiveJournaling": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "RedirectDLMessagesForLegacyArchiveJournaling",
"title": "RedirectDLMessagesForLegacyArchiveJournaling",
"required": true,
"type": "boolean",
"description": "This parameter is reserved for internal Microsoft use."
},
"SupervisionTags": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,",
"__type_mapping_type": "String[]",
"name": "SupervisionTags",
"title": "SupervisionTags",
"items": {
"type": "string"
},
"required": true,
"readonly": false,
"type": "array",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe SupervisionTags parameter specifies the various tags that are used for transport supervision in the organization.\nWhen you install Exchange, two tags, Allow and Reject, are created by default."
},
"InternalDsnSendHtml": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "InternalDsnSendHtml",
"title": "InternalDsnSendHtml",
"required": true,
"type": "boolean",
"description": "The InternalDsnSendHtml parameter specifies whether internal DSN messages should be sent by using HTML or whether messages should be sent in plain text. Valid input for this parameter is $true or $false. The default is $true."
},
"LegacyArchiveLiveJournalingEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "LegacyArchiveLiveJournalingEnabled",
"title": "LegacyArchiveLiveJournalingEnabled",
"required": true,
"type": "boolean",
"description": "This parameter is reserved for internal Microsoft use."
},
"ShadowHeartbeatRetryCount": {
"__type_requested": "System.Int32",
"readonly": false,
"__type_mapping_type": "Integer",
"name": "ShadowHeartbeatRetryCount",
"title": "ShadowHeartbeatRetryCount",
"required": true,
"type": "integer",
"description": "This parameter is available only in on-premises Exchange 2013.\nThis parameter isn't used by Microsoft Exchange Server 2013. It's only used by Microsoft Exchange 2010 servers in a coexistence environment.\nThe ShadowHeartbeatRetryCount parameter specifies the number of time-outs a server waits before deciding that a primary server has failed and assumes ownership of shadow messages in the shadow queue for the primary server that's unreachable. Valid input for this parameter is an integer between 1 and 15. The default value is 12.\nThis parameter is replaced by the ShadowResubmitTimeSpan parameter."
},
"AgentGeneratedMessageLoopDetectionInSmtpEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "AgentGeneratedMessageLoopDetectionInSmtpEnabled",
"title": "AgentGeneratedMessageLoopDetectionInSmtpEnabled",
"required": true,
"type": "boolean",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe AgentGeneratedMessageLoopDetectionInSmtpEnabled parameter controls the behavior of messages loop detection in for loops caused by transport agents in the Transport service. An agent-generated loop occurs when an agent creates a new copy of a message or adds recipients to a message, and the agent continues to process these resulting messages by creating copies or adding recipients.\nValid input for this parameter is $true or $false. The default value is $false.\nWhen Exchange detects an agent-generated message loop, the loop is stopped. When this parameter is set to $false, the loop is logged in the message tracking log. When this parameter is set to $true, the message is rejected with an NDR when the loop generates the number of messages specified by the MaxAllowedAgentGeneratedMessageDepth and MaxAllowedAgentGeneratedMessageDepthPerAgent parameters."
},
"PSComputerName": {
"__type_requested": "System.String",
"readonly": true,
"__type_mapping_type": "String",
"name": "PSComputerName",
"title": "PSComputerName",
"required": false,
"type": "string"
},
"MaxDumpsterTime": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MaxDumpsterTime",
"title": "MaxDumpsterTime",
"required": true,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2013.\nThis parameter isn't used by Microsoft Exchange Server 2013. It's only used by Microsoft Exchange 2010 servers in a coexistence environment.\nThe MaxDumpsterTime parameter specifies how long an email message should remain in the transport dumpster on a Hub Transport server. The default value is seven days.\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 10 days for this parameter, use 10.00:00:00. The valid input range for this parameter is 00:00:00 to 24855.03:14:07.\nTo enable the transport dumpster, the value of the MaxDumpsterSizePerStorageGroup parameter must be greater than 0, and the value of the MaxDumpsterTime parameter must be greater than 00:00:00.\nThis parameter is replaced by the SafetyNetHoldTime parameter."
},
"RedirectUnprovisionedUserMessagesForLegacyArchiveJournaling": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "RedirectUnprovisionedUserMessagesForLegacyArchiveJournaling",
"title": "RedirectUnprovisionedUserMessagesForLegacyArchiveJournaling",
"required": true,
"type": "boolean",
"description": "This parameter is reserved for internal Microsoft use."
},
"Identity": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "Identity",
"title": "Identity",
"required": true,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"AgentGeneratedMessageLoopDetectionInSubmissionEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "AgentGeneratedMessageLoopDetectionInSubmissionEnabled",
"title": "AgentGeneratedMessageLoopDetectionInSubmissionEnabled",
"required": true,
"type": "boolean",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe AgentGeneratedMessageLoopDetectionInSubmissionEnabled parameter controls the behavior of messages loop detection in for loops caused by transport agents in the Mailbox Transport Submission service. An agent-generated loop occurs when an agent creates a new copy of a message or adds recipients to a message, and the agent continues to process these resulting messages by creating copies or adding recipients.\nValid input for this parameter is $true or $false. The default value is $false.\nWhen Exchange detects an agent-generated message loop, the loop is stopped. When this parameter is set to $true, the loop is logged in the message tracking log. When this parameter is set to $false, the message is rejected with an NDR when the loop generates the number of messages specified by the MaxAllowedAgentGeneratedMessageDepthPerAgent and MaxAllowedAgentGeneratedMessageDepth parameters."
},
"RejectMessageOnShadowFailure": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "RejectMessageOnShadowFailure",
"title": "RejectMessageOnShadowFailure",
"required": true,
"type": "boolean",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe RejectMessageOnShadowFailure parameter accepts or rejects messages when a shadow copy of a message can't be created. Valid input for this parameter is $true or $false. The default value is $true.\nWhen this parameter is set to $true, messages are rejected with the SMTP code 450 4.5.1. When this parameter is set to $false, the message is accepted without making a shadow copy.\nThe number of attempts to make a shadow copy of the message and where to make the shadow copy are controlled by the MaxRetriesForLocalSiteShadow, MaxRetriesForRemoteSiteShadow, and ShadowMessagePreferenceSetting parameter settings."
},
"InternalDsnMaxMessageAttachSize": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "InternalDsnMaxMessageAttachSize",
"title": "InternalDsnMaxMessageAttachSize",
"required": true,
"type": "string",
"description": "The InternalDsnMaxMessageAttachSize parameter specifies the maximum size of the original message that generated an internal DSN message. If the original message exceeds this size, only the headers of the original message are included in the DSN message. The default value is 10 MB.\nWhen 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.\nThe valid input range for this parameter is from 0 through 2147483647 bytes. If you specify a value of 0, only the original message headers are included in the internal DSN message."
},
"HeaderPromotionModeSetting": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "HeaderPromotionModeSetting",
"title": "HeaderPromotionModeSetting",
"required": true,
"type": "string",
"description": "The HeaderPromotionModeSetting parameter specifies whether named properties are created for custom X-headers on messages received from outside the Exchange organization. You can use one of the following values:\nMustCreate Exchange creates a named property for each new custom X-header.\nMayCreate Exchange creates a named property for each new custom X-header on messages received from authenticated senders. No named properties are created for custom X-headers on messages received from unauthenticated senders.\nNoCreate Exchange won't create any named properties based on custom X-headers on incoming messages."
},
"JournalingReportNdrTo": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "JournalingReportNdrTo",
"title": "JournalingReportNdrTo",
"required": true,
"type": "string",
"description": "The JournalingReportNdrTo parameter specifies the email address to which journal reports are sent if the journaling mailbox is unavailable. By default, if this parameter is left empty, Exchange continues to try to deliver the journal report to the journaling mailbox."
},
"ShadowHeartbeatTimeoutInterval": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ShadowHeartbeatTimeoutInterval",
"title": "ShadowHeartbeatTimeoutInterval",
"required": true,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2013.\nThis parameter isn't used by Microsoft Exchange Server 2013. It's only used by Microsoft Exchange 2010 servers in a coexistence environment.\nThe ShadowHeartbeatTimeoutInterval parameter specifies the amount of time a server waits before establishing a connection to a primary server to query the discard status of shadow messages.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nValid input for this parameter is 00:00:01 to 1.00:00:00. The default value is 00:15:00 or 15 minutes.\nThis parameter is replaced by the ShadowHeartbeatFrequency parameter."
},
"MaxRecipientEnvelopeLimit": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MaxRecipientEnvelopeLimit",
"title": "MaxRecipientEnvelopeLimit",
"required": true,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe MaxRecipientEnvelopeLimit parameter specifies the maximum number of recipients in a message. The default value is 5000. The valid input range for this parameter is from 0 through 2147483647. If you enter a value of Unlimited, no limit is imposed on the number of recipients in a message. Exchange treats an unexpanded distribution group as one recipient."
},
"Rfc2231EncodingEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "Rfc2231EncodingEnabled",
"title": "Rfc2231EncodingEnabled",
"required": true,
"type": "boolean",
"description": "The Rfc2231EncodingEnabled parameter specifies whether the RFC 2231 encoding of MIME parameters for outbound messages is enabled in your organization. Valid input for this parameter is $true or $false. The default value is $false."
},
"ShadowResubmitTimeSpan": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "ShadowResubmitTimeSpan",
"title": "ShadowResubmitTimeSpan",
"required": true,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe ShadowResubmitTimeSpan parameter specifies amount of time a server waits before deciding that a primary server has failed and assumes ownership of shadow messages in the shadow queue for the primary server that's unreachable.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nValid input for this parameter is 00:00:01 to 1.00:00:00. The default value is 03:00:00 or 3 hours.\nThis parameter replaces the ShadowHeartbeatRetryCount parameter."
},
"InternalDsnReportingAuthority": {
"__type_requested": "SmtpDomain",
"__type_mapping_type": "Unknown",
"name": "InternalDsnReportingAuthority",
"title": "InternalDsnReportingAuthority",
"description": "The InternalDsnReportingAuthority parameter specifies what the server name should be in the internal DSN message. The default value is the authoritative domain specified during installation.",
"required": true,
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"WhenChangedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenChangedUTC",
"title": "WhenChangedUTC",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"ExternalPostmasterAddress": {
"__type_requested": "SmtpAddress",
"__type_mapping_type": "Unknown",
"name": "ExternalPostmasterAddress",
"title": "ExternalPostmasterAddress",
"description": "The ExternalPostmasterAddress parameter specifies the email address in the From header field of an external DSN message. The default value is $null. In the Transport service on a Mailbox server, the value of the external postmaster email address is postmaster@<defaultaccepteddomain>. If an Edge Transport server hasn't yet been through the EdgeSync process, and the ExternalPostmasterAddress parameter is set to $null, the external postmaster email address on the Edge Transport server is postmaster@<edgetransportserverfqdn>. If an Edge Transport server has completed the EdgeSync process, and the ExternalPostmasterAddress parameter is set to $null, the external postmaster email address on the Edge Transport server is postmaster@<defaultaccepteddomain>. To override the default behavior, you can specify an email address for the ExternalPostMasterAddress parameter.",
"required": true,
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"QueueDiagnosticsAggregationInterval": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "QueueDiagnosticsAggregationInterval",
"title": "QueueDiagnosticsAggregationInterval",
"required": true,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe QueueDiagnosticsAggregationInterval parameter specifies the polling interval that's used to retrieve message queue diagnostic information. The default value is 00:01:00 or one minute.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds."
},
"ExternalDsnSendHtml": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "ExternalDsnSendHtml",
"title": "ExternalDsnSendHtml",
"required": true,
"type": "boolean",
"description": "The ExternalDsnSendHtml parameter specifies whether external DSN messages should be sent by using HTML or whether messages should be sent in plain text. Valid input for this parameter is $true or $false.The default value is $true."
},
"WhenCreatedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreatedUTC",
"title": "WhenCreatedUTC",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"SafetyNetHoldTime": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "SafetyNetHoldTime",
"title": "SafetyNetHoldTime",
"required": true,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe SafetyNetHoldTime parameter specifies how long a copy of a successfully processed message is retained in Safety Net. Unacknowledged shadow copies of messages auto-expire from Safety Net based on adding the values of the SafetyNetHoldTime parameter and the MessageExpirationTimeout parameter on the Set-TransportService cmdlet.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nThe default value is 2.00:00:00 or 2 days."
},
"JournalArchivingEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "JournalArchivingEnabled",
"title": "JournalArchivingEnabled",
"required": true,
"type": "boolean",
"description": "This parameter is reserved for internal Microsoft use."
},
"TLSReceiveDomainSecureList": {
"__type_requested": "MultiValuedProperty",
"__type_mapping_type": "String[]",
"name": "TLSReceiveDomainSecureList",
"title": "TLSReceiveDomainSecureList",
"items": {
"type": "string"
},
"required": true,
"readonly": false,
"type": "array",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe TLSReceiveDomainSecureList parameter specifies the domains from which you want to receive domain secured email by using mutual Transport Layer Security (TLS) authentication. To fully support mutual TLS authentication, you must also perform the following steps:\nEnable Domain Security (Mutual Auth TLS) and the TLS authentication method on the Receive connectors that receive messages from the domains that you specified with the TLSReceiveDomainSecureList parameter.\nSpecify the domains to which you want to send domain secured email by using the TLSSendDomainSecureList parameter.\nEnable Domain Security (Mutual Auth TLS) on the Send connectors that send messages to the domains that you specified in the TLSSendDomainSecureList parameter.\nTo enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: \"<value1>\",\"<value2>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}.\nThe wildcard character (*) isn't supported in the domains listed in the TLSReceiveDomainSecureList parameter or in the TLSSendDomainSecureList parameter. The default value for both parameters is an empty list ({})."
},
"TransportRuleSizeLimit": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "TransportRuleSizeLimit",
"title": "TransportRuleSizeLimit",
"required": true,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"TransportRuleMinProductVersion": {
"__type_requested": "Version",
"__type_mapping_type": "Unknown",
"name": "TransportRuleMinProductVersion",
"title": "TransportRuleMinProductVersion",
"description": "This parameter is reserved for internal Microsoft use.",
"required": true,
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"TransportRuleCollectionAddedRecipientsLimit": {
"__type_requested": "System.Int32",
"readonly": false,
"__type_mapping_type": "Integer",
"name": "TransportRuleCollectionAddedRecipientsLimit",
"title": "TransportRuleCollectionAddedRecipientsLimit",
"required": true,
"type": "integer",
"description": "This parameter is reserved for internal Microsoft use."
},
"ObjectClass": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,",
"__type_mapping_type": "String[]",
"name": "ObjectClass",
"title": "ObjectClass",
"items": {
"type": "string"
},
"required": true,
"readonly": false,
"type": "array"
},
"HygieneSuite": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "HygieneSuite",
"title": "HygieneSuite",
"required": true,
"type": "string",
"description": "This parameter is reserved for internal Microsoft use."
},
"ConvertDisclaimerWrapperToEml": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "ConvertDisclaimerWrapperToEml",
"title": "ConvertDisclaimerWrapperToEml",
"required": true,
"type": "boolean",
"description": "The ConvertDisclaimerWrapperToEml parameter specifies whether the original message will be added as a TNEF attachment or a regular EML attachment to a disclaimer when all of the following are true:\nMessage is sent to an external user.\nThe sender has signed the message.\nThe message is processed by a Transport rule that adds a disclaimer.\nWhen a Transport rule that adds disclaimers to outbound messages encounters a message signed by the sender, the Transport rule can't add the disclaimer directly to the message. As a result, the disclaimer is sent to the intended recipient with the original message as an attachment.\nValid input for this parameter is $true or $false. The default value is $false. If you set this parameter to $true, the original message is sent as an EML attachment. Otherwise, it is sent as a TNEF attachment."
},
"MaxRetriesForRemoteSiteShadow": {
"__type_requested": "System.Int32",
"readonly": false,
"__type_mapping_type": "Integer",
"name": "MaxRetriesForRemoteSiteShadow",
"title": "MaxRetriesForRemoteSiteShadow",
"required": true,
"type": "integer",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe MaxRetriesForRemoteSiteShadow parameter specifies the maximum number of attempts to make a shadow copy of the message in a different Active Directory site. Valid input for this parameter is an integer between 0 and 255. The default value is 4. The total number of attempts to create a shadow copy of the message is controlled by the ShadowMessagePreferenceSetting parameter:\nIf ShadowMessagePreferenceSetting is set to RemoteOnly, the total number of attempts to make a shadow copy of the message is the value of the MaxRetriesForRemoteSiteShadow parameter.\nIf ShadowMessagePreferenceSetting is set to PreferRemote, the total number of attempts to make a shadow copy of the message is the value of the MaxRetriesForLocalSiteShadow and MaxRetriesForRemoteSiteShadow parameters added together.\nIf ShadowMessagePreferenceSetting is set to LocalOnly, the value of MaxRetriesForRemoteSiteShadow is 0, and the MaxRetriesForRemoteSiteShadow parameter has no effect on the total number of attempts to create a shadow copy of the message.\nIf a shadow copy of the message isn't created after the specified number of attempts, accepting or rejecting the message is controlled by the RejectMessageOnShadowFailure parameter."
},
"Name": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "Name",
"title": "Name",
"required": true,
"type": "string"
},
"TransportRuleConfig": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,",
"__type_mapping_type": "String[]",
"name": "TransportRuleConfig",
"title": "TransportRuleConfig",
"items": {
"type": "string"
},
"required": true,
"readonly": false,
"type": "array"
},
"ShadowRedundancyEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "ShadowRedundancyEnabled",
"title": "ShadowRedundancyEnabled",
"required": true,
"type": "boolean",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe ShadowRedundancyEnabled parameter specifies whether shadow redundancy is enabled in the organization. Valid input for this parameter is $true or $false. The default value is $true."
},
"VoicemailJournalingEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "VoicemailJournalingEnabled",
"title": "VoicemailJournalingEnabled",
"required": true,
"type": "boolean",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe VoicemailJournalingEnabled parameter specifies whether Unified Messaging voice mail messages are journaled by the Journaling agent. Valid input for this parameter is $true or $false. The default value is $true."
},
"ExternalDsnReportingAuthority": {
"__type_requested": "SmtpDomain",
"__type_mapping_type": "Unknown",
"name": "ExternalDsnReportingAuthority",
"title": "ExternalDsnReportingAuthority",
"description": "The ExternalDsnReportingAuthority parameter specifies what the server name should be in the machine-readable part of the external DSN message. The default value is the authoritative domain specified during installation.",
"required": true,
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"ClearCategories": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "ClearCategories",
"title": "ClearCategories",
"required": true,
"type": "boolean",
"description": "The ClearCategories parameter keeps or removes Microsoft Outlook message categories during content conversion. Valid input for this parameter is $true or $false. The default value is $true. This means that by default, Outlook message categories are removed during content conversion."
},
"ExternalDsnLanguageDetectionEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "ExternalDsnLanguageDetectionEnabled",
"title": "ExternalDsnLanguageDetectionEnabled",
"required": true,
"type": "boolean",
"description": "The ExternalDsnLanguageDetectionEnabled parameter specifies whether the server should try to send an external DSN message in the same language as the original message that generated the notification. Valid input for this parameter is $true or $false.The default value is $true."
},
"TransportRuleAttachmentTextScanLimit": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "TransportRuleAttachmentTextScanLimit",
"title": "TransportRuleAttachmentTextScanLimit",
"required": true,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2013.\nThe TransportRuleAttachmentTextScanLimit parameter specifies the maximum size of text to extract from attachments for scanning by attachment scanning predicates in transport rules and data loss prevention (DLP) policies. The default value is 150 kilobytes (KB).\nWhen 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.\nIf the amount of text in the attachment is larger than the value of this parameter, only the specified amount of text is scanned. For example, if a 5 megabyte attachment contains 300 kilobytes of text, and the value of TransportRuleAttachmentTextScanLimit is 150 kilobytes, only the first 150 kilobytes of text are extracted and scanned."
},
"Id": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "Id",
"title": "Id",
"required": true,
"type": "string"
},
"MigrationEnabled": {
"__type_requested": "System.Boolean",
"readonly": false,
"__type_mapping_type": "Boolean",
"name": "MigrationEnabled",
"title": "MigrationEnabled",
"required": true,
"type": "boolean",
"description": "This parameter is reserved for internal Microsoft use."
},
"MaxDumpsterSizePerDatabase": {
"__type_requested": "System.String",
"readonly": false,
"__type_mapping_type": "String",
"name": "MaxDumpsterSizePerDatabase",
"title": "MaxDumpsterSizePerDatabase",
"required": true,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2013.\nThis parameter isn't used by Microsoft Exchange Server 2013. It's only used by Microsoft Exchange 2010 servers in a coexistence environment.\nThe MaxDumpsterSizePerDatabase parameter specifies the maximum size of the transport dumpster on a Hub Transport server for each database. The default value is 18 MB. The valid input range for this parameter is from 0 through 2147483647 KB.\nWhen 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.\nTo enable the transport dumpster, the value of the MaxDumpsterSizePerDatabase parameter must be greater than 0, and the value of the MaxDumpsterTime parameter must be greater than 00:00:00.\nThis parameter has no replacement in Exchange 2013."
}
},
"schema_version": "15312"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/exchangehybrid/TransportConfig/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/exchangehybrid/TransportConfig/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/TransportConfig/[pkid1]", "/api/v0/device/exchangehybrid/TransportConfig/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/TransportConfig/?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/TransportConfig |
|
{"hrefs": ["/api/device/exchangehybrid/TransportConfig/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/TransportConfig |
|
{"hrefs": ["/api/device/exchangehybrid/TransportConfig/[pkid1]", "/api/device/exchangehybrid/TransportConfig/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/TransportConfig; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/TransportConfig/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/TransportConfig/[pkid1]", "/api/device/exchangehybrid/TransportConfig/[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/TransportConfig and the JSON format can be used to import instances of device/exchangehybrid/TransportConfig.
GET http://[host-proxy]/api/device/exchangehybrid/TransportConfig/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/TransportConfig | POST | /api/device/exchangehybrid/TransportConfig/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/TransportConfig/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/TransportConfig/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/exchangehybrid/TransportConfig/ |
|
The device/exchangehybrid/TransportConfig schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/TransportConfig instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "Name",
"direction": "asc",
"current": "/api/device/exchangehybrid/TransportConfig/?skip=0&limit=3&order_by=Name&direction=asc&traversal=down"
},
"operations": [
"move"
],
"meta": {
"model_type": "device/exchangehybrid/TransportConfig",
"summary_attrs": [
{
"name": "Name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"get",
"list",
"update",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"schema_version": "15312",
"actions": [
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/exchangehybrid/TransportConfig/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchangehybrid/TransportConfig",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/exchangehybrid/TransportConfig/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/device/exchangehybrid/TransportConfig/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/exchangehybrid/TransportConfig/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/exchangehybrid/TransportConfig/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/exchangehybrid/TransportConfig/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/exchangehybrid/TransportConfig/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/exchangehybrid/TransportConfig/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/exchangehybrid/TransportConfig. | GET | /api/device/exchangehybrid/TransportConfig/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/TransportConfig as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/exchangehybrid/TransportConfig/purge/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/exchangehybrid/TransportConfig/[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/TransportConfig/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/TransportConfig/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/TransportConfig | 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/TransportConfig; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/TransportConfig/[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/TransportConfig and the JSON format can be used to import instances of device/exchangehybrid/TransportConfig.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/exchangehybrid/TransportConfig/[pkid] | hierarchy=[hierarchy] | The device/exchangehybrid/TransportConfig instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/exchangehybrid/TransportConfig/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/TransportConfig. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/exchangehybrid/TransportConfig/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |