en-US/about_AzDoTestPlan.help.txt
|
.NAME
AzDoTestPlan .SYNOPSIS DSC resource for managing Azure DevOps test plans. .DESCRIPTION Manages a test plan - the top-level container for test suites, configurations and runs within a project. See the Test Plan REST API 7.1 (_apis/testplan/plans). There is no dedicated test-plan security namespace. 'Manage test plans' and 'Manage test suites' are permissions on the CSS (area path) security namespace, which AzDoAreaPermission already manages - there is no AzDoTestPlanPermission resource. Creating or updating a test plan requires the DSC identity to have Basic access plus a Test Plans license/access level in the organization. Integration tests detect a licensing or access refusal up front and skip with a reason rather than failing. .PARAMETER ProjectName Required - System.String The name of the Azure DevOps project. .PARAMETER Name Key - System.String The name of the test plan. .PARAMETER AreaPath Write - System.String The area path new test cases are assigned to by default. .PARAMETER Iteration Write - System.String The iteration path the plan is scoped to. .PARAMETER Owner Write - System.String The user or group who owns the plan. Resolved via Find-AzDoIdentity the same way other resources resolve identity strings (UPN, '[Project]\Group', or display name). .PARAMETER StartDate Write - System.String The date testing is scheduled to start. .PARAMETER EndDate Write - System.String The date testing is scheduled to end. .PARAMETER State Write - System.String Allowed values: Active, Inactive The plan's state: 'Active' or 'Inactive'. .PARAMETER BuildDefinitionId Write - System.Int32 The numeric id of the build pipeline used to identify the build under test for automated runs. Optional - omit for a plan with no associated build pipeline. |