Azure DevOps v2.7.0, Mar 27 23

azuredevops.ServiceEndpointGeneric

Explore with Pulumi AI

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.

Relevant Links

Azure DevOps Service REST API 6.0 - Agent Pools

Example Usage

using System.Collections.Generic;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    var exampleProject = new AzureDevOps.Project("exampleProject", new()
    {
        Visibility = "private",
        VersionControl = "Git",
        WorkItemTemplate = "Agile",
        Description = "Managed by Terraform",
    });

    var exampleServiceEndpointGeneric = new AzureDevOps.ServiceEndpointGeneric("exampleServiceEndpointGeneric", new()
    {
        ProjectId = exampleProject.Id,
        ServerUrl = "https://some-server.example.com",
        Username = "username",
        Password = "password",
        ServiceEndpointName = "Example Generic",
        Description = "Managed by Terraform",
    });

});

package main

import (
	"github.com/pulumi/pulumi-azuredevops/sdk/v2/go/azuredevops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleProject, err := azuredevops.NewProject(ctx, "exampleProject", &azuredevops.ProjectArgs{
			Visibility:       pulumi.String("private"),
			VersionControl:   pulumi.String("Git"),
			WorkItemTemplate: pulumi.String("Agile"),
			Description:      pulumi.String("Managed by Terraform"),
		})
		if err != nil {
			return err
		}
		_, err = azuredevops.NewServiceEndpointGeneric(ctx, "exampleServiceEndpointGeneric", &azuredevops.ServiceEndpointGenericArgs{
			ProjectId:           exampleProject.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 Terraform"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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 exampleProject = new Project("exampleProject", ProjectArgs.builder()        
            .visibility("private")
            .versionControl("Git")
            .workItemTemplate("Agile")
            .description("Managed by Terraform")
            .build());

        var exampleServiceEndpointGeneric = new ServiceEndpointGeneric("exampleServiceEndpointGeneric", ServiceEndpointGenericArgs.builder()        
            .projectId(exampleProject.id())
            .serverUrl("https://some-server.example.com")
            .username("username")
            .password("password")
            .serviceEndpointName("Example Generic")
            .description("Managed by Terraform")
            .build());

    }
}

import pulumi
import pulumi_azuredevops as azuredevops

example_project = azuredevops.Project("exampleProject",
    visibility="private",
    version_control="Git",
    work_item_template="Agile",
    description="Managed by Terraform")
example_service_endpoint_generic = azuredevops.ServiceEndpointGeneric("exampleServiceEndpointGeneric",
    project_id=example_project.id,
    server_url="https://some-server.example.com",
    username="username",
    password="password",
    service_endpoint_name="Example Generic",
    description="Managed by Terraform")

import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const exampleProject = new azuredevops.Project("exampleProject", {
    visibility: "private",
    versionControl: "Git",
    workItemTemplate: "Agile",
    description: "Managed by Terraform",
});
const exampleServiceEndpointGeneric = new azuredevops.ServiceEndpointGeneric("exampleServiceEndpointGeneric", {
    projectId: exampleProject.id,
    serverUrl: "https://some-server.example.com",
    username: "username",
    password: "password",
    serviceEndpointName: "Example Generic",
    description: "Managed by Terraform",
});

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

Create ServiceEndpointGeneric Resource

new ServiceEndpointGeneric(name: string, args: ServiceEndpointGenericArgs, opts?: CustomResourceOptions);

@overload
def ServiceEndpointGeneric(resource_name: 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)
@overload
def ServiceEndpointGeneric(resource_name: str,
                           args: ServiceEndpointGenericArgs,
                           opts: Optional[ResourceOptions] = 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.

name string: The unique name of the resource.
args ServiceEndpointGenericArgs: 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 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 string: The unique name of the resource.
args ServiceEndpointGenericArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServiceEndpointGenericArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ServiceEndpointGenericArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

The ServiceEndpointGeneric resource accepts the following input properties:

ProjectId string: The ID of the project.
ServerUrl string: The URL of the server associated with the service endpoint.
ServiceEndpointName string: The service endpoint name.
Authorization Dictionary<string, string>
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 string: The ID of the project.
ServerUrl string: The URL of the server associated with the service endpoint.
ServiceEndpointName string: The service endpoint name.
Authorization map[string]string
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 String: The ID of the project.
serverUrl String: The URL of the server associated with the service endpoint.
serviceEndpointName String: The service endpoint name.
authorization Map<String,String>
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 string: The ID of the project.
serverUrl string: The URL of the server associated with the service endpoint.
serviceEndpointName string: The service endpoint name.
authorization {[key: string]: string}
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 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.
authorization Mapping[str, str]
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 String: The ID of the project.
serverUrl String: The URL of the server associated with the service endpoint.
serviceEndpointName String: The service endpoint name.
authorization Map<String>
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:

Id string: The provider-assigned unique ID for this managed resource.
PasswordHash string: A bcrypted hash of the attribute 'password'

Id string: The provider-assigned unique ID for this managed resource.
PasswordHash string: A bcrypted hash of the attribute 'password'

id String: The provider-assigned unique ID for this managed resource.
passwordHash String: A bcrypted hash of the attribute 'password'

id string: The provider-assigned unique ID for this managed resource.
passwordHash string: A bcrypted hash of the attribute 'password'

id str: The provider-assigned unique ID for this managed resource.
password_hash str: A bcrypted hash of the attribute 'password'

id String: The provider-assigned unique ID for this managed resource.
passwordHash String: A bcrypted hash of the attribute 'password'

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,
        password_hash: 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)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Authorization Dictionary<string, string>
Description string
Password string: The password or token key used to authenticate to the server url using basic authentication.
PasswordHash string: A bcrypted hash of the attribute 'password'
ProjectId 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.
PasswordHash string: A bcrypted hash of the attribute 'password'
ProjectId 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.
passwordHash String: A bcrypted hash of the attribute 'password'
projectId 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.
passwordHash string: A bcrypted hash of the attribute 'password'
projectId 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.
password_hash str: A bcrypted hash of the attribute 'password'
project_id 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.
passwordHash String: A bcrypted hash of the attribute 'password'
projectId 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 Service Endpoint Generic 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

Package Details

Repository: Azure DevOps pulumi/pulumi-azuredevops
License: Apache-2.0
Notes: This Pulumi package is based on the azuredevops Terraform Provider.