1. Packages
  2. Azuredevops Provider
  3. API Docs
  4. ServiceendpointNuget
Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi

azuredevops.ServiceendpointNuget

Explore with Pulumi AI

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

    Manages a NuGet 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 Terraform",
    });
    const exampleServiceendpointNuget = new azuredevops.ServiceendpointNuget("example", {
        projectId: example.id,
        apiKey: "apikey",
        serviceEndpointName: "Example NuGet",
        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_serviceendpoint_nuget = azuredevops.ServiceendpointNuget("example",
        project_id=example.id,
        api_key="apikey",
        service_endpoint_name="Example NuGet",
        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.NewServiceendpointNuget(ctx, "example", &azuredevops.ServiceendpointNugetArgs{
    			ProjectId:           example.ID(),
    			ApiKey:              pulumi.String("apikey"),
    			ServiceEndpointName: pulumi.String("Example NuGet"),
    			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 exampleServiceendpointNuget = new AzureDevOps.ServiceendpointNuget("example", new()
        {
            ProjectId = example.Id,
            ApiKey = "apikey",
            ServiceEndpointName = "Example NuGet",
            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.ServiceendpointNuget;
    import com.pulumi.azuredevops.ServiceendpointNugetArgs;
    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 exampleServiceendpointNuget = new ServiceendpointNuget("exampleServiceendpointNuget", ServiceendpointNugetArgs.builder()
                .projectId(example.id())
                .apiKey("apikey")
                .serviceEndpointName("Example NuGet")
                .description("Managed by Terraform")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azuredevops:Project
        properties:
          name: Example Project
          visibility: private
          versionControl: Git
          workItemTemplate: Agile
          description: Managed by Terraform
      exampleServiceendpointNuget:
        type: azuredevops:ServiceendpointNuget
        name: example
        properties:
          projectId: ${example.id}
          apiKey: apikey
          serviceEndpointName: Example NuGet
          description: Managed by Terraform
    

    Create ServiceendpointNuget Resource

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

    Constructor syntax

    new ServiceendpointNuget(name: string, args: ServiceendpointNugetArgs, opts?: CustomResourceOptions);
    @overload
    def ServiceendpointNuget(resource_name: str,
                             args: ServiceendpointNugetArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def ServiceendpointNuget(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             feed_url: Optional[str] = None,
                             project_id: Optional[str] = None,
                             service_endpoint_name: Optional[str] = None,
                             api_key: Optional[str] = None,
                             authorization: Optional[Mapping[str, str]] = None,
                             description: Optional[str] = None,
                             password: Optional[str] = None,
                             personal_access_token: Optional[str] = None,
                             username: Optional[str] = None)
    func NewServiceendpointNuget(ctx *Context, name string, args ServiceendpointNugetArgs, opts ...ResourceOption) (*ServiceendpointNuget, error)
    public ServiceendpointNuget(string name, ServiceendpointNugetArgs args, CustomResourceOptions? opts = null)
    public ServiceendpointNuget(String name, ServiceendpointNugetArgs args)
    public ServiceendpointNuget(String name, ServiceendpointNugetArgs args, CustomResourceOptions options)
    
    type: azuredevops:ServiceendpointNuget
    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 ServiceendpointNugetArgs
    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 ServiceendpointNugetArgs
    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 ServiceendpointNugetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceendpointNugetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceendpointNugetArgs
    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 serviceendpointNugetResource = new AzureDevOps.ServiceendpointNuget("serviceendpointNugetResource", new()
    {
        FeedUrl = "string",
        ProjectId = "string",
        ServiceEndpointName = "string",
        ApiKey = "string",
        Authorization = 
        {
            { "string", "string" },
        },
        Description = "string",
        Password = "string",
        PersonalAccessToken = "string",
        Username = "string",
    });
    
    example, err := azuredevops.NewServiceendpointNuget(ctx, "serviceendpointNugetResource", &azuredevops.ServiceendpointNugetArgs{
    	FeedUrl:             pulumi.String("string"),
    	ProjectId:           pulumi.String("string"),
    	ServiceEndpointName: pulumi.String("string"),
    	ApiKey:              pulumi.String("string"),
    	Authorization: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Description:         pulumi.String("string"),
    	Password:            pulumi.String("string"),
    	PersonalAccessToken: pulumi.String("string"),
    	Username:            pulumi.String("string"),
    })
    
    var serviceendpointNugetResource = new ServiceendpointNuget("serviceendpointNugetResource", ServiceendpointNugetArgs.builder()
        .feedUrl("string")
        .projectId("string")
        .serviceEndpointName("string")
        .apiKey("string")
        .authorization(Map.of("string", "string"))
        .description("string")
        .password("string")
        .personalAccessToken("string")
        .username("string")
        .build());
    
    serviceendpoint_nuget_resource = azuredevops.ServiceendpointNuget("serviceendpointNugetResource",
        feed_url="string",
        project_id="string",
        service_endpoint_name="string",
        api_key="string",
        authorization={
            "string": "string",
        },
        description="string",
        password="string",
        personal_access_token="string",
        username="string")
    
    const serviceendpointNugetResource = new azuredevops.ServiceendpointNuget("serviceendpointNugetResource", {
        feedUrl: "string",
        projectId: "string",
        serviceEndpointName: "string",
        apiKey: "string",
        authorization: {
            string: "string",
        },
        description: "string",
        password: "string",
        personalAccessToken: "string",
        username: "string",
    });
    
    type: azuredevops:ServiceendpointNuget
    properties:
        apiKey: string
        authorization:
            string: string
        description: string
        feedUrl: string
        password: string
        personalAccessToken: string
        projectId: string
        serviceEndpointName: string
        username: string
    

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

    FeedUrl string
    The URL for the feed. This will generally end with index.json.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    ApiKey string
    The API Key used to connect to the endpoint.
    Authorization Dictionary<string, string>
    Description string
    Password string

    The account password used to connect to the endpoint

    Note Only one of api_key or personal_access_token or username, password can be set at the same time.

    PersonalAccessToken string
    The Personal access token used to connect to the endpoint. Personal access tokens are applicable only for NuGet feeds hosted on other Azure DevOps Services organizations or Azure DevOps Server 2019 (or later).
    Username string
    The account username used to connect to the endpoint.
    FeedUrl string
    The URL for the feed. This will generally end with index.json.
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    ApiKey string
    The API Key used to connect to the endpoint.
    Authorization map[string]string
    Description string
    Password string

    The account password used to connect to the endpoint

    Note Only one of api_key or personal_access_token or username, password can be set at the same time.

    PersonalAccessToken string
    The Personal access token used to connect to the endpoint. Personal access tokens are applicable only for NuGet feeds hosted on other Azure DevOps Services organizations or Azure DevOps Server 2019 (or later).
    Username string
    The account username used to connect to the endpoint.
    feedUrl String
    The URL for the feed. This will generally end with index.json.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    apiKey String
    The API Key used to connect to the endpoint.
    authorization Map<String,String>
    description String
    password String

    The account password used to connect to the endpoint

    Note Only one of api_key or personal_access_token or username, password can be set at the same time.

    personalAccessToken String
    The Personal access token used to connect to the endpoint. Personal access tokens are applicable only for NuGet feeds hosted on other Azure DevOps Services organizations or Azure DevOps Server 2019 (or later).
    username String
    The account username used to connect to the endpoint.
    feedUrl string
    The URL for the feed. This will generally end with index.json.
    projectId string
    The ID of the project.
    serviceEndpointName string
    The Service Endpoint name.
    apiKey string
    The API Key used to connect to the endpoint.
    authorization {[key: string]: string}
    description string
    password string

    The account password used to connect to the endpoint

    Note Only one of api_key or personal_access_token or username, password can be set at the same time.

    personalAccessToken string
    The Personal access token used to connect to the endpoint. Personal access tokens are applicable only for NuGet feeds hosted on other Azure DevOps Services organizations or Azure DevOps Server 2019 (or later).
    username string
    The account username used to connect to the endpoint.
    feed_url str
    The URL for the feed. This will generally end with index.json.
    project_id str
    The ID of the project.
    service_endpoint_name str
    The Service Endpoint name.
    api_key str
    The API Key used to connect to the endpoint.
    authorization Mapping[str, str]
    description str
    password str

    The account password used to connect to the endpoint

    Note Only one of api_key or personal_access_token or username, password can be set at the same time.

    personal_access_token str
    The Personal access token used to connect to the endpoint. Personal access tokens are applicable only for NuGet feeds hosted on other Azure DevOps Services organizations or Azure DevOps Server 2019 (or later).
    username str
    The account username used to connect to the endpoint.
    feedUrl String
    The URL for the feed. This will generally end with index.json.
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    apiKey String
    The API Key used to connect to the endpoint.
    authorization Map<String>
    description String
    password String

    The account password used to connect to the endpoint

    Note Only one of api_key or personal_access_token or username, password can be set at the same time.

    personalAccessToken String
    The Personal access token used to connect to the endpoint. Personal access tokens are applicable only for NuGet feeds hosted on other Azure DevOps Services organizations or Azure DevOps Server 2019 (or later).
    username String
    The account username used to connect to the endpoint.

    Outputs

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

    Get an existing ServiceendpointNuget 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?: ServiceendpointNugetState, opts?: CustomResourceOptions): ServiceendpointNuget
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_key: Optional[str] = None,
            authorization: Optional[Mapping[str, str]] = None,
            description: Optional[str] = None,
            feed_url: Optional[str] = None,
            password: Optional[str] = None,
            personal_access_token: Optional[str] = None,
            project_id: Optional[str] = None,
            service_endpoint_name: Optional[str] = None,
            username: Optional[str] = None) -> ServiceendpointNuget
    func GetServiceendpointNuget(ctx *Context, name string, id IDInput, state *ServiceendpointNugetState, opts ...ResourceOption) (*ServiceendpointNuget, error)
    public static ServiceendpointNuget Get(string name, Input<string> id, ServiceendpointNugetState? state, CustomResourceOptions? opts = null)
    public static ServiceendpointNuget get(String name, Output<String> id, ServiceendpointNugetState 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:
    ApiKey string
    The API Key used to connect to the endpoint.
    Authorization Dictionary<string, string>
    Description string
    FeedUrl string
    The URL for the feed. This will generally end with index.json.
    Password string

    The account password used to connect to the endpoint

    Note Only one of api_key or personal_access_token or username, password can be set at the same time.

    PersonalAccessToken string
    The Personal access token used to connect to the endpoint. Personal access tokens are applicable only for NuGet feeds hosted on other Azure DevOps Services organizations or Azure DevOps Server 2019 (or later).
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    Username string
    The account username used to connect to the endpoint.
    ApiKey string
    The API Key used to connect to the endpoint.
    Authorization map[string]string
    Description string
    FeedUrl string
    The URL for the feed. This will generally end with index.json.
    Password string

    The account password used to connect to the endpoint

    Note Only one of api_key or personal_access_token or username, password can be set at the same time.

    PersonalAccessToken string
    The Personal access token used to connect to the endpoint. Personal access tokens are applicable only for NuGet feeds hosted on other Azure DevOps Services organizations or Azure DevOps Server 2019 (or later).
    ProjectId string
    The ID of the project.
    ServiceEndpointName string
    The Service Endpoint name.
    Username string
    The account username used to connect to the endpoint.
    apiKey String
    The API Key used to connect to the endpoint.
    authorization Map<String,String>
    description String
    feedUrl String
    The URL for the feed. This will generally end with index.json.
    password String

    The account password used to connect to the endpoint

    Note Only one of api_key or personal_access_token or username, password can be set at the same time.

    personalAccessToken String
    The Personal access token used to connect to the endpoint. Personal access tokens are applicable only for NuGet feeds hosted on other Azure DevOps Services organizations or Azure DevOps Server 2019 (or later).
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    username String
    The account username used to connect to the endpoint.
    apiKey string
    The API Key used to connect to the endpoint.
    authorization {[key: string]: string}
    description string
    feedUrl string
    The URL for the feed. This will generally end with index.json.
    password string

    The account password used to connect to the endpoint

    Note Only one of api_key or personal_access_token or username, password can be set at the same time.

    personalAccessToken string
    The Personal access token used to connect to the endpoint. Personal access tokens are applicable only for NuGet feeds hosted on other Azure DevOps Services organizations or Azure DevOps Server 2019 (or later).
    projectId string
    The ID of the project.
    serviceEndpointName string
    The Service Endpoint name.
    username string
    The account username used to connect to the endpoint.
    api_key str
    The API Key used to connect to the endpoint.
    authorization Mapping[str, str]
    description str
    feed_url str
    The URL for the feed. This will generally end with index.json.
    password str

    The account password used to connect to the endpoint

    Note Only one of api_key or personal_access_token or username, password can be set at the same time.

    personal_access_token str
    The Personal access token used to connect to the endpoint. Personal access tokens are applicable only for NuGet feeds hosted on other Azure DevOps Services organizations or Azure DevOps Server 2019 (or later).
    project_id str
    The ID of the project.
    service_endpoint_name str
    The Service Endpoint name.
    username str
    The account username used to connect to the endpoint.
    apiKey String
    The API Key used to connect to the endpoint.
    authorization Map<String>
    description String
    feedUrl String
    The URL for the feed. This will generally end with index.json.
    password String

    The account password used to connect to the endpoint

    Note Only one of api_key or personal_access_token or username, password can be set at the same time.

    personalAccessToken String
    The Personal access token used to connect to the endpoint. Personal access tokens are applicable only for NuGet feeds hosted on other Azure DevOps Services organizations or Azure DevOps Server 2019 (or later).
    projectId String
    The ID of the project.
    serviceEndpointName String
    The Service Endpoint name.
    username String
    The account username used to connect to the endpoint.

    Import

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

    $ pulumi import azuredevops:index/serviceendpointNuget:ServiceendpointNuget 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