en-US/about_AzDoOrganizationSettings.help.txt

.NAME
    AzDoOrganizationSettings
 
.SYNOPSIS
    DSC resource for managing Azure DevOps organisation-level settings (singleton).
 
.DESCRIPTION
 
 
.PARAMETER OrganizationName
    Key - System.String
 
.PARAMETER AllowPublicProjects
    Write - System.Boolean
 
.PARAMETER AllowExternalGuestAccess
    Write - System.Boolean
 
.PARAMETER EnableOAuthAuthentication
    Write - System.Boolean
 
.PARAMETER EnableSSHAuthentication
    Write - System.Boolean
 
.PARAMETER DisallowAadGuestUserPolicy
    Write - System.Boolean
 
.EXAMPLE 1
 
This example shows how to configure organization-level settings in Azure DevOps.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoOrganizationSettings 'AddAzDoOrganizationSettings'
        {
            Ensure = 'Present'
            OrganizationName = 'test-organization'
            AllowPublicProjects = $false
            AllowExternalGuestAccess = $false
            EnableOAuthAuthentication = $true
            EnableSSHAuthentication = $true
            DisallowAadGuestUserPolicy = $false
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update organization-level settings in Azure DevOps.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoOrganizationSettings 'UpdateAzDoOrganizationSettings'
        {
            Ensure = 'Present'
            OrganizationName = 'test-organization'
            AllowPublicProjects = $false
            AllowExternalGuestAccess = $true
            EnableOAuthAuthentication = $true
            EnableSSHAuthentication = $false
            DisallowAadGuestUserPolicy = $true
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to reset organization-level settings to their defaults in Azure DevOps.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoOrganizationSettings 'RemoveAzDoOrganizationSettings'
        {
            Ensure = 'Absent'
            OrganizationName = 'test-organization'
        }
    }
}