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

azuredevops.ServiceEndpointGeneric

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.3.0 published on Wednesday, Sep 4, 2024 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 Terraform",
});
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 Terraform",
});

    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 Terraform")
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 Terraform")

    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 Terraform"),
		})
		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 Terraform"),
		})
		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 Terraform",
    });

    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 Terraform",
    });

});

    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 Terraform")
            .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 Terraform")
            .build());

    }
}

    resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Terraform
  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 Terraform

    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,
                           authorization: Optional[Mapping[str, 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 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.

    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",
    Authorization = 
    {
        { "string", "string" },
    },
    Description = "string",
    Password = "string",
    Username = "string",
});

    example, err := azuredevops.NewServiceEndpointGeneric(ctx, "serviceEndpointGenericResource", &azuredevops.ServiceEndpointGenericArgs{
	ProjectId:           pulumi.String("string"),
	ServerUrl:           pulumi.String("string"),
	ServiceEndpointName: pulumi.String("string"),
	Authorization: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Password:    pulumi.String("string"),
	Username:    pulumi.String("string"),
})

    var serviceEndpointGenericResource = new ServiceEndpointGeneric("serviceEndpointGenericResource", ServiceEndpointGenericArgs.builder()
    .projectId("string")
    .serverUrl("string")
    .serviceEndpointName("string")
    .authorization(Map.of("string", "string"))
    .description("string")
    .password("string")
    .username("string")
    .build());

    service_endpoint_generic_resource = azuredevops.ServiceEndpointGeneric("serviceEndpointGenericResource",
    project_id="string",
    server_url="string",
    service_endpoint_name="string",
    authorization={
        "string": "string",
    },
    description="string",
    password="string",
    username="string")

    const serviceEndpointGenericResource = new azuredevops.ServiceEndpointGeneric("serviceEndpointGenericResource", {
    projectId: "string",
    serverUrl: "string",
    serviceEndpointName: "string",
    authorization: {
        string: "string",
    },
    description: "string",
    password: "string",
    username: "string",
});

    type: azuredevops:ServiceEndpointGeneric
properties:
    authorization:
        string: string
    description: string
    password: string
    projectId: string
    serverUrl: string
    serviceEndpointName: string
    username: string

    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.
    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 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)
    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.
    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.
    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.
    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.
    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.
    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.
    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

    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.3.0 published on Wednesday, Sep 4, 2024 by Pulumi
    pulumi/pulumi-azuredevops