Set-SPTranslationServiceApplication
Sets property settings on a Machine Translation service application.
Syntax
Default (Default)
Set-SPTranslationServiceApplication
[-Identity] <TranslationServiceApplicationPipeBind>
[-AddEnabledFileExtensions <String[]>]
[-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>]
[-AssignmentCollection <SPAssignmentCollection>]
[-ClearEnabledFileExtensions]
[-Confirm]
[-DatabaseCredential <PSCredential>]
[-DatabaseName <String>]
[-DatabaseServer <String>]
[-DisableBinaryFileScan <Boolean>]
[-EnableAllFileExtensions]
[-FailoverDatabaseServer <String>]
[-JobExpirationDays <Int32>]
[-KeepAliveTimeout <Int32>]
[-MachineTranslationAddress <String>]
[-MachineTranslationCategory <String>]
[-MachineTranslationClientId <String>]
[-MaximumBinaryFileSize <Int32>]
[-MaximumItemsPerDay <Int32>]
[-MaximumItemsPerPartitionPerDay <Int32>]
[-MaximumSyncTranslationRequests <Int32>]
[-MaximumTextFileSize <Int32>]
[-MaximumTranslationAttempts <Int32>]
[-MaximumTranslationTime <Int32>]
[-MaximumWordCharacterCount <Int32>]
[-RecycleProcessThreshold <Int32>]
[-RemoveEnabledFileExtensions <String[]>]
[-TimerJobFrequency <Int32>]
[-TotalActiveProcesses <Int32>]
[-TranslationsPerInstance <Int32>]
[-UseDefaultInternetSettings]
[-WebProxyAddress <String>]
[-WhatIf]
[<CommonParameters>]
Description
Use the Set-SPTranslationServiceApplication cmdlet to set properties on a Machine Translation service application in the farm.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
EXAMPLE
Set-SPTranslationServiceApplication TranslationService -JobExpirationDays 14 -TotalActiveProcesses 3
This example sets the job expiration to 14 days and the number of worker processes per server to 3 for the Machine Translation Service application named TranslationService.
Parameters
-AddEnabledFileExtensions
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Comma delimited list of file extensions that you want to add to the set of enabled file extensions for the Machine Translation Service application
To return a list of supported file extensions, type [Microsoft.Office.TranslationServices.TranslationService]::EnumerateFileExtensions().
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ApplicationPool
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the managed application pool that the instance of Translation Service will run in.
Parameter properties
| Type: | SPIisWebServiceApplicationPoolPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AssignmentCollection
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
When the Global parameter is used, all objects are contained in the global store.
If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.
Parameter properties
| Type: | SPAssignmentCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ClearEnabledFileExtensions
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Disables all file extensions for the Machine Translation Service application.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Prompts you for confirmation before executing the command.
For more information, type the following command: get-help about_commonparameters
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseCredential
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the SQL Server credentials used for this Translation Service instance. This parameter to be used only used for SQL authentication; if not present, Windows authentication is used instead.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseName
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the database name which is to be used for this Translation Service instance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseServer
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the database server which is to be used for this Translation Service instance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DisableBinaryFileScan
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Determines whether Gatekeeper is run on binary files.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableAllFileExtensions
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Enables all file extensions for the Machine Translation Service application.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-FailoverDatabaseServer
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the SQL server instance that will be used as a backup to the primary SQL Server instance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the URL or GUID of the instance of the Machine Translation service to set.
The type must be a valid URL in the form, https://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh).
Parameter properties
| Type: | TranslationServiceApplicationPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-JobExpirationDays
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the amount of days after which completed jobs can be automatically removed from the Machine Translation Service queue database.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-KeepAliveTimeout
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the length of time (in seconds) that the worker can be inactive before it is automatically stopped.
The valid values are 60 to 600. The default value is 60.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MachineTranslationAddress
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the service URL the service application will use to call the translation provider. For example, https://api.microsofttranslator.com/v2/soap.svc
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MachineTranslationCategory
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the category which will be used by the service when calling the translation provider.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MachineTranslationClientId
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the AppId which will be used by the service when calling the translation provider.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MaximumBinaryFileSize
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the maximum file size in kilobytes (KB) which can be translated for file types which contain binary data. The valid values are 100 to 524288. The default value is 51200.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MaximumItemsPerDay
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the maximum number of items which can be added to the job queue in a 24-hour period. A value of zero indicates no limit.
The valid values are 1000 to 1000000. A value of zero indicates no limit. The default value is zero.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MaximumItemsPerPartitionPerDay
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the maximum number of items which can be added to the job queue in a 24-hour period per partition. A value of zero indicates no limit.
The valid values are 1000 to 1000000. A value of zero indicates no limit. The default value is zero.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MaximumSyncTranslationRequests
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the maximum number of items which can be added to the sync queue. A valid of zero indicates no limit.
The valid values are 0 to 300. The default value is 10.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MaximumTextFileSize
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the maximum file size in kilobytes (KB) which can be translated for file types which contain mostly text data. The valid values are 100 to 15360. The default value is 5120.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MaximumTranslationAttempts
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the maximum number of attempts an unsuccessful job is tried before it is marked as Failed.
The valid values are 1 to 10. The default value is 2.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MaximumTranslationTime
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the maximum length of time (in minutes) that a translation can take.
The valid values are 60 to 3600. The default value is 600.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MaximumWordCharacterCount
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the maximum character count for a Microsoft Word document which can be translated.
The valid Int values are 10000 to 10000000. The default value is 500000.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RecycleProcessThreshold
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the number of documents which are translated before a Translation Worker process is recycled.
The valid values are 1 to 1,000. The default value is 100.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RemoveEnabledFileExtensions
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Comma delimited list of file extensions that you want to remove from the set of enabled file extensions for the Machine Translation Service application.
To return a list of supported file extensions, type [Microsoft.Office.TranslationServices.TranslationService]::EnumerateFileExtensions().
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TimerJobFrequency
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the frequency (in minutes) with which the timer job for this service application runs. The valid values are 1 to 59. The default value is 15 minutes.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TotalActiveProcesses
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the number of Translation Workers which are simultaneously running on a single machine.
The valid values are 1 to 5. The default value is 1.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TranslationsPerInstance
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the number of translations dispatched to each service instance every time the timer job is run.
Valid values are 1 to 1,000. The default value is 200.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UseDefaultInternetSettings
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Determines whether the service application will use default Internet settings for the user service account to connect to the translation provider.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WebProxyAddress
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the web proxy address and port that the service application will use to connect to the translation provider.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Displays a message that describes the effect of the command instead of executing the command.
For more information, type the following command: get-help about_commonparameters
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.