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

azuredevops.ServiceendpointNexus

Explore with Pulumi AI

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

    Manages a Nexus IQ service endpoint within Azure DevOps, which can be used as a resource in YAML pipelines to connect to a Nexus IQ instance. Nexus IQ is not supported by default, to manage a nexus service connection resource, it is necessary to install the Nexus Extension in 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 Terraform",
});
const exampleServiceendpointNexus = new azuredevops.ServiceendpointNexus("example", {
    projectId: example.id,
    serviceEndpointName: "nexus-example",
    description: "Service Endpoint for 'Nexus IQ' (Managed by Terraform)",
    url: "https://example.com",
    username: "username",
    password: "password",
});

    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_serviceendpoint_nexus = azuredevops.ServiceendpointNexus("example",
    project_id=example.id,
    service_endpoint_name="nexus-example",
    description="Service Endpoint for 'Nexus IQ' (Managed by Terraform)",
    url="https://example.com",
    username="username",
    password="password")

    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.NewServiceendpointNexus(ctx, "example", &azuredevops.ServiceendpointNexusArgs{
			ProjectId:           example.ID(),
			ServiceEndpointName: pulumi.String("nexus-example"),
			Description:         pulumi.String("Service Endpoint for 'Nexus IQ' (Managed by Terraform)"),
			Url:                 pulumi.String("https://example.com"),
			Username:            pulumi.String("username"),
			Password:            pulumi.String("password"),
		})
		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 exampleServiceendpointNexus = new AzureDevOps.ServiceendpointNexus("example", new()
    {
        ProjectId = example.Id,
        ServiceEndpointName = "nexus-example",
        Description = "Service Endpoint for 'Nexus IQ' (Managed by Terraform)",
        Url = "https://example.com",
        Username = "username",
        Password = "password",
    });

});

    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.ServiceendpointNexus;
import com.pulumi.azuredevops.ServiceendpointNexusArgs;
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 exampleServiceendpointNexus = new ServiceendpointNexus("exampleServiceendpointNexus", ServiceendpointNexusArgs.builder()
            .projectId(example.id())
            .serviceEndpointName("nexus-example")
            .description("Service Endpoint for 'Nexus IQ' (Managed by Terraform)")
            .url("https://example.com")
            .username("username")
            .password("password")
            .build());

    }
}

    resources:
  example:
    type: azuredevops:Project
    properties:
      name: Example Project
      visibility: private
      versionControl: Git
      workItemTemplate: Agile
      description: Managed by Terraform
  exampleServiceendpointNexus:
    type: azuredevops:ServiceendpointNexus
    name: example
    properties:
      projectId: ${example.id}
      serviceEndpointName: nexus-example
      description: Service Endpoint for 'Nexus IQ' (Managed by Terraform)
      url: https://example.com
      username: username
      password: password

    Create ServiceendpointNexus Resource

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

    Constructor syntax

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

@overload
def ServiceendpointNexus(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         password: Optional[str] = None,
                         project_id: Optional[str] = None,
                         service_endpoint_name: Optional[str] = None,
                         url: Optional[str] = None,
                         username: Optional[str] = None,
                         authorization: Optional[Mapping[str, str]] = None,
                         description: Optional[str] = None)
    func NewServiceendpointNexus(ctx *Context, name string, args ServiceendpointNexusArgs, opts ...ResourceOption) (*ServiceendpointNexus, error)
    public ServiceendpointNexus(string name, ServiceendpointNexusArgs args, CustomResourceOptions? opts = null)
    public ServiceendpointNexus(String name, ServiceendpointNexusArgs args)
public ServiceendpointNexus(String name, ServiceendpointNexusArgs args, CustomResourceOptions options)

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

    example, err := azuredevops.NewServiceendpointNexus(ctx, "serviceendpointNexusResource", &azuredevops.ServiceendpointNexusArgs{
	Password:            pulumi.String("string"),
	ProjectId:           pulumi.String("string"),
	ServiceEndpointName: pulumi.String("string"),
	Url:                 pulumi.String("string"),
	Username:            pulumi.String("string"),
	Authorization: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
})

    var serviceendpointNexusResource = new ServiceendpointNexus("serviceendpointNexusResource", ServiceendpointNexusArgs.builder()
    .password("string")
    .projectId("string")
    .serviceEndpointName("string")
    .url("string")
    .username("string")
    .authorization(Map.of("string", "string"))
    .description("string")
    .build());

    serviceendpoint_nexus_resource = azuredevops.ServiceendpointNexus("serviceendpointNexusResource",
    password="string",
    project_id="string",
    service_endpoint_name="string",
    url="string",
    username="string",
    authorization={
        "string": "string",
    },
    description="string")

    const serviceendpointNexusResource = new azuredevops.ServiceendpointNexus("serviceendpointNexusResource", {
    password: "string",
    projectId: "string",
    serviceEndpointName: "string",
    url: "string",
    username: "string",
    authorization: {
        string: "string",
    },
    description: "string",
});

    type: azuredevops:ServiceendpointNexus
