Set-SBRuntimeSetting
Set-SBRuntimeSetting
You can use this cmdlet to modify sb_onprem runtime settings.
Syntax
Parameter Set: Default
Set-SBRuntimeSetting -Name <String> -Value <String> [ <CommonParameters>]
Detailed Description
Run Set-SBRuntimeSetting to change one of the Service Bus for Windows Server runtime settings. Service Bus for Windows Server enables changing some of its runtime attributes which impact quotas and performance of the overall Service Bus for Windows Server service. Before changing runtime settings with the Set-SBRuntimeSetting, it is highly recommended to check the current values by calling Get-SBRuntimeSettings.
Parameters
-Name<String>
The name of the Service Bus for Windows Server configuration parameter.
The valid setting names that can be changed are:
DefaultMaximumQueueSizeInMegabytes – Defines the default maximum queue size in megabytes.
DefaultMaximumTopicSizeInMegabytes – Defines the default maximum topic size in megabytes.
MaximumNumberOfConnectionsPerEntity – Defines the maximum number of connections per entity. Use this setting if you have concerns that a single application may abuse the s2 service and cause a denial of service.
MaximumNumberOfCorrelationFiltersPerTopic – Defines the maximum number of correlation filters per topic.
MaximumNumberOfQueuesPerNamespace – Defines the maximum number of queues per service namespace.
MaximumNumberOfSqlFiltersPerTopic – Defines the maximum number of SQL filters per topic.
MaximumNumberOfSubscriptionsPerTopic – Defines the maximum number of subscriptions per topic.
MaximumNumberOfTopicsPerNamespace - Defines the maximum number of topics per namespace.
MaximumQueueSizeInMegabytes – Defines the maximum number of subscriptions per topic.
MaximumTopicSizeInMegabytes – Defines the maximum topic size in megabytes.
MessageCacheSizePerEntity – Defines the message cache size per entity.
IncludeExceptionDetails – Indicates whether to include exception details.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Value<String>
The value to change for the given setting.
Depending on the setting type, the value should be of the same type. For example, if the setting is an integer type then the value is expected to be a string that represents an integer range from 1 to long.MaxValue (inclusive).
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- string, string
Outputs
The output type is the type of the objects that the cmdlet emits.
- none
Examples
Example
Set the DefaultMaximumQueueSizeInMegabytes to 2048:
PS C:\> Set-SBRuntimeSetting -Name DefaultMaximumQueueSizeInMegabytes -Value 2048