en-US/about_AzDoServiceHook.help.txt
|
.NAME
AzDoServiceHook .SYNOPSIS DSC resource for managing Azure DevOps service hook subscriptions. .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. .PARAMETER Name Key - System.String A logical name for the subscription. This is the key; it is not sent to Azure DevOps. .PARAMETER ProjectName Write - System.String Optional project to scope the subscription to; its id is added to the publisher inputs. .PARAMETER PublisherId Required - System.String The event publisher id (e.g. 'tfs', 'rm'). .PARAMETER EventType Required - System.String The event type (e.g. 'git.push', 'build.complete'). .PARAMETER ConsumerId Required - System.String The consumer id (e.g. 'webHooks'). .PARAMETER ConsumerActionId Required - System.String The consumer action id (e.g. 'httpRequest'). .PARAMETER ConsumerInputs Write - HashTable The consumer input values (e.g. @{ url = 'https://...' }). .PARAMETER PublisherInputs Write - HashTable The publisher input values (e.g. @{ repository = '...' }). .PARAMETER ResourceVersion Write - System.String The event resource version. Defaults to '1.0'. |