1. Packages
  2. Azure DevOps Provider
  3. API Docs
  4. ServiceendpointCheckmarxSast
Azure DevOps v3.8.0 published on Monday, Mar 17, 2025 by Pulumi

azuredevops.ServiceendpointCheckmarxSast

Explore with Pulumi AI

Manages a Checkmarx SAST service endpoint within Azure DevOps. Using this service endpoint requires you to install: Checkmarx SAST

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 exampleServiceendpointCheckmarxSast = new azuredevops.ServiceendpointCheckmarxSast("example", {
    projectId: example.id,
    serviceEndpointName: "Example Checkmarx SAST",
    serverUrl: "https://server.com",
    username: "username",
    password: "password",
    team: "team",
    preset: "preset",
});
Copy
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_checkmarx_sast = azuredevops.ServiceendpointCheckmarxSast("example",
    project_id=example.id,
    service_endpoint_name="Example Checkmarx SAST",
    server_url="https://server.com",
    username="username",
    password="password",
    team="team",
    preset="preset")
Copy
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.NewServiceendpointCheckmarxSast(ctx, "example", &azuredevops.ServiceendpointCheckmarxSastArgs{
			ProjectId:           example.ID(),
			ServiceEndpointName: pulumi.String("Example Checkmarx SAST"),
			ServerUrl:           pulumi.String("https://server.com"),
			Username:            pulumi.String("username"),
			Password:            pulumi.String("password"),
			Team:                pulumi.String("team"),
			Preset:              pulumi.String("preset"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 exampleServiceendpointCheckmarxSast = new AzureDevOps.ServiceendpointCheckmarxSast("example", new()
    {
        ProjectId = example.Id,
        ServiceEndpointName = "Example Checkmarx SAST",
        ServerUrl = "https://server.com",
        Username = "username",
        Password = "password",
        Team = "team",
        Preset = "preset",
    });

});
Copy
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.ServiceendpointCheckmarxSast;
import com.pulumi.azuredevops.ServiceendpointCheckmarxSastArgs;
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 exampleServiceendpointCheckmarxSast = new ServiceendpointCheckmarxSast("exampleServiceendpointCheckmarxSast", ServiceendpointCheckmarxSastArgs.builder()
            .projectId(example.id())
            .serviceEndpointName("Example Checkmarx SAST")
            .serverUrl("https://server.com")
            .username("username")
            .password("password")
            .team("team")
            .preset("preset")
            .build());

    }
}
Copy
resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Pulumi
  exampleServiceendpointCheckmarxSast:
    type: azuredevops:ServiceendpointCheckmarxSast
    name: example
    properties:
      projectId: ${example.id}
      serviceEndpointName: Example Checkmarx SAST
      serverUrl: https://server.com
      username: username
      password: password
      team: team
      preset: preset
Copy

Create ServiceendpointCheckmarxSast Resource

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

Constructor syntax

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

@overload
def ServiceendpointCheckmarxSast(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 password: Optional[str] = None,
                                 project_id: Optional[str] = None,
                                 server_url: Optional[str] = None,
                                 service_endpoint_name: Optional[str] = None,
                                 username: Optional[str] = None,
                                 description: Optional[str] = None,
                                 preset: Optional[str] = None,
                                 team: Optional[str] = None)
