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. .PARAMETER EnableIPConditionalAccessPolicyValidation Write - System.String Allowed values: , true, false Whether IP Conditional Access policy validation is enforced for this organization (Organization settings -> Policies -> Security -> "Enable IP Conditional Access policy validation"). Backed by the organization policy API, not the host settings entries used by the properties above. This and the other organization policy properties take 'true', 'false' or '' (the default). '' leaves the policy unmanaged: it is neither compared nor written. A plain boolean cannot express that, because the resource base class passes every property to Get and Set, so an unset boolean would arrive as $false and switch the policy off. $true and $false in a configuration are accepted and converted. .PARAMETER LogAuditEvents Write - System.String Allowed values: , true, false Whether organization audit events are logged (Organization settings -> Policies -> Security -> "Log audit events"). Turning this off means an AzDoAuditStream on this organization receives nothing; Set-AzDoOrganizationSettings warns when this is set to 'false'. .PARAMETER AllowTeamAdminsToInviteUsers Write - System.String Allowed values: , true, false Whether team and project administrators can invite new users (Organization settings -> Policies -> User -> "Allow team and project administrators to invite new users"). .PARAMETER EnableRequestAccess Write - System.String Allowed values: , true, false Whether the "Request access" link is shown to users without access (Organization settings -> Policies -> User -> "Request access"). .PARAMETER RequestAccessUrl Write - System.String The URL shown alongside the request-access prompt. Only compared and written when EnableRequestAccess is 'true' and this is not empty. .PARAMETER EnableArtifactsFeedUpstreamProtection Write - System.String Allowed values: , true, false Whether additional protections are applied when Artifacts feeds use public package registries as an upstream source (Organization settings -> Policies -> Security -> "Additional protections when using public package registries"). .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' } } } |