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

azuredevops.ServiceEndpointGeneric

Explore with Pulumi AI

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

Manages a generic service endpoint within Azure DevOps, which can be used to authenticate to any external server using basic authentication via a username and password.

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 exampleServiceEndpointGeneric = new azuredevops.ServiceEndpointGeneric("example", {
    projectId: example.id,
    serverUrl: "https://some-server.example.com",
    username: "username",
    password: "password",
    serviceEndpointName: "Example Generic",
    description: "Managed by Pulumi",
});
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_service_endpoint_generic = azuredevops.ServiceEndpointGeneric("example",
    project_id=example.id,
    server_url="https://some-server.example.com",
    username="username",
    password="password",
    service_endpoint_name="Example Generic",
    description="Managed by Pulumi")
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.NewServiceEndpointGeneric(ctx, "example", &azuredevops.ServiceEndpointGenericArgs{
			ProjectId:           example.ID(),
			ServerUrl:           pulumi.String("https://some-server.example.com"),
			Username:            pulumi.String("username"),
			Password:            pulumi.String("password"),
			ServiceEndpointName: pulumi.String("Example Generic"),
			Description:         pulumi.String("Managed by Pulumi"),
		})
		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 exampleServiceEndpointGeneric = new AzureDevOps.ServiceEndpointGeneric("example", new()
    {
        ProjectId = example.Id,
        ServerUrl = "https://some-server.example.com",
        Username = "username",
        Password = "password",
        ServiceEndpointName = "Example Generic",
        Description = "Managed by Pulumi",
    });

});
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.ServiceEndpointGeneric;
import com.pulumi.azuredevops.ServiceEndpointGenericArgs;
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 exampleServiceEndpointGeneric = new ServiceEndpointGeneric("exampleServiceEndpointGeneric", ServiceEndpointGenericArgs.builder()
            .projectId(example.id())
            .serverUrl("https://some-server.example.com")
            .username("username")
            .password("password")
            .serviceEndpointName("Example Generic")
            .description("Managed by Pulumi")
            .build());

    }
}
Copy
resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Pulumi
  exampleServiceEndpointGeneric:
    type: azuredevops:ServiceEndpointGeneric
    name: example
    properties:
      projectId: ${example.id}
      serverUrl: https://some-server.example.com
      username: username
      password: password
      serviceEndpointName: Example Generic
      description: Managed by Pulumi
Copy

Create ServiceEndpointGeneric Resource

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

Constructor syntax

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

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

type: azuredevops:ServiceEndpointGeneric
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. ServiceEndpointGenericArgs
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. ServiceEndpointGenericArgs
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. ServiceEndpointGenericArgs
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. ServiceEndpointGenericArgs
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. ServiceEndpointGenericArgs
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 serviceEndpointGenericResource = new AzureDevOps.ServiceEndpointGeneric("serviceEndpointGenericResource", new()
{
    ProjectId = "string",
    ServerUrl = "string",
    ServiceEndpointName = "string",
    Description = "string",
    Password = "string",
    Username = "string",
});
Copy
example, err := azuredevops.NewServiceEndpointGeneric(ctx, "serviceEndpointGenericResource", &azuredevops.ServiceEndpointGenericArgs{
	ProjectId:           pulumi.String("string"),
	ServerUrl:           pulumi.String("string"),
	ServiceEndpointName: pulumi.String("string"),
	Description:         pulumi.String("string"),
	Password:            pulumi.String("string"),
	Username:            pulumi.String("string"),
})
Copy
var serviceEndpointGenericResource = new ServiceEndpointGeneric("serviceEndpointGenericResource", ServiceEndpointGenericArgs.builder()
    .projectId("string")
    .serverUrl("string")
    .serviceEndpointName("string")
    .description("string")
    .password("string")
    .username("string")
    .build());
Copy
service_endpoint_generic_resource = azuredevops.ServiceEndpointGeneric("serviceEndpointGenericResource",
    project_id="string",
    server_url="string",
    service_endpoint_name="string",
    description="string",
    password="string",
    username="string")
Copy
const serviceEndpointGenericResource = new azuredevops.ServiceEndpointGeneric("serviceEndpointGenericResource", {
    projectId: "string",
    serverUrl: "string",
    serviceEndpointName: "string",
    description: "string",
    password: "string",
    username: "string",
});
Copy
type: azuredevops:ServiceEndpointGeneric
properties:
    description: string
    password: string
    projectId: string
    serverUrl: string
    serviceEndpointName: string
    username: string