func NewServiceendpointCheckmarxSast(ctx *Context, name string, args ServiceendpointCheckmarxSastArgs, opts ...ResourceOption) (*ServiceendpointCheckmarxSast, error)
public ServiceendpointCheckmarxSast(string name, ServiceendpointCheckmarxSastArgs args, CustomResourceOptions? opts = null)
public ServiceendpointCheckmarxSast(String name, ServiceendpointCheckmarxSastArgs args)
public ServiceendpointCheckmarxSast(String name, ServiceendpointCheckmarxSastArgs args, CustomResourceOptions options)
type: azuredevops:ServiceendpointCheckmarxSast
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ServiceendpointCheckmarxSastArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ServiceendpointCheckmarxSastArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ServiceendpointCheckmarxSastArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ServiceendpointCheckmarxSastArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ServiceendpointCheckmarxSastArgs
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 serviceendpointCheckmarxSastResource = new AzureDevOps.ServiceendpointCheckmarxSast("serviceendpointCheckmarxSastResource", new()
{
    Password = "string",
    ProjectId = "string",
    ServerUrl = "string",
    ServiceEndpointName = "string",
    Username = "string",
    Description = "string",
    Preset = "string",
    Team = "string",
});
Copy
example, err := azuredevops.NewServiceendpointCheckmarxSast(ctx, "serviceendpointCheckmarxSastResource", &azuredevops.ServiceendpointCheckmarxSastArgs{
	Password:            pulumi.String("string"),
	ProjectId:           pulumi.String("string"),
	ServerUrl:           pulumi.String("string"),
	ServiceEndpointName: pulumi.String("string"),
	Username:            pulumi.String("string"),
	Description:         pulumi.String("string"),
	Preset:              pulumi.String("string"),
	Team:                pulumi.String("string"),
})
Copy
var serviceendpointCheckmarxSastResource = new ServiceendpointCheckmarxSast("serviceendpointCheckmarxSastResource", ServiceendpointCheckmarxSastArgs.builder()
    .password("string")
    .projectId("string")
    .serverUrl("string")
    .serviceEndpointName("string")
    .username("string")
    .description("string")
    .preset("string")
    .team("string")
    .build());
Copy
serviceendpoint_checkmarx_sast_resource = azuredevops.ServiceendpointCheckmarxSast("serviceendpointCheckmarxSastResource",
    password="string",
    project_id="string",
    server_url="string",
    service_endpoint_name="string",
    username="string",
    description="string",
    preset="string",
    team="string")
Copy
const serviceendpointCheckmarxSastResource = new azuredevops.ServiceendpointCheckmarxSast("serviceendpointCheckmarxSastResource", {
    password: "string",
    projectId: "string",
    serverUrl: "string",
    serviceEndpointName: "string",
    username: "string",
    description: "string",
    preset: "string",
    team: "string",
});
Copy
type: azuredevops:ServiceendpointCheckmarxSast
properties:
    description: string
    password: string
    preset: string
    projectId: string
    serverUrl: string
    serviceEndpointName: string
    team: string
    username: string
Copy

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

