Kickstart your project with AVM templates.

load-testing-service

report

If you believe that this package or its contents contain harmful information, please inform us.
Please be aware that we will never share your credentials.

This package contains:

Please let us know what this package contains.

Email address

Please enter a valid email address.

Please provide is us with more information.

This Bicep AVM module deploys a Load test.

ipm add --package avm-bicep/load-testing-service --version 0.4.0

Published: 29-11-2024

Project URL: https://ipmhub.io/avm-bicep

Package Type: Bicep

License: MIT

Load Testing Service `[Microsoft.LoadTestService/loadTests]`

This module deploys a Load test.

Resource Types

Resource Type	API Version
`Microsoft.Authorization/locks`	2020-05-01
`Microsoft.Authorization/roleAssignments`	2022-04-01
`Microsoft.LoadTestService/loadTests`	2022-12-01

Usage examples

The following section provides usage examples for the module, which were used to validate and deploy the module successfully. For a full reference, please review the module's test folder in its repository.

Note: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.

Note: To reference the module, please use the following syntax ./packages/load-testing-service/main.bicep.

Using only defaults
Using large parameter set
Using Customer-Managed-Keys with User-Assigned identity
WAF-aligned

Example 1: Using only defaults

This instance deploys the module with the minimum set of required parameters.

via Bicep module

module loadTest './packages/load-testing-service/main.bicep' = {
  name: 'loadTestDeployment'
  params: {
    // Required parameters
    name: 'ltmin001'
    // Non-required parameters
    location: '<location>'
  }
}

via JSON parameters file

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "ltmin001"
    },
    // Non-required parameters
    "location": {
      "value": "<location>"
    }
  }
}

via Bicep parameters file

using './packages/load-testing-service/main.bicep'

// Required parameters
param name = 'ltmin001'
// Non-required parameters
param location = '<location>'

Example 2: Using large parameter set

This instance deploys the module with most of its features enabled.

via Bicep module

module loadTest './packages/load-testing-service/main.bicep' = {
  name: 'loadTestDeployment'
  params: {
    // Required parameters
    name: 'ltmax001'
    // Non-required parameters
    loadTestDescription: 'This is a test load test to validate the module.'
    location: '<location>'
    lock: {
      kind: 'None'
    }
    managedIdentities: {
      systemAssigned: true
    }
    roleAssignments: [
      {
        name: 'd37a15bc-8634-4f4f-a736-700c1b955cd7'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'Owner'
      }
      {
        name: '<name>'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
      }
      {
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
      }
    ]
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
  }
}

via JSON parameters file

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "ltmax001"
    },
    // Non-required parameters
    "loadTestDescription": {
      "value": "This is a test load test to validate the module."
    },
    "location": {
      "value": "<location>"
    },
    "lock": {
      "value": {
        "kind": "None"
      }
    },
    "managedIdentities": {
      "value": {
        "systemAssigned": true
      }
    },
    "roleAssignments": {
      "value": [
        {
          "name": "d37a15bc-8634-4f4f-a736-700c1b955cd7",
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "Owner"
        },
        {
          "name": "<name>",
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "b24988ac-6180-42a0-ab88-20f7382dd24c"
        },
        {
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "<roleDefinitionIdOrName>"
        }
      ]
    },
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    }
  }
}

via Bicep parameters file

using './packages/load-testing-service/main.bicep'

// Required parameters
param name = 'ltmax001'
// Non-required parameters
param loadTestDescription = 'This is a test load test to validate the module.'
param location = '<location>'
param lock = {
  kind: 'None'
}
param managedIdentities = {
  systemAssigned: true
}
param roleAssignments = [
  {
    name: 'd37a15bc-8634-4f4f-a736-700c1b955cd7'
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: 'Owner'
  }
  {
    name: '<name>'
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
  }
  {
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
  }
]
param tags = {
  Environment: 'Non-Prod'
  'hidden-title': 'This is visible in the resource name'
  Role: 'DeploymentValidation'
}

Example 3: Using Customer-Managed-Keys with User-Assigned identity

This instance deploys the module using Customer-Managed-Keys using a User-Assigned Identity to access the Customer-Managed-Key secret.

via Bicep module

module loadTest './packages/load-testing-service/main.bicep' = {
  name: 'loadTestDeployment'
  params: {
    // Required parameters
    name: 'ltucmk001'
    // Non-required parameters
    customerManagedKey: {
      keyName: '<keyName>'
      keyVaultResourceId: '<keyVaultResourceId>'
      userAssignedIdentityResourceId: '<userAssignedIdentityResourceId>'
    }
    location: '<location>'
    managedIdentities: {
      userAssignedResourceIds: [
        '<managedIdentityResourceId>'
      ]
    }
  }
}

via JSON parameters file

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "ltucmk001"
    },
    // Non-required parameters
    "customerManagedKey": {
      "value": {
        "keyName": "<keyName>",
        "keyVaultResourceId": "<keyVaultResourceId>",
        "userAssignedIdentityResourceId": "<userAssignedIdentityResourceId>"
      }
    },
    "location": {
      "value": "<location>"
    },
    "managedIdentities": {
      "value": {
        "userAssignedResourceIds": [
          "<managedIdentityResourceId>"
        ]
      }
    }
  }
}

via Bicep parameters file

using './packages/load-testing-service/main.bicep'

// Required parameters
param name = 'ltucmk001'
// Non-required parameters
param customerManagedKey = {
  keyName: '<keyName>'
  keyVaultResourceId: '<keyVaultResourceId>'
  userAssignedIdentityResourceId: '<userAssignedIdentityResourceId>'
}
param location = '<location>'
param managedIdentities = {
  userAssignedResourceIds: [
    '<managedIdentityResourceId>'
  ]
}

Example 4: WAF-aligned

This instance deploys the module in alignment with the best-practices of the Well-Architected Framework.

via Bicep module

module loadTest './packages/load-testing-service/main.bicep' = {
  name: 'loadTestDeployment'
  params: {
    // Required parameters
    name: 'ltwaf001'
    // Non-required parameters
    enableTelemetry: '<enableTelemetry>'
    loadTestDescription: 'This is a sample load test.'
    location: '<location>'
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
  }
}

via JSON parameters file

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "ltwaf001"
    },
    // Non-required parameters
    "enableTelemetry": {
      "value": "<enableTelemetry>"
    },
    "loadTestDescription": {
      "value": "This is a sample load test."
    },
    "location": {
      "value": "<location>"
    },
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    }
  }
}

via Bicep parameters file

using './packages/load-testing-service/main.bicep'

// Required parameters
param name = 'ltwaf001'
// Non-required parameters
param enableTelemetry = '<enableTelemetry>'
param loadTestDescription = 'This is a sample load test.'
param location = '<location>'
param tags = {
  Environment: 'Non-Prod'
  'hidden-title': 'This is visible in the resource name'
  Role: 'DeploymentValidation'
}

Parameters

Required parameters

Parameter	Type	Description
`name`	string	Name of the Load test.

Optional parameters

Parameter	Type	Description
`customerManagedKey`	object	The customer managed key definition.
`enableTelemetry`	bool	Enable/Disable usage telemetry for module.
`loadTestDescription`	string	The description of the load test.
`location`	string	Location for all resources.
`lock`	object	The lock settings of the service.
`managedIdentities`	object	The managed identity definition for this resource.
`roleAssignments`	array	Array of role assignments to create.
`tags`	object	Resource tags.

Parameter: `name`

Name of the Load test.

Required: Yes
Type: string

Parameter: `customerManagedKey`

The customer managed key definition.

Required: No
Type: object

Required parameters

Parameter	Type	Description
`keyName`	string	The name of the customer managed key to use for encryption.
`keyVaultResourceId`	string	The resource ID of a key vault to reference a customer managed key for encryption from.

Optional parameters

