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

octopusdeploy.LibraryVariableSet

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 library variable sets in Octopus Deploy.

    Create LibraryVariableSet Resource

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

    Constructor syntax

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

@overload
def LibraryVariableSet(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       description: Optional[str] = None,
                       name: Optional[str] = None,
                       space_id: Optional[str] = None,
                       templates: Optional[Sequence[LibraryVariableSetTemplateArgs]] = None)
    func NewLibraryVariableSet(ctx *Context, name string, args *LibraryVariableSetArgs, opts ...ResourceOption) (*LibraryVariableSet, error)
    public LibraryVariableSet(string name, LibraryVariableSetArgs? args = null, CustomResourceOptions? opts = null)
    public LibraryVariableSet(String name, LibraryVariableSetArgs args)
public LibraryVariableSet(String name, LibraryVariableSetArgs args, CustomResourceOptions options)

    type: octopusdeploy:LibraryVariableSet
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 LibraryVariableSetArgs
    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 LibraryVariableSetArgs
    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 LibraryVariableSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LibraryVariableSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LibraryVariableSetArgs
    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 libraryVariableSetResource = new Octopusdeploy.LibraryVariableSet("libraryVariableSetResource", new()
{
    Description = "string",
    Name = "string",
    SpaceId = "string",
    Templates = new[]
    {
        new Octopusdeploy.Inputs.LibraryVariableSetTemplateArgs
        {
            Name = "string",
            DefaultValue = "string",
            DisplaySettings = 
            {
                { "string", "string" },
            },
            HelpText = "string",
            Id = "string",
            Label = "string",
        },
    },
});

    example, err := octopusdeploy.NewLibraryVariableSet(ctx, "libraryVariableSetResource", &octopusdeploy.LibraryVariableSetArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	SpaceId:     pulumi.String("string"),
	Templates: octopusdeploy.LibraryVariableSetTemplateArray{
		&octopusdeploy.LibraryVariableSetTemplateArgs{
			Name:         pulumi.String("string"),
			DefaultValue: pulumi.String("string"),
			DisplaySettings: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			HelpText: pulumi.String("string"),
			Id:       pulumi.String("string"),
			Label:    pulumi.String("string"),
		},
	},
})

    var libraryVariableSetResource = new LibraryVariableSet("libraryVariableSetResource", LibraryVariableSetArgs.builder()
    .description("string")
    .name("string")
    .spaceId("string")
    .templates(LibraryVariableSetTemplateArgs.builder()
        .name("string")
        .defaultValue("string")
        .displaySettings(Map.of("string", "string"))
        .helpText("string")
        .id("string")
        .label("string")
        .build())
    .build());

    library_variable_set_resource = octopusdeploy.LibraryVariableSet("libraryVariableSetResource",
    description="string",
    name="string",
    space_id="string",
    templates=[{
        "name": "string",
        "default_value": "string",
        "display_settings": {
            "string": "string",
        },
        "help_text": "string",
        "id": "string",
        "label": "string",
    }])

    const libraryVariableSetResource = new octopusdeploy.LibraryVariableSet("libraryVariableSetResource", {
    description: "string",
    name: "string",
    spaceId: "string",
    templates: [{
        name: "string",
        defaultValue: "string",
        displaySettings: {
            string: "string",
        },
        helpText: "string",
        id: "string",
        label: "string",
    }],
});

    type: octopusdeploy:LibraryVariableSet
