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

azuredevops.ServiceendpointCheckmarxSca

Explore with Pulumi AI

Manages a Checkmarx SCA 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 exampleServiceendpointCheckmarxSca = new azuredevops.ServiceendpointCheckmarxSca("example", {
    projectId: example.id,
    serviceEndpointName: "Example Checkmarx SCA",
    accessControlUrl: "https://accesscontrol.com",
    serverUrl: "https://server.com",
    webAppUrl: "https://webapp.com",
    account: "account",
    username: "username",
    password: "password",
});
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_sca = azuredevops.ServiceendpointCheckmarxSca("example",
    project_id=example.id,
    service_endpoint_name="Example Checkmarx SCA",
    access_control_url="https://accesscontrol.com",
    server_url="https://server.com",
    web_app_url="https://webapp.com",
    account="account",
    username="username",
    password="password")
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.NewServiceendpointCheckmarxSca(ctx, "example", &azuredevops.ServiceendpointCheckmarxScaArgs{
			ProjectId:           example.ID(),
			ServiceEndpointName: pulumi.String("Example Checkmarx SCA"),
			AccessControlUrl:    pulumi.String("https://accesscontrol.com"),
			ServerUrl:           pulumi.String("https://server.com"),
			WebAppUrl:           pulumi.String("https://webapp.com"),
			Account:             pulumi.String("account"),
			Username:            pulumi.String("username"),
			Password:            pulumi.String("password"),
		})
		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 exampleServiceendpointCheckmarxSca = new AzureDevOps.ServiceendpointCheckmarxSca("example", new()
    {
        ProjectId = example.Id,
        ServiceEndpointName = "Example Checkmarx SCA",
        AccessControlUrl = "https://accesscontrol.com",
        ServerUrl = "https://server.com",
        WebAppUrl = "https://webapp.com",
        Account = "account",
        Username = "username",
        Password = "password",
    });

});
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.ServiceendpointCheckmarxSca;
import com.pulumi.azuredevops.ServiceendpointCheckmarxScaArgs;
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 exampleServiceendpointCheckmarxSca = new ServiceendpointCheckmarxSca("exampleServiceendpointCheckmarxSca", ServiceendpointCheckmarxScaArgs.builder()
            .projectId(example.id())
            .serviceEndpointName("Example Checkmarx SCA")
            .accessControlUrl("https://accesscontrol.com")
            .serverUrl("https://server.com")
            .webAppUrl("https://webapp.com")
            .account("account")
            .username("username")
            .password("password")
            .build());

    }
}
Copy
resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Pulumi
  exampleServiceendpointCheckmarxSca:
    type: azuredevops:ServiceendpointCheckmarxSca
    name: example
    properties:
      projectId: ${example.id}
      serviceEndpointName: Example Checkmarx SCA
      accessControlUrl: https://accesscontrol.com
      serverUrl: https://server.com
      webAppUrl: https://webapp.com
      account: account
      username: username
      password: password
Copy

Create ServiceendpointCheckmarxSca Resource

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

Constructor syntax

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

@overload
def ServiceendpointCheckmarxSca(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                access_control_url: Optional[str] = None,
                                account: Optional[str] = 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,
                                web_app_url: Optional[str] = None,
                                description: Optional[str] = None,
                                team: Optional[str] = None)
func NewServiceendpointCheckmarxSca(ctx *Context, name string, args ServiceendpointCheckmarxScaArgs, opts ...ResourceOption) (*ServiceendpointCheckmarxSca, error)
public ServiceendpointCheckmarxSca(string name, ServiceendpointCheckmarxScaArgs args, CustomResourceOptions? opts = null)
public ServiceendpointCheckmarxSca(String name, ServiceendpointCheckmarxScaArgs args)
public ServiceendpointCheckmarxSca(String name, ServiceendpointCheckmarxScaArgs args, CustomResourceOptions options)
type: azuredevops:ServiceendpointCheckmarxSca
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. ServiceendpointCheckmarxScaArgs
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. ServiceendpointCheckmarxScaArgs
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. ServiceendpointCheckmarxScaArgs
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. ServiceendpointCheckmarxScaArgs
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. ServiceendpointCheckmarxScaArgs
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 serviceendpointCheckmarxScaResource = new AzureDevOps.ServiceendpointCheckmarxSca("serviceendpointCheckmarxScaResource", new()
{
    AccessControlUrl = "string",
    Account = "string",
    Password = "string",
    ProjectId = "string",
    ServerUrl = "string",
    ServiceEndpointName = "string",
    Username = "string",
    WebAppUrl = "string",
    Description = "string",
    Team = "string",
});
Copy
example, err := azuredevops.NewServiceendpointCheckmarxSca(ctx, "serviceendpointCheckmarxScaResource", &azuredevops.ServiceendpointCheckmarxScaArgs{
	AccessControlUrl:    pulumi.String("string"),
	Account:             pulumi.String("string"),
	Password:            pulumi.String("string"),
	ProjectId:           pulumi.String("string"),
	ServerUrl:           pulumi.String("string"),
	ServiceEndpointName: pulumi.String("string"),
	Username:            pulumi.String("string"),
	WebAppUrl:           pulumi.String("string"),
	Description:         pulumi.String("string"),
	Team:                pulumi.String("string"),
})
Copy
var serviceendpointCheckmarxScaResource = new ServiceendpointCheckmarxSca("serviceendpointCheckmarxScaResource", ServiceendpointCheckmarxScaArgs.builder()
    .accessControlUrl("string")
    .account("string")
    .password("string")
    .projectId("string")
    .serverUrl("string")
    .serviceEndpointName("string")
    .username("string")
    .webAppUrl("string")
    .description("string")
    .team("string")
    .build());
