Set-TfsRegistryValue
Sets the value of a given Team Foundation Server registry entry.
Table of Contents
Syntax
Set-TfsRegistryValue
[-Path] <string>
[-Value] <string>
[-Collection <object>]
[-Passthru]
[-Scope <RegistryScope>]
[-Server <object>]
Description
The ‘Set-TfsRegistry’ cmdlet changes the value of a TFS registry key to the value specified in the command.
Examples
Example 1
Gets the current value of the ‘EmailEnabled’ key in the TFS Registry
PS> Get-TfsRegistryValue -Path '/Service/Integration/Settings/EmailEnabled'
Parameters
-Collection (Aliases: Organization)
Specifies the URL to the Team Project Collection or Azure DevOps Organization to connect to, a TfsTeamProjectCollection object (Windows PowerShell only), or a VssConnection object. You can also connect to an Azure DevOps Services organizations by simply providing its name instead of the full URL. For more details, see the Get-TfsTeamProjectCollection cmdlet. When omitted, it defaults to the connection set by Connect-TfsTeamProjectCollection (if any).
| Type | object |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Returns the results of the command. By default, this cmdlet does not generate any output.
| Type | SwitchParameter |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies the full path of the TFS Registry key
| Type | string |
| Position | 0 |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies the scope under which to search for the key. When omitted, defaults to the Server scope. Possible values: User, Collection, Server
| Type | RegistryScope |
| Position | (Named) |
| Default Value | Server |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies the URL to the Team Foundation Server to connect to, a TfsConfigurationServer object (Windows PowerShell only), or a VssConnection object. When omitted, it defaults to the connection set by Connect-TfsConfiguration (if any). For more details, see the Get-TfsConfigurationServer cmdlet.
| Type | object |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies the new value of the Registry key. To remove an existing value, set it to $null
| Type | string |
| Position | 1 |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |