Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure DevOps Provider
  3. API Docs
  4. ServiceendpointSnyk
Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.ServiceendpointSnyk

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi
pulumi/pulumi-azuredevops

    Manages a Snyk Security Scan service endpoint within Azure DevOps. Using this service endpoint requires you to install: Snyk Security Scan

    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 exampleServiceendpointSnyk = new azuredevops.ServiceendpointSnyk("example", {
    projectId: example.id,
    serverUrl: "https://snyk.io/",
    apiToken: "00000000-0000-0000-0000-000000000000",
    serviceEndpointName: "Example Snyk",
    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_snyk = azuredevops.ServiceendpointSnyk("example",
    project_id=example.id,
    server_url="https://snyk.io/",
    api_token="00000000-0000-0000-0000-000000000000",
    service_endpoint_name="Example Snyk",
    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.NewServiceendpointSnyk(ctx, "example", &azuredevops.ServiceendpointSnykArgs{
			ProjectId:           example.ID(),
			ServerUrl:           pulumi.String("https://snyk.io/"),
			ApiToken:            pulumi.String("00000000-0000-0000-0000-000000000000"),
			ServiceEndpointName: pulumi.String("Example Snyk"),
			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 exampleServiceendpointSnyk = new AzureDevOps.ServiceendpointSnyk("example", new()
    {
        ProjectId = example.Id,
        ServerUrl = "https://snyk.io/",
        ApiToken = "00000000-0000-0000-0000-000000000000",
        ServiceEndpointName = "Example Snyk",
        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.ServiceendpointSnyk;
import com.pulumi.azuredevops.ServiceendpointSnykArgs;
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 exampleServiceendpointSnyk = new ServiceendpointSnyk("exampleServiceendpointSnyk", ServiceendpointSnykArgs.builder()
            .projectId(example.id())
            .serverUrl("https://snyk.io/")
            .apiToken("00000000-0000-0000-0000-000000000000")
            .serviceEndpointName("Example Snyk")
            .description("Managed by Pulumi")
            .build());

    }
}

    resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Pulumi
  exampleServiceendpointSnyk:
    type: azuredevops:ServiceendpointSnyk
    name: example
    properties:
      projectId: ${example.id}
      serverUrl: https://snyk.io/
      apiToken: 00000000-0000-0000-0000-000000000000
      serviceEndpointName: Example Snyk
      description: Managed by Pulumi

    Create ServiceendpointSnyk Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ServiceendpointSnyk(name: string, args: ServiceendpointSnykArgs, opts?: CustomResourceOptions);
    @overload
def ServiceendpointSnyk(resource_name: str,
                        args: ServiceendpointSnykArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def ServiceendpointSnyk(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        api_token: Optional[str] = None,
                        project_id: Optional[str] = None,
                        server_url: Optional[str] = None,
                        service_endpoint_name: Optional[str] = None,
                        description: Optional[str] = None)
    func NewServiceendpointSnyk(ctx *Context, name string, args ServiceendpointSnykArgs, opts ...ResourceOption) (*ServiceendpointSnyk, error)
    public ServiceendpointSnyk(string name, ServiceendpointSnykArgs args, CustomResourceOptions? opts = null)
    public ServiceendpointSnyk(String name, ServiceendpointSnykArgs args)
public ServiceendpointSnyk(String name, ServiceendpointSnykArgs args, CustomResourceOptions options)

    type: azuredevops:ServiceendpointSnyk
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 ServiceendpointSnykArgs
    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 ServiceendpointSnykArgs
    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 ServiceendpointSnykArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceendpointSnykArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceendpointSnykArgs
    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 serviceendpointSnykResource = new AzureDevOps.ServiceendpointSnyk("serviceendpointSnykResource", new()
{
    ApiToken = "string",
    ProjectId = "string",
    ServerUrl = "string",
    ServiceEndpointName = "string",
    Description = "string",
});

    example, err := azuredevops.NewServiceendpointSnyk(ctx, "serviceendpointSnykResource", &azuredevops.ServiceendpointSnykArgs{
	ApiToken:            pulumi.String("string"),
	ProjectId:           pulumi.String("string"),
	ServerUrl:           pulumi.String("string"),
	ServiceEndpointName: pulumi.String("string"),
	Description:         pulumi.String("string"),
})

    var serviceendpointSnykResource = new ServiceendpointSnyk("serviceendpointSnykResource", ServiceendpointSnykArgs.builder()
    .apiToken("string")
    .projectId("string")
    .serverUrl("string")
    .serviceEndpointName("string")
    .description("string")
    .build());

    serviceendpoint_snyk_resource = azuredevops.ServiceendpointSnyk("serviceendpointSnykResource",
    api_token="string",
    project_id="string",
    server_url="string",
    service_endpoint_name="string",
    description="string")

    const serviceendpointSnykResource = new azuredevops.ServiceendpointSnyk("serviceendpointSnykResource", {
    apiToken: "string",
    projectId: "string",
    serverUrl: "string",
    serviceEndpointName: "string",
    description: "string",
});

    type: azuredevops:ServiceendpointSnyk
properties:
    apiToken: string
    description: string
    projectId: string
    serverUrl: string
    serviceEndpointName: string

    ServiceendpointSnyk 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 ServiceendpointSnyk resource accepts the following input properties:

    ApiToken string
    The API token of the Snyk Security Scan.
    ProjectId string
    The ID of the project.
    ServerUrl string
    The server URL of the Snyk Security Scan.
    ServiceEndpointName string
    The Service Endpoint name.
    Description string
    ApiToken string
    The API token of the Snyk Security Scan.
    ProjectId string
    The ID of the project.
    ServerUrl string
    The server URL of the Snyk Security Scan.
    ServiceEndpointName string
    The Service Endpoint name.
    Description string
    apiToken String
    The API token of the Snyk Security Scan.
    projectId String
    The ID of the project.
    serverUrl String
    The server URL of the Snyk Security Scan.
    serviceEndpointName String
    The Service Endpoint name.
    description String
    apiToken string
    The API token of the Snyk Security Scan.
    projectId string
    The ID of the project.
    serverUrl string
    The server URL of the Snyk Security Scan.
    serviceEndpointName string
    The Service Endpoint name.
    description string
    api_token str
    The API token of the Snyk Security Scan.
    project_id str
    The ID of the project.
    server_url str
    The server URL of the Snyk Security Scan.
    service_endpoint_name str
    The Service Endpoint name.
    description str
    apiToken String
    The API token of the Snyk Security Scan.
    projectId String
    The ID of the project.
    serverUrl String
    The server URL of the Snyk Security Scan.
    serviceEndpointName String
    The Service Endpoint name.
    description String

    Outputs

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

    Authorization Dictionary<string, string>
    Id string
    The provider-assigned unique ID for this managed resource.
    Authorization map[string]string
    Id string
    The provider-assigned unique ID for this managed resource.
    authorization Map<String,String>
    id String
    The provider-assigned unique ID for this managed resource.
    authorization {[key: string]: string}
    id string
    The provider-assigned unique ID for this managed resource.
    authorization Mapping[str, str]
    id str
    The provider-assigned unique ID for this managed resource.
    authorization Map<String>
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ServiceendpointSnyk Resource

    Get an existing ServiceendpointSnyk 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?: ServiceendpointSnykState, opts?: CustomResourceOptions): ServiceendpointSnyk
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_token: Optional[str] = None,
        authorization: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        project_id: Optional[str] = None,
        server_url: Optional[str] = None,
        service_endpoint_name: Optional[str] = None) -> ServiceendpointSnyk
    func GetServiceendpointSnyk(ctx *Context, name string, id IDInput, state *ServiceendpointSnykState, opts ...ResourceOption) (*ServiceendpointSnyk, error)
    public static ServiceendpointSnyk Get(string name, Input<string> id, ServiceendpointSnykState? state, CustomResourceOptions? opts = null)
    public static ServiceendpointSnyk get(String name, Output<String> id, ServiceendpointSnykState state, CustomResourceOptions options)
    resources:  _:    type: azuredevops:ServiceendpointSnyk    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.
    The following state arguments are supported:
    ApiToken string
    The API token of the Snyk Security Scan.
    Authorization Dictionary<string, string>
    Description string
    ProjectId string
    The ID of the project.
    ServerUrl string
    The server URL of the Snyk Security Scan.
    ServiceEndpointName string
    The Service Endpoint name.
    ApiToken string
    The API token of the Snyk Security Scan.
    Authorization map[string]string
    Description string
    ProjectId string
    The ID of the project.
    ServerUrl string
    The server URL of the Snyk Security Scan.
    ServiceEndpointName string
    The Service Endpoint name.
    apiToken String
    The API token of the Snyk Security Scan.
    authorization Map<String,String>
    description String
    projectId String
    The ID of the project.
    serverUrl String
    The server URL of the Snyk Security Scan.
    serviceEndpointName String
    The Service Endpoint name.
    apiToken string
    The API token of the Snyk Security Scan.
    authorization {[key: string]: string}
    description string
    projectId string
    The ID of the project.
    serverUrl string
    The server URL of the Snyk Security Scan.
    serviceEndpointName string
    The Service Endpoint name.
    api_token str
    The API token of the Snyk Security Scan.
    authorization Mapping[str, str]
    description str
    project_id str
    The ID of the project.
    server_url str
    The server URL of the Snyk Security Scan.
    service_endpoint_name str
    The Service Endpoint name.
    apiToken String
    The API token of the Snyk Security Scan.
    authorization Map<String>
    description String
    projectId String
    The ID of the project.
    serverUrl String
    The server URL of the Snyk Security Scan.
    serviceEndpointName String
    The Service Endpoint name.

    Import

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

    $ pulumi import azuredevops:index/serviceendpointSnyk:ServiceendpointSnyk 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 azuredevops Terraform Provider.
    azuredevops logo
    Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi
    pulumi/pulumi-azuredevops