en-US/about_AzDoOrganizationSettings.help.txt
|
.NAME
AzDoOrganizationSettings .SYNOPSIS DSC resource for managing Azure DevOps organisation-level settings (singleton). .DESCRIPTION This resource manages organization-level security and access settings in Azure DevOps. These settings affect the entire organization and should be managed carefully. Only one instance of this resource should be configured per organization. .PARAMETER OrganizationName Key - System.String The name of the Azure DevOps organization. This property is mandatory and serves as the key property for the resource. It is not configurable after initial setup. .PARAMETER AllowPublicProjects Write - System.Boolean Whether users can create public (anonymous-access) projects. .PARAMETER AllowExternalGuestAccess Write - System.Boolean Whether external guest users (Azure AD guests) can be added to the organization. .PARAMETER EnableOAuthAuthentication Write - System.Boolean Whether OAuth authentication is enabled for third-party applications. .PARAMETER EnableSSHAuthentication Write - System.Boolean Whether SSH authentication is enabled for Git operations. .PARAMETER DisallowAadGuestUserPolicy Write - System.Boolean Whether the Azure AD guest user policy is disallowed. .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' } } } |