Password This property is required. string
The password of the Checkmarx SAST.
ProjectId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the project.
ServerUrl This property is required. string
The Server URL of the Checkmarx SAST.
ServiceEndpointName This property is required. string
The Service Endpoint name.
Username This property is required. string
The username of the Checkmarx SAST.
Description string
Preset string
Predefined sets of queries that you can select when Creating, Configuring and Branching Projects. Predefined presets are provided by Checkmarx and you can configure your own. You can also import and export presets (on the server).In Service Connection if preset(optional) value is added, then it will igonres Preset available in pipeline and uses preset available in service connection only.If Preset is blank in service connection then it will use pipelines preset.
Team string
The full team name of the Checkmarx.
Password This property is required. string
The password of the Checkmarx SAST.
ProjectId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the project.
ServerUrl This property is required. string
The Server URL of the Checkmarx SAST.
ServiceEndpointName This property is required. string
The Service Endpoint name.
Username This property is required. string
The username of the Checkmarx SAST.
Description string
Preset string
Predefined sets of queries that you can select when Creating, Configuring and Branching Projects. Predefined presets are provided by Checkmarx and you can configure your own. You can also import and export presets (on the server).In Service Connection if preset(optional) value is added, then it will igonres Preset available in pipeline and uses preset available in service connection only.If Preset is blank in service connection then it will use pipelines preset.
Team string
The full team name of the Checkmarx.
password This property is required. String
The password of the Checkmarx SAST.
projectId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the project.
serverUrl This property is required. String
The Server URL of the Checkmarx SAST.
serviceEndpointName This property is required. String
The Service Endpoint name.
username This property is required. String
The username of the Checkmarx SAST.
description String
preset String
Predefined sets of queries that you can select when Creating, Configuring and Branching Projects. Predefined presets are provided by Checkmarx and you can configure your own. You can also import and export presets (on the server).In Service Connection if preset(optional) value is added, then it will igonres Preset available in pipeline and uses preset available in service connection only.If Preset is blank in service connection then it will use pipelines preset.
team String
The full team name of the Checkmarx.
password This property is required. string
The password of the Checkmarx SAST.
projectId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the project.
serverUrl This property is required. string
The Server URL of the Checkmarx SAST.
serviceEndpointName This property is required. string
The Service Endpoint name.
username This property is required. string
The username of the Checkmarx SAST.
description string
preset string
Predefined sets of queries that you can select when Creating, Configuring and Branching Projects. Predefined presets are provided by Checkmarx and you can configure your own. You can also import and export presets (on the server).In Service Connection if preset(optional) value is added, then it will igonres Preset available in pipeline and uses preset available in service connection only.If Preset is blank in service connection then it will use pipelines preset.
team string
The full team name of the Checkmarx.
password This property is required. str
The password of the Checkmarx SAST.
project_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the project.
server_url This property is required. str
The Server URL of the Checkmarx SAST.
service_endpoint_name This property is required. str
The Service Endpoint name.
username This property is required. str
The username of the Checkmarx SAST.
description str
preset str
Predefined sets of queries that you can select when Creating, Configuring and Branching Projects. Predefined presets are provided by Checkmarx and you can configure your own. You can also import and export presets (on the server).In Service Connection if preset(optional) value is added, then it will igonres Preset available in pipeline and uses preset available in service connection only.If Preset is blank in service connection then it will use pipelines preset.
team str
The full team name of the Checkmarx.
password This property is required. String
The password of the Checkmarx SAST.
projectId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the project.
serverUrl This property is required. String
The Server URL of the Checkmarx SAST.
serviceEndpointName This property is required. String
The Service Endpoint name.
username This property is required. String
The username of the Checkmarx SAST.
description String
preset String
Predefined sets of queries that you can select when Creating, Configuring and Branching Projects. Predefined presets are provided by Checkmarx and you can configure your own. You can also import and export presets (on the server).In Service Connection if preset(optional) value is added, then it will igonres Preset available in pipeline and uses preset available in service connection only.If Preset is blank in service connection then it will use pipelines preset.
team String
The full team name of the Checkmarx.

Outputs

All input properties are implicitly available as output properties. Additionally, the ServiceendpointCheckmarxSast 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 ServiceendpointCheckmarxSast Resource

Get an existing ServiceendpointCheckmarxSast 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?: ServiceendpointCheckmarxSastState, opts?: CustomResourceOptions): ServiceendpointCheckmarxSast
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorization: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        password: Optional[str] = None,
        preset: Optional[str] = None,
        project_id: Optional[str] = None,
        server_url: Optional[str] = None,
        service_endpoint_name: Optional[str] = None,
        team: Optional[str] = None,
        username: Optional[str] = None) -> ServiceendpointCheckmarxSast
