1. Packages
  2. Azure DevOps Provider
  3. API Docs
  4. ServiceendpointExternaltfs
Azure DevOps v3.9.0 published on Tuesday, Apr 22, 2025 by Pulumi

azuredevops.ServiceendpointExternaltfs

Explore with Pulumi AI

Manages an Azure Repository/Team Foundation Server service endpoint within Azure DevOps.

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 exampleServiceendpointExternaltfs = new azuredevops.ServiceendpointExternaltfs("example", {
    projectId: example.id,
    serviceEndpointName: "Example External TFS Name",
    connectionUrl: "https://dev.azure.com/myorganization",
    description: "Managed by Pulumi",
    authPersonal: {
        personalAccessToken: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    },
});
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_externaltfs = azuredevops.ServiceendpointExternaltfs("example",
    project_id=example.id,
    service_endpoint_name="Example External TFS Name",
    connection_url="https://dev.azure.com/myorganization",
    description="Managed by Pulumi",
    auth_personal={
        "personal_access_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    })
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.NewServiceendpointExternaltfs(ctx, "example", &azuredevops.ServiceendpointExternaltfsArgs{
			ProjectId:           example.ID(),
			ServiceEndpointName: pulumi.String("Example External TFS Name"),
			ConnectionUrl:       pulumi.String("https://dev.azure.com/myorganization"),
			Description:         pulumi.String("Managed by Pulumi"),
			AuthPersonal: &azuredevops.ServiceendpointExternaltfsAuthPersonalArgs{
				PersonalAccessToken: pulumi.String("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
			},
		})
		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 exampleServiceendpointExternaltfs = new AzureDevOps.ServiceendpointExternaltfs("example", new()
    {
        ProjectId = example.Id,
        ServiceEndpointName = "Example External TFS Name",
        ConnectionUrl = "https://dev.azure.com/myorganization",
        Description = "Managed by Pulumi",
        AuthPersonal = new AzureDevOps.Inputs.ServiceendpointExternaltfsAuthPersonalArgs
        {
            PersonalAccessToken = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        },
    });

});
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.ServiceendpointExternaltfs;
import com.pulumi.azuredevops.ServiceendpointExternaltfsArgs;
import com.pulumi.azuredevops.inputs.ServiceendpointExternaltfsAuthPersonalArgs;
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 exampleServiceendpointExternaltfs = new ServiceendpointExternaltfs("exampleServiceendpointExternaltfs", ServiceendpointExternaltfsArgs.builder()
            .projectId(example.id())
            .serviceEndpointName("Example External TFS Name")
            .connectionUrl("https://dev.azure.com/myorganization")
            .description("Managed by Pulumi")
            .authPersonal(ServiceendpointExternaltfsAuthPersonalArgs.builder()
                .personalAccessToken("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Pulumi
  exampleServiceendpointExternaltfs:
    type: azuredevops:ServiceendpointExternaltfs
    name: example
    properties:
      projectId: ${example.id}
      serviceEndpointName: Example External TFS Name
      connectionUrl: https://dev.azure.com/myorganization
      description: Managed by Pulumi
      authPersonal:
        personalAccessToken: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Copy

Create ServiceendpointExternaltfs Resource

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

Constructor syntax

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

@overload
def ServiceendpointExternaltfs(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               auth_personal: Optional[ServiceendpointExternaltfsAuthPersonalArgs] = None,
                               connection_url: Optional[str] = None,
                               project_id: Optional[str] = None,
                               service_endpoint_name: Optional[str] = None,
                               description: Optional[str] = None)
func NewServiceendpointExternaltfs(ctx *Context, name string, args ServiceendpointExternaltfsArgs, opts ...ResourceOption) (*ServiceendpointExternaltfs, error)
public ServiceendpointExternaltfs(string name, ServiceendpointExternaltfsArgs args, CustomResourceOptions? opts = null)
public ServiceendpointExternaltfs(String name, ServiceendpointExternaltfsArgs args)
public ServiceendpointExternaltfs(String name, ServiceendpointExternaltfsArgs args, CustomResourceOptions options)
type: azuredevops:ServiceendpointExternaltfs
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. ServiceendpointExternaltfsArgs
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. ServiceendpointExternaltfsArgs
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. ServiceendpointExternaltfsArgs
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. ServiceendpointExternaltfsArgs
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. ServiceendpointExternaltfsArgs
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 serviceendpointExternaltfsResource = new AzureDevOps.ServiceendpointExternaltfs("serviceendpointExternaltfsResource", new()
{
    AuthPersonal = new AzureDevOps.Inputs.ServiceendpointExternaltfsAuthPersonalArgs
    {
        PersonalAccessToken = "string",
    },
    ConnectionUrl = "string",
    ProjectId = "string",
    ServiceEndpointName = "string",
    Description = "string",
});
Copy
example, err := azuredevops.NewServiceendpointExternaltfs(ctx, "serviceendpointExternaltfsResource", &azuredevops.ServiceendpointExternaltfsArgs{
	AuthPersonal: &azuredevops.ServiceendpointExternaltfsAuthPersonalArgs{
		PersonalAccessToken: pulumi.String("string"),
	},
	ConnectionUrl:       pulumi.String("string"),
	ProjectId:           pulumi.String("string"),
	ServiceEndpointName: pulumi.String("string"),
	Description:         pulumi.String("string"),
})
Copy
var serviceendpointExternaltfsResource = new ServiceendpointExternaltfs("serviceendpointExternaltfsResource", ServiceendpointExternaltfsArgs.builder()
    .authPersonal(ServiceendpointExternaltfsAuthPersonalArgs.builder()
        .personalAccessToken("string")
        .build())
    .connectionUrl("string")
    .projectId("string")
    .serviceEndpointName("string")
    .description("string")
    .build());
Copy
serviceendpoint_externaltfs_resource = azuredevops.ServiceendpointExternaltfs("serviceendpointExternaltfsResource",
    auth_personal={
        "personal_access_token": "string",
    },
    connection_url="string",
    project_id="string",
    service_endpoint_name="string",
    description="string")
Copy
const serviceendpointExternaltfsResource = new azuredevops.ServiceendpointExternaltfs("serviceendpointExternaltfsResource", {
    authPersonal: {
        personalAccessToken: "string",
    },
    connectionUrl: "string",
    projectId: "string",
    serviceEndpointName: "string",
    description: "string",
});
Copy
type: azuredevops:ServiceendpointExternaltfs
properties:
    authPersonal:
        personalAccessToken: string
    connectionUrl: string
    description: string
    projectId: string
    serviceEndpointName: string
Copy

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

AuthPersonal This property is required. Pulumi.AzureDevOps.Inputs.ServiceendpointExternaltfsAuthPersonal
An auth_personal block as documented below. Allows connecting using a personal access token.
ConnectionUrl This property is required. string
Azure DevOps Organization or TFS Project Collection Url.
ProjectId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the project.
ServiceEndpointName This property is required. string
The Service Endpoint name.
Description string
AuthPersonal This property is required. ServiceendpointExternaltfsAuthPersonalArgs
An auth_personal block as documented below. Allows connecting using a personal access token.
ConnectionUrl This property is required. string
Azure DevOps Organization or TFS Project Collection Url.
ProjectId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the project.
ServiceEndpointName This property is required. string
The Service Endpoint name.
Description string
authPersonal This property is required. ServiceendpointExternaltfsAuthPersonal
An auth_personal block as documented below. Allows connecting using a personal access token.
connectionUrl This property is required. String
Azure DevOps Organization or TFS Project Collection Url.
projectId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the project.
serviceEndpointName This property is required. String
The Service Endpoint name.
description String
authPersonal This property is required. ServiceendpointExternaltfsAuthPersonal
An auth_personal block as documented below. Allows connecting using a personal access token.
connectionUrl This property is required. string
Azure DevOps Organization or TFS Project Collection Url.
projectId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the project.
serviceEndpointName This property is required. string
The Service Endpoint name.
description string
auth_personal This property is required. ServiceendpointExternaltfsAuthPersonalArgs
An auth_personal block as documented below. Allows connecting using a personal access token.
connection_url This property is required. str
Azure DevOps Organization or TFS Project Collection Url.
project_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the project.
service_endpoint_name This property is required. str
The Service Endpoint name.
description str
authPersonal This property is required. Property Map
An auth_personal block as documented below. Allows connecting using a personal access token.
connectionUrl This property is required. String
Azure DevOps Organization or TFS Project Collection Url.
projectId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the project.
serviceEndpointName This property is required. String
The Service Endpoint name.
description String

Outputs

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

Get an existing ServiceendpointExternaltfs 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?: ServiceendpointExternaltfsState, opts?: CustomResourceOptions): ServiceendpointExternaltfs
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_personal: Optional[ServiceendpointExternaltfsAuthPersonalArgs] = None,
        authorization: Optional[Mapping[str, str]] = None,
        connection_url: Optional[str] = None,
        description: Optional[str] = None,
        project_id: Optional[str] = None,
        service_endpoint_name: Optional[str] = None) -> ServiceendpointExternaltfs
func GetServiceendpointExternaltfs(ctx *Context, name string, id IDInput, state *ServiceendpointExternaltfsState, opts ...ResourceOption) (*ServiceendpointExternaltfs, error)
public static ServiceendpointExternaltfs Get(string name, Input<string> id, ServiceendpointExternaltfsState? state, CustomResourceOptions? opts = null)
public static ServiceendpointExternaltfs get(String name, Output<String> id, ServiceendpointExternaltfsState state, CustomResourceOptions options)
resources:  _:    type: azuredevops:ServiceendpointExternaltfs    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:
AuthPersonal Pulumi.AzureDevOps.Inputs.ServiceendpointExternaltfsAuthPersonal
An auth_personal block as documented below. Allows connecting using a personal access token.
Authorization Dictionary<string, string>
ConnectionUrl string
Azure DevOps Organization or TFS Project Collection Url.
Description string
ProjectId Changes to this property will trigger replacement. string
The ID of the project.
ServiceEndpointName string
The Service Endpoint name.
AuthPersonal ServiceendpointExternaltfsAuthPersonalArgs
An auth_personal block as documented below. Allows connecting using a personal access token.
Authorization map[string]string
ConnectionUrl string
Azure DevOps Organization or TFS Project Collection Url.
Description string
ProjectId Changes to this property will trigger replacement. string
The ID of the project.
ServiceEndpointName string
The Service Endpoint name.
authPersonal ServiceendpointExternaltfsAuthPersonal
An auth_personal block as documented below. Allows connecting using a personal access token.
authorization Map<String,String>
connectionUrl String
Azure DevOps Organization or TFS Project Collection Url.
description String
projectId Changes to this property will trigger replacement. String
The ID of the project.
serviceEndpointName String
The Service Endpoint name.
authPersonal ServiceendpointExternaltfsAuthPersonal
An auth_personal block as documented below. Allows connecting using a personal access token.
authorization {[key: string]: string}
connectionUrl string
Azure DevOps Organization or TFS Project Collection Url.
description string
projectId Changes to this property will trigger replacement. string
The ID of the project.
serviceEndpointName string
The Service Endpoint name.
auth_personal ServiceendpointExternaltfsAuthPersonalArgs
An auth_personal block as documented below. Allows connecting using a personal access token.
authorization Mapping[str, str]
connection_url str
Azure DevOps Organization or TFS Project Collection Url.
description str
project_id Changes to this property will trigger replacement. str
The ID of the project.
service_endpoint_name str
The Service Endpoint name.
authPersonal Property Map
An auth_personal block as documented below. Allows connecting using a personal access token.
authorization Map<String>
connectionUrl String
Azure DevOps Organization or TFS Project Collection Url.
description String
projectId Changes to this property will trigger replacement. String
The ID of the project.
serviceEndpointName String
The Service Endpoint name.

Supporting Types

ServiceendpointExternaltfsAuthPersonal
, ServiceendpointExternaltfsAuthPersonalArgs

PersonalAccessToken This property is required. string
The Personal Access Token for Azure DevOps Organization.
PersonalAccessToken This property is required. string
The Personal Access Token for Azure DevOps Organization.
personalAccessToken This property is required. String
The Personal Access Token for Azure DevOps Organization.
personalAccessToken This property is required. string
The Personal Access Token for Azure DevOps Organization.
personal_access_token This property is required. str
The Personal Access Token for Azure DevOps Organization.
personalAccessToken This property is required. String
The Personal Access Token for Azure DevOps Organization.

Import

Azure DevOps Azure Repository/Team Foundation Server Service Endpoint can be imported using projectID/serviceEndpointID or projectName/serviceEndpointID

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