Link

Get-TfsRestClient

Gets an Azure DevOps HTTP Client object instance.


Table of Contents

  1. Syntax
  2. Description
  3. Parameters
  4. Inputs
  5. Outputs
  6. Related Links

Syntax

Get-TfsRestClient
    [-TypeName] <string>
    [-Collection <object>]
    [-Server <object>]

[Go to top]

Description

Connection objects (Microsoft.VisualStudio.Services.Client.VssConnection in PowerShell Core, Microsoft.TeamFoundation.Client.TfsTeamProjectCollection in Windows PowerShell) provide access to many HTTP client objects such as Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClient that wrap many of the REST APIs exposed by Azure DevOps. Those clients inherit the authentication information supplied by their parent connection object and can be used as a more convenient mechanism to issue API calls.

[Go to top]

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

-Server

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

-TypeName (Aliases: Type)

Specifies the full type name (optionally including its assembly name) of the HTTP Client class to return.

Type string
Position 0
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).

Outputs

Microsoft.VisualStudio.Services.WebApi.VssHttpClientBase