Link

Get-TfsServiceHookConsumer

Gets one or more service hook consumers.


Table of Contents

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

Syntax

Get-TfsServiceHookConsumer
    [-Consumer <string>]
    [-Collection <object>]
    [-Server <object>]

[Go to top]

Description

Service hook consumers are the services that can consume (receive) notifications triggered by Azure DevOps. Examples of consumers available out-of-box with Azure DevOps are Microsoft Teams, Slack, Trello ou the generic WebHook consumer. Use this cmdlet to list the available consumers and get the ID of the desired one to be able to manage service hook subscriptions.

[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

-Consumer (Aliases: Name, Id)

Specifies the name or ID of the service hook consumer to return. Wildcards are supported. When omitted, all service hook consumers registered in the given project collection/organization are returned.

Type string
Position 0
Default Value *
Accept pipeline input False
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

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.ServiceHooks.WebApi.Consumer