Test suite

Synopsis

Start a test run for a test suite.

Syntax

Start-TestSuite [-TestSuiteID] <Int32> [[-TestCaseID] <Int32[]>] [-TargetEnvironment] <String> [[-Note] <String>] [-PurgeOnstaging] [-SendEmailOnCompletion] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Submits a test run for functional testing of a test suite.

Parameters

‑AccountSwitchKey

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑Note

Notes about the test run.

‑PurgeOnstaging

Purges the configuration for the test run. It applies only for targetEnvironment set to STAGING.

‑Section

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

‑SendEmailOnCompletion

Sends a notification email after the test run completes.

‑TargetEnvironment
Required

Environment against which the test run executes the request, either PRODUCTION or STAGING.

‑TestCaseID

Your functional test case's ID.

‑TestSuiteID
Required

Your test suite's ID.

Related Links