Azure DevOps v2.7.0, Mar 27 23

azuredevops.ServiceendpointIncomingwebhook

Explore with Pulumi AI

Manages an Incoming WebHook service endpoint within Azure DevOps, which can be used as a resource in YAML pipelines to subscribe to a webhook event.

Example Usage

using System.Collections.Generic;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    var exampleProject = new AzureDevOps.Project("exampleProject", new()
    {
        Visibility = "private",
        VersionControl = "Git",
        WorkItemTemplate = "Agile",
        Description = "Managed by Terraform",
    });

    var exampleServiceendpointIncomingwebhook = new AzureDevOps.ServiceendpointIncomingwebhook("exampleServiceendpointIncomingwebhook", new()
    {
        ProjectId = exampleProject.Id,
        WebhookName = "example_webhook",
        Secret = "secret",
        HttpHeader = "X-Hub-Signature",
        ServiceEndpointName = "Example IncomingWebhook",
        Description = "Managed by Terraform",
    });

});

package main

import (
	"github.com/pulumi/pulumi-azuredevops/sdk/v2/go/azuredevops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleProject, err := azuredevops.NewProject(ctx, "exampleProject", &azuredevops.ProjectArgs{
			Visibility:       pulumi.String("private"),
			VersionControl:   pulumi.String("Git"),
			WorkItemTemplate: pulumi.String("Agile"),
			Description:      pulumi.String("Managed by Terraform"),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewServiceendpointIncomingwebhook(ctx, "exampleServiceendpointIncomingwebhook", &azuredevops.ServiceendpointIncomingwebhookArgs{
			ProjectId:           exampleProject.ID(),
			WebhookName:         pulumi.String("example_webhook"),
			Secret:              pulumi.String("secret"),
			HttpHeader:          pulumi.String("X-Hub-Signature"),
			ServiceEndpointName: pulumi.String("Example IncomingWebhook"),
			Description:         pulumi.String("Managed by Terraform"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.Project;
import com.pulumi.azuredevops.ProjectArgs;
import com.pulumi.azuredevops.ServiceendpointIncomingwebhook;
import com.pulumi.azuredevops.ServiceendpointIncomingwebhookArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleProject = new Project("exampleProject", ProjectArgs.builder()        
            .visibility("private")
            .versionControl("Git")
            .workItemTemplate("Agile")
            .description("Managed by Terraform")
            .build());

        var exampleServiceendpointIncomingwebhook = new ServiceendpointIncomingwebhook("exampleServiceendpointIncomingwebhook", ServiceendpointIncomingwebhookArgs.builder()        
            .projectId(exampleProject.id())
            .webhookName("example_webhook")
            .secret("secret")
            .httpHeader("X-Hub-Signature")
            .serviceEndpointName("Example IncomingWebhook")
            .description("Managed by Terraform")
            .build());

    }
}

import pulumi
import pulumi_azuredevops as azuredevops

example_project = azuredevops.Project("exampleProject",
    visibility="private",
    version_control="Git",
    work_item_template="Agile",
    description="Managed by Terraform")
example_serviceendpoint_incomingwebhook = azuredevops.ServiceendpointIncomingwebhook("exampleServiceendpointIncomingwebhook",
    project_id=example_project.id,
    webhook_name="example_webhook",
    secret="secret",
    http_header="X-Hub-Signature",
    service_endpoint_name="Example IncomingWebhook",
    description="Managed by Terraform")

import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const exampleProject = new azuredevops.Project("exampleProject", {
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
    description: "Managed by Terraform",
});
const exampleServiceendpointIncomingwebhook = new azuredevops.ServiceendpointIncomingwebhook("exampleServiceendpointIncomingwebhook", {
    projectId: exampleProject.id,
    webhookName: "example_webhook",
    secret: "secret",
    httpHeader: "X-Hub-Signature",
    serviceEndpointName: "Example IncomingWebhook",
    description: "Managed by Terraform",
});

resources:
  exampleProject:
    type: azuredevops:Project
    properties:
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Terraform
  exampleServiceendpointIncomingwebhook:
    type: azuredevops:ServiceendpointIncomingwebhook
    properties:
      projectId: ${exampleProject.id}
      webhookName: example_webhook
      secret: secret
      httpHeader: X-Hub-Signature
      serviceEndpointName: Example IncomingWebhook
      description: Managed by Terraform

Create ServiceendpointIncomingwebhook Resource

new ServiceendpointIncomingwebhook(name: string, args: ServiceendpointIncomingwebhookArgs, opts?: CustomResourceOptions);

@overload
def ServiceendpointIncomingwebhook(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   authorization: Optional[Mapping[str, str]] = None,
                                   description: Optional[str] = None,
                                   http_header: Optional[str] = None,
                                   project_id: Optional[str] = None,
                                   secret: Optional[str] = None,
                                   service_endpoint_name: Optional[str] = None,
                                   webhook_name: Optional[str] = None)
@overload
def ServiceendpointIncomingwebhook(resource_name: str,
                                   args: ServiceendpointIncomingwebhookArgs,
                                   opts: Optional[ResourceOptions] = None)

func NewServiceendpointIncomingwebhook(ctx *Context, name string, args ServiceendpointIncomingwebhookArgs, opts ...ResourceOption) (*ServiceendpointIncomingwebhook, error)

public ServiceendpointIncomingwebhook(string name, ServiceendpointIncomingwebhookArgs args, CustomResourceOptions? opts = null)

public ServiceendpointIncomingwebhook(String name, ServiceendpointIncomingwebhookArgs args)
public ServiceendpointIncomingwebhook(String name, ServiceendpointIncomingwebhookArgs args, CustomResourceOptions options)

type: azuredevops:ServiceendpointIncomingwebhook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServiceendpointIncomingwebhookArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ServiceendpointIncomingwebhookArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ServiceendpointIncomingwebhookArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServiceendpointIncomingwebhookArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ServiceendpointIncomingwebhookArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ServiceendpointIncomingwebhook Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ServiceendpointIncomingwebhook resource accepts the following input properties:

ProjectId string: The ID of the project. Changing this forces a new Service Connection Incoming WebHook to be created.
ServiceEndpointName string: The name of the service endpoint. Changing this forces a new Service Connection Incoming WebHook to be created.
WebhookName string: The name of the WebHook.
Authorization Dictionary<string, string>
Description string
HttpHeader string: Http header name on which checksum will be sent.
Secret string: Secret for the WebHook. WebHook service will use this secret to calculate the payload checksum.

ProjectId string: The ID of the project. Changing this forces a new Service Connection Incoming WebHook to be created.
ServiceEndpointName string: The name of the service endpoint. Changing this forces a new Service Connection Incoming WebHook to be created.
WebhookName string: The name of the WebHook.
Authorization map[string]string
Description string
HttpHeader string: Http header name on which checksum will be sent.
Secret string: Secret for the WebHook. WebHook service will use this secret to calculate the payload checksum.

projectId String: The ID of the project. Changing this forces a new Service Connection Incoming WebHook to be created.
serviceEndpointName String: The name of the service endpoint. Changing this forces a new Service Connection Incoming WebHook to be created.
webhookName String: The name of the WebHook.
authorization Map<String,String>
description String
httpHeader String: Http header name on which checksum will be sent.
secret String: Secret for the WebHook. WebHook service will use this secret to calculate the payload checksum.

projectId string: The ID of the project. Changing this forces a new Service Connection Incoming WebHook to be created.
serviceEndpointName string: The name of the service endpoint. Changing this forces a new Service Connection Incoming WebHook to be created.
webhookName string: The name of the WebHook.
authorization {[key: string]: string}
description string
httpHeader string: Http header name on which checksum will be sent.
secret string: Secret for the WebHook. WebHook service will use this secret to calculate the payload checksum.

project_id str: The ID of the project. Changing this forces a new Service Connection Incoming WebHook to be created.
service_endpoint_name str: The name of the service endpoint. Changing this forces a new Service Connection Incoming WebHook to be created.
webhook_name str: The name of the WebHook.
authorization Mapping[str, str]
description str
http_header str: Http header name on which checksum will be sent.
secret str: Secret for the WebHook. WebHook service will use this secret to calculate the payload checksum.

projectId String: The ID of the project. Changing this forces a new Service Connection Incoming WebHook to be created.
serviceEndpointName String: The name of the service endpoint. Changing this forces a new Service Connection Incoming WebHook to be created.
webhookName String: The name of the WebHook.
authorization Map<String>
description String
httpHeader String: Http header name on which checksum will be sent.
secret String: Secret for the WebHook. WebHook service will use this secret to calculate the payload checksum.

Outputs

All input properties are implicitly available as output properties. Additionally, the ServiceendpointIncomingwebhook resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing ServiceendpointIncomingwebhook Resource

Get an existing ServiceendpointIncomingwebhook resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ServiceendpointIncomingwebhookState, opts?: CustomResourceOptions): ServiceendpointIncomingwebhook

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorization: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        http_header: Optional[str] = None,
        project_id: Optional[str] = None,
        secret: Optional[str] = None,
        service_endpoint_name: Optional[str] = None,
        webhook_name: Optional[str] = None) -> ServiceendpointIncomingwebhook

