Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azuredevops Provider
  3. API Docs
  4. ServiceendpointExternaltfs
Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.ServiceendpointExternaltfs

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-azuredevops

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

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

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

    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,
                               authorization: Optional[Mapping[str, 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 string
    The unique name of the resource.
    args ServiceendpointExternaltfsArgs
    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 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 string
    The unique name of the resource.
    args ServiceendpointExternaltfsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceendpointExternaltfsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
    Authorization = 
    {
        { "string", "string" },
    },
    Description = "string",
});

    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"),
	Authorization: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
})

    var serviceendpointExternaltfsResource = new ServiceendpointExternaltfs("serviceendpointExternaltfsResource", ServiceendpointExternaltfsArgs.builder()
    .authPersonal(ServiceendpointExternaltfsAuthPersonalArgs.builder()
        .personalAccessToken("string")
        .build())
    .connectionUrl("string")
    .projectId("string")
    .serviceEndpointName("string")
    .authorization(Map.of("string", "string"))
    .description("string")
    .build());

    serviceendpoint_externaltfs_resource = azuredevops.ServiceendpointExternaltfs("serviceendpointExternaltfsResource",
    auth_personal={
        "personal_access_token": "string",
    },
    connection_url="string",
    project_id="string",
    service_endpoint_name="string",
    authorization={
        "string": "string",
    },
    description="string")

    const serviceendpointExternaltfsResource = new azuredevops.ServiceendpointExternaltfs("serviceendpointExternaltfsResource", {
    authPersonal: {
        personalAccessToken: "string",
    },
    connectionUrl: "string",
    projectId: "string",
    serviceEndpointName: "string",
    authorization: {
        string: "string",
    },
    description: "string",
});

    type: azuredevops:ServiceendpointExternaltfs
properties:
    authPersonal:
        personalAccessToken: string
    authorization:
        string: string
    connectionUrl: string
    description: string
    projectId: string
    serviceEndpointName: string

    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 Pulumi.AzureDevOps.Inputs.ServiceendpointExternaltfsAuthPersonal
    An auth_personal block as documented below. Allows connecting using a personal access token.
    ConnectionUrl string
    URL of the Azure DevOps organization or the TFS Project Collection to connect to.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    Authorization Dictionary<string, string>
    Description string
    AuthPersonal ServiceendpointExternaltfsAuthPersonalArgs
    An auth_personal block as documented below. Allows connecting using a personal access token.
    ConnectionUrl string
    URL of the Azure DevOps organization or the TFS Project Collection to connect to.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    Authorization map[string]string
    Description string
    authPersonal ServiceendpointExternaltfsAuthPersonal
    An auth_personal block as documented below. Allows connecting using a personal access token.
    connectionUrl String
    URL of the Azure DevOps organization or the TFS Project Collection to connect to.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    authorization Map<String,String>
    description String
    authPersonal ServiceendpointExternaltfsAuthPersonal
    An auth_personal block as documented below. Allows connecting using a personal access token.
    connectionUrl string
    URL of the Azure DevOps organization or the TFS Project Collection to connect to.
    projectId string
    The ID of the project.
    serviceEndpointName string
    The Service Endpoint name.
    authorization {[key: string]: string}
    description string
    auth_personal ServiceendpointExternaltfsAuthPersonalArgs
    An auth_personal block as documented below. Allows connecting using a personal access token.
    connection_url str
    URL of the Azure DevOps organization or the TFS Project Collection to connect to.
    project_id str
    The ID of the project.
    service_endpoint_name str
    The Service Endpoint name.
    authorization Mapping[str, str]
    description str
    authPersonal Property Map
    An auth_personal block as documented below. Allows connecting using a personal access token.
    connectionUrl String
    URL of the Azure DevOps organization or the TFS Project Collection to connect to.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    authorization Map<String>
    description String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ServiceendpointExternaltfs resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    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)
    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:
    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
    URL of the Azure DevOps organization or the TFS Project Collection to connect to.
    Description string
    ProjectId 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
    URL of the Azure DevOps organization or the TFS Project Collection to connect to.
    Description string
    ProjectId 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
    URL of the Azure DevOps organization or the TFS Project Collection to connect to.
    description String
    projectId 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
    URL of the Azure DevOps organization or the TFS Project Collection to connect to.
    description string
    projectId 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
    URL of the Azure DevOps organization or the TFS Project Collection to connect to.
    description str
    project_id 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
    URL of the Azure DevOps organization or the TFS Project Collection to connect to.
    description String
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.

    Supporting Types

    ServiceendpointExternaltfsAuthPersonal, ServiceendpointExternaltfsAuthPersonalArgs

    PersonalAccessToken string
    The Personal Access Token for Azure DevOps Organization.
    PersonalAccessToken string
    The Personal Access Token for Azure DevOps Organization.
    personalAccessToken String
    The Personal Access Token for Azure DevOps Organization.
    personalAccessToken string
    The Personal Access Token for Azure DevOps Organization.
    personal_access_token str
    The Personal Access Token for Azure DevOps Organization.
    personalAccessToken String
    The Personal Access Token for Azure DevOps Organization.

    Import

    Azure DevOps Service Endpoint External TFS 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

    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.
    azuredevops logo
    Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
    pulumi/pulumi-azuredevops