Start-TestRun

NAME Start-TestRun



SYNOPSIS

Start a test run





SYNTAX

Start-TestRun [-ApiUrl] <Uri> [-OrganizationId] <Guid> [[-ApiCredential] <PSCredential>] -TestSuiteName <string>

[-ConnectionTimeoutInMinutes <int>] [<CommonParameters>]





DESCRIPTION

Start a test run for the specified test suite



Returns the newly started test run Id





PARAMETERS

-TestSuiteName <string>

Test Suite Name



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <string>

Test Suite Name



This is an alias of the TestSuiteName parameter.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ApiUrl <Uri>

URI for the Admin API server



Required? true

Position? 0

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ApiCredential <PSCredential>

Login credentials for the Admin API



Required? false

Position? 2

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-OrganizationId <Guid>

Organization Id against which the tests will need to run



This value can be obtained from CRM -> Settings -> Customizations -> Developer Resources page



Required? true

Position? 1

Default value 00000000-0000-0000-0000-000000000000

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ConnectionTimeoutInMinutes <int>

Amount of time that the client will wait till it times out



Required? false

Position? named

Default value 2

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.Uri

URI for the Admin API server



System.Management.Automation.PSCredential

Login credentials for the Admin API



System.Guid

Organization Id against which the tests will need to run



This value can be obtained from CRM -> Settings -> Customizations -> Developer Resources page



System.Int32

Amount of time that the client will wait till it times out





OUTPUTS

System.String





---------- EXAMPLE 1 ----------



$mycreds = New-Object System.Management.Automation.PSCredential ( "email address", (ConvertTo-SecureString "user

password" -AsPlainText -Force) )

$testRunId = Start-TestRun -ApiUrl "https://admin.services.crm.dynamics.com/" -ApiCredential $mycreds

-OrganizationId "org id" -TestSuiteName "myTestName"





RELATED LINKS