1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. getVariables
octopusdeploy 0.43.2 published on Friday, May 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.getVariables

Get Started
octopusdeploy logo
octopusdeploy 0.43.2 published on Friday, May 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    Provides information about existing variables.

    Example Usage

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

const example = octopusdeploy.getVariables({});

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.get_variables()

    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.GetVariables(ctx, &octopusdeploy.GetVariablesArgs{}, nil)
		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 = Octopusdeploy.GetVariables.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.OctopusdeployFunctions;
import com.pulumi.octopusdeploy.inputs.GetVariablesArgs;
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) {
        final var example = OctopusdeployFunctions.getVariables();

    }
}

    variables:
  example:
    fn::invoke:
      function: octopusdeploy:getVariables
      arguments: {}

    Using getVariables

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVariables(args: GetVariablesArgs, opts?: InvokeOptions): Promise<GetVariablesResult>
function getVariablesOutput(args: GetVariablesOutputArgs, opts?: InvokeOptions): Output<GetVariablesResult>
    def get_variables(name: Optional[str] = None,
                  owner_id: Optional[str] = None,
                  scopes: Optional[Sequence[GetVariablesScope]] = None,
                  space_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetVariablesResult
def get_variables_output(name: Optional[pulumi.Input[str]] = None,
                  owner_id: Optional[pulumi.Input[str]] = None,
                  scopes: Optional[pulumi.Input[Sequence[pulumi.Input[GetVariablesScopeArgs]]]] = None,
                  space_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetVariablesResult]
    func GetVariables(ctx *Context, args *GetVariablesArgs, opts ...InvokeOption) (*GetVariablesResult, error)
func GetVariablesOutput(ctx *Context, args *GetVariablesOutputArgs, opts ...InvokeOption) GetVariablesResultOutput

    > Note: This function is named GetVariables in the Go SDK.

    public static class GetVariables 
{
    public static Task<GetVariablesResult> InvokeAsync(GetVariablesArgs args, InvokeOptions? opts = null)
    public static Output<GetVariablesResult> Invoke(GetVariablesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVariablesResult> getVariables(GetVariablesArgs args, InvokeOptions options)
public static Output<GetVariablesResult> getVariables(GetVariablesArgs args, InvokeOptions options)

    fn::invoke:
  function: octopusdeploy:index/getVariables:getVariables
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of variable to find.
    OwnerId string
    Owner ID for the variable to find.
    Scopes List<GetVariablesScope>
    As variable names can appear more than once under different scopes, a VariableScope must also be provided
    SpaceId string
    The space ID associated with this variable.
    Name string
    The name of variable to find.
    OwnerId string
    Owner ID for the variable to find.
    Scopes []GetVariablesScope
    As variable names can appear more than once under different scopes, a VariableScope must also be provided
    SpaceId string
    The space ID associated with this variable.
    name String
    The name of variable to find.
    ownerId String
    Owner ID for the variable to find.
    scopes List<GetVariablesScope>
    As variable names can appear more than once under different scopes, a VariableScope must also be provided
    spaceId String
    The space ID associated with this variable.
    name string
    The name of variable to find.
    ownerId string
    Owner ID for the variable to find.
    scopes GetVariablesScope[]
    As variable names can appear more than once under different scopes, a VariableScope must also be provided
    spaceId string
    The space ID associated with this variable.
    name str
    The name of variable to find.
    owner_id str
    Owner ID for the variable to find.
    scopes Sequence[GetVariablesScope]
    As variable names can appear more than once under different scopes, a VariableScope must also be provided
    space_id str
    The space ID associated with this variable.
    name String
    The name of variable to find.
    ownerId String
    Owner ID for the variable to find.
    scopes List<Property Map>
    As variable names can appear more than once under different scopes, a VariableScope must also be provided
    spaceId String
    The space ID associated with this variable.

    getVariables Result

    The following output properties are available:

    Description string
    The description of this variable.
    Id string
    The identifier of the variable to find.
    IsEditable bool
    Indicates whether or not this variable is considered editable.
    IsSensitive bool
    Indicates whether or not this resource is considered sensitive and should be kept secret.
    Name string
    The name of variable to find.
    OwnerId string
    Owner ID for the variable to find.
    Prompts List<GetVariablesPrompt>
    Scopes List<GetVariablesScope>
    As variable names can appear more than once under different scopes, a VariableScope must also be provided
    SensitiveValue string
    SpaceId string
    The space ID associated with this variable.
    Type string
    The type of variable represented by this resource. Valid types are AmazonWebServicesAccount, AzureAccount, GoogleCloudAccount, UsernamePasswordAccount, Certificate, Sensitive, String, WorkerPool.
    Value string
    Description string
    The description of this variable.
    Id string
    The identifier of the variable to find.
    IsEditable bool
    Indicates whether or not this variable is considered editable.
    IsSensitive bool
    Indicates whether or not this resource is considered sensitive and should be kept secret.
    Name string
    The name of variable to find.
    OwnerId string
    Owner ID for the variable to find.
    Prompts []GetVariablesPrompt
    Scopes []GetVariablesScope
    As variable names can appear more than once under different scopes, a VariableScope must also be provided
    SensitiveValue string
    SpaceId string
    The space ID associated with this variable.
    Type string
    The type of variable represented by this resource. Valid types are AmazonWebServicesAccount, AzureAccount, GoogleCloudAccount, UsernamePasswordAccount, Certificate, Sensitive, String, WorkerPool.
    Value string
    description String
    The description of this variable.
    id String
    The identifier of the variable to find.
    isEditable Boolean
    Indicates whether or not this variable is considered editable.
    isSensitive Boolean
    Indicates whether or not this resource is considered sensitive and should be kept secret.
    name String
    The name of variable to find.
    ownerId String
    Owner ID for the variable to find.
    prompts List<GetVariablesPrompt>
    scopes List<GetVariablesScope>
    As variable names can appear more than once under different scopes, a VariableScope must also be provided
    sensitiveValue String
    spaceId String
    The space ID associated with this variable.
    type String
    The type of variable represented by this resource. Valid types are AmazonWebServicesAccount, AzureAccount, GoogleCloudAccount, UsernamePasswordAccount, Certificate, Sensitive, String, WorkerPool.
    value String
    description string
    The description of this variable.
    id string
    The identifier of the variable to find.
    isEditable boolean
    Indicates whether or not this variable is considered editable.
    isSensitive boolean
    Indicates whether or not this resource is considered sensitive and should be kept secret.
    name string
    The name of variable to find.
    ownerId string
    Owner ID for the variable to find.
    prompts GetVariablesPrompt[]
    scopes GetVariablesScope[]
    As variable names can appear more than once under different scopes, a VariableScope must also be provided
    sensitiveValue string
    spaceId string
    The space ID associated with this variable.
    type string
    The type of variable represented by this resource. Valid types are AmazonWebServicesAccount, AzureAccount, GoogleCloudAccount, UsernamePasswordAccount, Certificate, Sensitive, String, WorkerPool.
    value string
    description str
    The description of this variable.
    id str
    The identifier of the variable to find.
    is_editable bool
    Indicates whether or not this variable is considered editable.
    is_sensitive bool
    Indicates whether or not this resource is considered sensitive and should be kept secret.
    name str
    The name of variable to find.
    owner_id str
    Owner ID for the variable to find.
    prompts Sequence[GetVariablesPrompt]
    scopes Sequence[GetVariablesScope]
    As variable names can appear more than once under different scopes, a VariableScope must also be provided
    sensitive_value str
    space_id str
    The space ID associated with this variable.
    type str
    The type of variable represented by this resource. Valid types are AmazonWebServicesAccount, AzureAccount, GoogleCloudAccount, UsernamePasswordAccount, Certificate, Sensitive, String, WorkerPool.
    value str
    description String
    The description of this variable.
    id String
    The identifier of the variable to find.
    isEditable Boolean
    Indicates whether or not this variable is considered editable.
    isSensitive Boolean
    Indicates whether or not this resource is considered sensitive and should be kept secret.
    name String
    The name of variable to find.
    ownerId String
    Owner ID for the variable to find.
    prompts List<Property Map>
    scopes List<Property Map>
    As variable names can appear more than once under different scopes, a VariableScope must also be provided
    sensitiveValue String
    spaceId String
    The space ID associated with this variable.
    type String
    The type of variable represented by this resource. Valid types are AmazonWebServicesAccount, AzureAccount, GoogleCloudAccount, UsernamePasswordAccount, Certificate, Sensitive, String, WorkerPool.
    value String

    Supporting Types

    GetVariablesPrompt

    Description string
    The description of this variable prompt option.
    DisplaySettings List<GetVariablesPromptDisplaySetting>
    IsRequired bool
    Label string
    Description string
    The description of this variable prompt option.
    DisplaySettings []GetVariablesPromptDisplaySetting
    IsRequired bool
    Label string
    description String
    The description of this variable prompt option.
    displaySettings List<GetVariablesPromptDisplaySetting>
    isRequired Boolean
    label String
    description string
    The description of this variable prompt option.
    displaySettings GetVariablesPromptDisplaySetting[]
    isRequired boolean
    label string
    description str
    The description of this variable prompt option.
    display_settings Sequence[GetVariablesPromptDisplaySetting]
    is_required bool
    label str
    description String
    The description of this variable prompt option.
    displaySettings List<Property Map>
    isRequired Boolean
    label String

    GetVariablesPromptDisplaySetting

    ControlType string
    The type of control for rendering this prompted variable. Valid types are SingleLineText, MultiLineText, Checkbox, Select.
    SelectOptions List<GetVariablesPromptDisplaySettingSelectOption>
    If the control_type is Select, then this value defines an option.
    ControlType string
    The type of control for rendering this prompted variable. Valid types are SingleLineText, MultiLineText, Checkbox, Select.
    SelectOptions []GetVariablesPromptDisplaySettingSelectOption
    If the control_type is Select, then this value defines an option.
    controlType String
    The type of control for rendering this prompted variable. Valid types are SingleLineText, MultiLineText, Checkbox, Select.
    selectOptions List<GetVariablesPromptDisplaySettingSelectOption>
    If the control_type is Select, then this value defines an option.
    controlType string
    The type of control for rendering this prompted variable. Valid types are SingleLineText, MultiLineText, Checkbox, Select.
    selectOptions GetVariablesPromptDisplaySettingSelectOption[]
    If the control_type is Select, then this value defines an option.
    control_type str
    The type of control for rendering this prompted variable. Valid types are SingleLineText, MultiLineText, Checkbox, Select.
    select_options Sequence[GetVariablesPromptDisplaySettingSelectOption]
    If the control_type is Select, then this value defines an option.
    controlType String
    The type of control for rendering this prompted variable. Valid types are SingleLineText, MultiLineText, Checkbox, Select.
    selectOptions List<Property Map>
    If the control_type is Select, then this value defines an option.

    GetVariablesPromptDisplaySettingSelectOption

    DisplayName string
    The display name for the select value
    Value string
    The select value
    DisplayName string
    The display name for the select value
    Value string
    The select value
    displayName String
    The display name for the select value
    value String
    The select value
    displayName string
    The display name for the select value
    value string
    The select value
    display_name str
    The display name for the select value
    value str
    The select value
    displayName String
    The display name for the select value
    value String
    The select value

    GetVariablesScope

    Actions List<string>
    A list of actions that are scoped to this variable value.
    Channels List<string>
    A list of channels that are scoped to this variable value.
    Environments List<string>
    A list of environments that are scoped to this variable value.
    Machines List<string>
    A list of machines that are scoped to this variable value.
    Processes List<string>
    A list of processes that are scoped to this variable value.
    Roles List<string>
    A list of roles that are scoped to this variable value.
    TenantTags List<string>
    A list of tenant tags that are scoped to this variable value.
    Actions []string
    A list of actions that are scoped to this variable value.
    Channels []string
    A list of channels that are scoped to this variable value.
    Environments []string
    A list of environments that are scoped to this variable value.
    Machines []string
    A list of machines that are scoped to this variable value.
    Processes []string
    A list of processes that are scoped to this variable value.
    Roles []string
    A list of roles that are scoped to this variable value.
    TenantTags []string
    A list of tenant tags that are scoped to this variable value.
    actions List<String>
    A list of actions that are scoped to this variable value.
    channels List<String>
    A list of channels that are scoped to this variable value.
    environments List<String>
    A list of environments that are scoped to this variable value.
    machines List<String>
    A list of machines that are scoped to this variable value.
    processes List<String>
    A list of processes that are scoped to this variable value.
    roles List<String>
    A list of roles that are scoped to this variable value.
    tenantTags List<String>
    A list of tenant tags that are scoped to this variable value.
    actions string[]
    A list of actions that are scoped to this variable value.
    channels string[]
    A list of channels that are scoped to this variable value.
    environments string[]
    A list of environments that are scoped to this variable value.
    machines string[]
    A list of machines that are scoped to this variable value.
    processes string[]
    A list of processes that are scoped to this variable value.
    roles string[]
    A list of roles that are scoped to this variable value.
    tenantTags string[]
    A list of tenant tags that are scoped to this variable value.
    actions Sequence[str]
    A list of actions that are scoped to this variable value.
    channels Sequence[str]
    A list of channels that are scoped to this variable value.
    environments Sequence[str]
    A list of environments that are scoped to this variable value.
    machines Sequence[str]
    A list of machines that are scoped to this variable value.
    processes Sequence[str]
    A list of processes that are scoped to this variable value.
    roles Sequence[str]
    A list of roles that are scoped to this variable value.
    tenant_tags Sequence[str]
    A list of tenant tags that are scoped to this variable value.
    actions List<String>
    A list of actions that are scoped to this variable value.
    channels List<String>
    A list of channels that are scoped to this variable value.
    environments List<String>
    A list of environments that are scoped to this variable value.
    machines List<String>
    A list of machines that are scoped to this variable value.
    processes List<String>
    A list of processes that are scoped to this variable value.
    roles List<String>
    A list of roles that are scoped to this variable value.
    tenantTags List<String>
    A list of tenant tags that are scoped to this variable value.

    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.2 published on Friday, May 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy
      Meet Neo: Your AI Platform Teammate