Package com.azure.developer.loadtesting

Class LoadTestAdministrationClient

java.lang.Object

com.azure.developer.loadtesting.LoadTestAdministrationClient

public final class LoadTestAdministrationClient
extends Object

Initializes a new instance of the synchronous LoadTestingClient type.

Method Summary

Modifier and Type	Method	Description
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	createOrUpdateAppComponentsWithResponse(String name, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Associate an App Component (Azure resource) to a test or test run.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	createOrUpdateServerMetricsConfigWithResponse(String name, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Configure server metrics for a test or test run.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	createOrUpdateTestWithResponse(String testId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Create a new test or Update an existing test.
com.azure.core.http.rest.Response<Void>	deleteAppComponentWithResponse(String name, com.azure.core.http.rest.RequestOptions requestOptions)	Delete an App Component.
com.azure.core.http.rest.Response<Void>	deleteLoadTestWithResponse(String testId, com.azure.core.http.rest.RequestOptions requestOptions)	Delete a test by its name.
com.azure.core.http.rest.Response<Void>	deleteServerMetricsWithResponse(String name, com.azure.core.http.rest.RequestOptions requestOptions)	Delete server metrics configuration by its name.
com.azure.core.http.rest.Response<Void>	deleteTestFileWithResponse(String testId, String fileId, com.azure.core.http.rest.RequestOptions requestOptions)	Delete file by the file name for a test.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getAppComponentByNameWithResponse(String name, com.azure.core.http.rest.RequestOptions requestOptions)	Get App Component details by App Component name.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getAppComponentWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)	Get App Components for a test or a test run by its name.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getLoadTestWithResponse(String testId, com.azure.core.http.rest.RequestOptions requestOptions)	Get load test details by test name.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getServerDefaultMetricsWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)	Get all default server metrics configuration for supported resource types.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getServerMetricsByNameWithResponse(String name, com.azure.core.http.rest.RequestOptions requestOptions)	Get server metrics configuration by its name.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getServerMetricsWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)	Get server metrics configuration for a test or test run by its name.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getTestFileWithResponse(String testId, String fileId, com.azure.core.http.rest.RequestOptions requestOptions)	Get test file by the file name.
com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>	listLoadTestSearch(com.azure.core.http.rest.RequestOptions requestOptions)	Get all load tests by the fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	listSupportedResourceTypeWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)	Get all supported resource types for App Components(Azure resource types).
com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>	listTestFiles(String testId, com.azure.core.http.rest.RequestOptions requestOptions)	List all test files.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	uploadTestFileWithResponse(String testId, String fileId, String fileName, com.azure.core.util.BinaryData file, com.azure.core.http.rest.RequestOptions requestOptions)	Upload input file for a given test name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createOrUpdateAppComponentsWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createOrUpdateAppComponentsWithResponse(String name,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Associate an App Component (Azure resource) to a test or test run.

Request Body Schema

 {
     resourceId: String (Optional)
     testId: String (Optional)
     testRunId: String (Optional)
     name: String (Optional)
     value (Required): {
         String (Required): {
             resourceId: String (Required)
             resourceName: String (Required)
             resourceType: String (Required)
             displayName: String (Optional)
             resourceGroup: String (Optional)
             subscriptionId: String (Optional)
             kind: String (Optional)
         }
     }
 }
 

Response Body Schema

 {
     resourceId: String (Optional)
     testId: String (Optional)
     testRunId: String (Optional)
     name: String (Optional)
     value (Required): {
         String (Required): {
             resourceId: String (Required)
             resourceName: String (Required)
             resourceType: String (Required)
             displayName: String (Optional)
             resourceGroup: String (Optional)
             subscriptionId: String (Optional)
             kind: String (Optional)
         }
     }
 }
 

Parameters:

name - Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$.

body - App Component model.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

app Components model along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

deleteAppComponentWithResponse

public com.azure.core.http.rest.Response<Void> deleteAppComponentWithResponse(String name,
 com.azure.core.http.rest.RequestOptions requestOptions)

Delete an App Component.

Parameters:

name - Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getAppComponentByNameWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getAppComponentByNameWithResponse(String name,
 com.azure.core.http.rest.RequestOptions requestOptions)

Get App Component details by App Component name.

Response Body Schema

 {
     resourceId: String (Optional)
     testId: String (Optional)
     testRunId: String (Optional)
     name: String (Optional)
     value (Required): {
         String (Required): {
             resourceId: String (Required)
             resourceName: String (Required)
             resourceType: String (Required)
             displayName: String (Optional)
             resourceGroup: String (Optional)
             subscriptionId: String (Optional)
             kind: String (Optional)
         }
     }
 }
 

Parameters:

name - Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

app Component details by App Component name along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getAppComponentWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getAppComponentWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)