func GetServiceendpointIncomingwebhook(ctx *Context, name string, id IDInput, state *ServiceendpointIncomingwebhookState, opts ...ResourceOption) (*ServiceendpointIncomingwebhook, error)

public static ServiceendpointIncomingwebhook Get(string name, Input<string> id, ServiceendpointIncomingwebhookState? state, CustomResourceOptions? opts = null)

public static ServiceendpointIncomingwebhook get(String name, Output<String> id, ServiceendpointIncomingwebhookState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Authorization Dictionary<string, string>
Description string
HttpHeader string: Http header name on which checksum will be sent.
ProjectId string: The ID of the project. Changing this forces a new Service Connection Incoming WebHook to be created.
Secret string: Secret for the WebHook. WebHook service will use this secret to calculate the payload checksum.
ServiceEndpointName string: The name of the service endpoint. Changing this forces a new Service Connection Incoming WebHook to be created.
WebhookName string: The name of the WebHook.

Authorization map[string]string
Description string
HttpHeader string: Http header name on which checksum will be sent.
ProjectId string: The ID of the project. Changing this forces a new Service Connection Incoming WebHook to be created.
Secret string: Secret for the WebHook. WebHook service will use this secret to calculate the payload checksum.
ServiceEndpointName string: The name of the service endpoint. Changing this forces a new Service Connection Incoming WebHook to be created.
WebhookName string: The name of the WebHook.

authorization Map<String,String>
description String
httpHeader String: Http header name on which checksum will be sent.
projectId String: The ID of the project. Changing this forces a new Service Connection Incoming WebHook to be created.
secret String: Secret for the WebHook. WebHook service will use this secret to calculate the payload checksum.
serviceEndpointName String: The name of the service endpoint. Changing this forces a new Service Connection Incoming WebHook to be created.
webhookName String: The name of the WebHook.

authorization {[key: string]: string}
description string
httpHeader string: Http header name on which checksum will be sent.
projectId string: The ID of the project. Changing this forces a new Service Connection Incoming WebHook to be created.
secret string: Secret for the WebHook. WebHook service will use this secret to calculate the payload checksum.
serviceEndpointName string: The name of the service endpoint. Changing this forces a new Service Connection Incoming WebHook to be created.
webhookName string: The name of the WebHook.

authorization Mapping[str, str]
description str
http_header str: Http header name on which checksum will be sent.
project_id str: The ID of the project. Changing this forces a new Service Connection Incoming WebHook to be created.
secret str: Secret for the WebHook. WebHook service will use this secret to calculate the payload checksum.
service_endpoint_name str: The name of the service endpoint. Changing this forces a new Service Connection Incoming WebHook to be created.
webhook_name str: The name of the WebHook.

authorization Map<String>
description String
httpHeader String: Http header name on which checksum will be sent.
projectId String: The ID of the project. Changing this forces a new Service Connection Incoming WebHook to be created.
secret String: Secret for the WebHook. WebHook service will use this secret to calculate the payload checksum.
serviceEndpointName String: The name of the service endpoint. Changing this forces a new Service Connection Incoming WebHook to be created.
webhookName String: The name of the WebHook.

Import

Azure DevOps Service Endpoint Incoming WebHook can be imported using projectID/serviceEndpointID or projectName/serviceEndpointID

 $ pulumi import azuredevops:index/serviceendpointIncomingwebhook:ServiceendpointIncomingwebhook example 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000

Package Details

Repository: Azure DevOps pulumi/pulumi-azuredevops
License: Apache-2.0
Notes: This Pulumi package is based on the azuredevops Terraform Provider.