Link

Get-TfsServiceHookSubscription

Gets one or more service hook subscriptions


Table of Contents

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

Syntax

Get-TfsServiceHookSubscription
    [-Subscription <object>]
    [-Collection <object>]
    [-Consumer <object>]
    [-EventType <string>]
    [-Publisher <object>]
    [-Server <object>]

[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

Specifies the name or ID of the service hook consumer to filter subscriptions by. When omitted, returns all subscriptions regardless of their consumers.

Type object
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-EventType

Specifies the event type to filter subscriptions by. When omitted, returns all subscriptions regardless of their event types.

Type string
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-Publisher

Specifies the name or ID of the service hook publisher to filter subscriptions by. When omitted, returns all subscriptions regardless of their publishers.

Type object
Position (Named)
Default Value (N/A)
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

-Subscription (Aliases: Name)

Specifies the name (“action description”) of the subscription. Wildcards are supported. When omitted, returns all service hook subscriptions in the given team project collection.

Type object
Position 0
Default Value *
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.Subscription