@azure-rest/load-testing package
Interfaces
Type Aliases
Functions
Function Details
default(string, TokenCredential, ClientOptions)
Initialize a new instance of the class AzureLoadTestingClient class.
function default(Endpoint: string, credentials: TokenCredential, options?: ClientOptions): AzureLoadTestingClient
Parameters
- Endpoint
-
string
type: string URL to perform data plane API operations on the resource.
- credentials
- TokenCredential
type: TokenCredential
- options
- ClientOptions
Returns
getLongRunningPoller(AzureLoadTestingClient, TestUploadFile201Response)
function getLongRunningPoller(client: AzureLoadTestingClient, initialResponse: TestUploadFile201Response): Promise<FileUploadAndValidatePoller>
Parameters
- client
- AzureLoadTestingClient
- initialResponse
- TestUploadFile201Response
Returns
Promise<FileUploadAndValidatePoller>
getLongRunningPoller(AzureLoadTestingClient, TestRunCreateOrUpdateSuccessResponse)
function getLongRunningPoller(client: AzureLoadTestingClient, initialResponse: TestRunCreateOrUpdateSuccessResponse): Promise<TestRunCompletionPoller>
Parameters
- client
- AzureLoadTestingClient
- initialResponse
- TestRunCreateOrUpdateSuccessResponse
Returns
Promise<TestRunCompletionPoller>
isUnexpected(TestCreateOrUpdate200Response | TestCreateOrUpdate201Response | TestCreateOrUpdateDefaultResponse)
function isUnexpected(response: TestCreateOrUpdate200Response | TestCreateOrUpdate201Response | TestCreateOrUpdateDefaultResponse): response is TestCreateOrUpdateDefaultResponse
Parameters
Returns
response is TestCreateOrUpdateDefaultResponse
isUnexpected(TestDelete204Response | TestDeleteDefaultResponse)
function isUnexpected(response: TestDelete204Response | TestDeleteDefaultResponse): response is TestDeleteDefaultResponse
Parameters
- response
Returns
response is TestDeleteDefaultResponse
isUnexpected(TestGet200Response | TestGetDefaultResponse)
function isUnexpected(response: TestGet200Response | TestGetDefaultResponse): response is TestGetDefaultResponse
Parameters
- response
Returns
response is TestGetDefaultResponse
isUnexpected(TestList200Response | TestListDefaultResponse)
function isUnexpected(response: TestList200Response | TestListDefaultResponse): response is TestListDefaultResponse
Parameters
- response
Returns
response is TestListDefaultResponse
isUnexpected(TestUploadFile201Response | TestUploadFileDefaultResponse)
function isUnexpected(response: TestUploadFile201Response | TestUploadFileDefaultResponse): response is TestUploadFileDefaultResponse
Parameters
Returns
response is TestUploadFileDefaultResponse
isUnexpected(TestGetFile200Response | TestGetFileDefaultResponse)
function isUnexpected(response: TestGetFile200Response | TestGetFileDefaultResponse): response is TestGetFileDefaultResponse
Parameters
- response
Returns
response is TestGetFileDefaultResponse
isUnexpected(TestDeleteFile204Response | TestDeleteFileDefaultResponse)
function isUnexpected(response: TestDeleteFile204Response | TestDeleteFileDefaultResponse): response is TestDeleteFileDefaultResponse
Parameters
Returns
response is TestDeleteFileDefaultResponse
isUnexpected(TestListFiles200Response | TestListFilesDefaultResponse)
function isUnexpected(response: TestListFiles200Response | TestListFilesDefaultResponse): response is TestListFilesDefaultResponse
Parameters
Returns
response is TestListFilesDefaultResponse
isUnexpected(TestCreateOrUpdateAppComponents200Response | TestCreateOrUpdateAppComponents201Response | TestCreateOrUpdateAppComponentsDefaultResponse)
function isUnexpected(response: TestCreateOrUpdateAppComponents200Response | TestCreateOrUpdateAppComponents201Response | TestCreateOrUpdateAppComponentsDefaultResponse): response is TestCreateOrUpdateAppComponentsDefaultResponse
Parameters
Returns
response is TestCreateOrUpdateAppComponentsDefaultResponse
isUnexpected(TestListAppComponents200Response | TestListAppComponentsDefaultResponse)
function isUnexpected(response: TestListAppComponents200Response | TestListAppComponentsDefaultResponse): response is TestListAppComponentsDefaultResponse
Parameters
Returns
response is TestListAppComponentsDefaultResponse
isUnexpected(TestCreateOrUpdateServerMetricsConfig200Response | TestCreateOrUpdateServerMetricsConfig201Response | TestCreateOrUpdateServerMetricsConfigDefaultResponse)
function isUnexpected(response: TestCreateOrUpdateServerMetricsConfig200Response | TestCreateOrUpdateServerMetricsConfig201Response | TestCreateOrUpdateServerMetricsConfigDefaultResponse): response is TestCreateOrUpdateServerMetricsConfigDefaultResponse
Parameters
Returns
response is TestCreateOrUpdateServerMetricsConfigDefaultResponse
isUnexpected(TestListServerMetricsConfig200Response | TestListServerMetricsConfigDefaultResponse)
function isUnexpected(response: TestListServerMetricsConfig200Response | TestListServerMetricsConfigDefaultResponse): response is TestListServerMetricsConfigDefaultResponse
Parameters
Returns
response is TestListServerMetricsConfigDefaultResponse
isUnexpected(TestRunDelete204Response | TestRunDeleteDefaultResponse)
function isUnexpected(response: TestRunDelete204Response | TestRunDeleteDefaultResponse): response is TestRunDeleteDefaultResponse
Parameters
Returns
response is TestRunDeleteDefaultResponse
isUnexpected(TestRunCreateOrUpdate200Response | TestRunCreateOrUpdate201Response | TestRunCreateOrUpdateDefaultResponse)
function isUnexpected(response: TestRunCreateOrUpdate200Response | TestRunCreateOrUpdate201Response | TestRunCreateOrUpdateDefaultResponse): response is TestRunCreateOrUpdateDefaultResponse
Parameters
Returns
response is TestRunCreateOrUpdateDefaultResponse
isUnexpected(TestRunGet200Response | TestRunGetDefaultResponse)
function isUnexpected(response: TestRunGet200Response | TestRunGetDefaultResponse): response is TestRunGetDefaultResponse
Parameters
- response
Returns
response is TestRunGetDefaultResponse
isUnexpected(TestRunGetFile200Response | TestRunGetFileDefaultResponse)
function isUnexpected(response: TestRunGetFile200Response | TestRunGetFileDefaultResponse): response is TestRunGetFileDefaultResponse
Parameters
Returns
response is TestRunGetFileDefaultResponse
isUnexpected(TestRunList200Response | TestRunListDefaultResponse)
function isUnexpected(response: TestRunList200Response | TestRunListDefaultResponse): response is TestRunListDefaultResponse
Parameters
- response
Returns
response is TestRunListDefaultResponse
isUnexpected(TestRunStop200Response | TestRunStopDefaultResponse)
function isUnexpected(response: TestRunStop200Response | TestRunStopDefaultResponse): response is TestRunStopDefaultResponse
Parameters
- response
Returns
response is TestRunStopDefaultResponse
isUnexpected(TestRunListMetricNamespaces200Response | TestRunListMetricNamespacesDefaultResponse)
function isUnexpected(response: TestRunListMetricNamespaces200Response | TestRunListMetricNamespacesDefaultResponse): response is TestRunListMetricNamespacesDefaultResponse
Parameters
Returns
response is TestRunListMetricNamespacesDefaultResponse
isUnexpected(TestRunListMetricDefinitions200Response | TestRunListMetricDefinitionsDefaultResponse)
function isUnexpected(response: TestRunListMetricDefinitions200Response | TestRunListMetricDefinitionsDefaultResponse): response is TestRunListMetricDefinitionsDefaultResponse
Parameters
Returns
response is TestRunListMetricDefinitionsDefaultResponse
isUnexpected(TestRunListMetrics200Response | TestRunListMetricsDefaultResponse)
function isUnexpected(response: TestRunListMetrics200Response | TestRunListMetricsDefaultResponse): response is TestRunListMetricsDefaultResponse
Parameters
Returns
response is TestRunListMetricsDefaultResponse
isUnexpected(TestRunListMetricDimensionValues200Response | TestRunListMetricDimensionValuesDefaultResponse)
function isUnexpected(response: TestRunListMetricDimensionValues200Response | TestRunListMetricDimensionValuesDefaultResponse): response is TestRunListMetricDimensionValuesDefaultResponse
Parameters
Returns
response is TestRunListMetricDimensionValuesDefaultResponse
isUnexpected(TestRunCreateOrUpdateAppComponents200Response | TestRunCreateOrUpdateAppComponents201Response | TestRunCreateOrUpdateAppComponentsDefaultResponse)
function isUnexpected(response: TestRunCreateOrUpdateAppComponents200Response | TestRunCreateOrUpdateAppComponents201Response | TestRunCreateOrUpdateAppComponentsDefaultResponse): response is TestRunCreateOrUpdateAppComponentsDefaultResponse
Parameters
Returns
response is TestRunCreateOrUpdateAppComponentsDefaultResponse
isUnexpected(TestRunListAppComponents200Response | TestRunListAppComponentsDefaultResponse)
function isUnexpected(response: TestRunListAppComponents200Response | TestRunListAppComponentsDefaultResponse): response is TestRunListAppComponentsDefaultResponse
Parameters
Returns
response is TestRunListAppComponentsDefaultResponse
isUnexpected(TestRunCreateOrUpdateServerMetricsConfig200Response | TestRunCreateOrUpdateServerMetricsConfig201Response | TestRunCreateOrUpdateServerMetricsConfigDefaultResponse)
function isUnexpected(response: TestRunCreateOrUpdateServerMetricsConfig200Response | TestRunCreateOrUpdateServerMetricsConfig201Response | TestRunCreateOrUpdateServerMetricsConfigDefaultResponse): response is TestRunCreateOrUpdateServerMetricsConfigDefaultResponse
Parameters
Returns
response is TestRunCreateOrUpdateServerMetricsConfigDefaultResponse
isUnexpected(TestRunListServerMetricsConfig200Response | TestRunListServerMetricsConfigDefaultResponse)
function isUnexpected(response: TestRunListServerMetricsConfig200Response | TestRunListServerMetricsConfigDefaultResponse): response is TestRunListServerMetricsConfigDefaultResponse
Parameters
Returns
response is TestRunListServerMetricsConfigDefaultResponse
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>, PaginateReturn<TResponse>[], PageSettings>
Parameters
- client
- Client
Client to use for sending the next page requests
- initialResponse
-
TResponse
Initial response containing the nextLink and current page of elements
- options
-
PagingOptions<TResponse>
Returns
PagedAsyncIterableIterator<PaginateReturn<TResponse>, PaginateReturn<TResponse>[], PageSettings>
- PagedAsyncIterableIterator to iterate the elements