Test suite

Get-TestSuite

Synopsis

Get a test suite with child objects.

Syntax

Get-TestSuite [-IncludeRecentlyDeleted] [-PropertyID <Int32>] [-PropertyName <String>] [-PropertyVersion <Int32>] [-User <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-TestSuite -TestSuiteID <Int32> [-IncludeChildObjects] [-ResolveVariables] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all test suites in your account or retrieves a specific test suite by its ID.

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.

‑IncludeChildObjects

When enabled, includes child objects such as test cases and variables in the result.

‑IncludeRecentlyDeleted

When enabled, includes items deleted within the last 30 days, which you can restore.

‑PropertyID

The ID of the property associated with the test suite to filter the list by. You can combine this parameter with -PropertyVersion. Use either this parameter or -PropertyName to specify the property.

‑PropertyName

The name of the property associated with a test suite to filter the list by. You can combine this parameter with - PropertyVersion. Use either this parameter or -PropertyID to specify the property.

‑PropertyVersion

The version of the associated property to filter the test suites by. Combine this parameter with -PropertyID or -PropertyName.

‑ResolveVariables

When enabled, returns test cases with resolved variables assigned statically.

‑Section

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

‑TestSuiteID
Conditionally required

Your test suite's ID.

‑User

Filters the list to items created, edited, or deleted by a specific username.

Related Links