properties:
    description: string
    name: string
    spaceId: string
    templates:
        - defaultValue: string
          displaySettings:
            string: string
          helpText: string
          id: string
          label: string
          name: string

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

    Description string
    The description of this library variable set.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this library variable set.
    Templates List<LibraryVariableSetTemplate>
    Description string
    The description of this library variable set.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this library variable set.
    Templates []LibraryVariableSetTemplateArgs
    description String
    The description of this library variable set.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this library variable set.
    templates List<LibraryVariableSetTemplate>
    description string
    The description of this library variable set.
    name string
    The name of this resource.
    spaceId string
    The space ID associated with this library variable set.
    templates LibraryVariableSetTemplate[]
    description str
    The description of this library variable set.
    name str
    The name of this resource.
    space_id str
    The space ID associated with this library variable set.
    templates Sequence[LibraryVariableSetTemplateArgs]
    description String
    The description of this library variable set.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this library variable set.
    templates List<Property Map>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LibraryVariableSet resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    TemplateIds Dictionary<string, string>
    VariableSetId string
    Id string
    The provider-assigned unique ID for this managed resource.
    TemplateIds map[string]string
    VariableSetId string
    id String
    The provider-assigned unique ID for this managed resource.
    templateIds Map<String,String>
    variableSetId String
    id string
    The provider-assigned unique ID for this managed resource.
    templateIds {[key: string]: string}
    variableSetId string
    id str
    The provider-assigned unique ID for this managed resource.
    template_ids Mapping[str, str]
    variable_set_id str
    id String
    The provider-assigned unique ID for this managed resource.
    templateIds Map<String>
    variableSetId String

    Look up Existing LibraryVariableSet Resource

    Get an existing LibraryVariableSet 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?: LibraryVariableSetState, opts?: CustomResourceOptions): LibraryVariableSet
    @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,
        template_ids: Optional[Mapping[str, str]] = None,
        templates: Optional[Sequence[LibraryVariableSetTemplateArgs]] = None,
        variable_set_id: Optional[str] = None) -> LibraryVariableSet
    func GetLibraryVariableSet(ctx *Context, name string, id IDInput, state *LibraryVariableSetState, opts ...ResourceOption) (*LibraryVariableSet, error)
    public static LibraryVariableSet Get(string name, Input<string> id, LibraryVariableSetState? state, CustomResourceOptions? opts = null)
    public static LibraryVariableSet get(String name, Output<String> id, LibraryVariableSetState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:LibraryVariableSet    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 library variable set.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this library variable set.
    TemplateIds Dictionary<string, string>
    Templates List<LibraryVariableSetTemplate>
    VariableSetId string
    Description string
    The description of this library variable set.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this library variable set.
    TemplateIds map[string]string
    Templates []LibraryVariableSetTemplateArgs
    VariableSetId string
    description String
    The description of this library variable set.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this library variable set.
    templateIds Map<String,String>
    templates List<LibraryVariableSetTemplate>
    variableSetId String
    description string
    The description of this library variable set.
    name string
    The name of this resource.
    spaceId string
    The space ID associated with this library variable set.
    templateIds {[key: string]: string}
    templates LibraryVariableSetTemplate[]
    variableSetId string
    description str
    The description of this library variable set.
    name str
    The name of this resource.
    space_id str
    The space ID associated with this library variable set.
    template_ids Mapping[str, str]
    templates Sequence[LibraryVariableSetTemplateArgs]
    variable_set_id str
    description String
    The description of this library variable set.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this library variable set.
    templateIds Map<String>
    templates List<Property Map>
    variableSetId String

    Supporting Types

    LibraryVariableSetTemplate, LibraryVariableSetTemplateArgs

    Name string
    The name of the variable set by the parameter. The name can contain letters, digits, dashes and periods. Example: ServerName
    DefaultValue string
    A default value for the parameter, if applicable. This can be a hard-coded value or a variable reference.
    DisplaySettings Dictionary<string, string>
    The display settings for the parameter.
    HelpText string
    The help presented alongside the parameter input.
    Id string
    The unique ID for this resource.
    Label string
    The label shown beside the parameter when presented in the deployment process. Example: Server name.
    Name string
    The name of the variable set by the parameter. The name can contain letters, digits, dashes and periods. Example: ServerName
    DefaultValue string
    A default value for the parameter, if applicable. This can be a hard-coded value or a variable reference.
    DisplaySettings map[string]string
    The display settings for the parameter.
    HelpText string
    The help presented alongside the parameter input.
    Id string
    The unique ID for this resource.
    Label string
    The label shown beside the parameter when presented in the deployment process. Example: Server name.
    name String
    The name of the variable set by the parameter. The name can contain letters, digits, dashes and periods. Example: ServerName
    defaultValue String
    A default value for the parameter, if applicable. This can be a hard-coded value or a variable reference.
    displaySettings Map<String,String>
    The display settings for the parameter.
    helpText String
    The help presented alongside the parameter input.
    id String
    The unique ID for this resource.
    label String
    The label shown beside the parameter when presented in the deployment process. Example: Server name.
    name string
    The name of the variable set by the parameter. The name can contain letters, digits, dashes and periods. Example: ServerName
    defaultValue string
    A default value for the parameter, if applicable. This can be a hard-coded value or a variable reference.
    displaySettings {[key: string]: string}
    The display settings for the parameter.
    helpText string
    The help presented alongside the parameter input.
    id string
    The unique ID for this resource.
    label string
    The label shown beside the parameter when presented in the deployment process. Example: Server name.
    name str
    The name of the variable set by the parameter. The name can contain letters, digits, dashes and periods. Example: ServerName
    default_value str
    A default value for the parameter, if applicable. This can be a hard-coded value or a variable reference.
    display_settings Mapping[str, str]
    The display settings for the parameter.
    help_text str
    The help presented alongside the parameter input.
    id str
    The unique ID for this resource.
    label str
    The label shown beside the parameter when presented in the deployment process. Example: Server name.
    name String
    The name of the variable set by the parameter. The name can contain letters, digits, dashes and periods. Example: ServerName
    defaultValue String
    A default value for the parameter, if applicable. This can be a hard-coded value or a variable reference.
    displaySettings Map<String>
    The display settings for the parameter.
    helpText String
    The help presented alongside the parameter input.
    id String
    The unique ID for this resource.
    label String
    The label shown beside the parameter when presented in the deployment process. Example: Server name.

    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