en-US/about_AzDoSecureFilePermission.help.txt

.NAME
    AzDoSecureFilePermission
 
.SYNOPSIS
    DSC resource for managing permissions on Azure DevOps secure files.
 
.DESCRIPTION
    Manages the ACL on a secure file, using the 'Library' security namespace - the same namespace
    that secures variable groups.
 
    Omitting SecureFileName targets the project's Library root, which sets the baseline for every
    secure file and variable group in the project.
 
.PARAMETER ProjectName
    Key - System.String
    The name of the Azure DevOps project.
 
.PARAMETER SecureFileName
    Write - System.String
    The name of the secure file. Omit to target the project's Library root.
 
.PARAMETER isInherited
    Write - System.Boolean
    Whether the ACL inherits permissions from its parent. Defaults to $true.
 
.PARAMETER Permissions
    Write - HashTable[]
    The access control entries, as an array of hashtables:
    @{ Identity = '[ProjectName]\GroupName'; Permission = @{ View = 'Allow' } }
 
.EXAMPLE 1
 
This example grants a group access to a secure file.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoSecureFile 'AddSigningCertificate'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            SecureFileName = 'signing.pfx'
            FilePath = 'C:\certs\signing.pfx'
        }
 
        AzDoSecureFilePermission 'SigningCertificatePermissions'
        {
            ProjectName = 'MyProject'
            SecureFileName = 'signing.pfx'
            isInherited = $true
            Permissions = @(
                @{
                    Identity = '[MyProject]\Release Managers'
                    Permission = @{
                        View = 'Allow'
                        Use = 'Allow'
                    }
                }
            )
            DependsOn = '[AzDoSecureFile]AddSigningCertificate'
        }
    }
}