properties:
    authorization:
        string: string
    description: string
    password: string
    projectId: string
    serviceEndpointName: string
    url: string
    username: string

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

    Password string
    The Service Endpoint password to authenticate at the Nexus IQ Instance.
    ProjectId string
    The ID of the project. Changing this forces a new Service Connection Nexus to be created.
    ServiceEndpointName string
    The name of the service endpoint. Changing this forces a new Service Connection Nexus to be created.
    Url string
    The Service Endpoint url.
    Username string
    The Service Endpoint username to authenticate at the Nexus IQ Instance.
    Authorization Dictionary<string, string>
    Description string
    Password string
    The Service Endpoint password to authenticate at the Nexus IQ Instance.
    ProjectId string
    The ID of the project. Changing this forces a new Service Connection Nexus to be created.
    ServiceEndpointName string
    The name of the service endpoint. Changing this forces a new Service Connection Nexus to be created.
    Url string
    The Service Endpoint url.
    Username string
    The Service Endpoint username to authenticate at the Nexus IQ Instance.
    Authorization map[string]string
    Description string
    password String
    The Service Endpoint password to authenticate at the Nexus IQ Instance.
    projectId String
    The ID of the project. Changing this forces a new Service Connection Nexus to be created.
    serviceEndpointName String
    The name of the service endpoint. Changing this forces a new Service Connection Nexus to be created.
    url String
    The Service Endpoint url.
    username String
    The Service Endpoint username to authenticate at the Nexus IQ Instance.
    authorization Map<String,String>
    description String
    password string
    The Service Endpoint password to authenticate at the Nexus IQ Instance.
    projectId string
    The ID of the project. Changing this forces a new Service Connection Nexus to be created.
    serviceEndpointName string
    The name of the service endpoint. Changing this forces a new Service Connection Nexus to be created.
    url string
    The Service Endpoint url.
    username string
    The Service Endpoint username to authenticate at the Nexus IQ Instance.
    authorization {[key: string]: string}
    description string
    password str
    The Service Endpoint password to authenticate at the Nexus IQ Instance.
    project_id str
    The ID of the project. Changing this forces a new Service Connection Nexus to be created.
    service_endpoint_name str
    The name of the service endpoint. Changing this forces a new Service Connection Nexus to be created.
    url str
    The Service Endpoint url.
    username str
    The Service Endpoint username to authenticate at the Nexus IQ Instance.
    authorization Mapping[str, str]
    description str
    password String
    The Service Endpoint password to authenticate at the Nexus IQ Instance.
    projectId String
    The ID of the project. Changing this forces a new Service Connection Nexus to be created.
    serviceEndpointName String
    The name of the service endpoint. Changing this forces a new Service Connection Nexus to be created.
    url String
    The Service Endpoint url.
    username String
    The Service Endpoint username to authenticate at the Nexus IQ Instance.
    authorization Map<String>
    description String

    Outputs

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

    Get an existing ServiceendpointNexus 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?: ServiceendpointNexusState, opts?: CustomResourceOptions): ServiceendpointNexus
    @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,
        service_endpoint_name: Optional[str] = None,
        url: Optional[str] = None,
        username: Optional[str] = None) -> ServiceendpointNexus
    func GetServiceendpointNexus(ctx *Context, name string, id IDInput, state *ServiceendpointNexusState, opts ...ResourceOption) (*ServiceendpointNexus, error)
    public static ServiceendpointNexus Get(string name, Input<string> id, ServiceendpointNexusState? state, CustomResourceOptions? opts = null)
    public static ServiceendpointNexus get(String name, Output<String> id, ServiceendpointNexusState 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 Service Endpoint password to authenticate at the Nexus IQ Instance.
    ProjectId string
    The ID of the project. Changing this forces a new Service Connection Nexus to be created.
    ServiceEndpointName string
    The name of the service endpoint. Changing this forces a new Service Connection Nexus to be created.
    Url string
    The Service Endpoint url.
    Username string
    The Service Endpoint username to authenticate at the Nexus IQ Instance.
    Authorization map[string]string
    Description string
    Password string
    The Service Endpoint password to authenticate at the Nexus IQ Instance.
    ProjectId string
    The ID of the project. Changing this forces a new Service Connection Nexus to be created.
    ServiceEndpointName string
    The name of the service endpoint. Changing this forces a new Service Connection Nexus to be created.
    Url string
    The Service Endpoint url.
    Username string
    The Service Endpoint username to authenticate at the Nexus IQ Instance.
    authorization Map<String,String>
    description String
    password String
    The Service Endpoint password to authenticate at the Nexus IQ Instance.
    projectId String
    The ID of the project. Changing this forces a new Service Connection Nexus to be created.
    serviceEndpointName String
    The name of the service endpoint. Changing this forces a new Service Connection Nexus to be created.
    url String
    The Service Endpoint url.
    username String
    The Service Endpoint username to authenticate at the Nexus IQ Instance.
    authorization {[key: string]: string}
    description string
    password string
    The Service Endpoint password to authenticate at the Nexus IQ Instance.
    projectId string
    The ID of the project. Changing this forces a new Service Connection Nexus to be created.
    serviceEndpointName string
    The name of the service endpoint. Changing this forces a new Service Connection Nexus to be created.
    url string
    The Service Endpoint url.
    username string
    The Service Endpoint username to authenticate at the Nexus IQ Instance.
    authorization Mapping[str, str]
    description str
    password str
    The Service Endpoint password to authenticate at the Nexus IQ Instance.
    project_id str
    The ID of the project. Changing this forces a new Service Connection Nexus to be created.
    service_endpoint_name str
    The name of the service endpoint. Changing this forces a new Service Connection Nexus to be created.
    url str
    The Service Endpoint url.
    username str
    The Service Endpoint username to authenticate at the Nexus IQ Instance.
    authorization Map<String>
    description String
    password String
    The Service Endpoint password to authenticate at the Nexus IQ Instance.
    projectId String
    The ID of the project. Changing this forces a new Service Connection Nexus to be created.
    serviceEndpointName String
    The name of the service endpoint. Changing this forces a new Service Connection Nexus to be created.
    url String
    The Service Endpoint url.
    username String
    The Service Endpoint username to authenticate at the Nexus IQ Instance.

    Import

    Service Connection Nexus can be imported using the projectId/id or or projectName/id, e.g.

    $ pulumi import azuredevops:index/serviceendpointNexus:ServiceendpointNexus example projectName/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