load_tests

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

Overview

Name	load_tests
Type	Resource
Id	azure.load_testing.load_tests

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataPlaneURI	string	Resource data plane URI.
description	string	Description of the resource.
encryption	object	CMK Encryption property.
identity	object	The type of identity used for the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", "Canceled", and "Deleted".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataPlaneURI	string	Resource data plane URI.
description	string	Description of the resource.
encryption	object	CMK Encryption property.
identity	object	The type of identity used for the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", "Canceled", and "Deleted".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataPlaneURI	string	Resource data plane URI.
description	string	Description of the resource.
encryption	object	CMK Encryption property.
identity	object	The type of identity used for the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", "Canceled", and "Deleted".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, load_test_name, subscription_id		Get a LoadTest resource.
list_by_resource_group	select	resource_group_name, subscription_id		Lists loadtest resources in a resource group.
list_by_subscription	select	subscription_id		Lists loadtests resources in a subscription.
create_or_update	insert	resource_group_name, load_test_name, subscription_id, location		Create or update LoadTest resource.
update	update	resource_group_name, load_test_name, subscription_id		Update a loadtest resource.
create_or_update	replace	resource_group_name, load_test_name, subscription_id, location		Create or update LoadTest resource.
delete	delete	resource_group_name, load_test_name, subscription_id		Delete a LoadTest resource.
list_outbound_network_dependencies_endpoints	exec	resource_group_name, load_test_name, subscription_id		Lists the endpoints that agents may call as part of load testing.

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
load_test_name	string	Load Test name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a LoadTest resource.

SELECT
id,
name,
dataPlaneURI,
description,
encryption,
identity,
location,
provisioningState,
systemData,
tags,
type
FROM azure.load_testing.load_tests
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND load_test_name = '{{ load_test_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists loadtest resources in a resource group.

SELECT
id,
name,
dataPlaneURI,
description,
encryption,
identity,
location,
provisioningState,
systemData,
tags,
type
FROM azure.load_testing.load_tests
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists loadtests resources in a subscription.

SELECT
id,
name,
dataPlaneURI,
description,
encryption,
identity,
location,
provisioningState,
systemData,
tags,
type
FROM azure.load_testing.load_tests
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update LoadTest resource.

INSERT INTO azure.load_testing.load_tests (
tags,
location,
identity,
properties,
resource_group_name,
load_test_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ load_test_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: load_tests
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the load_tests resource.
  - name: load_test_name
    value: "{{ load_test_name }}"
    description: Required parameter for the load_tests resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the load_tests resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: identity
    description: |
      The type of identity used for the resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    value:
      description: "{{ description }}"
      encryption:
        identity:
          type: "{{ type }}"
          resourceId: "{{ resourceId }}"
        keyUrl: "{{ keyUrl }}"

UPDATE examples

update

Update a loadtest resource.

UPDATE azure.load_testing.load_tests
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND load_test_name = '{{ load_test_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update LoadTest resource.

REPLACE azure.load_testing.load_tests
SET 
tags = '{{ tags }}',
location = '{{ location }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND load_test_name = '{{ load_test_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a LoadTest resource.

DELETE FROM azure.load_testing.load_tests
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND load_test_name = '{{ load_test_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_outbound_network_dependencies_endpoints

Lists the endpoints that agents may call as part of load testing.

EXEC azure.load_testing.load_tests.list_outbound_network_dependencies_endpoints 
@resource_group_name='{{ resource_group_name }}' --required, 
@load_test_name='{{ load_test_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;