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",
});
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")
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
	})
}
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",
    });
});
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());
    }
}
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
Relevant Links
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 string
- The unique name of the resource.
- args ServiceendpointCheckmarxScaArgs
- 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 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 string
- The unique name of the resource.
- args ServiceendpointCheckmarxScaArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServiceendpointCheckmarxScaArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
});
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"),
})
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());
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")
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",
});
type: azuredevops:ServiceendpointCheckmarxSca
properties:
    accessControlUrl: string
    account: string
    description: string
    password: string
    projectId: string
    serverUrl: string
    serviceEndpointName: string
    team: string
    username: string
    webAppUrl: string
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:
- AccessControl stringUrl 
- The Access Control URL of the Checkmarx SCA.
- Account string
- The account of the Checkmarx SCA.
- Password string
- The password of the Checkmarx SCA.
- ProjectId string
- The ID of the project.
- ServerUrl string
- The Server URL of the Checkmarx SCA.
- ServiceEndpoint stringName 
- The Service Endpoint name.
- Username string
- The username of the Checkmarx SCA.
- WebApp stringUrl 
- The Web App URL of the Checkmarx SCA.
- Description string
- Team string
- The full team name of the Checkmarx.
- AccessControl stringUrl 
- The Access Control URL of the Checkmarx SCA.
- Account string
- The account of the Checkmarx SCA.
- Password string
- The password of the Checkmarx SCA.
- ProjectId string
- The ID of the project.
- ServerUrl string
- The Server URL of the Checkmarx SCA.
- ServiceEndpoint stringName 
- The Service Endpoint name.
- Username string
- The username of the Checkmarx SCA.
- WebApp stringUrl 
- The Web App URL of the Checkmarx SCA.
- Description string
- Team string
- The full team name of the Checkmarx.
- accessControl StringUrl 
- The Access Control URL of the Checkmarx SCA.
- account String
- The account of the Checkmarx SCA.
- password String
- The password of the Checkmarx SCA.
- projectId String
- The ID of the project.
- serverUrl String
- The Server URL of the Checkmarx SCA.
- serviceEndpoint StringName 
- The Service Endpoint name.
- username String
- The username of the Checkmarx SCA.
- webApp StringUrl 
- The Web App URL of the Checkmarx SCA.
- description String
- team String
- The full team name of the Checkmarx.
- accessControl stringUrl 
- The Access Control URL of the Checkmarx SCA.
- account string
- The account of the Checkmarx SCA.
- password string
- The password of the Checkmarx SCA.
- projectId string
- The ID of the project.
- serverUrl string
- The Server URL of the Checkmarx SCA.
- serviceEndpoint stringName 
- The Service Endpoint name.
- username string
- The username of the Checkmarx SCA.
- webApp stringUrl 
- The Web App URL of the Checkmarx SCA.
- description string
- team string
- The full team name of the Checkmarx.
- access_control_ strurl 
- The Access Control URL of the Checkmarx SCA.
- account str
- The account of the Checkmarx SCA.
- password str
- The password of the Checkmarx SCA.
- project_id str
- The ID of the project.
- server_url str
- The Server URL of the Checkmarx SCA.
- service_endpoint_ strname 
- The Service Endpoint name.
- username str
- The username of the Checkmarx SCA.
- web_app_ strurl 
- The Web App URL of the Checkmarx SCA.
- description str
- team str
- The full team name of the Checkmarx.
- accessControl StringUrl 
- The Access Control URL of the Checkmarx SCA.
- account String
- The account of the Checkmarx SCA.
- password String
- The password of the Checkmarx SCA.
- projectId String
- The ID of the project.
- serverUrl String
- The Server URL of the Checkmarx SCA.
- serviceEndpoint StringName 
- The Service Endpoint name.
- username String
- The username of the Checkmarx SCA.
- webApp StringUrl 
- 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:
- 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 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) -> ServiceendpointCheckmarxScafunc 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
- 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.
- AccessControl stringUrl 
- The Access Control URL of the Checkmarx SCA.
- Account string
- The account of the Checkmarx SCA.
- Dictionary<string, string>
- Description string
- Password string
- The password of the Checkmarx SCA.
- ProjectId string
- The ID of the project.
- ServerUrl string
- The Server URL of the Checkmarx SCA.
- ServiceEndpoint stringName 
- The Service Endpoint name.
- Team string
- The full team name of the Checkmarx.
- Username string
- The username of the Checkmarx SCA.
- WebApp stringUrl 
- The Web App URL of the Checkmarx SCA.
- AccessControl stringUrl 
- The Access Control URL of the Checkmarx SCA.
- Account string
- The account of the Checkmarx SCA.
- map[string]string
- Description string
- Password string
- The password of the Checkmarx SCA.
- ProjectId string
- The ID of the project.
- ServerUrl string
- The Server URL of the Checkmarx SCA.
- ServiceEndpoint stringName 
- The Service Endpoint name.
- Team string
- The full team name of the Checkmarx.
- Username string
- The username of the Checkmarx SCA.
- WebApp stringUrl 
- The Web App URL of the Checkmarx SCA.
- accessControl StringUrl 
- The Access Control URL of the Checkmarx SCA.
- account String
- The account of the Checkmarx SCA.
- Map<String,String>
- description String
- password String
- The password of the Checkmarx SCA.
- projectId String
- The ID of the project.
- serverUrl String
- The Server URL of the Checkmarx SCA.
- serviceEndpoint StringName 
- The Service Endpoint name.
- team String
- The full team name of the Checkmarx.
- username String
- The username of the Checkmarx SCA.
- webApp StringUrl 
- The Web App URL of the Checkmarx SCA.
- accessControl stringUrl 
- The Access Control URL of the Checkmarx SCA.
- account string
- The account of the Checkmarx SCA.
- {[key: string]: string}
- description string
- password string
- The password of the Checkmarx SCA.
- projectId string
- The ID of the project.
- serverUrl string
- The Server URL of the Checkmarx SCA.
- serviceEndpoint stringName 
- The Service Endpoint name.
- team string
- The full team name of the Checkmarx.
- username string
- The username of the Checkmarx SCA.
- webApp stringUrl 
- The Web App URL of the Checkmarx SCA.
- access_control_ strurl 
- The Access Control URL of the Checkmarx SCA.
- account str
- The account of the Checkmarx SCA.
- Mapping[str, str]
- description str
- password str
- The password of the Checkmarx SCA.
- project_id str
- The ID of the project.
- server_url str
- The Server URL of the Checkmarx SCA.
- service_endpoint_ strname 
- The Service Endpoint name.
- team str
- The full team name of the Checkmarx.
- username str
- The username of the Checkmarx SCA.
- web_app_ strurl 
- The Web App URL of the Checkmarx SCA.
- accessControl StringUrl 
- The Access Control URL of the Checkmarx SCA.
- account String
- The account of the Checkmarx SCA.
- Map<String>
- description String
- password String
- The password of the Checkmarx SCA.
- projectId String
- The ID of the project.
- serverUrl String
- The Server URL of the Checkmarx SCA.
- serviceEndpoint StringName 
- The Service Endpoint name.
- team String
- The full team name of the Checkmarx.
- username String
- The username of the Checkmarx SCA.
- webApp StringUrl 
- 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
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.