Parameter	Type	Description
`keyVersion`	string	The version of the customer managed key to reference for encryption. If not provided, the deployment will use the latest version available at deployment time.
`userAssignedIdentityResourceId`	string	User assigned identity to use when fetching the customer managed key. Required if no system assigned identity is available for use.

Parameter: `customerManagedKey.keyName`

The name of the customer managed key to use for encryption.

Required: Yes
Type: string

Parameter: `customerManagedKey.keyVaultResourceId`

The resource ID of a key vault to reference a customer managed key for encryption from.

Required: Yes
Type: string

Parameter: `customerManagedKey.keyVersion`

The version of the customer managed key to reference for encryption. If not provided, the deployment will use the latest version available at deployment time.

Required: No
Type: string

Parameter: `customerManagedKey.userAssignedIdentityResourceId`

User assigned identity to use when fetching the customer managed key. Required if no system assigned identity is available for use.

Required: No
Type: string

Parameter: `enableTelemetry`

Enable/Disable usage telemetry for module.

Required: No
Type: bool
Default: True

Parameter: `loadTestDescription`

The description of the load test.

Required: No
Type: string

Parameter: `location`

Location for all resources.

Required: No
Type: string
Default: [resourceGroup().location]

Parameter: `lock`

The lock settings of the service.

Required: No
Type: object

Optional parameters

Parameter	Type	Description
`kind`	string	Specify the type of lock.
`name`	string	Specify the name of lock.

Parameter: `lock.kind`

Specify the type of lock.

Required: No
Type: string

Allowed:

[
  'CanNotDelete'
  'None'
  'ReadOnly'
]

Parameter: `lock.name`

Specify the name of lock.

Required: No
Type: string

Parameter: `managedIdentities`

The managed identity definition for this resource.

Required: No
Type: object

Optional parameters

Parameter	Type	Description
`systemAssigned`	bool	Enables system assigned managed identity on the resource.
`userAssignedResourceIds`	array	The resource ID(s) to assign to the resource. Required if a user assigned identity is used for encryption.

Parameter: `managedIdentities.systemAssigned`

Enables system assigned managed identity on the resource.

Required: No
Type: bool

Parameter: `managedIdentities.userAssignedResourceIds`

The resource ID(s) to assign to the resource. Required if a user assigned identity is used for encryption.

Required: No
Type: array

Parameter: `roleAssignments`

Array of role assignments to create.

Required: No
Type: array
Roles configurable by name:
- 'Contributor'
- 'Owner'
- 'Reader'
- 'Role Based Access Control Administrator'
- 'User Access Administrator'

Required parameters

Parameter	Type	Description
`principalId`	string	The principal ID of the principal (user/group/identity) to assign the role to.
`roleDefinitionIdOrName`	string	The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.

Optional parameters

Parameter	Type	Description
`condition`	string	The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container".
`conditionVersion`	string	Version of the condition.
`delegatedManagedIdentityResourceId`	string	The Resource Id of the delegated managed identity resource.
`description`	string	The description of the role assignment.
`name`	string	The name (as GUID) of the role assignment. If not provided, a GUID will be generated.
`principalType`	string	The principal type of the assigned principal ID.

Parameter: `roleAssignments.principalId`

The principal ID of the principal (user/group/identity) to assign the role to.

Required: Yes
Type: string

Parameter: `roleAssignments.roleDefinitionIdOrName`

The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.

Required: Yes
Type: string

Parameter: `roleAssignments.condition`

The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container".

Required: No
Type: string

Parameter: `roleAssignments.conditionVersion`

Version of the condition.

Required: No
Type: string
Allowed:
```
[
  '2.0'
]
```

Parameter: `roleAssignments.delegatedManagedIdentityResourceId`

The Resource Id of the delegated managed identity resource.

Required: No
Type: string

Parameter: `roleAssignments.description`

The description of the role assignment.

Required: No
Type: string

Parameter: `roleAssignments.name`

The name (as GUID) of the role assignment. If not provided, a GUID will be generated.

Required: No
Type: string

