en-US/about_AzDevOpsProject.help.txt
|
.NAME
AzDevOpsProject .SYNOPSIS A DSC Resource for Azure DevOps that represents the 'Project' resource. .DESCRIPTION A DSC Resource for Azure DevOps that represents the 'Project' resource. .PARAMETER ProjectId Write - System.String The 'Id' of the Azure DevOps, 'Project' resource. .PARAMETER ProjectName Key - System.String The 'Name' of the Azure DevOps, 'Project' resource. .PARAMETER ProjectDescription Write - System.String The 'Description' of the Azure DevOps, 'Project' resource. .PARAMETER SourceControlType Write - System.String Allowed values: Git, Tfvc The 'SourceControlType' of the Azure DevOps, 'Project' resource. If the 'Project' resource already exists in Azure DevOps, the parameter SourceControlType cannot be used to change to another type. .EXAMPLE 1 This example shows how to ensure that the Azure DevOps project called 'Test Project' exists (or is added if it does not exist). Configuration Example { param ( [Parameter(Mandatory = $true)] [string] $ApiUri, [Parameter(Mandatory = $true)] [string] $Pat ) Import-DscResource -ModuleName 'AzureDevOpsDsc' node localhost { AzDevOpsProject 'AddProject' { Ensure = 'Present' ApiUri = $ApiUri Pat = $Pat ProjectName = 'Test Project' ProjectDescription = 'A Test Project' SourceControlType = 'Git' } } } .EXAMPLE 2 This example shows how to ensure that an Azure DevOps project with a ProjectName of 'Test Project' can have it's description updated to 'A Test Project with a new description'. Configuration Example { param ( [Parameter(Mandatory = $true)] [string] $ApiUri, [Parameter(Mandatory = $true)] [string] $Pat ) Import-DscResource -ModuleName 'AzureDevOpsDsc' node localhost { AzDevOpsProject 'UpdateProject' { Ensure = 'Present' ApiUri = $ApiUri Pat = $Pat ProjectName = 'Test Project' ProjectDescription = 'A Test Project with a new description' # Updated property #SourceControlType = 'Git' # Note: Update of this property is not supported } } } .EXAMPLE 3 This example shows how to delete a project called 'Test Project'. Configuration Example { param ( [Parameter(Mandatory = $true)] [string] $ApiUri, [Parameter(Mandatory = $true)] [string] $Pat ) Import-DscResource -ModuleName 'AzureDevOpsDsc' node localhost { AzDevOpsProject 'DeleteProject' { Ensure = 'Absent' # 'Absent' ensures this will be removed/deleted ApiUri = $ApiUri Pat = $Pat ProjectName = 'Test Project' # Identifies the name of the project to be deleted } } } |