AzureDevOpsDscNative.AzDoVariableGroup.dsc.adaptedResource.json
|
{
"$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json", "type": "AzureDevOpsDscNative/AzDoVariableGroup", "kind": "resource", "version": "1.3.0", "capabilities": [ "set", "test", "get" ], "description": "DSC resource for managing Azure DevOps pipeline variable groups.", "author": "ZanattaMichael", "requireAdapter": "Microsoft.Adapter/PowerShell", "path": "AzureDevOpsDscNative.psd1", "schema": { "embedded": { "required": [ "ProjectName", "VariableGroupName" ], "title": "AzureDevOpsDscNative/AzDoVariableGroup", "description": "DSC resource for managing Azure DevOps pipeline variable groups.", "additionalProperties": false, "properties": { "Ensure": { "type": "string", "enum": [ "Present", "Absent" ], "title": "Ensure", "description": "The Ensure property." }, "LookupResult": { "type": "object", "title": "LookupResult", "readOnly": true, "description": "The LookupResult property." }, "ProjectName": { "type": "string", "title": "ProjectName", "description": "The name of the Azure DevOps project. This property is mandatory and serves as a key property for the resource." }, "VariableGroupName": { "type": "string", "title": "VariableGroupName", "description": "The name of the variable group. This is a key property." }, "Description": { "type": "string", "title": "Description", "description": "An optional description for the variable group." }, "VariableGroupType": { "type": "string", "enum": [ "Vsts", "AzureKeyVault" ], "title": "VariableGroupType", "description": "The type of variable group. Valid values are Vsts (standard) and AzureKeyVault. Defaults to Vsts." }, "Variables": { "type": "object", "title": "Variables", "description": "The variables of the group, keyed by variable name. Each entry is either a plain string value (a non-secret variable) or a hashtable with 'value' and 'isSecret' (key names are not case sensitive): Variables = @{ APP_ENV = 'production' APP_API_KEY = @{ value = 'p@ssw0rd'; isSecret = $true } } A secret variable is stored encrypted by Azure DevOps and can never be read back, so Test only checks that it exists and is secret - a changed secret value is not detected as drift. Its value is written when the configuration supplies one; '@{ isSecret = $true }' with no value keeps the value already stored. When Variables is specified it is the complete set: a variable that is not listed is removed on Set. When it is not specified the live variables are left alone." }, "AllowAccess": { "type": "boolean", "title": "AllowAccess", "description": "Whether all pipelines can access this variable group. Defaults to $false." } }, "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object" } } } |