VariableGroup

Manages variable groups within Azure DevOps.

Relevant Links

PAT Permissions Required

Variable Groups: Read, Create, & Manage

Create a VariableGroup Resource

new VariableGroup(name: string, args: VariableGroupArgs, opts?: CustomResourceOptions);

def VariableGroup(resource_name, opts=None, allow_access=None, description=None, key_vault=None, name=None, project_id=None, variables=None, __props__=None);

func NewVariableGroup(ctx *Context, name string, args VariableGroupArgs, opts ...ResourceOption) (*VariableGroup, error)

public VariableGroup(string name, VariableGroupArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args VariableGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args VariableGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VariableGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

VariableGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The VariableGroup resource accepts the following input properties:

ProjectId string: The project ID or project name.
Variables List<Pulumi.AzureDevOps.Pipeline.Inputs.VariableGroupVariableArgs>: One or more variable blocks as documented below.
AllowAccess bool: Boolean that indicate if this variable group is shared by all pipelines of this project.
Description string: The description of the Variable Group.
KeyVault Pulumi.AzureDevOps.Pipeline.Inputs.VariableGroupKeyVaultArgs
Name string: The name of the Variable Group.

ProjectId string: The project ID or project name.
Variables []VariableGroupVariable: One or more variable blocks as documented below.
AllowAccess bool: Boolean that indicate if this variable group is shared by all pipelines of this project.
Description string: The description of the Variable Group.
KeyVault VariableGroupKeyVault
Name string: The name of the Variable Group.

projectId string: The project ID or project name.
variables VariableGroupVariable[]: One or more variable blocks as documented below.
allowAccess boolean: Boolean that indicate if this variable group is shared by all pipelines of this project.
description string: The description of the Variable Group.
keyVault VariableGroupKeyVault
name string: The name of the Variable Group.

project_id str: The project ID or project name.
variables List[VariableGroupVariable]: One or more variable blocks as documented below.
allow_access bool: Boolean that indicate if this variable group is shared by all pipelines of this project.
description str: The description of the Variable Group.
key_vault Dict[VariableGroupKeyVault]
name str: The name of the Variable Group.

Outputs

All input properties are implicitly available as output properties. Additionally, the VariableGroup 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing VariableGroup Resource

Get an existing VariableGroup 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?: VariableGroupState, opts?: CustomResourceOptions): VariableGroup

static get(resource_name, id, opts=None, allow_access=None, description=None, key_vault=None, name=None, project_id=None, variables=None, __props__=None);

func GetVariableGroup(ctx *Context, name string, id IDInput, state *VariableGroupState, opts ...ResourceOption) (*VariableGroup, error)

public static VariableGroup Get(string name, Input<string> id, VariableGroupState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

AllowAccess bool: Boolean that indicate if this variable group is shared by all pipelines of this project.
Description string: The description of the Variable Group.
KeyVault Pulumi.AzureDevOps.Pipeline.Inputs.VariableGroupKeyVaultArgs
Name string: The name of the Variable Group.
ProjectId string: The project ID or project name.
Variables List<Pulumi.AzureDevOps.Pipeline.Inputs.VariableGroupVariableArgs>: One or more variable blocks as documented below.

AllowAccess bool: Boolean that indicate if this variable group is shared by all pipelines of this project.
Description string: The description of the Variable Group.
KeyVault VariableGroupKeyVault
Name string: The name of the Variable Group.
ProjectId string: The project ID or project name.
Variables []VariableGroupVariable: One or more variable blocks as documented below.

allowAccess boolean: Boolean that indicate if this variable group is shared by all pipelines of this project.
description string: The description of the Variable Group.
keyVault VariableGroupKeyVault
name string: The name of the Variable Group.
projectId string: The project ID or project name.
variables VariableGroupVariable[]: One or more variable blocks as documented below.

allow_access bool: Boolean that indicate if this variable group is shared by all pipelines of this project.
description str: The description of the Variable Group.
key_vault Dict[VariableGroupKeyVault]
name str: The name of the Variable Group.
project_id str: The project ID or project name.
variables List[VariableGroupVariable]: One or more variable blocks as documented below.

Supporting Types

VariableGroupKeyVault

See the input and output API doc for this type.

Name string: The name of the Variable Group.
ServiceEndpointId string

Name string: The name of the Variable Group.
ServiceEndpointId string

name string: The name of the Variable Group.
serviceEndpointId string

name str: The name of the Variable Group.
serviceEndpointId str

VariableGroupVariable

See the input and output API doc for this type.

Name string: The key value used for the variable. Must be unique within the Variable Group.
ContentType string
Enabled bool
Expires string
IsSecret bool: A boolean flag describing if the variable value is sensitive. Defaults to false.
SecretValue string: The secret value of the variable. If omitted, it will default to empty string. Used when is_secret set to true.
Value string: The value of the variable. If omitted, it will default to empty string.

Name string: The key value used for the variable. Must be unique within the Variable Group.
ContentType string
Enabled bool
Expires string
IsSecret bool: A boolean flag describing if the variable value is sensitive. Defaults to false.
SecretValue string: The secret value of the variable. If omitted, it will default to empty string. Used when is_secret set to true.
Value string: The value of the variable. If omitted, it will default to empty string.

name string: The key value used for the variable. Must be unique within the Variable Group.
contentType string
enabled boolean
expires string
isSecret boolean: A boolean flag describing if the variable value is sensitive. Defaults to false.
secretValue string: The secret value of the variable. If omitted, it will default to empty string. Used when is_secret set to true.
value string: The value of the variable. If omitted, it will default to empty string.

name str: The key value used for the variable. Must be unique within the Variable Group.
contentType str
enabled bool
expires str
isSecret bool: A boolean flag describing if the variable value is sensitive. Defaults to false.
secretValue str: The secret value of the variable. If omitted, it will default to empty string. Used when is_secret set to true.
value str: The value of the variable. If omitted, it will default to empty string.

Package Details

Repository: https://github.com/pulumi/pulumi-azuredevops
License: Apache-2.0
Notes: This Pulumi package is based on the azuredevops Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud