AzureDevOpsDscNative

1.1.0-preview2

en-US/about_AzDoEnvironmentPermission.help.txt

.NAME
    AzDoEnvironmentPermission
 
.SYNOPSIS
    DSC resource for managing deployment environment ACL permissions.
 
.DESCRIPTION
    This resource manages security permissions on Azure DevOps pipeline environments, controlling
    which groups or users can view, use, or administer specific environments.
 
.PARAMETER ProjectName
    Key - System.String
    The name of the Azure DevOps project. This property is mandatory and serves as a key property for the resource.
 
.PARAMETER EnvironmentName
    Required - System.String
    The name of the pipeline environment. This is a key property.
 
.PARAMETER GroupName
    Required - System.String
    The name of the group to grant permissions to. This is a key property. Use the format [ProjectName]\GroupName.
 
.PARAMETER isInherited
    Write - System.Boolean
    Whether permissions are inherited. Defaults to $true.
 
.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'
        }
    }
}