func GetServiceendpointCheckmarxSast(ctx *Context, name string, id IDInput, state *ServiceendpointCheckmarxSastState, opts ...ResourceOption) (*ServiceendpointCheckmarxSast, error)
public static ServiceendpointCheckmarxSast Get(string name, Input<string> id, ServiceendpointCheckmarxSastState? state, CustomResourceOptions? opts = null)
public static ServiceendpointCheckmarxSast get(String name, Output<String> id, ServiceendpointCheckmarxSastState state, CustomResourceOptions options)
resources:  _:    type: azuredevops:ServiceendpointCheckmarxSast    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
Password string
The password of the Checkmarx SAST.
Preset string
Predefined sets of queries that you can select when Creating, Configuring and Branching Projects. Predefined presets are provided by Checkmarx and you can configure your own. You can also import and export presets (on the server).In Service Connection if preset(optional) value is added, then it will igonres Preset available in pipeline and uses preset available in service connection only.If Preset is blank in service connection then it will use pipelines preset.
ProjectId Changes to this property will trigger replacement. string
The ID of the project.
ServerUrl string
The Server URL of the Checkmarx SAST.
ServiceEndpointName string
The Service Endpoint name.
Team string
The full team name of the Checkmarx.
Username string
The username of the Checkmarx SAST.
Authorization map[string]string
Description string
Password string
The password of the Checkmarx SAST.
Preset string
Predefined sets of queries that you can select when Creating, Configuring and Branching Projects. Predefined presets are provided by Checkmarx and you can configure your own. You can also import and export presets (on the server).In Service Connection if preset(optional) value is added, then it will igonres Preset available in pipeline and uses preset available in service connection only.If Preset is blank in service connection then it will use pipelines preset.
ProjectId Changes to this property will trigger replacement. string
The ID of the project.
ServerUrl string
The Server URL of the Checkmarx SAST.
ServiceEndpointName string
The Service Endpoint name.
Team string
The full team name of the Checkmarx.
Username string
The username of the Checkmarx SAST.
authorization Map<String,String>
description String
password String
The password of the Checkmarx SAST.
preset String
Predefined sets of queries that you can select when Creating, Configuring and Branching Projects. Predefined presets are provided by Checkmarx and you can configure your own. You can also import and export presets (on the server).In Service Connection if preset(optional) value is added, then it will igonres Preset available in pipeline and uses preset available in service connection only.If Preset is blank in service connection then it will use pipelines preset.
projectId Changes to this property will trigger replacement. String
The ID of the project.
serverUrl String
The Server URL of the Checkmarx SAST.
serviceEndpointName String
The Service Endpoint name.
team String
The full team name of the Checkmarx.
username String
The username of the Checkmarx SAST.
authorization {[key: string]: string}
description string
password string
The password of the Checkmarx SAST.
preset string
Predefined sets of queries that you can select when Creating, Configuring and Branching Projects. Predefined presets are provided by Checkmarx and you can configure your own. You can also import and export presets (on the server).In Service Connection if preset(optional) value is added, then it will igonres Preset available in pipeline and uses preset available in service connection only.If Preset is blank in service connection then it will use pipelines preset.
projectId Changes to this property will trigger replacement. string
The ID of the project.
serverUrl string
The Server URL of the Checkmarx SAST.
serviceEndpointName string
The Service Endpoint name.
team string
The full team name of the Checkmarx.
username string
The username of the Checkmarx SAST.
authorization Mapping[str, str]
description str
password str
The password of the Checkmarx SAST.
preset str
Predefined sets of queries that you can select when Creating, Configuring and Branching Projects. Predefined presets are provided by Checkmarx and you can configure your own. You can also import and export presets (on the server).In Service Connection if preset(optional) value is added, then it will igonres Preset available in pipeline and uses preset available in service connection only.If Preset is blank in service connection then it will use pipelines preset.
project_id Changes to this property will trigger replacement. str
The ID of the project.
server_url str
The Server URL of the Checkmarx SAST.
service_endpoint_name str
The Service Endpoint name.
team str
The full team name of the Checkmarx.
username str
The username of the Checkmarx SAST.
authorization Map<String>
description String
password String
The password of the Checkmarx SAST.
preset String
Predefined sets of queries that you can select when Creating, Configuring and Branching Projects. Predefined presets are provided by Checkmarx and you can configure your own. You can also import and export presets (on the server).In Service Connection if preset(optional) value is added, then it will igonres Preset available in pipeline and uses preset available in service connection only.If Preset is blank in service connection then it will use pipelines preset.
projectId Changes to this property will trigger replacement. String
The ID of the project.
serverUrl String
The Server URL of the Checkmarx SAST.
serviceEndpointName String
The Service Endpoint name.
team String
The full team name of the Checkmarx.
username String
The username of the Checkmarx SAST.

Import

Azure DevOps Service Endpoint Check Marx SAST can be imported using projectID/serviceEndpointID or projectName/serviceEndpointID

$ pulumi import azuredevops:index/serviceendpointCheckmarxSast:ServiceendpointCheckmarxSast example 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000
Copy

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.