AzureDevOpsDscNative

1.0.0-preview02

en-US/about_AzDoEnvironmentPermission.help.txt

.NAME
    AzDoEnvironmentPermission
 
.SYNOPSIS
    DSC resource for managing deployment environment ACL permissions.
 
.DESCRIPTION
 
 
.PARAMETER ProjectName
    Key - System.String
 
.PARAMETER EnvironmentName
    Required - System.String
 
.PARAMETER GroupName
    Required - System.String
 
.PARAMETER isInherited
    Write - System.Boolean
 
.PARAMETER Permissions
    Write - HashTable[]
 
.EXAMPLE 1
 
This example shows how to grant permissions on a pipeline environment in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoEnvironmentPermission 'AddAzDoEnvironmentPermission'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            EnvironmentName = 'Production'
            GroupName = '[MyProject]\Contributors'
            isInherited = $true
            Permissions = @(
                @{ Permission = 'View'; Access = 'Allow' }
            )
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update permissions on a pipeline environment in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoEnvironmentPermission 'UpdateAzDoEnvironmentPermission'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            EnvironmentName = 'Production'
            GroupName = '[MyProject]\Contributors'
            isInherited = $false
            Permissions = @(
                @{ Permission = 'View'; Access = 'Allow' }
                @{ Permission = 'Manage'; Access = 'Deny' }
            )
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove permissions on a pipeline environment in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoEnvironmentPermission 'RemoveAzDoEnvironmentPermission'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
            EnvironmentName = 'Production'
            GroupName = '[MyProject]\Contributors'
        }
    }
}