AzureDevOpsDscNative

1.1.0-preview2

en-US/about_AzDoServiceConnectionPermission.help.txt

.NAME
    AzDoServiceConnectionPermission
 
.SYNOPSIS
    DSC resource for managing Azure DevOps service connection permissions.
 
.DESCRIPTION
    This resource manages security permissions on Azure DevOps service connections, controlling
    which groups or users can use or manage specific service connections in pipelines.
 
.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 ConnectionName
    Required - System.String
    The name of the service connection. 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 service connection in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoServiceConnectionPermission 'AddAzDoServiceConnectionPermission'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            ConnectionName = 'MyAzureServiceConnection'
            GroupName = '[MyProject]\Contributors'
            isInherited = $true
            Permissions = @(
                @{ Permission = 'Use'; Access = 'Allow' }
            )
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update permissions on a service connection in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoServiceConnectionPermission 'UpdateAzDoServiceConnectionPermission'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            ConnectionName = 'MyAzureServiceConnection'
            GroupName = '[MyProject]\Contributors'
            isInherited = $false
            Permissions = @(
                @{ Permission = 'Use'; Access = 'Allow' }
                @{ Permission = 'Administer'; Access = 'Deny' }
            )
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove permissions on a service connection in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoServiceConnectionPermission 'RemoveAzDoServiceConnectionPermission'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
            ConnectionName = 'MyAzureServiceConnection'
            GroupName = '[MyProject]\Contributors'
        }
    }
}