Hosts - Put
Update host instance settings
PUT http://localhost/BizTalkManagementService/Hosts/Settings/{hostName}URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
host
|
path | True |
string |
Name of the host |
Request Body
Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| Name | Type | Description |
|---|---|---|
| GeneralSettings |
General settings |
|
| MessageProcessThrottlingSettings |
Message process throttling settings |
|
| OrchestrationThrottlingSettings |
Orchestration throttling settings |
|
| ResourceBasedThrottlingSettings |
Resource based throttlingS settings |
Responses
| Name | Type | Description |
|---|---|---|
| 204 No Content |
No Content |
Definitions
| Name | Description |
|---|---|
|
General |
General gettings |
|
Host |
Host settings |
|
Message |
Message process throttling settings |
|
Orchestration |
Orchestration throttling settings |
|
Resource |
Resource based throttlingS settings |
GeneralSettings
General gettings
| Name | Type | Description |
|---|---|---|
| AllowMultipleResponses |
boolean |
This property allow multiple responses to be sent back to a 2-way RL (Isolated-host ONLY). |
| AuthTrusted |
boolean |
This property indicates whether the BizTalk Host is trusted to collect authentication information. |
| DecryptCertComment |
string |
This is a comment field that allows to associate some friendly name with a decryption certificate. |
| DecryptCertThumbprint |
string |
ThumbPrint of the Decryption certificate. |
| HostTracking |
boolean |
whether instances of this BizTalk Host will host the tracking sub service |
| IsHost32BitOnly |
boolean |
This property indicates whether the host instance process should be created as 32-bit on both 32-bit and 64-bit servers. |
| LegacyWhitespace |
boolean |
This property turns preservation of White Spaces with mapping on or off. |
| MessagingMaxReceiveInterval |
integer |
Messaging polling interval in milliseconds |
| MessagingReqRespTTL |
integer |
Default timeout for request response messages. |
| MsgAgentPerfCounterServiceClassID |
string |
service for which perf counters are shown. |
| ThreadPoolSize |
integer |
Maximum number of messaging engine threads per CPU. |
| UseDefaultAppDomainForIsolatedAdapter |
boolean |
This property controls whether the isolated adapter runs in default app domain or the domain of the caller. |
| XlangMaxReceiveInterval |
integer |
Polling intervals i milliseconds of orchestrations running in this host. |
HostSettings
Host settings
| Name | Type | Description |
|---|---|---|
| GeneralSettings |
General settings |
|
| MessageProcessThrottlingSettings |
Message process throttling settings |
|
| OrchestrationThrottlingSettings |
Orchestration throttling settings |
|
| ResourceBasedThrottlingSettings |
Resource based throttlingS settings |
MessageProcessThrottlingSettings
Message process throttling settings
| Name | Type | Description |
|---|---|---|
| MessageDeliveryMaximumDelay |
integer |
Maximum Delay (in milliseconds) imposed for Message Delivery Throttling. Zero indicates disable Message Delivery Throttling. |
| MessageDeliveryOverdriveFactor |
integer |
Percent factor by which the system will overdrive the Input rate for Message Delivery Throttling. |
| MessageDeliverySampleSpaceSize |
integer |
|
| MessageDeliverySampleSpaceWindow |
integer |
Time-window (in milliseconds) beyond which samples will be deemed invalid for consideration. |
| MessagePublishMaximumDelay |
integer |
Maximum Delay (in milliseconds) imposed for Message Publishing Throttling. Zero indicates disable Message Publishing Throttling. |
| MessagePublishOverdriveFactor |
integer |
Percent Factor by which the system will overdrive the Input rate. |
| MessagePublishSampleSpaceSize |
integer |
Number of samples that are used for determining the rate of the Message Publishing by the Service Classes. |
| MessagePublishSampleSpaceWindow |
integer |
Time-window (in milliseconds) beyond which samples will be deemed invalid for consideration. |
| ThrottlingDeliveryOverride |
integer |
This property increases / decreases the severity of an outbound throttling condition. |
| ThrottlingDeliveryOverrideSeverity |
integer |
This property increases / decreases the severity of an outbound throttling condition. |
| ThrottlingPublishOverride |
integer |
This property increases / decreases the severity of an inbound throttling condition. |
| ThrottlingPublishOverrideSeverity |
integer |
This property increases / decreases the severity of an outbound throttling condition. |
OrchestrationThrottlingSettings
Orchestration throttling settings
| Name | Type | Description |
|---|---|---|
| DehydrationBehavior |
integer |
dehydration behavior of the orhestration(XLANG) engine. Only if Custom is selected then other xlang settings should be editable. ValueMap {"0", "1", "2"}, Values {"Always", "Never", "Custom"}] |
| SubscriptionPauseAt |
integer |
If any subscription has >= PauseAt messages waiting to be consumed, then stop delivering messages to subscription instance. |
| SubscriptionResumeAt |
integer |
If any subscription was paused due to PauseAt setting and no of outstanding messages got down to ResumeAt value, then messagebox will resume giving messages to subscription. |
| TimeBasedMaxThreshold |
integer |
Max waittime (sec) an orchestration instance could block before being dehydrated. |
| TimeBasedMinThreshold |
integer |
Min waittime(sec) an orchestration instance could block before being dehydrated. |
ResourceBasedThrottlingSettings
Resource based throttlingS settings
| Name | Type | Description |
|---|---|---|
| DBQueueSizeThreshold |
integer |
Maximum number of items in the Database. |
| DBSessionThreshold |
integer |
Maximum number of DB Sessions (per CPU) allowed before throttling begins. |
| DeliveryQueueSize |
integer |
Size of the in-memory Queue that the host maintains as a temporary placeholder for delivering messages. |
| GlobalMemoryThreshold |
integer |
Maximum System-wide Virtual Memory (in percent) usage allowed before throttling begins. |
| InflightMessageThreshold |
integer |
Maximum number of in-memory in-flight messages allowed before throttling Message Delivery begins. |
| ProcessMemoryThreshold |
integer |
Maximum Process Memory (in percent) allowed before throttling begins. |
| ThreadThreshold |
integer |
Maximum number of threads in the process (per CPU) allowed before throttling begins. |
| ThrottlingBatchMemoryThresholdPercent |
integer |
This property controls the memory threshold beyond which to throttle the publishing of a batch of messages. The batch memory threshold is computed by multiplying this percentage factor by the Process memory usage threshold. If the memory estimated to execute a publishing batch exceeds the batch memory threshold, the batch will be subject to process memory based throttling. Otherwise the batch will be exempt from process memory based throttling even when the total process memory exceeds the Process memory usage threshold. A value of zero indicates that all publishing batches may be subject to process memory based throttling even if the memory estimated to execute the batch is minimal. |
| ThrottlingLimitToTriggerGC |
integer |
This property controls when a .NET garbage collection (GC) will be triggered as process memory consumption increases and approaches the threshold. When the memory consumption exceeds this percentage value of the memory threshold, a GC is triggered. |
| ThrottlingSeverityDatabaseSize |
integer |
This property controls the severity of a database sized triggered throttling condition. This is specified in percentage value and this parameter sets the severity of a throttling condition caused when the Message count in database threshold is exceeded. |
| ThrottlingSeverityInflightMessage |
integer |
This property controls the reaction time of throttling when the In-process size exceeds the threshold. This is specified in percentage value and this parameter sets the severity of a throttling condition caused when the In-process messages per CPU threshold is exceeded. |
| ThrottlingSeverityProcessMemory |
integer |
This property controls the severity of a process memory triggered throttling condition. This is specified in percentage value and this parameter sets the severity of a throttling condition caused when the Process memory usage threshold is exceeded. |
| ThrottlingSpoolMultiplier |
integer |
This property specifies the factor by which the Message count in database threshold will be multiplied and then compared against the current record count in the spool table to determine whether the system should throttle on spool table size. If this is set to 0, spool table size is not used as a consideration for determining a throttling condition. Max value 1000 |
| ThrottlingTrackingDataMultiplier |
integer |
This property specifies the factor by which the Message count in database threshold will be multiplied and then compared against the current record count in the tracking table to determine whether the system should throttle on tracking table size. If this is set to 0, tracking table size is not used as a consideration for determining a throttling condition. |