Get App Components for a test or a test run by its name.

Query Parameters

Query Parameters

Name	Type	Required	Description
testRunId	String	No	[Required, if testId is not provided] Test run Id.
testId	String	No	Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 {
     resourceId: String (Optional)
     testId: String (Optional)
     testRunId: String (Optional)
     name: String (Optional)
     value (Required): {
         String (Required): {
             resourceId: String (Required)
             resourceName: String (Required)
             resourceType: String (Required)
             displayName: String (Optional)
             resourceGroup: String (Optional)
             subscriptionId: String (Optional)
             kind: String (Optional)
         }
     }
 }
 

Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

app Components for a test or a test run by its name along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

createOrUpdateServerMetricsConfigWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createOrUpdateServerMetricsConfigWithResponse(String name,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Configure server metrics for a test or test run.

Request Body Schema

 {
     name: String (Optional)
     testId: String (Optional)
     testRunId: String (Optional)
     metrics (Optional): {
         String (Optional): {
             id: String (Optional)
             resourceId: String (Required)
             metricnamespace: String (Required)
             displayDescription: String (Optional)
             name (Required): {
                 value: String (Required)
                 localizedValue: String (Required)
             }
             aggregation: String (Required)
             unit: String (Optional)
             resourceType: String (Required)
         }
     }
 }
 

Response Body Schema

 {
     name: String (Optional)
     testId: String (Optional)
     testRunId: String (Optional)
     metrics (Optional): {
         String (Optional): {
             id: String (Optional)
             resourceId: String (Required)
             metricnamespace: String (Required)
             displayDescription: String (Optional)
             name (Required): {
                 value: String (Required)
                 localizedValue: String (Required)
             }
             aggregation: String (Required)
             unit: String (Optional)
             resourceType: String (Required)
         }
     }
 }
 

Parameters:

name - Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$.

body - Server metrics configuration model.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

server metrics config model along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getServerMetricsByNameWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getServerMetricsByNameWithResponse(String name,
 com.azure.core.http.rest.RequestOptions requestOptions)

Get server metrics configuration by its name.

Response Body Schema

 {
     name: String (Optional)
     testId: String (Optional)
     testRunId: String (Optional)
     metrics (Optional): {
         String (Optional): {
             id: String (Optional)
             resourceId: String (Required)
             metricnamespace: String (Required)
             displayDescription: String (Optional)
             name (Required): {
                 value: String (Required)
                 localizedValue: String (Required)
             }
             aggregation: String (Required)
             unit: String (Optional)
             resourceType: String (Required)
         }
     }
 }
 

Parameters:

name - Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

server metrics configuration by its name along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

deleteServerMetricsWithResponse

public com.azure.core.http.rest.Response<Void> deleteServerMetricsWithResponse(String name,
 com.azure.core.http.rest.RequestOptions requestOptions)

Delete server metrics configuration by its name.

Parameters:

name - Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getServerMetricsWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getServerMetricsWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)

Get server metrics configuration for a test or test run by its name.

Query Parameters

Query Parameters

Name	Type	Required	Description
testRunId	String	No	[Required, if testId is not provided] Test run Id.
testId	String	No	Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 {
     name: String (Optional)
     testId: String (Optional)
     testRunId: String (Optional)
     metrics (Optional): {
         String (Optional): {
             id: String (Optional)
             resourceId: String (Required)
             metricnamespace: String (Required)
             displayDescription: String (Optional)
             name (Required): {
                 value: String (Required)
                 localizedValue: String (Required)
             }
             aggregation: String (Required)
             unit: String (Optional)
             resourceType: String (Required)
         }
     }
 }
 

Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

