Test

Synopsis

Start a test run.

Syntax

Start-Test -Client <String> [-IPVersion <String>] [-GeoLocation <String>] -ConditionExpression <String> [-TestRequestURL <String>] [-RequestMethod <String>] [-RequestHeaders <Hashtable[]>] [-RequestBody <String>] [-EncodeRequestBody] [-Tags <String[]>] -TargetEnvironment <String> [-Note <String>] [-PurgeOnstaging] [-SendEmailOnCompletion] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Start-Test -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Submits a test run for functional testing of a simple test case.

Parameters

`‑AccountSwitchKey`	String Pipeline input: False 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.
`‑Body` Conditionally required	Object Parameter sets: `Request body` Pipeline input: ByValue A request body, either as a `PSCustomObject` or string. This parameter supports pipelining.
`‑Client` Conditionally required	String Accepted values: `CHROME`, `CURL` Parameter sets: `Specify test attributes` Pipeline input: False Client type you want to use for the test run, either CHROME or CURL.
`‑ConditionExpression` Conditionally required	String Parameter sets: `Specify test attributes` Pipeline input: False Condition expression you want to evaluate in the test run. To create the expression, you need to Get the test catalog template.
`‑EdgeRCFile`	String Pipeline input: False Your EdgeGrid resource file to authenticate your command. Defaults to `~/.edgerc`.
`‑EncodeRequestBody`	Switch Parameter sets: `Specify test attributes` Pipeline input: False Encodes requestBody. It applies only if clientType is set to CURL and requestMethod to POST, true by default.
`‑GeoLocation`	String Accepted values: `US` Parameter sets: `Specify test attributes` Pipeline input: False Location type you want to use for the test run. The only currently supported value is US.
`‑IPVersion`	String Accepted values: `IPV4`, `IPV6` Parameter sets: `Specify test attributes` Pipeline input: False IP version to use in the test run, either IPV4 or IPV6.
`‑Note`	String Parameter sets: `Specify test attributes` Pipeline input: False Notes about the test run.
`‑PurgeOnstaging`	Switch Parameter sets: `Specify test attributes` Pipeline input: False Purges the configuration for the test run. It applies only for targetEnvironment set to STAGING.
`‑RequestBody`	String Parameter sets: `Specify test attributes` Pipeline input: False Request body for the testRequestUrl. Provide it only if clientType is set to CURL and requestMethod is POST.
`‑RequestHeaders`	Hashtable[] Parameter sets: `Specify test attributes` Pipeline input: False One or more hashtables with the following members: headerAction - should always be 'ADD', headerName - the name of the header to add, headerValue - the value of the header to add. For example `@{ headerAction = 'ADD'; headerName = 'user-agent'; headerValue = 'powershell' }`.
`‑RequestMethod`	String Parameter sets: `Specify test attributes` Pipeline input: False Request method for the testRequestUrl. The available values are: HEAD, GET, and POST.
`‑Section`	String Pipeline input: False The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to `default`.
`‑SendEmailOnCompletion`	Switch Parameter sets: `Specify test attributes` Pipeline input: False Sends a notification email after the test run completes.
`‑Tags`	String[] Parameter sets: `Specify test attributes` Pipeline input: False Lists keywords for the test request. They're useful to filter test cases in the Test Center application.
`‑TargetEnvironment` Conditionally required	String Accepted values: `PRODUCTION`, `STAGING` Parameter sets: `Specify test attributes` Pipeline input: False Environment against which the test run executes the request, either PRODUCTION or STAGING.
`‑TestRequestURL`	String Parameter sets: `Specify test attributes` Pipeline input: False Fully qualified URL of the page or object you want to test. The URL needs to include a protocol, a hostname, a path, and any optional query parameters. Test Center requests this URL from a browser, as well as any requests triggered by it.

Related Links

Updated 12 days ago