Azure DevOps v2.7.0, Mar 27 23

azuredevops.ServiceEndpointSsh

Explore with Pulumi AI

Manages a SSH service endpoint within Azure DevOps.

Relevant Links

Azure DevOps Service REST API 6.0 - Service Endpoints

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 exampleServiceEndpointSsh = new AzureDevOps.ServiceEndpointSsh("exampleServiceEndpointSsh", new()
    {
        ProjectId = exampleProject.Id,
        ServiceEndpointName = "Example SSH",
        Host = "1.2.3.4",
        Username = "username",
        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.NewServiceEndpointSsh(ctx, "exampleServiceEndpointSsh", &azuredevops.ServiceEndpointSshArgs{
			ProjectId:           exampleProject.ID(),
			ServiceEndpointName: pulumi.String("Example SSH"),
			Host:                pulumi.String("1.2.3.4"),
			Username:            pulumi.String("username"),
			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.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 exampleProject = new Project("exampleProject", ProjectArgs.builder()        
            .visibility("private")
            .versionControl("Git")
            .workItemTemplate("Agile")
            .description("Managed by Terraform")
            .build());

        var exampleServiceEndpointSsh = new ServiceEndpointSsh("exampleServiceEndpointSsh", ServiceEndpointSshArgs.builder()        
            .projectId(exampleProject.id())
            .serviceEndpointName("Example SSH")
            .host("1.2.3.4")
            .username("username")
            .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_ssh = azuredevops.ServiceEndpointSsh("exampleServiceEndpointSsh",
    project_id=example_project.id,
    service_endpoint_name="Example SSH",
    host="1.2.3.4",
    username="username",
    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 exampleServiceEndpointSsh = new azuredevops.ServiceEndpointSsh("exampleServiceEndpointSsh", {
    projectId: exampleProject.id,
    serviceEndpointName: "Example SSH",
    host: "1.2.3.4",
    username: "username",
    description: "Managed by Terraform",
});

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

Create ServiceEndpointSsh Resource

new ServiceEndpointSsh(name: string, args: ServiceEndpointSshArgs, opts?: CustomResourceOptions);

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

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.

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

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.
Authorization Dictionary<string, string>
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.
Authorization map[string]string
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.
authorization Map<String,String>
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.
authorization {[key: string]: string}
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.
authorization Mapping[str, str]
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.
authorization Map<String>
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:

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

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

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

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

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

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

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,
        password_hash: Optional[str] = None,
        port: Optional[int] = None,
        private_key: Optional[str] = None,
        private_key_hash: 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)

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
Host string: The Host name or IP address of the remote machine.
Password string: Password for connecting to the endpoint.
PasswordHash string: A bcrypted hash of the attribute 'password'
Port int: Port number on the remote machine to use for connecting. Defaults to 22.
PrivateKey string: Private Key for connecting to the endpoint.
PrivateKeyHash string: A bcrypted hash of the attribute 'private_key'
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.
PasswordHash string: A bcrypted hash of the attribute 'password'
Port int: Port number on the remote machine to use for connecting. Defaults to 22.
PrivateKey string: Private Key for connecting to the endpoint.
PrivateKeyHash string: A bcrypted hash of the attribute 'private_key'
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.
passwordHash String: A bcrypted hash of the attribute 'password'
port Integer: Port number on the remote machine to use for connecting. Defaults to 22.
privateKey String: Private Key for connecting to the endpoint.
privateKeyHash String: A bcrypted hash of the attribute 'private_key'
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.
passwordHash string: A bcrypted hash of the attribute 'password'
port number: Port number on the remote machine to use for connecting. Defaults to 22.
privateKey string: Private Key for connecting to the endpoint.
privateKeyHash string: A bcrypted hash of the attribute 'private_key'
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.
password_hash str: A bcrypted hash of the attribute 'password'
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.
private_key_hash str: A bcrypted hash of the attribute 'private_key'
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.
passwordHash String: A bcrypted hash of the attribute 'password'
port Number: Port number on the remote machine to use for connecting. Defaults to 22.
privateKey String: Private Key for connecting to the endpoint.
privateKeyHash String: A bcrypted hash of the attribute 'private_key'
projectId String: The ID of the project.
serviceEndpointName String: The Service Endpoint name.
username String: Username for connecting to the endpoint.

Import

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

Package Details

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