Parameter: `roleAssignments.principalType`

The principal type of the assigned principal ID.

Required: No
Type: string

Allowed:

[
  'Device'
  'ForeignGroup'
  'Group'
  'ServicePrincipal'
  'User'
]

Parameter: `tags`

Resource tags.

Required: No
Type: object

Outputs

Output	Type	Description
`location`	string	The location the resource was deployed into.
`name`	string	The name of the load test.
`resourceGroupName`	string	The resource group the load test was deployed into.
`resourceId`	string	The resource ID of the load test.
`systemAssignedMIPrincipalId`	string	The principal ID of the system assigned identity.

Cross-referenced modules

This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).

Reference	Type
`./packages/utl-common-types/main.bicep`	Local Reference

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

No release notes uploaded for this version

 
 {
  "workingFolder": "packages",
  "packages": [
    // packages defined earlier
    {
      "name": "avm-bicep/load-testing-service",
      "version": "0.4.0"
    }
  ]
}

avm-bicep/utl-common-types:0.4.0

Stats

Selected version:

0.4.0

Downloads this version:

Downloads all versions:

Latest version:

0.4.0

Latest update:

29-11-2024

avm-bicep

Other versions (2)

0.4.0

0.3.0

Other packages

from avm-bicep

action-groups

action-rules

aad-domain-services

View all from publisher

Kickstart your project with AVM templates.

Report Package load-testing-service

Load Testing Service [Microsoft.LoadTestService/loadTests]

Navigation

Resource Types

Usage examples

Example 1: Using only defaults

Example 2: Using large parameter set

Example 3: Using Customer-Managed-Keys with User-Assigned identity

Example 4: WAF-aligned

Parameters

Parameter: name

Parameter: customerManagedKey

Parameter: customerManagedKey.keyName

Parameter: customerManagedKey.keyVaultResourceId

Parameter: customerManagedKey.keyVersion

Parameter: customerManagedKey.userAssignedIdentityResourceId

Parameter: enableTelemetry

Parameter: loadTestDescription

Parameter: location

Parameter: lock

Parameter: lock.kind

Parameter: lock.name

Parameter: managedIdentities

Parameter: managedIdentities.systemAssigned

Parameter: managedIdentities.userAssignedResourceIds

Parameter: roleAssignments

Parameter: roleAssignments.principalId

Parameter: roleAssignments.roleDefinitionIdOrName

Parameter: roleAssignments.condition

Parameter: roleAssignments.conditionVersion

Parameter: roleAssignments.delegatedManagedIdentityResourceId

Parameter: roleAssignments.description

Parameter: roleAssignments.name

Parameter: roleAssignments.principalType

Parameter: tags

Outputs

Cross-referenced modules

Data Collection

Stats

avm-bicep

Other versions (2)

Other packages

from avm-bicep

Load Testing Service `[Microsoft.LoadTestService/loadTests]`

Parameter: `name`

Parameter: `customerManagedKey`

Parameter: `customerManagedKey.keyName`

Parameter: `customerManagedKey.keyVaultResourceId`

Parameter: `customerManagedKey.keyVersion`

Parameter: `customerManagedKey.userAssignedIdentityResourceId`

Parameter: `enableTelemetry`

Parameter: `loadTestDescription`

Parameter: `location`

Parameter: `lock`

Parameter: `lock.kind`

Parameter: `lock.name`

Parameter: `managedIdentities`

Parameter: `managedIdentities.systemAssigned`

Parameter: `managedIdentities.userAssignedResourceIds`

Parameter: `roleAssignments`

Parameter: `roleAssignments.principalId`

Parameter: `roleAssignments.roleDefinitionIdOrName`

Parameter: `roleAssignments.condition`

Parameter: `roleAssignments.conditionVersion`

Parameter: `roleAssignments.delegatedManagedIdentityResourceId`

Parameter: `roleAssignments.description`

Parameter: `roleAssignments.name`

Parameter: `roleAssignments.principalType`

Parameter: `tags`