Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. DockerContainerRegistry
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.DockerContainerRegistry

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    This resource manages a Docker Container Registry in Octopus Deploy.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as octopusdeploy from "@pulumi/octopusdeploy";

const example = new octopusdeploy.DockerContainerRegistry("example", {
    feedUri: "https://index.docker.io",
    password: "test-password",
    registryPath: "testing/test-image",
    username: "test-username",
});

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.DockerContainerRegistry("example",
    feed_uri="https://index.docker.io",
    password="test-password",
    registry_path="testing/test-image",
    username="test-username")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/octopusdeploy/octopusdeploy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := octopusdeploy.NewDockerContainerRegistry(ctx, "example", &octopusdeploy.DockerContainerRegistryArgs{
			FeedUri:      pulumi.String("https://index.docker.io"),
			Password:     pulumi.String("test-password"),
			RegistryPath: pulumi.String("testing/test-image"),
			Username:     pulumi.String("test-username"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Octopusdeploy = Pulumi.Octopusdeploy;

return await Deployment.RunAsync(() => 
{
    var example = new Octopusdeploy.DockerContainerRegistry("example", new()
    {
        FeedUri = "https://index.docker.io",
        Password = "test-password",
        RegistryPath = "testing/test-image",
        Username = "test-username",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.DockerContainerRegistry;
import com.pulumi.octopusdeploy.DockerContainerRegistryArgs;
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 DockerContainerRegistry("example", DockerContainerRegistryArgs.builder()
            .feedUri("https://index.docker.io")
            .password("test-password")
            .registryPath("testing/test-image")
            .username("test-username")
            .build());

    }
}

    resources:
  example:
    type: octopusdeploy:DockerContainerRegistry
    properties:
      feedUri: https://index.docker.io
      password: test-password
      registryPath: testing/test-image
      username: test-username

    Create DockerContainerRegistry Resource

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

    Constructor syntax

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

@overload
def DockerContainerRegistry(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            feed_uri: Optional[str] = None,
                            api_version: Optional[str] = None,
                            name: Optional[str] = None,
                            package_acquisition_location_options: Optional[Sequence[str]] = None,
                            password: Optional[str] = None,
                            registry_path: Optional[str] = None,
                            space_id: Optional[str] = None,
                            username: Optional[str] = None)
    func NewDockerContainerRegistry(ctx *Context, name string, args DockerContainerRegistryArgs, opts ...ResourceOption) (*DockerContainerRegistry, error)
    public DockerContainerRegistry(string name, DockerContainerRegistryArgs args, CustomResourceOptions? opts = null)
    public DockerContainerRegistry(String name, DockerContainerRegistryArgs args)
public DockerContainerRegistry(String name, DockerContainerRegistryArgs args, CustomResourceOptions options)

    type: octopusdeploy:DockerContainerRegistry
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 DockerContainerRegistryArgs
    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 DockerContainerRegistryArgs
    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 DockerContainerRegistryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DockerContainerRegistryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DockerContainerRegistryArgs
    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 dockerContainerRegistryResource = new Octopusdeploy.DockerContainerRegistry("dockerContainerRegistryResource", new()
{
    FeedUri = "string",
    ApiVersion = "string",
    Name = "string",
    PackageAcquisitionLocationOptions = new[]
    {
        "string",
    },
    Password = "string",
    RegistryPath = "string",
    SpaceId = "string",
    Username = "string",
});

    example, err := octopusdeploy.NewDockerContainerRegistry(ctx, "dockerContainerRegistryResource", &octopusdeploy.DockerContainerRegistryArgs{
	FeedUri:    pulumi.String("string"),
	ApiVersion: pulumi.String("string"),
	Name:       pulumi.String("string"),
	PackageAcquisitionLocationOptions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Password:     pulumi.String("string"),
	RegistryPath: pulumi.String("string"),
	SpaceId:      pulumi.String("string"),
	Username:     pulumi.String("string"),
})

    var dockerContainerRegistryResource = new DockerContainerRegistry("dockerContainerRegistryResource", DockerContainerRegistryArgs.builder()
    .feedUri("string")
    .apiVersion("string")
    .name("string")
    .packageAcquisitionLocationOptions("string")
    .password("string")
    .registryPath("string")
    .spaceId("string")
    .username("string")
    .build());

    docker_container_registry_resource = octopusdeploy.DockerContainerRegistry("dockerContainerRegistryResource",
    feed_uri="string",
    api_version="string",
    name="string",
    package_acquisition_location_options=["string"],
    password="string",
    registry_path="string",
    space_id="string",
    username="string")

    const dockerContainerRegistryResource = new octopusdeploy.DockerContainerRegistry("dockerContainerRegistryResource", {
    feedUri: "string",
    apiVersion: "string",
    name: "string",
    packageAcquisitionLocationOptions: ["string"],
    password: "string",
    registryPath: "string",
    spaceId: "string",
    username: "string",
});

    type: octopusdeploy:DockerContainerRegistry
properties:
    apiVersion: string
    feedUri: string
    name: string
    packageAcquisitionLocationOptions:
        - string
    password: string
    registryPath: string
    spaceId: string
    username: string

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

    FeedUri string
    ApiVersion string
    Name string
    The name of this resource.
    PackageAcquisitionLocationOptions List<string>
    Password string
    The password associated with this resource.
    RegistryPath string
    SpaceId string
    The space ID associated with this docker container registry feed.
    Username string
    The username associated with this resource.
    FeedUri string
    ApiVersion string
    Name string
    The name of this resource.
    PackageAcquisitionLocationOptions []string
    Password string
    The password associated with this resource.
    RegistryPath string
    SpaceId string
    The space ID associated with this docker container registry feed.
    Username string
    The username associated with this resource.
    feedUri String
    apiVersion String
    name String
    The name of this resource.
    packageAcquisitionLocationOptions List<String>
    password String
    The password associated with this resource.
    registryPath String
    spaceId String
    The space ID associated with this docker container registry feed.
    username String
    The username associated with this resource.
    feedUri string
    apiVersion string
    name string
    The name of this resource.
    packageAcquisitionLocationOptions string[]
    password string
    The password associated with this resource.
    registryPath string
    spaceId string
    The space ID associated with this docker container registry feed.
    username string
    The username associated with this resource.
    feed_uri str
    api_version str
    name str
    The name of this resource.
    package_acquisition_location_options Sequence[str]
    password str
    The password associated with this resource.
    registry_path str
    space_id str
    The space ID associated with this docker container registry feed.
    username str
    The username associated with this resource.
    feedUri String
    apiVersion String
    name String
    The name of this resource.
    packageAcquisitionLocationOptions List<String>
    password String
    The password associated with this resource.
    registryPath String
    spaceId String
    The space ID associated with this docker container registry feed.
    username String
    The username associated with this resource.

    Outputs

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

    Get an existing DockerContainerRegistry 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?: DockerContainerRegistryState, opts?: CustomResourceOptions): DockerContainerRegistry
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_version: Optional[str] = None,
        feed_uri: Optional[str] = None,
        name: Optional[str] = None,
        package_acquisition_location_options: Optional[Sequence[str]] = None,
        password: Optional[str] = None,
        registry_path: Optional[str] = None,
        space_id: Optional[str] = None,
        username: Optional[str] = None) -> DockerContainerRegistry
    func GetDockerContainerRegistry(ctx *Context, name string, id IDInput, state *DockerContainerRegistryState, opts ...ResourceOption) (*DockerContainerRegistry, error)
    public static DockerContainerRegistry Get(string name, Input<string> id, DockerContainerRegistryState? state, CustomResourceOptions? opts = null)
    public static DockerContainerRegistry get(String name, Output<String> id, DockerContainerRegistryState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:DockerContainerRegistry    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:
    ApiVersion string
    FeedUri string
    Name string
    The name of this resource.
    PackageAcquisitionLocationOptions List<string>
    Password string
    The password associated with this resource.
    RegistryPath string
    SpaceId string
    The space ID associated with this docker container registry feed.
    Username string
    The username associated with this resource.
    ApiVersion string
    FeedUri string
    Name string
    The name of this resource.
    PackageAcquisitionLocationOptions []string
    Password string
    The password associated with this resource.
    RegistryPath string
    SpaceId string
    The space ID associated with this docker container registry feed.
    Username string
    The username associated with this resource.
    apiVersion String
    feedUri String
    name String
    The name of this resource.
    packageAcquisitionLocationOptions List<String>
    password String
    The password associated with this resource.
    registryPath String
    spaceId String
    The space ID associated with this docker container registry feed.
    username String
    The username associated with this resource.
    apiVersion string
    feedUri string
    name string
    The name of this resource.
    packageAcquisitionLocationOptions string[]
    password string
    The password associated with this resource.
    registryPath string
    spaceId string
    The space ID associated with this docker container registry feed.
    username string
    The username associated with this resource.
    api_version str
    feed_uri str
    name str
    The name of this resource.
    package_acquisition_location_options Sequence[str]
    password str
    The password associated with this resource.
    registry_path str
    space_id str
    The space ID associated with this docker container registry feed.
    username str
    The username associated with this resource.
    apiVersion String
    feedUri String
    name String
    The name of this resource.
    packageAcquisitionLocationOptions List<String>
    password String
    The password associated with this resource.
    registryPath String
    spaceId String
    The space ID associated with this docker container registry feed.
    username String
    The username associated with this resource.

    Import

    $ pulumi import octopusdeploy:index/dockerContainerRegistry:DockerContainerRegistry [options] octopusdeploy_docker_container_registry.<name> <feed-id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy