Microsoft.LoadTestService loadTests 2023-12-01-preview
Bicep resource definition
The loadTests resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.LoadTestService/loadTests resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.LoadTestService/loadTests@2023-12-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
description: 'string'
encryption: {
identity: {
resourceId: 'string'
type: 'string'
}
keyUrl: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property values
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| identity | All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. | EncryptionPropertiesIdentity |
| keyUrl | key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. | string |
EncryptionPropertiesIdentity
| Name | Description | Value |
|---|---|---|
| resourceId | User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. | string |
| type | Managed identity type to use for accessing encryption key Url. | 'SystemAssigned' 'UserAssigned' |
LoadTestProperties
| Name | Description | Value |
|---|---|---|
| description | Description of the resource. | string Constraints: Max length = |
| encryption | CMK Encryption property. | EncryptionProperties |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
Microsoft.LoadTestService/loadTests
| Name | Description | Value |
|---|---|---|
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The resource-specific properties for this resource. | LoadTestProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
ARM template resource definition
The loadTests resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.LoadTestService/loadTests resource, add the following JSON to your template.
{
"type": "Microsoft.LoadTestService/loadTests",
"apiVersion": "2023-12-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"description": "string",
"encryption": {
"identity": {
"resourceId": "string",
"type": "string"
},
"keyUrl": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property values
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| identity | All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. | EncryptionPropertiesIdentity |
| keyUrl | key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. | string |
EncryptionPropertiesIdentity
| Name | Description | Value |
|---|---|---|
| resourceId | User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. | string |
| type | Managed identity type to use for accessing encryption key Url. | 'SystemAssigned' 'UserAssigned' |
LoadTestProperties
| Name | Description | Value |
|---|---|---|
| description | Description of the resource. | string Constraints: Max length = |
| encryption | CMK Encryption property. | EncryptionProperties |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
Microsoft.LoadTestService/loadTests
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-12-01-preview' |
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The resource-specific properties for this resource. | LoadTestProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.LoadTestService/loadTests' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The loadTests resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.LoadTestService/loadTests resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.LoadTestService/loadTests@2023-12-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
description = "string"
encryption = {
identity = {
resourceId = "string"
type = "string"
}
keyUrl = "string"
}
}
})
}
Property values
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| identity | All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. | EncryptionPropertiesIdentity |
| keyUrl | key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. | string |
EncryptionPropertiesIdentity
| Name | Description | Value |
|---|---|---|
| resourceId | User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. | string |
| type | Managed identity type to use for accessing encryption key Url. | 'SystemAssigned' 'UserAssigned' |
LoadTestProperties
| Name | Description | Value |
|---|---|---|
| description | Description of the resource. | string Constraints: Max length = |
| encryption | CMK Encryption property. | EncryptionProperties |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
Microsoft.LoadTestService/loadTests
| Name | Description | Value |
|---|---|---|
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | The resource-specific properties for this resource. | LoadTestProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.LoadTestService/loadTests@2023-12-01-preview" |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|