Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/add variable groups support #170

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
169 changes: 169 additions & 0 deletions .docs/Add-VSTeamVariableGroup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
<!-- #include "./common/header.md" -->

# Add-VSTeamVariableGroup

## SYNOPSIS

<!-- #include "./synopsis/Add-VSTeamVariableGroup.md" -->

DarqueWarrior marked this conversation as resolved.
Show resolved Hide resolved
## SYNTAX

## DESCRIPTION

<!-- #include "./synopsis/Add-VSTeamVariableGroup.md" -->

## EXAMPLES
DarqueWarrior marked this conversation as resolved.
Show resolved Hide resolved

### -------------------------- EXAMPLE 1 --------------------------

```powershell

$methodParameters = @{
ProjectName = "some_project_name"
Name = "new_variable_group"
Description = "Describe the Variable Group"
Type = "Vsts"
Variables = @{
key1 = @{
value = "value1"
}
key2 = @{
value = "value2"
isSecret = $true
}
}
}

Add-VSTeamVariableGroup @methodParameters
```

### -------------------------- EXAMPLE 2 --------------------------

```powershell

$methodParameters = @{
ProjectName = "some_project_name"
Name = "new_variable_group"
Description = "Describe the Variable Group"
Type = "AzureKeyVault"
Variables = @{
name_of_existing_secret = @{
enabled = $true
contentType = ""
value = ""
isSecret = $true
}
}
ProviderData = @{
serviceEndpointId = "AzureRMServiceEndpointGuid"
vault = "name_of_existing_key_vault"
}
}

Add-VSTeamVariableGroup @methodParameters
```

## PARAMETERS

<!-- #include "./params/projectName.md" -->

### -Description

The variable group description

```yaml
Type: String
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -Name

The variable group name

```yaml
Type: String
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -ProviderData

The variable group ProviderData. This parameter is not available in TFS2017. This should be $null for Vsts types.

```yaml
Type: Hashtable
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -Type

The variable group type. This parameter is not available in TFS2017; all variable groups are type Vsts in this case.

```yaml
Type: String
Aliases:
Accepted values: Vsts, AzureKeyVault

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -Variables

The variable group variables.

```yaml
Type: Hashtable
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### System.String

System.Collections.Hashtable

## OUTPUTS

### System.Object

## NOTES

## RELATED LINKS

[Update-VSTeamVariableGroup](Update-VSTeamVariableGroup.md)

[Get-VSTeamVariableGroup](Get-VSTeamVariableGroup.md)

[Remove-VSTeamVariableGroup](Remove-VSTeamVariableGroup.md)
82 changes: 82 additions & 0 deletions .docs/Get-VSTeamVariableGroup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
<!-- #include "./common/header.md" -->

# Get-VSTeamVariableGroup

## SYNOPSIS

<!-- #include "./synopsis/Get-VSTeamVariableGroup.md" -->

## SYNTAX

## DESCRIPTION

<!-- #include "./synopsis/Get-VSTeamVariableGroup.md" -->

## EXAMPLES

### -------------------------- EXAMPLE 1 --------------------------

```powershell

$methodParameters = @{
ProjectName = "some_project_name"
}

Get-VSTeamVariableGroup @methodParameters
```

### -------------------------- EXAMPLE 2 --------------------------

```powershell

$methodParameters = @{
ProjectName = "some_project_name"
Id = "variable_group_id"
}

Get-VSTeamVariableGroup @methodParameters
```

## PARAMETERS

### -ProjectName

<!-- #include "./params/projectName.md" -->

### -Id

ID of the existing variable group

```yaml
Type: String
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### System.String

## OUTPUTS

### System.Object

## NOTES

## RELATED LINKS

[Add-VSTeamVariableGroup](Add-VSTeamVariableGroup.md)

[Update-VSTeamVariableGroup](Update-VSTeamVariableGroup.md)

[Remove-VSTeamVariableGroup](Remove-VSTeamVariableGroup.md)
135 changes: 135 additions & 0 deletions .docs/Remove-VSTeamVariableGroup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
<!-- #include "./common/header.md" -->

# Remove-VSTeamVariableGroup

## SYNOPSIS

<!-- #include "./synopsis/Remove-VSTeamVariableGroup.md" -->

## SYNTAX

## DESCRIPTION

<!-- #include "./synopsis/Remove-VSTeamVariableGroup.md" -->

## EXAMPLES

### -------------------------- EXAMPLE 1 --------------------------

```powershell

$methodParameters = @{
ProjectName = "some_project_name"
Name = "new_variable_group"
Description = "Describe the Variable Group"
Type = "Vsts"
Variables = @{
key1 = @{
value = "value1"
isSecret = $true
}
}
}

$newVariableGroup = Add-VSTeamVariableGroup @methodParameters

$methodParameters = @{
Id = $newVariableGroup.id
ProjectName = "some_project_name"
Force = $true
}

Remove-VSTeamVariableGroup @methodParameters
```

## PARAMETERS

### -Confirm

Prompts you for confirmation before running the cmdlet.

```yaml
Type: SwitchParameter
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Force

Does not prompt

```yaml
Type: SwitchParameter
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ProjectName

<!-- #include "./params/projectName.md" -->

### -WhatIf

Shows what would happen if the cmdlet runs.
The cmdlet is not run.

```yaml
Type: SwitchParameter
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Id

ID of the existing variable group

```yaml
Type: String
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### System.String[]

System.String

## OUTPUTS

### System.Object

## NOTES

## RELATED LINKS

[Add-VSTeamVariableGroup](Add-VSTeamVariableGroup.md)

[Get-VSTeamVariableGroup](Get-VSTeamVariableGroup.md)

[Update-VSTeamVariableGroup](Update-VSTeamVariableGroup.md)
Loading