Copy

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

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 URL of the server associated with the service endpoint.
ServiceEndpointName This property is required. string
The service endpoint name.
Description string
Password string
The password or token key used to authenticate to the server url using basic authentication.
Username string
The username used to authenticate to the server url using basic authentication.
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 URL of the server associated with the service endpoint.
ServiceEndpointName This property is required. string
The service endpoint name.
Description string
Password string
The password or token key used to authenticate to the server url using basic authentication.
Username string
The username used to authenticate to the server url using basic authentication.
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 URL of the server associated with the service endpoint.
serviceEndpointName This property is required. String
The service endpoint name.
description String
password String
The password or token key used to authenticate to the server url using basic authentication.
username String
The username used to authenticate to the server url using basic authentication.
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 URL of the server associated with the service endpoint.
serviceEndpointName This property is required. string
The service endpoint name.
description string
password string
The password or token key used to authenticate to the server url using basic authentication.
username string
The username used to authenticate to the server url using basic authentication.
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 URL of the server associated with the service endpoint.
service_endpoint_name This property is required. str
The service endpoint name.
description str
password str
The password or token key used to authenticate to the server url using basic authentication.
username str
The username used to authenticate to the server url using basic authentication.
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 URL of the server associated with the service endpoint.
serviceEndpointName This property is required. String
The service endpoint name.
description String
password String
The password or token key used to authenticate to the server url using basic authentication.
username String
The username used to authenticate to the server url using basic authentication.

Outputs

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

Get an existing ServiceEndpointGeneric 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?: ServiceEndpointGenericState, opts?: CustomResourceOptions): ServiceEndpointGeneric
@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,
        project_id: Optional[str] = None,
        server_url: Optional[str] = None,
        service_endpoint_name: Optional[str] = None,
        username: Optional[str] = None) -> ServiceEndpointGeneric
func GetServiceEndpointGeneric(ctx *Context, name string, id IDInput, state *ServiceEndpointGenericState, opts ...ResourceOption) (*ServiceEndpointGeneric, error)
public static ServiceEndpointGeneric Get(string name, Input<string> id, ServiceEndpointGenericState? state, CustomResourceOptions? opts = null)
public static ServiceEndpointGeneric get(String name, Output<String> id, ServiceEndpointGenericState state, CustomResourceOptions options)
resources:  _:    type: azuredevops:ServiceEndpointGeneric    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 or token key used to authenticate to the server url using basic authentication.
ProjectId Changes to this property will trigger replacement. string
The ID of the project.
ServerUrl string
The URL of the server associated with the service endpoint.
ServiceEndpointName string
The service endpoint name.
Username string
The username used to authenticate to the server url using basic authentication.
Authorization map[string]string
Description string
Password string
The password or token key used to authenticate to the server url using basic authentication.
ProjectId Changes to this property will trigger replacement. string
The ID of the project.
ServerUrl string
The URL of the server associated with the service endpoint.
ServiceEndpointName string
The service endpoint name.
Username string
The username used to authenticate to the server url using basic authentication.
authorization Map<String,String>
description String
password String
The password or token key used to authenticate to the server url using basic authentication.
projectId Changes to this property will trigger replacement. String
The ID of the project.
serverUrl String
The URL of the server associated with the service endpoint.
serviceEndpointName String
The service endpoint name.
username String
The username used to authenticate to the server url using basic authentication.
authorization {[key: string]: string}
description string
password string
The password or token key used to authenticate to the server url using basic authentication.
projectId Changes to this property will trigger replacement. string
The ID of the project.
serverUrl string
The URL of the server associated with the service endpoint.
serviceEndpointName string
The service endpoint name.
username string
The username used to authenticate to the server url using basic authentication.
authorization Mapping[str, str]
description str
password str
The password or token key used to authenticate to the server url using basic authentication.
project_id Changes to this property will trigger replacement. str
The ID of the project.
server_url str
The URL of the server associated with the service endpoint.
service_endpoint_name str
The service endpoint name.
username str
The username used to authenticate to the server url using basic authentication.
authorization Map<String>
description String
password String
The password or token key used to authenticate to the server url using basic authentication.
projectId Changes to this property will trigger replacement. String
The ID of the project.
serverUrl String
The URL of the server associated with the service endpoint.
serviceEndpointName String
The service endpoint name.
username String
The username used to authenticate to the server url using basic authentication.

Import

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

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