Skip to content

AzDoServiceHook

github-actions[bot] edited this page Aug 19, 2026 · 4 revisions

Parameters

Parameter Attribute DataType Description Allowed Values
Name Key System.String A logical name for the subscription. This is the key; it is not sent to Azure DevOps.
ConsumerActionId Required System.String The consumer action id (e.g. 'httpRequest').
ConsumerId Required System.String The consumer id (e.g. 'webHooks').
EventType Required System.String The event type (e.g. 'git.push', 'build.complete').
PublisherId Required System.String The event publisher id (e.g. 'tfs', 'rm').
ConsumerInputs Write System.Collections.Hashtable The consumer input values (e.g. @{ url = 'https://...' }).
Ensure Write Ensure Present, Absent
ProjectName Write System.String Optional project to scope the subscription to; its id is added to the publisher inputs.
PublisherInputs Write System.Collections.Hashtable The publisher input values (e.g. @{ repository = '...' }).
ResourceVersion Write System.String The event resource version. Defaults to '1.0'.
LookupResult Read System.Collections.Hashtable

Description

The AzDoServiceHook resource creates and manages service hook subscriptions (e.g. webhooks to external systems) via the Service Hooks REST API. Subscriptions have no native name, so the Name property is a logical DSC handle; the live subscription is matched by its identity tuple (publisherId + eventType + consumerId + consumerActionId, plus the consumer 'url'). It inherits Test()/Set() from the AzDevOpsDscResourceBase class.

Commands

Resources

Clone this wiki locally