Get-TfsRegistryValue
Gets the value of a given Team Foundation Server registry entry.
Table of Contents
Syntax
Get-TfsRegistryValue
[-Path] <string>
[-Collection <object>]
[-Scope <RegistryScope>]
[-Server <object>]
Description
The ‘Get-TfsRegistry’ cmdlet retrieves the value of a TFS registry entry at the given path and scope. Registry entries can be scoped to the server, to a collection or to a specific user.
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 | True (byvalue) |
| 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 |
Inputs
System.Object
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).