Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure DevOps Provider
  3. API Docs
  4. ServiceEndpointSsh
Azure DevOps v3.9.0 published on Tuesday, Apr 22, 2025 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.ServiceEndpointSsh

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.9.0 published on Tuesday, Apr 22, 2025 by Pulumi
pulumi/pulumi-azuredevops

    Manages a SSH 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 exampleServiceEndpointSsh = new azuredevops.ServiceEndpointSsh("example", {
    projectId: example.id,
    serviceEndpointName: "Example SSH",
    host: "1.2.3.4",
    username: "username",
    description: "Managed by Pulumi",
});

    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_ssh = azuredevops.ServiceEndpointSsh("example",
    project_id=example.id,
    service_endpoint_name="Example SSH",
    host="1.2.3.4",
    username="username",
    description="Managed by Pulumi")

    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.NewServiceEndpointSsh(ctx, "example", &azuredevops.ServiceEndpointSshArgs{
			ProjectId:           example.ID(),
			ServiceEndpointName: pulumi.String("Example SSH"),
			Host:                pulumi.String("1.2.3.4"),
			Username:            pulumi.String("username"),
			Description:         pulumi.String("Managed by Pulumi"),
		})
		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 Pulumi",
    });

    var exampleServiceEndpointSsh = new AzureDevOps.ServiceEndpointSsh("example", new()
    {
        ProjectId = example.Id,
        ServiceEndpointName = "Example SSH",
        Host = "1.2.3.4",
        Username = "username",
        Description = "Managed by Pulumi",
    });

});

    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.ServiceEndpointSsh;
import com.pulumi.azuredevops.ServiceEndpointSshArgs;
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 exampleServiceEndpointSsh = new ServiceEndpointSsh("exampleServiceEndpointSsh", ServiceEndpointSshArgs.builder()
            .projectId(example.id())
            .serviceEndpointName("Example SSH")
            .host("1.2.3.4")
            .username("username")
            .description("Managed by Pulumi")
            .build());

    }
}

    resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Pulumi
  exampleServiceEndpointSsh:
    type: azuredevops:ServiceEndpointSsh
    name: example
    properties:
      projectId: ${example.id}
      serviceEndpointName: Example SSH
      host: 1.2.3.4
      username: username
      description: Managed by Pulumi

    Create ServiceEndpointSsh Resource

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

    Constructor syntax

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

@overload
def ServiceEndpointSsh(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       host: Optional[str] = None,
                       project_id: Optional[str] = None,
                       service_endpoint_name: Optional[str] = None,
                       username: Optional[str] = None,
                       description: Optional[str] = None,
                       password: Optional[str] = None,
                       port: Optional[int] = None,
                       private_key: Optional[str] = None)
    func NewServiceEndpointSsh(ctx *Context, name string, args ServiceEndpointSshArgs, opts ...ResourceOption) (*ServiceEndpointSsh, error)
    public ServiceEndpointSsh(string name, ServiceEndpointSshArgs args, CustomResourceOptions? opts = null)
    public ServiceEndpointSsh(String name, ServiceEndpointSshArgs args)
public ServiceEndpointSsh(String name, ServiceEndpointSshArgs args, CustomResourceOptions options)

    type: azuredevops:ServiceEndpointSsh
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 ServiceEndpointSshArgs
    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 ServiceEndpointSshArgs
    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 ServiceEndpointSshArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceEndpointSshArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceEndpointSshArgs
    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 serviceEndpointSshResource = new AzureDevOps.ServiceEndpointSsh("serviceEndpointSshResource", new()
{
    Host = "string",
    ProjectId = "string",
    ServiceEndpointName = "string",
    Username = "string",
    Description = "string",
    Password = "string",
    Port = 0,
    PrivateKey = "string",
});

    example, err := azuredevops.NewServiceEndpointSsh(ctx, "serviceEndpointSshResource", &azuredevops.ServiceEndpointSshArgs{
	Host:                pulumi.String("string"),
	ProjectId:           pulumi.String("string"),
	ServiceEndpointName: pulumi.String("string"),
	Username:            pulumi.String("string"),
	Description:         pulumi.String("string"),
	Password:            pulumi.String("string"),
	Port:                pulumi.Int(0),
	PrivateKey:          pulumi.String("string"),
})

    var serviceEndpointSshResource = new ServiceEndpointSsh("serviceEndpointSshResource", ServiceEndpointSshArgs.builder()
    .host("string")
    .projectId("string")
    .serviceEndpointName("string")
    .username("string")
    .description("string")
    .password("string")
    .port(0)
    .privateKey("string")
    .build());

    service_endpoint_ssh_resource = azuredevops.ServiceEndpointSsh("serviceEndpointSshResource",
    host="string",
    project_id="string",
    service_endpoint_name="string",
    username="string",
    description="string",
    password="string",
    port=0,
    private_key="string")

    const serviceEndpointSshResource = new azuredevops.ServiceEndpointSsh("serviceEndpointSshResource", {
    host: "string",
    projectId: "string",
    serviceEndpointName: "string",
    username: "string",
    description: "string",
    password: "string",
    port: 0,
    privateKey: "string",
});

    type: azuredevops:ServiceEndpointSsh
