azuredevops.ServiceendpointOctopusdeploy
Explore with Pulumi AI
Manages an Octopus Deploy service endpoint within Azure DevOps. Using this service endpoint requires you to install Octopus Deploy.
Relevant Links
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 exampleServiceendpointOctopusdeploy = new AzureDevOps.ServiceendpointOctopusdeploy("exampleServiceendpointOctopusdeploy", new()
{
ProjectId = exampleProject.Id,
Url = "https://octopus.com",
ApiKey = "000000000000000000000000000000000000",
ServiceEndpointName = "Example Octopus Deploy",
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.NewServiceendpointOctopusdeploy(ctx, "exampleServiceendpointOctopusdeploy", &azuredevops.ServiceendpointOctopusdeployArgs{
ProjectId: exampleProject.ID(),
Url: pulumi.String("https://octopus.com"),
ApiKey: pulumi.String("000000000000000000000000000000000000"),
ServiceEndpointName: pulumi.String("Example Octopus Deploy"),
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.ServiceendpointOctopusdeploy;
import com.pulumi.azuredevops.ServiceendpointOctopusdeployArgs;
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 exampleServiceendpointOctopusdeploy = new ServiceendpointOctopusdeploy("exampleServiceendpointOctopusdeploy", ServiceendpointOctopusdeployArgs.builder()
.projectId(exampleProject.id())
.url("https://octopus.com")
.apiKey("000000000000000000000000000000000000")
.serviceEndpointName("Example Octopus Deploy")
.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_serviceendpoint_octopusdeploy = azuredevops.ServiceendpointOctopusdeploy("exampleServiceendpointOctopusdeploy",
project_id=example_project.id,
url="https://octopus.com",
api_key="000000000000000000000000000000000000",
service_endpoint_name="Example Octopus Deploy",
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 exampleServiceendpointOctopusdeploy = new azuredevops.ServiceendpointOctopusdeploy("exampleServiceendpointOctopusdeploy", {
projectId: exampleProject.id,
url: "https://octopus.com",
apiKey: "000000000000000000000000000000000000",
serviceEndpointName: "Example Octopus Deploy",
description: "Managed by Terraform",
});
resources:
exampleProject:
type: azuredevops:Project
properties:
visibility: private
versionControl: Git
workItemTemplate: Agile
description: Managed by Terraform
exampleServiceendpointOctopusdeploy:
type: azuredevops:ServiceendpointOctopusdeploy
properties:
projectId: ${exampleProject.id}
url: https://octopus.com
apiKey: '000000000000000000000000000000000000'
serviceEndpointName: Example Octopus Deploy
description: Managed by Terraform
Create ServiceendpointOctopusdeploy Resource
new ServiceendpointOctopusdeploy(name: string, args: ServiceendpointOctopusdeployArgs, opts?: CustomResourceOptions);
@overload
def ServiceendpointOctopusdeploy(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_key: Optional[str] = None,
authorization: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
ignore_ssl_error: Optional[bool] = None,
project_id: Optional[str] = None,
service_endpoint_name: Optional[str] = None,
url: Optional[str] = None)
@overload
def ServiceendpointOctopusdeploy(resource_name: str,
args: ServiceendpointOctopusdeployArgs,
opts: Optional[ResourceOptions] = None)
func NewServiceendpointOctopusdeploy(ctx *Context, name string, args ServiceendpointOctopusdeployArgs, opts ...ResourceOption) (*ServiceendpointOctopusdeploy, error)
public ServiceendpointOctopusdeploy(string name, ServiceendpointOctopusdeployArgs args, CustomResourceOptions? opts = null)
public ServiceendpointOctopusdeploy(String name, ServiceendpointOctopusdeployArgs args)
public ServiceendpointOctopusdeploy(String name, ServiceendpointOctopusdeployArgs args, CustomResourceOptions options)
type: azuredevops:ServiceendpointOctopusdeploy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServiceendpointOctopusdeployArgs
- 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 ServiceendpointOctopusdeployArgs
- 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 ServiceendpointOctopusdeployArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServiceendpointOctopusdeployArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ServiceendpointOctopusdeployArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ServiceendpointOctopusdeploy 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 ServiceendpointOctopusdeploy resource accepts the following input properties:
- Api
Key string API key to connect to Octopus Deploy.
- Project
Id string The ID of the project.
- Service
Endpoint stringName The Service Endpoint name.
- Url string
Octopus Server url.
- Dictionary<string, string>
- Description string
- Ignore
Ssl boolError Whether to ignore SSL errors when connecting to the Octopus server from the agent. Default to
false
.
- Api
Key string API key to connect to Octopus Deploy.
- Project
Id string The ID of the project.
- Service
Endpoint stringName The Service Endpoint name.
- Url string
Octopus Server url.
- map[string]string
- Description string
- Ignore
Ssl boolError Whether to ignore SSL errors when connecting to the Octopus server from the agent. Default to
false
.
- api
Key String API key to connect to Octopus Deploy.
- project
Id String The ID of the project.
- service
Endpoint StringName The Service Endpoint name.
- url String
Octopus Server url.
- Map<String,String>
- description String
- ignore
Ssl BooleanError Whether to ignore SSL errors when connecting to the Octopus server from the agent. Default to
false
.
- api
Key string API key to connect to Octopus Deploy.
- project
Id string The ID of the project.
- service
Endpoint stringName The Service Endpoint name.
- url string
Octopus Server url.
- {[key: string]: string}
- description string
- ignore
Ssl booleanError Whether to ignore SSL errors when connecting to the Octopus server from the agent. Default to
false
.
- api_
key str API key to connect to Octopus Deploy.
- project_
id str The ID of the project.
- service_
endpoint_ strname The Service Endpoint name.
- url str
Octopus Server url.
- Mapping[str, str]
- description str
- ignore_
ssl_ boolerror Whether to ignore SSL errors when connecting to the Octopus server from the agent. Default to
false
.
- api
Key String API key to connect to Octopus Deploy.
- project
Id String The ID of the project.
- service
Endpoint StringName The Service Endpoint name.
- url String
Octopus Server url.
- Map<String>
- description String
- ignore
Ssl BooleanError Whether to ignore SSL errors when connecting to the Octopus server from the agent. Default to
false
.
Outputs
All input properties are implicitly available as output properties. Additionally, the ServiceendpointOctopusdeploy 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 ServiceendpointOctopusdeploy Resource
Get an existing ServiceendpointOctopusdeploy 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?: ServiceendpointOctopusdeployState, opts?: CustomResourceOptions): ServiceendpointOctopusdeploy
@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,
ignore_ssl_error: Optional[bool] = None,
project_id: Optional[str] = None,
service_endpoint_name: Optional[str] = None,
url: Optional[str] = None) -> ServiceendpointOctopusdeploy
func GetServiceendpointOctopusdeploy(ctx *Context, name string, id IDInput, state *ServiceendpointOctopusdeployState, opts ...ResourceOption) (*ServiceendpointOctopusdeploy, error)
public static ServiceendpointOctopusdeploy Get(string name, Input<string> id, ServiceendpointOctopusdeployState? state, CustomResourceOptions? opts = null)
public static ServiceendpointOctopusdeploy get(String name, Output<String> id, ServiceendpointOctopusdeployState 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.
- Api
Key string API key to connect to Octopus Deploy.
- Dictionary<string, string>
- Description string
- Ignore
Ssl boolError Whether to ignore SSL errors when connecting to the Octopus server from the agent. Default to
false
.- Project
Id string The ID of the project.
- Service
Endpoint stringName The Service Endpoint name.
- Url string
Octopus Server url.
- Api
Key string API key to connect to Octopus Deploy.
- map[string]string
- Description string
- Ignore
Ssl boolError Whether to ignore SSL errors when connecting to the Octopus server from the agent. Default to
false
.- Project
Id string The ID of the project.
- Service
Endpoint stringName The Service Endpoint name.
- Url string
Octopus Server url.
- api
Key String API key to connect to Octopus Deploy.
- Map<String,String>
- description String
- ignore
Ssl BooleanError Whether to ignore SSL errors when connecting to the Octopus server from the agent. Default to
false
.- project
Id String The ID of the project.
- service
Endpoint StringName The Service Endpoint name.
- url String
Octopus Server url.
- api
Key string API key to connect to Octopus Deploy.
- {[key: string]: string}
- description string
- ignore
Ssl booleanError Whether to ignore SSL errors when connecting to the Octopus server from the agent. Default to
false
.- project
Id string The ID of the project.
- service
Endpoint stringName The Service Endpoint name.
- url string
Octopus Server url.
- api_
key str API key to connect to Octopus Deploy.
- Mapping[str, str]
- description str
- ignore_
ssl_ boolerror Whether to ignore SSL errors when connecting to the Octopus server from the agent. Default to
false
.- project_
id str The ID of the project.
- service_
endpoint_ strname The Service Endpoint name.
- url str
Octopus Server url.
- api
Key String API key to connect to Octopus Deploy.
- Map<String>
- description String
- ignore
Ssl BooleanError Whether to ignore SSL errors when connecting to the Octopus server from the agent. Default to
false
.- project
Id String The ID of the project.
- service
Endpoint StringName The Service Endpoint name.
- url String
Octopus Server url.
Import
Azure DevOps Service Endpoint Octopus Deploy can be imported using projectID/serviceEndpointID or projectName/serviceEndpointID
$ pulumi import azuredevops:index/serviceendpointOctopusdeploy:ServiceendpointOctopusdeploy 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.