en-US/about_AzDoSecurityNamespacePermission.help.txt

.NAME
    AzDoSecurityNamespacePermission
 
.SYNOPSIS
    DSC resource for managing generic Azure DevOps security namespace permissions.
 
.DESCRIPTION
 
 
.PARAMETER SecurityNamespace
    Key - System.String
 
.PARAMETER Token
    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 within a security namespace in Azure DevOps.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoSecurityNamespacePermission 'AddAzDoSecurityNamespacePermission'
        {
            Ensure = 'Present'
            SecurityNamespace = 'Build'
            Token = 'repoV2/00000000-0000-0000-0000-000000000001'
            GroupName = '[MyProject]\Contributors'
            isInherited = $true
            Permissions = @(
                @{ Permission = 'ViewBuilds'; Access = 'Allow' }
                @{ Permission = 'QueueBuilds'; Access = 'Allow' }
            )
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update permissions within a security namespace in Azure DevOps.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoSecurityNamespacePermission 'UpdateAzDoSecurityNamespacePermission'
        {
            Ensure = 'Present'
            SecurityNamespace = 'Build'
            Token = 'repoV2/00000000-0000-0000-0000-000000000001'
            GroupName = '[MyProject]\Contributors'
            isInherited = $false
            Permissions = @(
                @{ Permission = 'ViewBuilds'; Access = 'Allow' }
                @{ Permission = 'QueueBuilds'; Access = 'Allow' }
                @{ Permission = 'DeleteBuilds'; Access = 'Deny' }
            )
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove permissions within a security namespace in Azure DevOps.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoSecurityNamespacePermission 'RemoveAzDoSecurityNamespacePermission'
        {
            Ensure = 'Absent'
            SecurityNamespace = 'Build'
            Token = 'repoV2/00000000-0000-0000-0000-000000000001'
            GroupName = '[MyProject]\Contributors'
        }
    }
}