Copy
serviceendpoint_checkmarx_sca_resource = azuredevops.ServiceendpointCheckmarxSca("serviceendpointCheckmarxScaResource",
    access_control_url="string",
    account="string",
    password="string",
    project_id="string",
    server_url="string",
    service_endpoint_name="string",
    username="string",
    web_app_url="string",
    description="string",
    team="string")
Copy
const serviceendpointCheckmarxScaResource = new azuredevops.ServiceendpointCheckmarxSca("serviceendpointCheckmarxScaResource", {
    accessControlUrl: "string",
    account: "string",
    password: "string",
    projectId: "string",
    serverUrl: "string",
    serviceEndpointName: "string",
    username: "string",
    webAppUrl: "string",
    description: "string",
    team: "string",
});
Copy
type: azuredevops:ServiceendpointCheckmarxSca
properties:
    accessControlUrl: string
    account: string
    description: string
    password: string
    projectId: string
    serverUrl: string
    serviceEndpointName: string
    team: string
    username: string
    webAppUrl: string
Copy

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

AccessControlUrl This property is required. string
The Access Control URL of the Checkmarx SCA.
Account This property is required. string
The account of the Checkmarx SCA.
Password This property is required. string
The password of the Checkmarx SCA.
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 SCA.
ServiceEndpointName This property is required. string
The Service Endpoint name.
Username This property is required. string
The username of the Checkmarx SCA.
WebAppUrl This property is required. string
The Web App URL of the Checkmarx SCA.
Description string
Team string
The full team name of the Checkmarx.
AccessControlUrl This property is required. string
The Access Control URL of the Checkmarx SCA.
Account This property is required. string
The account of the Checkmarx SCA.
Password This property is required. string
The password of the Checkmarx SCA.
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 SCA.
ServiceEndpointName This property is required. string
The Service Endpoint name.
Username This property is required. string
The username of the Checkmarx SCA.
WebAppUrl This property is required. string
The Web App URL of the Checkmarx SCA.
Description string
Team string
The full team name of the Checkmarx.
accessControlUrl This property is required. String
The Access Control URL of the Checkmarx SCA.
account This property is required. String
The account of the Checkmarx SCA.
password This property is required. String
The password of the Checkmarx SCA.
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 SCA.
serviceEndpointName This property is required. String
The Service Endpoint name.
username This property is required. String
The username of the Checkmarx SCA.
webAppUrl This property is required. String
The Web App URL of the Checkmarx SCA.
description String
team String
The full team name of the Checkmarx.
accessControlUrl This property is required. string
The Access Control URL of the Checkmarx SCA.
account This property is required. string
The account of the Checkmarx SCA.
password This property is required. string
The password of the Checkmarx SCA.
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 SCA.
serviceEndpointName This property is required. string
The Service Endpoint name.
username This property is required. string
The username of the Checkmarx SCA.
webAppUrl This property is required. string
The Web App URL of the Checkmarx SCA.
description string
team string
The full team name of the Checkmarx.
access_control_url This property is required. str
The Access Control URL of the Checkmarx SCA.
account This property is required. str
The account of the Checkmarx SCA.
password This property is required. str
The password of the Checkmarx SCA.
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 SCA.
service_endpoint_name This property is required. str
The Service Endpoint name.
username This property is required. str
The username of the Checkmarx SCA.
web_app_url This property is required. str
The Web App URL of the Checkmarx SCA.
description str
team str
The full team name of the Checkmarx.
accessControlUrl This property is required. String
The Access Control URL of the Checkmarx SCA.
account This property is required. String
The account of the Checkmarx SCA.
password This property is required. String
The password of the Checkmarx SCA.
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 SCA.
serviceEndpointName This property is required. String
The Service Endpoint name.
username This property is required. String
The username of the Checkmarx SCA.
webAppUrl This property is required. String
The Web App URL of the Checkmarx SCA.
description String
team String
The full team name of the Checkmarx.

