test_profiles

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

Overview

Name	test_profiles
Type	Resource
Id	azure.developer_loadtesting.test_profiles

Fields

The following fields are returned by SELECT queries:

get_test_profile

Name	Datatype	Description
createdBy	string	The user that created.
createdDateTime	string (date-time)	The creation datetime(RFC 3339 literal format).
description	string	Description for the test profile.
displayName	string	Display name of the test profile.
lastModifiedBy	string	The user that last modified.
lastModifiedDateTime	string (date-time)	The last Modified datetime(RFC 3339 literal format).
targetResourceConfigurations	object	Configurations of the target resource on which testing would be done.
targetResourceId	string	Target resource ID on which the test profile is created. This property is required for creating a Test Profile and it's not allowed to be updated.
testId	string	Associated test ID for the test profile. This property is required for creating a Test Profile and it's not allowed to be updated.
testProfileId	string	Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.

list_test_profiles

Name	Datatype	Description
createdBy	string	The user that created.
createdDateTime	string (date-time)	The creation datetime(RFC 3339 literal format).
description	string	Description for the test profile.
displayName	string	Display name of the test profile.
lastModifiedBy	string	The user that last modified.
lastModifiedDateTime	string (date-time)	The last Modified datetime(RFC 3339 literal format).
targetResourceConfigurations	object	Configurations of the target resource on which testing would be done.
targetResourceId	string	Target resource ID on which the test profile is created. This property is required for creating a Test Profile and it's not allowed to be updated.
testId	string	Associated test ID for the test profile. This property is required for creating a Test Profile and it's not allowed to be updated.
testProfileId	string	Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_test_profile	select	test_profile_id, endpoint		Get load test profile details. Get load test profile details by test profile Id.
list_test_profiles	select	endpoint	maxpagesize, lastModifiedStartTime, lastModifiedEndTime, testProfileIds, testIds	List test profiles. Get all test profiles for the given filters.
create_or_update_test_profile	insert	test_profile_id, endpoint		Create a new test profile or update an existing test profile. Create a new test profile or update an existing test profile by providing the test profile Id.
create_or_update_test_profile	replace	test_profile_id, endpoint		Create a new test profile or update an existing test profile. Create a new test profile or update an existing test profile by providing the test profile Id.
delete_test_profile	delete	test_profile_id, endpoint		Delete a test profile. Delete a test profile by its test profile 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_id	string	Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.
lastModifiedEndTime	string (date-time)	End DateTime(RFC 3339 literal format) of the last updated time range to filter test profiles. Default value is None.
lastModifiedStartTime	string (date-time)	Start DateTime(RFC 3339 literal format) of the last updated time range to filter test profiles. Default value is None.
maxpagesize	integer
testIds	array	Comma separated list IDs of the tests which should be associated with the test profiles to fetch. Default value is None.
testProfileIds	array	Comma separated list of IDs of the test profiles to filter. Default value is None.

SELECT examples

get_test_profile

Get load test profile details. Get load test profile details by test profile Id.

SELECT
createdBy,
createdDateTime,
description,
displayName,
lastModifiedBy,
lastModifiedDateTime,
targetResourceConfigurations,
targetResourceId,
testId,
testProfileId
FROM azure.developer_loadtesting.test_profiles
WHERE test_profile_id = '{{ test_profile_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_test_profiles

List test profiles. Get all test profiles for the given filters.

SELECT
createdBy,
createdDateTime,
description,
displayName,
lastModifiedBy,
lastModifiedDateTime,
targetResourceConfigurations,
targetResourceId,
testId,
testProfileId
FROM azure.developer_loadtesting.test_profiles
WHERE endpoint = '{{ endpoint }}' -- required
AND maxpagesize = '{{ maxpagesize }}'
AND lastModifiedStartTime = '{{ lastModifiedStartTime }}'
AND lastModifiedEndTime = '{{ lastModifiedEndTime }}'
AND testProfileIds = '{{ testProfileIds }}'
AND testIds = '{{ testIds }}'
;

INSERT examples

create_or_update_test_profile

Create a new test profile or update an existing test profile. Create a new test profile or update an existing test profile by providing the test profile Id.

INSERT INTO azure.developer_loadtesting.test_profiles (
displayName,
description,
testId,
targetResourceId,
targetResourceConfigurations,
test_profile_id,
endpoint
)
SELECT 
'{{ displayName }}',
'{{ description }}',
'{{ testId }}',
'{{ targetResourceId }}',
'{{ targetResourceConfigurations }}',
'{{ test_profile_id }}',
'{{ endpoint }}'
RETURNING
createdBy,
createdDateTime,
description,
displayName,
lastModifiedBy,
lastModifiedDateTime,
targetResourceConfigurations,
targetResourceId,
testId,
testProfileId
;

Manifest

# Description fields are for documentation purposes
- name: test_profiles
props:
  - name: test_profile_id
    value: "{{ test_profile_id }}"
    description: Required parameter for the test_profiles resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the test_profiles resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Display name of the test profile.
  - name: description
    value: "{{ description }}"
    description: |
      Description for the test profile.
  - name: testId
    value: "{{ testId }}"
    description: |
      Associated test ID for the test profile. This property is required for creating a Test Profile and it's not allowed to be updated.
  - name: targetResourceId
    value: "{{ targetResourceId }}"
    description: |
      Target resource ID on which the test profile is created. This property is required for creating a Test Profile and it's not allowed to be updated.
  - name: targetResourceConfigurations
    description: |
      Configurations of the target resource on which testing would be done.
    value:
      kind: "{{ kind }}"

REPLACE examples

create_or_update_test_profile

Create a new test profile or update an existing test profile. Create a new test profile or update an existing test profile by providing the test profile Id.

REPLACE azure.developer_loadtesting.test_profiles
SET 
displayName = '{{ displayName }}',
description = '{{ description }}',
testId = '{{ testId }}',
targetResourceId = '{{ targetResourceId }}',
targetResourceConfigurations = '{{ targetResourceConfigurations }}'
WHERE 
test_profile_id = '{{ test_profile_id }}' --required
AND endpoint = '{{ endpoint }}' --required
RETURNING
createdBy,
createdDateTime,
description,
displayName,
lastModifiedBy,
lastModifiedDateTime,
targetResourceConfigurations,
targetResourceId,
testId,
testProfileId;

DELETE examples

delete_test_profile

Delete a test profile. Delete a test profile by its test profile Id.

DELETE FROM azure.developer_loadtesting.test_profiles
WHERE test_profile_id = '{{ test_profile_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;