test_profile_runs

Creates, updates, deletes, gets or lists a test_profile_runs resource.

Overview

Name	test_profile_runs
Type	Resource
Id	azure.developer_loadtesting.test_profile_runs

Fields

The following fields are returned by SELECT queries:

get_test_profile_run

Name	Datatype	Description
createdBy	string	The user that created.
createdDateTime	string (date-time)	The creation datetime(RFC 3339 literal format).
description	string	The test profile run description.
displayName	string	Display name for the test profile run.
durationInSeconds	integer	Test profile run duration in seconds.
endDateTime	string (date-time)	The test profile run end DateTime(RFC 3339 literal format).
errorDetails	array	Error details if there is any failure in test profile run. These errors are specific to the Test Profile Run.
lastModifiedBy	string	The user that last modified.
lastModifiedDateTime	string (date-time)	The last Modified datetime(RFC 3339 literal format).
recommendations	array	Recommendations provided based on a successful test profile run.
startDateTime	string (date-time)	The test profile run start DateTime(RFC 3339 literal format).
status	string	The test profile run status. Known values are: "ACCEPTED", "NOTSTARTED", "EXECUTING", "DONE", "CANCELLING", "CANCELLED", and "FAILED". (ACCEPTED, NOTSTARTED, EXECUTING, DONE, CANCELLING, CANCELLED, FAILED)
targetResourceConfigurations	object	Configurations of the target resource on which the test profile ran.
targetResourceId	string	Target resource ID on which the test profile run is created.
testProfileId	string	Associated test profile ID for the test profile run. This is required to create a test profile run and can't be updated.
testProfileRunId	string	Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.
testRunDetails	object	Details of the test runs ran as part of the test profile run. Key is the testRunId of the corresponding testRun.

list_test_profile_runs

Name	Datatype	Description
createdBy	string	The user that created.
createdDateTime	string (date-time)	The creation datetime(RFC 3339 literal format).
description	string	The test profile run description.
displayName	string	Display name for the test profile run.
durationInSeconds	integer	Test profile run duration in seconds.
endDateTime	string (date-time)	The test profile run end DateTime(RFC 3339 literal format).
errorDetails	array	Error details if there is any failure in test profile run. These errors are specific to the Test Profile Run.
lastModifiedBy	string	The user that last modified.
lastModifiedDateTime	string (date-time)	The last Modified datetime(RFC 3339 literal format).
recommendations	array	Recommendations provided based on a successful test profile run.
startDateTime	string (date-time)	The test profile run start DateTime(RFC 3339 literal format).
status	string	The test profile run status. Known values are: "ACCEPTED", "NOTSTARTED", "EXECUTING", "DONE", "CANCELLING", "CANCELLED", and "FAILED". (ACCEPTED, NOTSTARTED, EXECUTING, DONE, CANCELLING, CANCELLED, FAILED)
targetResourceConfigurations	object	Configurations of the target resource on which the test profile ran.
targetResourceId	string	Target resource ID on which the test profile run is created.
testProfileId	string	Associated test profile ID for the test profile run. This is required to create a test profile run and can't be updated.
testProfileRunId	string	Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.
testRunDetails	object	Details of the test runs ran as part of the test profile run. Key is the testRunId of the corresponding testRun.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_test_profile_run	select	test_profile_run_id, endpoint		Get test profile run details. Get test profile run details by test profile run Id.
list_test_profile_runs	select	endpoint	maxpagesize, minStartDateTime, maxStartDateTime, minEndDateTime, maxEndDateTime, createdDateStartTime, createdDateEndTime, testProfileRunIds, testProfileIds, statuses	List test profile runs. Get all test profile runs for the given filters.
delete_test_profile_run	delete	test_profile_run_id, endpoint		Delete an existing load test profile run. Delete an existing load test profile run by providing the test profile run Id.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
test_profile_run_id	string	Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.
createdDateEndTime	string (date-time)	End DateTime(RFC 3339 literal format) of the created time range to filter test profile runs. Default value is None.
createdDateStartTime	string (date-time)	Start DateTime(RFC 3339 literal format) of the created time range to filter test profile runs. Default value is None.
maxEndDateTime	string (date-time)	Maximum End DateTime(RFC 3339 literal format) of the test profile runs to filter on. Default value is None.
maxStartDateTime	string (date-time)	Maximum Start DateTime(RFC 3339 literal format) of the test profile runs to filter on. Default value is None.
maxpagesize	integer
minEndDateTime	string (date-time)	Minimum End DateTime(RFC 3339 literal format) of the test profile runs to filter on. Default value is None.
minStartDateTime	string (date-time)	Minimum Start DateTime(RFC 3339 literal format) of the test profile runs to filter on. Default value is None.
statuses	array	Comma separated list of Statuses of the test profile runs to filter. Default value is None.
testProfileIds	array	Comma separated IDs of the test profiles which should be associated with the test profile runs to fetch. Default value is None.
testProfileRunIds	array	Comma separated list of IDs of the test profile runs to filter. Default value is None.

SELECT examples

get_test_profile_run

Get test profile run details. Get test profile run details by test profile run Id.

SELECT
createdBy,
createdDateTime,
description,
displayName,
durationInSeconds,
endDateTime,
errorDetails,
lastModifiedBy,
lastModifiedDateTime,
recommendations,
startDateTime,
status,
targetResourceConfigurations,
targetResourceId,
testProfileId,
testProfileRunId,
testRunDetails
FROM azure.developer_loadtesting.test_profile_runs
WHERE test_profile_run_id = '{{ test_profile_run_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_test_profile_runs

List test profile runs. Get all test profile runs for the given filters.

SELECT
createdBy,
createdDateTime,
description,
displayName,
durationInSeconds,
endDateTime,
errorDetails,
lastModifiedBy,
lastModifiedDateTime,
recommendations,
startDateTime,
status,
targetResourceConfigurations,
targetResourceId,
testProfileId,
testProfileRunId,
testRunDetails
FROM azure.developer_loadtesting.test_profile_runs
WHERE endpoint = '{{ endpoint }}' -- required
AND maxpagesize = '{{ maxpagesize }}'
AND minStartDateTime = '{{ minStartDateTime }}'
AND maxStartDateTime = '{{ maxStartDateTime }}'
AND minEndDateTime = '{{ minEndDateTime }}'
AND maxEndDateTime = '{{ maxEndDateTime }}'
AND createdDateStartTime = '{{ createdDateStartTime }}'
AND createdDateEndTime = '{{ createdDateEndTime }}'
AND testProfileRunIds = '{{ testProfileRunIds }}'
AND testProfileIds = '{{ testProfileIds }}'
AND statuses = '{{ statuses }}'
;

DELETE examples

delete_test_profile_run

Delete an existing load test profile run. Delete an existing load test profile run by providing the test profile run Id.

DELETE FROM azure.developer_loadtesting.test_profile_runs
WHERE test_profile_run_id = '{{ test_profile_run_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;