Outputs

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

Get an existing ServiceendpointCheckmarxSca 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?: ServiceendpointCheckmarxScaState, opts?: CustomResourceOptions): ServiceendpointCheckmarxSca
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_control_url: Optional[str] = None,
        account: Optional[str] = None,
        authorization: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        password: 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,
        web_app_url: Optional[str] = None) -> ServiceendpointCheckmarxSca
func GetServiceendpointCheckmarxSca(ctx *Context, name string, id IDInput, state *ServiceendpointCheckmarxScaState, opts ...ResourceOption) (*ServiceendpointCheckmarxSca, error)
public static ServiceendpointCheckmarxSca Get(string name, Input<string> id, ServiceendpointCheckmarxScaState? state, CustomResourceOptions? opts = null)
public static ServiceendpointCheckmarxSca get(String name, Output<String> id, ServiceendpointCheckmarxScaState state, CustomResourceOptions options)
resources:  _:    type: azuredevops:ServiceendpointCheckmarxSca    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:
AccessControlUrl string
The Access Control URL of the Checkmarx SCA.
Account string
The account of the Checkmarx SCA.
Authorization Dictionary<string, string>
Description string
Password string
The password of the Checkmarx SCA.
ProjectId Changes to this property will trigger replacement. string
The ID of the project.
ServerUrl string
The Server URL of the Checkmarx SCA.
ServiceEndpointName string
The Service Endpoint name.
Team string
The full team name of the Checkmarx.
Username string
The username of the Checkmarx SCA.
WebAppUrl string
The Web App URL of the Checkmarx SCA.
AccessControlUrl string
The Access Control URL of the Checkmarx SCA.
Account string
The account of the Checkmarx SCA.
Authorization map[string]string
Description string
Password string
The password of the Checkmarx SCA.
ProjectId Changes to this property will trigger replacement. string
The ID of the project.
ServerUrl string
The Server URL of the Checkmarx SCA.
ServiceEndpointName string
The Service Endpoint name.
Team string
The full team name of the Checkmarx.
Username string
The username of the Checkmarx SCA.
WebAppUrl string
The Web App URL of the Checkmarx SCA.
accessControlUrl String
The Access Control URL of the Checkmarx SCA.
account String
The account of the Checkmarx SCA.
authorization Map<String,String>
description String
password String
The password of the Checkmarx SCA.
projectId Changes to this property will trigger replacement. String
The ID of the project.
serverUrl String
The Server URL of the Checkmarx SCA.
serviceEndpointName String
The Service Endpoint name.
team String
The full team name of the Checkmarx.
username String
The username of the Checkmarx SCA.
webAppUrl String
The Web App URL of the Checkmarx SCA.
accessControlUrl string
The Access Control URL of the Checkmarx SCA.
account string
The account of the Checkmarx SCA.
authorization {[key: string]: string}
description string
password string
The password of the Checkmarx SCA.
projectId Changes to this property will trigger replacement. string
The ID of the project.
serverUrl string
The Server URL of the Checkmarx SCA.
serviceEndpointName string
The Service Endpoint name.
team string
The full team name of the Checkmarx.
username string
The username of the Checkmarx SCA.
webAppUrl string
The Web App URL of the Checkmarx SCA.
access_control_url str
The Access Control URL of the Checkmarx SCA.
account str
The account of the Checkmarx SCA.
authorization Mapping[str, str]
description str
password str
The password of the Checkmarx SCA.
project_id Changes to this property will trigger replacement. str
The ID of the project.
server_url str
The Server URL of the Checkmarx SCA.
service_endpoint_name str
The Service Endpoint name.
team str
The full team name of the Checkmarx.
username str
The username of the Checkmarx SCA.
web_app_url str
The Web App URL of the Checkmarx SCA.
accessControlUrl String
The Access Control URL of the Checkmarx SCA.
account String
The account of the Checkmarx SCA.
authorization Map<String>
description String
password String
The password of the Checkmarx SCA.
projectId Changes to this property will trigger replacement. String
The ID of the project.
serverUrl String
The Server URL of the Checkmarx SCA.
serviceEndpointName String
The Service Endpoint name.
team String
The full team name of the Checkmarx.
username String
The username of the Checkmarx SCA.
webAppUrl String
The Web App URL of the Checkmarx SCA.

Import

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

$ pulumi import azuredevops:index/serviceendpointCheckmarxSca:ServiceendpointCheckmarxSca 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.