properties:
    description: string
    host: string
    password: string
    port: 0
    privateKey: string
    projectId: string
    serviceEndpointName: string
    username: string

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

    Host string
    The Host name or IP address of the remote machine.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    Username string
    Username for connecting to the endpoint.
    Description string
    Password string
    Password for connecting to the endpoint.
    Port int
    Port number on the remote machine to use for connecting. Defaults to 22.
    PrivateKey string
    Private Key for connecting to the endpoint.
    Host string
    The Host name or IP address of the remote machine.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    Username string
    Username for connecting to the endpoint.
    Description string
    Password string
    Password for connecting to the endpoint.
    Port int
    Port number on the remote machine to use for connecting. Defaults to 22.
    PrivateKey string
    Private Key for connecting to the endpoint.
    host String
    The Host name or IP address of the remote machine.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    username String
    Username for connecting to the endpoint.
    description String
    password String
    Password for connecting to the endpoint.
    port Integer
    Port number on the remote machine to use for connecting. Defaults to 22.
    privateKey String
    Private Key for connecting to the endpoint.
    host string
    The Host name or IP address of the remote machine.
    projectId string
    The ID of the project.
    serviceEndpointName string
    The Service Endpoint name.
    username string
    Username for connecting to the endpoint.
    description string
    password string
    Password for connecting to the endpoint.
    port number
    Port number on the remote machine to use for connecting. Defaults to 22.
    privateKey string
    Private Key for connecting to the endpoint.
    host str
    The Host name or IP address of the remote machine.
    project_id str
    The ID of the project.
    service_endpoint_name str
    The Service Endpoint name.
    username str
    Username for connecting to the endpoint.
    description str
    password str
    Password for connecting to the endpoint.
    port int
    Port number on the remote machine to use for connecting. Defaults to 22.
    private_key str
    Private Key for connecting to the endpoint.
    host String
    The Host name or IP address of the remote machine.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    username String
    Username for connecting to the endpoint.
    description String
    password String
    Password for connecting to the endpoint.
    port Number
    Port number on the remote machine to use for connecting. Defaults to 22.
    privateKey String
    Private Key for connecting to the endpoint.

    Outputs

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

    Get an existing ServiceEndpointSsh 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?: ServiceEndpointSshState, opts?: CustomResourceOptions): ServiceEndpointSsh
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorization: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        host: Optional[str] = None,
        password: Optional[str] = None,
        port: Optional[int] = None,
        private_key: Optional[str] = None,
        project_id: Optional[str] = None,
        service_endpoint_name: Optional[str] = None,
        username: Optional[str] = None) -> ServiceEndpointSsh
    func GetServiceEndpointSsh(ctx *Context, name string, id IDInput, state *ServiceEndpointSshState, opts ...ResourceOption) (*ServiceEndpointSsh, error)
    public static ServiceEndpointSsh Get(string name, Input<string> id, ServiceEndpointSshState? state, CustomResourceOptions? opts = null)
    public static ServiceEndpointSsh get(String name, Output<String> id, ServiceEndpointSshState state, CustomResourceOptions options)
    resources:  _:    type: azuredevops:ServiceEndpointSsh    get:      id: ${id}
    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
    Host string
    The Host name or IP address of the remote machine.
    Password string
    Password for connecting to the endpoint.
    Port int
    Port number on the remote machine to use for connecting. Defaults to 22.
    PrivateKey string
    Private Key for connecting to the endpoint.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    Username string
    Username for connecting to the endpoint.
    Authorization map[string]string
    Description string
    Host string
    The Host name or IP address of the remote machine.
    Password string
    Password for connecting to the endpoint.
    Port int
    Port number on the remote machine to use for connecting. Defaults to 22.
    PrivateKey string
    Private Key for connecting to the endpoint.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    Username string
    Username for connecting to the endpoint.
    authorization Map<String,String>
    description String
    host String
    The Host name or IP address of the remote machine.
    password String
    Password for connecting to the endpoint.
    port Integer
    Port number on the remote machine to use for connecting. Defaults to 22.
    privateKey String
    Private Key for connecting to the endpoint.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    username String
    Username for connecting to the endpoint.
    authorization {[key: string]: string}
    description string
    host string
    The Host name or IP address of the remote machine.
    password string
    Password for connecting to the endpoint.
    port number
    Port number on the remote machine to use for connecting. Defaults to 22.
    privateKey string
    Private Key for connecting to the endpoint.
    projectId string
    The ID of the project.
    serviceEndpointName string
    The Service Endpoint name.
    username string
    Username for connecting to the endpoint.
    authorization Mapping[str, str]
    description str
    host str
    The Host name or IP address of the remote machine.
    password str
    Password for connecting to the endpoint.
    port int
    Port number on the remote machine to use for connecting. Defaults to 22.
    private_key str
    Private Key for connecting to the endpoint.
    project_id str
    The ID of the project.
    service_endpoint_name str
    The Service Endpoint name.
    username str
    Username for connecting to the endpoint.
    authorization Map<String>
    description String
    host String
    The Host name or IP address of the remote machine.
    password String
    Password for connecting to the endpoint.
    port Number
    Port number on the remote machine to use for connecting. Defaults to 22.
    privateKey String
    Private Key for connecting to the endpoint.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    username String
    Username for connecting to the endpoint.

    Import

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

    $ pulumi import azuredevops:index/serviceEndpointSsh:ServiceEndpointSsh 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.9.0 published on Tuesday, Apr 22, 2025 by Pulumi
    pulumi/pulumi-azuredevops