server metrics configuration for a test or test run by its name along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getServerDefaultMetricsWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getServerDefaultMetricsWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)

Get all default server metrics configuration for supported resource types.

Response Body Schema

 {
     defaultMetrics (Optional): {
         String (Optional): [
              (Optional){
                 metricnamespace: String (Optional)
                 aggregation: String (Optional)
                 name (Optional): {
                     value: String (Optional)
                     localizedValue: String (Optional)
                 }
                 unit: String (Optional)
                 displayDescription: String (Optional)
             }
         ]
     }
 }
 

Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

all default server metrics configuration for supported resource types along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

listSupportedResourceTypeWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> listSupportedResourceTypeWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)

Get all supported resource types for App Components(Azure resource types).

Response Body Schema

 {
     value (Optional): [
         String (Optional)
     ]
 }
 

Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

all supported resource types for App Components(Azure resource types) along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

createOrUpdateTestWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createOrUpdateTestWithResponse(String testId,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Create a new test or Update an existing test.

Request Body Schema

 {
     testId: String (Optional)
     description: String (Optional)
     displayName: String (Optional)
     resourceId: String (Optional)
     loadTestConfig (Optional): {
         engineInstances: Integer (Optional)
         splitAllCSVs: Boolean (Optional)
     }
     passFailCriteria (Optional): {
         passFailMetrics (Optional): {
             String (Optional): {
                 clientmetric: String (Optional)
                 aggregate: String (Optional)
                 condition: String (Optional)
                 requestName: String (Optional)
                 value: Double (Optional)
                 action: String (Optional)
                 actualValue: Double (Optional)
                 result: String (Optional)
             }
         }
     }
     createdDateTime: OffsetDateTime (Optional)
     createdBy: String (Optional)
     lastModifiedDateTime: OffsetDateTime (Optional)
     lastModifiedBy: String (Optional)
     inputArtifacts (Optional): {
         configUrl (Optional): {
             url: String (Optional)
             fileId: String (Optional)
             filename: String (Optional)
             fileType: String(0/1/2) (Optional)
             expireTime: OffsetDateTime (Optional)
             validationStatus: String (Optional)
         }
         testScriptUrl (Optional): (recursive schema, see testScriptUrl above)
         userPropUrl (Optional): (recursive schema, see userPropUrl above)
         inputArtifactsZipFileurl (Optional): (recursive schema, see inputArtifactsZipFileurl above)
         additionalUrls (Optional): [
             (recursive schema, see above)
         ]
     }
     secrets (Optional): {
         String (Optional): {
             value: String (Optional)
             type: String (Optional)
         }
     }
     environmentVariables (Optional): {
         String: String (Optional)
     }
     subnetId: String (Optional)
     keyvaultReferenceIdentityType: String (Optional)
     keyvaultReferenceIdentityId: String (Optional)
 }
 

Response Body Schema

 {
     testId: String (Optional)
     description: String (Optional)
     displayName: String (Optional)
     resourceId: String (Optional)
     loadTestConfig (Optional): {
         engineInstances: Integer (Optional)
         splitAllCSVs: Boolean (Optional)
     }
     passFailCriteria (Optional): {
         passFailMetrics (Optional): {
             String (Optional): {
                 clientmetric: String (Optional)
                 aggregate: String (Optional)
                 condition: String (Optional)
                 requestName: String (Optional)
                 value: Double (Optional)
                 action: String (Optional)
                 actualValue: Double (Optional)
                 result: String (Optional)
             }
         }
     }
     createdDateTime: OffsetDateTime (Optional)
     createdBy: String (Optional)
     lastModifiedDateTime: OffsetDateTime (Optional)
     lastModifiedBy: String (Optional)
     inputArtifacts (Optional): {
         configUrl (Optional): {
             url: String (Optional)
             fileId: String (Optional)
             filename: String (Optional)
             fileType: String(0/1/2) (Optional)
             expireTime: OffsetDateTime (Optional)
             validationStatus: String (Optional)
         }
         testScriptUrl (Optional): (recursive schema, see testScriptUrl above)
         userPropUrl (Optional): (recursive schema, see userPropUrl above)
         inputArtifactsZipFileurl (Optional): (recursive schema, see inputArtifactsZipFileurl above)
         additionalUrls (Optional): [
             (recursive schema, see above)
         ]
     }
     secrets (Optional): {
         String (Optional): {
             value: String (Optional)
             type: String (Optional)
         }
     }
     environmentVariables (Optional): {
         String: String (Optional)
     }
     subnetId: String (Optional)
     keyvaultReferenceIdentityType: String (Optional)
     keyvaultReferenceIdentityId: String (Optional)
 }
 

Parameters:

testId - Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$.

body - Load test model.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

load test model along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

deleteLoadTestWithResponse

public com.azure.core.http.rest.Response<Void> deleteLoadTestWithResponse(String testId,
 com.azure.core.http.rest.RequestOptions requestOptions)

Delete a test by its name.

Parameters:

testId - Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getLoadTestWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getLoadTestWithResponse(String testId,
 com.azure.core.http.rest.RequestOptions requestOptions)

Get load test details by test name.

Response Body Schema

 {
     testId: String (Optional)
     description: String (Optional)
     displayName: String (Optional)
     resourceId: String (Optional)
     loadTestConfig (Optional): {
         engineInstances: Integer (Optional)
         splitAllCSVs: Boolean (Optional)
     }
     passFailCriteria (Optional): {
         passFailMetrics (Optional): {
             String (Optional): {
                 clientmetric: String (Optional)
                 aggregate: String (Optional)
                 condition: String (Optional)
                 requestName: String (Optional)
                 value: Double (Optional)
                 action: String (Optional)
                 actualValue: Double (Optional)
                 result: String (Optional)
             }
         }
     }
     createdDateTime: OffsetDateTime (Optional)
     createdBy: String (Optional)
     lastModifiedDateTime: OffsetDateTime (Optional)
     lastModifiedBy: String (Optional)
     inputArtifacts (Optional): {
         configUrl (Optional): {
             url: String (Optional)
             fileId: String (Optional)
             filename: String (Optional)
             fileType: String(0/1/2) (Optional)
             expireTime: OffsetDateTime (Optional)
             validationStatus: String (Optional)
         }
         testScriptUrl (Optional): (recursive schema, see testScriptUrl above)
         userPropUrl (Optional): (recursive schema, see userPropUrl above)
         inputArtifactsZipFileurl (Optional): (recursive schema, see inputArtifactsZipFileurl above)
         additionalUrls (Optional): [
             (recursive schema, see above)
         ]
     }
     secrets (Optional): {
         String (Optional): {
             value: String (Optional)
             type: String (Optional)
         }
     }
     environmentVariables (Optional): {
         String: String (Optional)
     }
     subnetId: String (Optional)
     keyvaultReferenceIdentityType: String (Optional)
     keyvaultReferenceIdentityId: String (Optional)
 }
 

Parameters:

testId - Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

load test details by test name along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

uploadTestFileWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> uploadTestFileWithResponse(String testId,
 String fileId,
 String fileName,
 com.azure.core.util.BinaryData file,
 com.azure.core.http.rest.RequestOptions requestOptions)
                                                                                             throws IOException

Upload input file for a given test name. File size can't be more than 50 MB. Existing file with same name for the given test will be overwritten. File should be provided in the request body as multipart/form-data.

Query Parameters

Query Parameters

Name	Type	Required	Description
fileType	Integer	No	Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS).

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Request Body Schema

 BinaryData
 

