Test suite

Get-TestSuite

Synopsis

Get a test suite with child objects.

Syntax

all (Default)

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

single

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

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Account switch keys can be found using Get-AccountSwitchKey.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IncludeChildObjects

Include child objects such as test cases and variables in the result.

Type: SwitchParameter
Parameter Sets: single
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IncludeRecentlyDeleted

Includes items deleted within the last 30 days, which you can restore.

Type: SwitchParameter
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-PropertyID

Unique identifier for 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.

Type: Int32
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PropertyName

Property name 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.

Type: String
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PropertyVersion

Version of the associated Property Manager property to filter the test suites by. Combine this parameter with propertyId or propertyName.

Type: Int32
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResolveVariables

Returns test cases with resolved variables assigned statically.

Type: SwitchParameter
Parameter Sets: single
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TestSuiteID

Identifies a test suite.

Type: Int32
Parameter Sets: single
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-User

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

Type: String
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object