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
import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";
const example = new azuredevops.Project("example", {
    name: "Example Project",
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
    description: "Managed by Pulumi",
});
const exampleServiceendpointIncomingwebhook = new azuredevops.ServiceendpointIncomingwebhook("example", {
    projectId: example.id,
    webhookName: "example_webhook",
    secret: "secret",
    httpHeader: "X-Hub-Signature",
    serviceEndpointName: "Example IncomingWebhook",
    description: "Managed by Pulumi",
});
import pulumi
import pulumi_azuredevops as azuredevops
example = azuredevops.Project("example",
    name="Example Project",
    visibility="private",
    version_control="Git",
    work_item_template="Agile",
    description="Managed by Pulumi")
example_serviceendpoint_incomingwebhook = azuredevops.ServiceendpointIncomingwebhook("example",
    project_id=example.id,
    webhook_name="example_webhook",
    secret="secret",
    http_header="X-Hub-Signature",
    service_endpoint_name="Example IncomingWebhook",
    description="Managed by Pulumi")
package main
import (
	"github.com/pulumi/pulumi-azuredevops/sdk/v3/go/azuredevops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := azuredevops.NewProject(ctx, "example", &azuredevops.ProjectArgs{
			Name:             pulumi.String("Example Project"),
			Visibility:       pulumi.String("private"),
			VersionControl:   pulumi.String("Git"),
			WorkItemTemplate: pulumi.String("Agile"),
			Description:      pulumi.String("Managed by Pulumi"),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewServiceendpointIncomingwebhook(ctx, "example", &azuredevops.ServiceendpointIncomingwebhookArgs{
			ProjectId:           example.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 Pulumi"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;
return await Deployment.RunAsync(() => 
{
    var example = new AzureDevOps.Project("example", new()
    {
        Name = "Example Project",
        Visibility = "private",
        VersionControl = "Git",
        WorkItemTemplate = "Agile",
        Description = "Managed by Pulumi",
    });
    var exampleServiceendpointIncomingwebhook = new AzureDevOps.ServiceendpointIncomingwebhook("example", new()
    {
        ProjectId = example.Id,
        WebhookName = "example_webhook",
        Secret = "secret",
        HttpHeader = "X-Hub-Signature",
        ServiceEndpointName = "Example IncomingWebhook",
        Description = "Managed by Pulumi",
    });
});
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 example = new Project("example", ProjectArgs.builder()
            .name("Example Project")
            .visibility("private")
            .versionControl("Git")
            .workItemTemplate("Agile")
            .description("Managed by Pulumi")
            .build());
        var exampleServiceendpointIncomingwebhook = new ServiceendpointIncomingwebhook("exampleServiceendpointIncomingwebhook", ServiceendpointIncomingwebhookArgs.builder()
            .projectId(example.id())
            .webhookName("example_webhook")
            .secret("secret")
            .httpHeader("X-Hub-Signature")
            .serviceEndpointName("Example IncomingWebhook")
            .description("Managed by Pulumi")
            .build());
    }
}
resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Pulumi
  exampleServiceendpointIncomingwebhook:
    type: azuredevops:ServiceendpointIncomingwebhook
    name: example
    properties:
      projectId: ${example.id}
      webhookName: example_webhook
      secret: secret
      httpHeader: X-Hub-Signature
      serviceEndpointName: Example IncomingWebhook
      description: Managed by Pulumi
Create ServiceendpointIncomingwebhook Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ServiceendpointIncomingwebhook(name: string, args: ServiceendpointIncomingwebhookArgs, opts?: CustomResourceOptions);@overload
def ServiceendpointIncomingwebhook(resource_name: str,
                                   args: ServiceendpointIncomingwebhookArgs,
                                   opts: Optional[ResourceOptions] = None)
@overload
def ServiceendpointIncomingwebhook(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   project_id: Optional[str] = None,
                                   service_endpoint_name: Optional[str] = None,
                                   webhook_name: Optional[str] = None,
                                   description: Optional[str] = None,
                                   http_header: Optional[str] = None,
                                   secret: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var serviceendpointIncomingwebhookResource = new AzureDevOps.ServiceendpointIncomingwebhook("serviceendpointIncomingwebhookResource", new()
{
    ProjectId = "string",
    ServiceEndpointName = "string",
    WebhookName = "string",
    Description = "string",
    HttpHeader = "string",
    Secret = "string",
});
example, err := azuredevops.NewServiceendpointIncomingwebhook(ctx, "serviceendpointIncomingwebhookResource", &azuredevops.ServiceendpointIncomingwebhookArgs{
	ProjectId:           pulumi.String("string"),
	ServiceEndpointName: pulumi.String("string"),
	WebhookName:         pulumi.String("string"),
	Description:         pulumi.String("string"),
	HttpHeader:          pulumi.String("string"),
	Secret:              pulumi.String("string"),
})
var serviceendpointIncomingwebhookResource = new ServiceendpointIncomingwebhook("serviceendpointIncomingwebhookResource", ServiceendpointIncomingwebhookArgs.builder()
    .projectId("string")
    .serviceEndpointName("string")
    .webhookName("string")
    .description("string")
    .httpHeader("string")
    .secret("string")
    .build());
serviceendpoint_incomingwebhook_resource = azuredevops.ServiceendpointIncomingwebhook("serviceendpointIncomingwebhookResource",
    project_id="string",
    service_endpoint_name="string",
    webhook_name="string",
    description="string",
    http_header="string",
    secret="string")
const serviceendpointIncomingwebhookResource = new azuredevops.ServiceendpointIncomingwebhook("serviceendpointIncomingwebhookResource", {
    projectId: "string",
    serviceEndpointName: "string",
    webhookName: "string",
    description: "string",
    httpHeader: "string",
    secret: "string",
});
type: azuredevops:ServiceendpointIncomingwebhook
properties:
    description: string
    httpHeader: string
    projectId: string
    secret: string
    serviceEndpointName: string
    webhookName: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
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.
- ServiceEndpoint stringName 
- 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.
- 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.
- ServiceEndpoint stringName 
- 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.
- 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.
- serviceEndpoint StringName 
- 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.
- 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.
- serviceEndpoint stringName 
- 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.
- 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_ strname 
- 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.
- 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.
- serviceEndpoint StringName 
- 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.
- 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:
- Dictionary<string, string>
- Id string
- The provider-assigned unique ID for this managed resource.
- map[string]string
- Id string
- The provider-assigned unique ID for this managed resource.
- Map<String,String>
- id String
- The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
- id string
- The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
- id str
- The provider-assigned unique ID for this managed resource.
- Map<String>
- 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) -> ServiceendpointIncomingwebhookfunc 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)resources:  _:    type: azuredevops:ServiceendpointIncomingwebhook    get:      id: ${id}- 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.
- 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.
- ServiceEndpoint stringName 
- 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.
- 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.
- ServiceEndpoint stringName 
- 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.
- 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.
- serviceEndpoint StringName 
- 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.
- {[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.
- serviceEndpoint stringName 
- 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.
- 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_ strname 
- 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.
- 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.
- serviceEndpoint StringName 
- 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 Incoming WebHook Service Endpoint 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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure DevOps pulumi/pulumi-azuredevops
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the azuredevopsTerraform Provider.