Response Body Schema

 {
     url: String (Optional)
     fileId: String (Optional)
     filename: String (Optional)
     fileType: String(0/1/2) (Optional)
     expireTime: OffsetDateTime (Optional)
     validationStatus: String (Optional)
 }
 

Parameters:

testId - Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$.

fileId - Unique identifier for test file, must be a valid URL character ^[a-z0-9_-]*$.

fileName - Name of test file, must be a valid URL character ^[a-z0-9_-]*$.

file - The file to be uploaded.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

fileUrl Model along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

IOException - thrown if the multipart/form-data body cannot be constructed from file.

getTestFileWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getTestFileWithResponse(String testId,
 String fileId,
 com.azure.core.http.rest.RequestOptions requestOptions)

Get test file by the file name.

Response Body Schema

 {
     url: String (Optional)
     fileId: String (Optional)
     filename: String (Optional)
     fileType: String(0/1/2) (Optional)
     expireTime: OffsetDateTime (Optional)
     validationStatus: String (Optional)
 }
 

Parameters:

testId - Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$.

fileId - Unique identifier for test file, must be a valid URL character ^[a-z0-9_-]*$.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

test file by the file name along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

deleteTestFileWithResponse

public com.azure.core.http.rest.Response<Void> deleteTestFileWithResponse(String testId,
 String fileId,
 com.azure.core.http.rest.RequestOptions requestOptions)

