app_components

Creates, updates, deletes, gets or lists an app_components resource.

Overview

Name	app_components
Type	Resource
Id	azure.developer_loadtesting.app_components

Fields

The following fields are returned by SELECT queries:

get_app_components

Name	Datatype	Description
components	object	Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})
createdBy	string	The user that created.
createdDateTime	string (date-time)	The creation datetime(RFC 3339 literal format).
lastModifiedBy	string	The user that last modified.
lastModifiedDateTime	string (date-time)	The last Modified datetime(RFC 3339 literal format).
testId	string	Test identifier.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_app_components	select	test_id, endpoint		Get associated app component (collection of azure resources) for the given test. Get associated app component (collection of azure resources) for the given test.
create_or_update_app_components	insert	test_id, endpoint, components		Add an app component to a test. Add an app component to a test by providing the resource Id, name and type.
create_or_update_app_components	replace	test_id, endpoint, components		Add an app component to a test. Add an app component to a test by providing the resource Id, name and type.

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_id	string	Unique name for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.

SELECT examples

get_app_components

Get associated app component (collection of azure resources) for the given test. Get associated app component (collection of azure resources) for the given test.

SELECT
components,
createdBy,
createdDateTime,
lastModifiedBy,
lastModifiedDateTime,
testId
FROM azure.developer_loadtesting.app_components
WHERE test_id = '{{ test_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update_app_components

Add an app component to a test. Add an app component to a test by providing the resource Id, name and type.

INSERT INTO azure.developer_loadtesting.app_components (
components,
test_id,
endpoint
)
SELECT 
'{{ components }}' /* required */,
'{{ test_id }}',
'{{ endpoint }}'
RETURNING
components,
createdBy,
createdDateTime,
lastModifiedBy,
lastModifiedDateTime,
testId
;

Manifest

# Description fields are for documentation purposes
- name: app_components
props:
  - name: test_id
    value: "{{ test_id }}"
    description: Required parameter for the app_components resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the app_components resource.
  - name: components
    value: "{{ components }}"
    description: |
      Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})

REPLACE examples

create_or_update_app_components

Add an app component to a test. Add an app component to a test by providing the resource Id, name and type.

REPLACE azure.developer_loadtesting.app_components
SET 
components = '{{ components }}'
WHERE 
test_id = '{{ test_id }}' --required
AND endpoint = '{{ endpoint }}' --required
AND components = '{{ components }}' --required
RETURNING
components,
createdBy,
createdDateTime,
lastModifiedBy,
lastModifiedDateTime,
testId;