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

octopusdeploy.ProjectGroup

Explore with Pulumi AI

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

    Example Usage

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

const example = new octopusdeploy.ProjectGroup("example", {description: "The development project group."});

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.ProjectGroup("example", description="The development project group.")

    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.NewProjectGroup(ctx, "example", &octopusdeploy.ProjectGroupArgs{
			Description: pulumi.String("The development project group."),
		})
		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.ProjectGroup("example", new()
    {
        Description = "The development project group.",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.ProjectGroup;
import com.pulumi.octopusdeploy.ProjectGroupArgs;
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 ProjectGroup("example", ProjectGroupArgs.builder()
            .description("The development project group.")
            .build());

    }
}

    resources:
  example:
    type: octopusdeploy:ProjectGroup
    properties:
      description: The development project group.

    Create ProjectGroup Resource

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

    Constructor syntax

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

@overload
def ProjectGroup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 description: Optional[str] = None,
                 name: Optional[str] = None,
                 space_id: Optional[str] = None)
    func NewProjectGroup(ctx *Context, name string, args *ProjectGroupArgs, opts ...ResourceOption) (*ProjectGroup, error)
    public ProjectGroup(string name, ProjectGroupArgs? args = null, CustomResourceOptions? opts = null)
    public ProjectGroup(String name, ProjectGroupArgs args)
public ProjectGroup(String name, ProjectGroupArgs args, CustomResourceOptions options)

    type: octopusdeploy:ProjectGroup
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 ProjectGroupArgs
    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 ProjectGroupArgs
    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 ProjectGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectGroupArgs
    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 projectGroupResource = new Octopusdeploy.ProjectGroup("projectGroupResource", new()
{
    Description = "string",
    Name = "string",
    SpaceId = "string",
});

    example, err := octopusdeploy.NewProjectGroup(ctx, "projectGroupResource", &octopusdeploy.ProjectGroupArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	SpaceId:     pulumi.String("string"),
})

    var projectGroupResource = new ProjectGroup("projectGroupResource", ProjectGroupArgs.builder()
    .description("string")
    .name("string")
    .spaceId("string")
    .build());

    project_group_resource = octopusdeploy.ProjectGroup("projectGroupResource",
    description="string",
    name="string",
    space_id="string")

    const projectGroupResource = new octopusdeploy.ProjectGroup("projectGroupResource", {
    description: "string",
    name: "string",
    spaceId: "string",
});

    type: octopusdeploy:ProjectGroup
properties:
    description: string
    name: string
    spaceId: string

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

    Description string
    The description of this project group.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this project group.
    Description string
    The description of this project group.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this project group.
    description String
    The description of this project group.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this project group.
    description string
    The description of this project group.
    name string
    The name of this resource.
    spaceId string
    The space ID associated with this project group.
    description str
    The description of this project group.
    name str
    The name of this resource.
    space_id str
    The space ID associated with this project group.
    description String
    The description of this project group.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this project group.

    Outputs

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

    Get an existing ProjectGroup 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?: ProjectGroupState, opts?: CustomResourceOptions): ProjectGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        space_id: Optional[str] = None) -> ProjectGroup
    func GetProjectGroup(ctx *Context, name string, id IDInput, state *ProjectGroupState, opts ...ResourceOption) (*ProjectGroup, error)
    public static ProjectGroup Get(string name, Input<string> id, ProjectGroupState? state, CustomResourceOptions? opts = null)
    public static ProjectGroup get(String name, Output<String> id, ProjectGroupState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:ProjectGroup    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:
    Description string
    The description of this project group.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this project group.
    Description string
    The description of this project group.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this project group.
    description String
    The description of this project group.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this project group.
    description string
    The description of this project group.
    name string
    The name of this resource.
    spaceId string
    The space ID associated with this project group.
    description str
    The description of this project group.
    name str
    The name of this resource.
    space_id str
    The space ID associated with this project group.
    description String
    The description of this project group.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this project group.

    Import

    $ pulumi import octopusdeploy:index/projectGroup:ProjectGroup [options] octopusdeploy_project_group.<name> <project_group-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