Delete file by the file name for a test.

Parameters:

testId - Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$.

fileId - Unique identifier for test file, must be a valid URL character ^[a-z0-9_-]*$.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

listLoadTestSearch

public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listLoadTestSearch(com.azure.core.http.rest.RequestOptions requestOptions)

Get all load tests by the fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.

Query Parameters

Query Parameters

Name	Type	Required	Description
orderBy	String	No	Sort on one of the field - lastModifiedDateTime, displayName, createdBy in (field asc/desc) format. eg: displayName asc.
search	String	No	Filter search based on searchable fields - testId, createdBy.
lastUpdatedStartTime	OffsetDateTime	No	Start DateTime(ISO 8601 literal format) of the last updated time range to filter tests.
lastUpdatedEndTime	OffsetDateTime	No	End DateTime(ISO 8601 literal format) of the last updated time range to filter tests.
continuationToken	String	No	Continuation token to get the next page of response.
maxPageSize	Integer	No	Number of results in response.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 {
     value (Required): [
          (Required){
             testId: String (Optional)
             description: String (Optional)
             displayName: String (Optional)
             resourceId: String (Optional)
             loadTestConfig (Optional): {
                 engineInstances: Integer (Optional)
                 splitAllCSVs: Boolean (Optional)
             }
             passFailCriteria (Optional): {
                 passFailMetrics (Optional): {
                     String (Optional): {
                         clientmetric: String (Optional)
                         aggregate: String (Optional)
                         condition: String (Optional)
                         requestName: String (Optional)
                         value: Double (Optional)
                         action: String (Optional)
                         actualValue: Double (Optional)
                         result: String (Optional)
                     }
                 }
             }
             createdDateTime: OffsetDateTime (Optional)
             createdBy: String (Optional)
             lastModifiedDateTime: OffsetDateTime (Optional)
             lastModifiedBy: String (Optional)
             inputArtifacts (Optional): {
                 configUrl (Optional): {
                     url: String (Optional)
                     fileId: String (Optional)
                     filename: String (Optional)
                     fileType: String(0/1/2) (Optional)
                     expireTime: OffsetDateTime (Optional)
                     validationStatus: String (Optional)
                 }
                 testScriptUrl (Optional): (recursive schema, see testScriptUrl above)
                 userPropUrl (Optional): (recursive schema, see userPropUrl above)
                 inputArtifactsZipFileurl (Optional): (recursive schema, see inputArtifactsZipFileurl above)
                 additionalUrls (Optional): [
                     (recursive schema, see above)
                 ]
             }
             secrets (Optional): {
                 String (Optional): {
                     value: String (Optional)
                     type: String (Optional)
                 }
             }
             environmentVariables (Optional): {
                 String: String (Optional)
             }
             subnetId: String (Optional)
             keyvaultReferenceIdentityType: String (Optional)
             keyvaultReferenceIdentityId: String (Optional)
         }
     ]
     nextLink: String (Optional)
 }
 

Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

all load tests by the fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName} as paginated response with PagedIterable.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

listTestFiles

public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listTestFiles(String testId,
 com.azure.core.http.rest.RequestOptions requestOptions)

List all test files.

Query Parameters

Query Parameters

Name	Type	Required	Description
continuationToken	String	No	Continuation token to get the next page of response.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 {
     value (Required): [
          (Required){
             url: String (Optional)
             fileId: String (Optional)
             filename: String (Optional)
             fileType: String(0/1/2) (Optional)
             expireTime: OffsetDateTime (Optional)
             validationStatus: String (Optional)
         }
     ]
     nextLink: String (Optional)
 }
 

Parameters:

testId - Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

all test files as paginated response with PagedIterable.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.