Microsoft.LoadTestService (preview:2024-12-01)

2025/02/24 • 23 new methods

LoadTestMappings_List (new)
Description :  List LoadTestMappingResource resources by parent
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.LoadTestService/loadTestMappings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LoadTestMappingResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
sourceResourceId:
{
Description: Mapped source resource Id. ,
Required: False ,
}
string ,
azureLoadTestingResourceId:
{
Description: Mapped Azure Load Test resource Id. ,
Required: False ,
}
string ,
testId:
{
Description: Mapped Azure Load Test resource test-id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTestMappings_Get (new)
Description :  Get a LoadTestMappingResource
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.LoadTestService/loadTestMappings/{loadTestMappingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
loadTestMappingName:
{
Description: Load Test Mapping name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
sourceResourceId:
{
Description: Mapped source resource Id. ,
Required: False ,
}
string ,
azureLoadTestingResourceId:
{
Description: Mapped Azure Load Test resource Id. ,
Required: False ,
}
string ,
testId:
{
Description: Mapped Azure Load Test resource test-id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTestMappings_CreateOrUpdate (new)
Description :  Create a LoadTestMappingResource
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.LoadTestService/loadTestMappings/{loadTestMappingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
loadTestMappingName:
{
Description: Load Test Mapping name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
sourceResourceId:
{
Description: Mapped source resource Id. ,
Required: False ,
}
string ,
azureLoadTestingResourceId:
{
Description: Mapped Azure Load Test resource Id. ,
Required: False ,
}
string ,
testId:
{
Description: Mapped Azure Load Test resource test-id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
sourceResourceId:
{
Description: Mapped source resource Id. ,
Required: False ,
}
string ,
azureLoadTestingResourceId:
{
Description: Mapped Azure Load Test resource Id. ,
Required: False ,
}
string ,
testId:
{
Description: Mapped Azure Load Test resource test-id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
sourceResourceId:
{
Description: Mapped source resource Id. ,
Required: False ,
}
string ,
azureLoadTestingResourceId:
{
Description: Mapped Azure Load Test resource Id. ,
Required: False ,
}
string ,
testId:
{
Description: Mapped Azure Load Test resource test-id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTestMappings_Update (new)
Description :  Update a LoadTestMappingResource
Reference :  Link ¶

⚼ Request

PATCH:  /{resourceUri}/providers/Microsoft.LoadTestService/loadTestMappings/{loadTestMappingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
loadTestMappingName:
{
Description: Load Test Mapping name ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
sourceResourceId:
{
Description: Mapped source resource Id. ,
Required: False ,
}
string ,
azureLoadTestingResourceId:
{
Description: Mapped Azure Load Test resource Id. ,
Required: False ,
}
string ,
testId:
{
Description: Mapped Azure Load Test resource test-id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
sourceResourceId:
{
Description: Mapped source resource Id. ,
Required: False ,
}
string ,
azureLoadTestingResourceId:
{
Description: Mapped Azure Load Test resource Id. ,
Required: False ,
}
string ,
testId:
{
Description: Mapped Azure Load Test resource test-id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTestMappings_Delete (new)
Description :  Delete a LoadTestMappingResource
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.LoadTestService/loadTestMappings/{loadTestMappingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
loadTestMappingName:
{
Description: Load Test Mapping name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTestProfileMappings_List (new)
Description :  List LoadTestProfileMappingResource resources by parent
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.LoadTestService/loadTestProfileMappings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LoadTestProfileMappingResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
sourceResourceId:
{
Description: Mapped source resource Id. ,
Required: False ,
}
string ,
azureLoadTestingResourceId:
{
Description: Mapped Azure Load Test resource Id. ,
Required: False ,
}
string ,
testProfileId:
{
Description: Mapped Azure Load Test resource test-profile-id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTestProfileMappings_Get (new)
Description :  Get a LoadTestProfileMappingResource
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.LoadTestService/loadTestProfileMappings/{loadTestProfileMappingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
loadTestProfileMappingName:
{
Description: Load Test Profile Mapping name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
sourceResourceId:
{
Description: Mapped source resource Id. ,
Required: False ,
}
string ,
azureLoadTestingResourceId:
{
Description: Mapped Azure Load Test resource Id. ,
Required: False ,
}
string ,
testProfileId:
{
Description: Mapped Azure Load Test resource test-profile-id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTestProfileMappings_CreateOrUpdate (new)
Description :  Create a LoadTestProfileMappingResource
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.LoadTestService/loadTestProfileMappings/{loadTestProfileMappingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
loadTestProfileMappingName:
{
Description: Load Test Profile Mapping name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
sourceResourceId:
{
Description: Mapped source resource Id. ,
Required: False ,
}
string ,
azureLoadTestingResourceId:
{
Description: Mapped Azure Load Test resource Id. ,
Required: False ,
}
string ,
testProfileId:
{
Description: Mapped Azure Load Test resource test-profile-id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
sourceResourceId:
{
Description: Mapped source resource Id. ,
Required: False ,
}
string ,
azureLoadTestingResourceId:
{
Description: Mapped Azure Load Test resource Id. ,
Required: False ,
}
string ,
testProfileId:
{
Description: Mapped Azure Load Test resource test-profile-id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
sourceResourceId:
{
Description: Mapped source resource Id. ,
Required: False ,
}
string ,
azureLoadTestingResourceId:
{
Description: Mapped Azure Load Test resource Id. ,
Required: False ,
}
string ,
testProfileId:
{
Description: Mapped Azure Load Test resource test-profile-id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTestProfileMappings_Update (new)
Description :  Update a LoadTestProfileMappingResource
Reference :  Link ¶

⚼ Request

PATCH:  /{resourceUri}/providers/Microsoft.LoadTestService/loadTestProfileMappings/{loadTestProfileMappingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
loadTestProfileMappingName:
{
Description: Load Test Profile Mapping name ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
sourceResourceId:
{
Description: Mapped source resource Id. ,
Required: False ,
}
string ,
azureLoadTestingResourceId:
{
Description: Mapped Azure Load Test resource Id. ,
Required: False ,
}
string ,
testProfileId:
{
Description: Mapped Azure Load Test resource test-profile-id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
sourceResourceId:
{
Description: Mapped source resource Id. ,
Required: False ,
}
string ,
azureLoadTestingResourceId:
{
Description: Mapped Azure Load Test resource Id. ,
Required: False ,
}
string ,
testProfileId:
{
Description: Mapped Azure Load Test resource test-profile-id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTestProfileMappings_Delete (new)
Description :  Delete a LoadTestProfileMappingResource
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.LoadTestService/loadTestProfileMappings/{loadTestProfileMappingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
loadTestProfileMappingName:
{
Description: Load Test Profile Mapping name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.LoadTestService/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTests_ListBySubscription (new)
Description :  List LoadTestResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LoadTestService/loadTests
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LoadTestResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleted: Deleted state. ,
}
,
Required: False ,
}
enum ,
dataPlaneURI:
{
Description: Resource data plane URI. ,
Required: False ,
}
string ,
encryption:
{
Description: CMK Encryption property. ,
Required: False ,
}
{
identity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
type:
{
Description: Managed identity type to use for accessing encryption key Url. ,
Enum:
{
SystemAssigned: System assigned identity. ,
UserAssigned: User assigned identity. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Quotas_List (new)
Description :  List quotas for a given subscription Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LoadTestService/locations/{location}/quotas
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The QuotaResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
limit:
{
Description: Current quota limit of the quota bucket. ,
Format: int32 ,
Required: False ,
}
integer ,
usage:
{
Description: Current quota usage of the quota bucket. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleted: Deleted state. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Quotas_Get (new)
Description :  Get the available quota for a quota bucket per region per subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.LoadTestService/locations/{location}/quotas/{quotaBucketName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
quotaBucketName:
{
Description: The quota name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
limit:
{
Description: Current quota limit of the quota bucket. ,
Format: int32 ,
Required: False ,
}
integer ,
usage:
{
Description: Current quota usage of the quota bucket. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleted: Deleted state. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Quotas_CheckAvailability (new)
Description :  Check Quota Availability on quota bucket per region per subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.LoadTestService/locations/{location}/quotas/{quotaBucketName}/checkAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
quotaBucketName:
{
Description: The quota name. ,
Required: True ,
}
string ,
QuotaBucketRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
properties:
{
Description: Request object of new quota for a quota bucket. ,
Required: False ,
}
{
currentUsage:
{
Description: Current quota usage of the quota bucket. ,
Format: int32 ,
Required: False ,
}
integer ,
currentQuota:
{
Description: Current quota limit of the quota bucket. ,
Format: int32 ,
Required: False ,
}
integer ,
newQuota:
{
Description: New quota limit of the quota bucket. ,
Format: int32 ,
Required: False ,
}
integer ,
dimensions:
{
Description: Dimensions for new quota request. ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id dimension for new quota request of the quota bucket. ,
Required: False ,
}
string ,
location:
{
Description: Location dimension for new quota request of the quota bucket. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Required: True ,
}
string ,
type:
{
Description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ,
Required: True ,
}
string ,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Check quota availability response properties. ,
Required: False ,
}
{
isAvailable:
{
Description: True/False indicating whether the quota request be granted based on availability. ,
Required: False ,
}
boolean ,
availabilityStatus:
{
Description: Message indicating additional details to add to quota support request. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTests_ListByResourceGroup (new)
Description :  List LoadTestResource resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LoadTestResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleted: Deleted state. ,
}
,
Required: False ,
}
enum ,
dataPlaneURI:
{
Description: Resource data plane URI. ,
Required: False ,
}
string ,
encryption:
{
Description: CMK Encryption property. ,
Required: False ,
}
{
identity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
type:
{
Description: Managed identity type to use for accessing encryption key Url. ,
Enum:
{
SystemAssigned: System assigned identity. ,
UserAssigned: User assigned identity. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTests_Get (new)
Description :  Get a LoadTestResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests/{loadTestName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
loadTestName:
{
Description: Load Test name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleted: Deleted state. ,
}
,
Required: False ,
}
enum ,
dataPlaneURI:
{
Description: Resource data plane URI. ,
Required: False ,
}
string ,
encryption:
{
Description: CMK Encryption property. ,
Required: False ,
}
{
identity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
type:
{
Description: Managed identity type to use for accessing encryption key Url. ,
Enum:
{
SystemAssigned: System assigned identity. ,
UserAssigned: User assigned identity. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTests_CreateOrUpdate (new)
Description :  Create a LoadTestResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests/{loadTestName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
loadTestName:
{
Description: Load Test name ,
Required: True ,
}
string ,
LoadTestResource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleted: Deleted state. ,
}
,
Required: False ,
}
enum ,
dataPlaneURI:
{
Description: Resource data plane URI. ,
Required: False ,
}
string ,
encryption:
{
Description: CMK Encryption property. ,
Required: False ,
}
{
identity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
type:
{
Description: Managed identity type to use for accessing encryption key Url. ,
Enum:
{
SystemAssigned: System assigned identity. ,
UserAssigned: User assigned identity. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleted: Deleted state. ,
}
,
Required: False ,
}
enum ,
dataPlaneURI:
{
Description: Resource data plane URI. ,
Required: False ,
}
string ,
encryption:
{
Description: CMK Encryption property. ,
Required: False ,
}
{
identity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
type:
{
Description: Managed identity type to use for accessing encryption key Url. ,
Enum:
{
SystemAssigned: System assigned identity. ,
UserAssigned: User assigned identity. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: LoadTest details. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleted: Deleted state. ,
}
,
Required: False ,
}
enum ,
dataPlaneURI:
{
Description: Resource data plane URI. ,
Required: False ,
}
string ,
encryption:
{
Description: CMK Encryption property. ,
Required: False ,
}
{
identity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
type:
{
Description: Managed identity type to use for accessing encryption key Url. ,
Enum:
{
SystemAssigned: System assigned identity. ,
UserAssigned: User assigned identity. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTests_Update (new)
Description :  Update a LoadTestResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests/{loadTestName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
loadTestName:
{
Description: Load Test name ,
Required: True ,
}
string ,
LoadTestResourcePatchRequestBody:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the resource. ,
Required: False ,
}
string ,
encryption:
{
Description: CMK Encryption property. ,
Required: False ,
}
{
identity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
type:
{
Description: Managed identity type to use for accessing encryption key Url. ,
Enum:
{
SystemAssigned: System assigned identity. ,
UserAssigned: User assigned identity. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleted: Deleted state. ,
}
,
Required: False ,
}
enum ,
dataPlaneURI:
{
Description: Resource data plane URI. ,
Required: False ,
}
string ,
encryption:
{
Description: CMK Encryption property. ,
Required: False ,
}
{
identity:
{
Description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. ,
Required: False ,
}
{
type:
{
Description: Managed identity type to use for accessing encryption key Url. ,
Enum:
{
SystemAssigned: System assigned identity. ,
UserAssigned: User assigned identity. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. ,
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTests_Delete (new)
Description :  Delete a LoadTestResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests/{loadTestName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
loadTestName:
{
Description: Load Test name ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTestsMaxMonthlyVirtualUserHoursLimitsResource_Get (new)
Description :  Get the limit of max monthly virtual user hours for the load testing resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests/{loadTestName}/limits/maxMonthlyVirtualUserHours
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
loadTestName:
{
Description: Load Test name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
limit:
{
Description: Current limit value, with -1 indicating that there is no limit. ,
Format: int32 ,
Required: False ,
}
integer ,
usage:
{
Description: Current usage value. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleted: Deleted state. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTestsMaxMonthlyVirtualUserHoursLimitsResource_Set (new)
Description :  Set the limit of max monthly virtual user hours for the load testing resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests/{loadTestName}/limits/maxMonthlyVirtualUserHours/set
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
loadTestName:
{
Description: Load Test name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
limit:
{
Description: The new maxMonthlyVirtualUserHours limit, with -1 indicating that there is no limit. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
limit:
{
Description: Current limit value, with -1 indicating that there is no limit. ,
Format: int32 ,
Required: False ,
}
integer ,
usage:
{
Description: Current usage value. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleted: Deleted state. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LoadTests_ListOutboundNetworkDependenciesEndpoints (new)
Description :  Lists the endpoints that agents may call as part of load testing.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests/{loadTestName}/outboundNetworkDependenciesEndpoints
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
loadTestName:
{
Description: Load Test name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The OutboundEnvironmentEndpoint items on this page ,
Required: True ,
}
[
{
category:
{
Description: The type of service that Azure Load Testing connects to. ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints for this service to which the Batch service makes outbound calls. ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name of the dependency. Domain names may be fully qualified or may contain a * wildcard. ,
Required: True ,
}
string ,
description:
{
Description: Human-readable supplemental information about the dependency and when it is applicable. ,
Required: False ,
}
string ,
endpointDetails:
{
Description: The list of connection details for this endpoint. ,
Required: False ,
}
[
{
port:
{
Description: The port an endpoint is connected to. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}