@azure-rest/load-testing package
Interfaces
Type Aliases
Functions
Function Details
default(string, TokenCredential, AzureLoadTestingClientOptions)
Initialize a new instance of AzureLoadTestingClient
function default(endpointParam: string, credentials: TokenCredential, options?: AzureLoadTestingClientOptions): AzureLoadTestingClient
Parameters
- endpointParam
-
string
A sequence of textual characters.
- credentials
- TokenCredential
uniquely identify client credential
- options
- AzureLoadTestingClientOptions
the parameter for all optional parameters
Returns
getLongRunningPoller(AzureLoadTestingClient, LoadTestAdministrationUploadTestFile201Response, PolledOperationOptions)
Helper function that builds a Poller object to help polling a long running operation.
function getLongRunningPoller(client: AzureLoadTestingClient, initialResponse: LoadTestAdministrationUploadTestFile201Response, polledOperationOptions?: PolledOperationOptions): Promise<FileUploadAndValidatePoller>
Parameters
- client
- AzureLoadTestingClient
Client to use for sending the request to get additional pages.
- initialResponse
- LoadTestAdministrationUploadTestFile201Response
The initial response.
- polledOperationOptions
- PolledOperationOptions
Returns
Promise<FileUploadAndValidatePoller>
- A poller object to poll for operation state updates and eventually get the final response.
getLongRunningPoller(AzureLoadTestingClient, TestRunCreateOrUpdateSuccessResponse, PolledOperationOptions)
function getLongRunningPoller(client: AzureLoadTestingClient, initialResponse: TestRunCreateOrUpdateSuccessResponse, polledOperationOptions?: PolledOperationOptions): Promise<TestRunCompletionPoller>
Parameters
- client
- AzureLoadTestingClient
- initialResponse
- TestRunCreateOrUpdateSuccessResponse
- polledOperationOptions
- PolledOperationOptions
Returns
Promise<TestRunCompletionPoller>
getLongRunningPoller(AzureLoadTestingClient, TestProfileRunCreateOrUpdateSuccessResponse, PolledOperationOptions)
function getLongRunningPoller(client: AzureLoadTestingClient, initialResponse: TestProfileRunCreateOrUpdateSuccessResponse, polledOperationOptions?: PolledOperationOptions): Promise<TestProfileRunCompletionPoller>
Parameters
- client
- AzureLoadTestingClient
- initialResponse
- TestProfileRunCreateOrUpdateSuccessResponse
- polledOperationOptions
- PolledOperationOptions
Returns
Promise<TestProfileRunCompletionPoller>
getLongRunningPoller<TResult>(Client, LoadTestAdministrationCloneTest202Response | LoadTestAdministrationCloneTestDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: LoadTestAdministrationCloneTest202Response | LoadTestAdministrationCloneTestDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameters
- client
- Client
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Returns
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, LoadTestAdministrationGenerateTestPlanRecommendations202Response | LoadTestAdministrationGenerateTestPlanRecommendationsDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: LoadTestAdministrationGenerateTestPlanRecommendations202Response | LoadTestAdministrationGenerateTestPlanRecommendationsDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameters
- client
- Client
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Returns
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, LoadTestRunGenerateInsights202Response | LoadTestRunGenerateInsightsDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: LoadTestRunGenerateInsights202Response | LoadTestRunGenerateInsightsDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameters
- client
- Client
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Returns
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
isUnexpected(OperationsGetStatus200Response | OperationsGetStatusDefaultResponse)
function isUnexpected(response: OperationsGetStatus200Response | OperationsGetStatusDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestAdministrationCreateOrUpdateTest200Response | LoadTestAdministrationCreateOrUpdateTest201Response | LoadTestAdministrationCreateOrUpdateTestDefaultResponse)
function isUnexpected(response: LoadTestAdministrationCreateOrUpdateTest200Response | LoadTestAdministrationCreateOrUpdateTest201Response | LoadTestAdministrationCreateOrUpdateTestDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestAdministrationDeleteTest204Response | LoadTestAdministrationDeleteTestDefaultResponse)
function isUnexpected(response: LoadTestAdministrationDeleteTest204Response | LoadTestAdministrationDeleteTestDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestAdministrationGetTest200Response | LoadTestAdministrationGetTestDefaultResponse)
function isUnexpected(response: LoadTestAdministrationGetTest200Response | LoadTestAdministrationGetTestDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestAdministrationListTests200Response | LoadTestAdministrationListTestsDefaultResponse)
function isUnexpected(response: LoadTestAdministrationListTests200Response | LoadTestAdministrationListTestsDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestAdministrationCloneTest202Response | LoadTestAdministrationCloneTestDefaultResponse | LoadTestAdministrationCloneTestLogicalResponse)
function isUnexpected(response: LoadTestAdministrationCloneTest202Response | LoadTestAdministrationCloneTestDefaultResponse | LoadTestAdministrationCloneTestLogicalResponse): response
Parameters
Returns
response
isUnexpected(LoadTestAdministrationGenerateTestPlanRecommendations202Response | LoadTestAdministrationGenerateTestPlanRecommendationsDefaultResponse | LoadTestAdministrationGenerateTestPlanRecommendationsLogicalResponse)
function isUnexpected(response: LoadTestAdministrationGenerateTestPlanRecommendations202Response | LoadTestAdministrationGenerateTestPlanRecommendationsDefaultResponse | LoadTestAdministrationGenerateTestPlanRecommendationsLogicalResponse): response
Parameters
Returns
response
isUnexpected(LoadTestAdministrationUploadTestFile201Response | LoadTestAdministrationUploadTestFileDefaultResponse)
function isUnexpected(response: LoadTestAdministrationUploadTestFile201Response | LoadTestAdministrationUploadTestFileDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestAdministrationGetTestFile200Response | LoadTestAdministrationGetTestFileDefaultResponse)
function isUnexpected(response: LoadTestAdministrationGetTestFile200Response | LoadTestAdministrationGetTestFileDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestAdministrationDeleteTestFile204Response | LoadTestAdministrationDeleteTestFileDefaultResponse)
function isUnexpected(response: LoadTestAdministrationDeleteTestFile204Response | LoadTestAdministrationDeleteTestFileDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestAdministrationListTestFiles200Response | LoadTestAdministrationListTestFilesDefaultResponse)
function isUnexpected(response: LoadTestAdministrationListTestFiles200Response | LoadTestAdministrationListTestFilesDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestAdministrationCreateOrUpdateAppComponents200Response | LoadTestAdministrationCreateOrUpdateAppComponents201Response | LoadTestAdministrationCreateOrUpdateAppComponentsDefaultResponse)
function isUnexpected(response: LoadTestAdministrationCreateOrUpdateAppComponents200Response | LoadTestAdministrationCreateOrUpdateAppComponents201Response | LoadTestAdministrationCreateOrUpdateAppComponentsDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestAdministrationGetAppComponents200Response | LoadTestAdministrationGetAppComponentsDefaultResponse)
function isUnexpected(response: LoadTestAdministrationGetAppComponents200Response | LoadTestAdministrationGetAppComponentsDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestAdministrationCreateOrUpdateServerMetricsConfig200Response | LoadTestAdministrationCreateOrUpdateServerMetricsConfig201Response | LoadTestAdministrationCreateOrUpdateServerMetricsConfigDefaultResponse)
function isUnexpected(response: LoadTestAdministrationCreateOrUpdateServerMetricsConfig200Response | LoadTestAdministrationCreateOrUpdateServerMetricsConfig201Response | LoadTestAdministrationCreateOrUpdateServerMetricsConfigDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestAdministrationGetServerMetricsConfig200Response | LoadTestAdministrationGetServerMetricsConfigDefaultResponse)
function isUnexpected(response: LoadTestAdministrationGetServerMetricsConfig200Response | LoadTestAdministrationGetServerMetricsConfigDefaultResponse): response
Parameters
Returns
response
isUnexpected(TestProfileAdministrationCreateOrUpdateTestProfile200Response | TestProfileAdministrationCreateOrUpdateTestProfile201Response | TestProfileAdministrationCreateOrUpdateTestProfileDefaultResponse)
function isUnexpected(response: TestProfileAdministrationCreateOrUpdateTestProfile200Response | TestProfileAdministrationCreateOrUpdateTestProfile201Response | TestProfileAdministrationCreateOrUpdateTestProfileDefaultResponse): response
Parameters
Returns
response
isUnexpected(TestProfileAdministrationDeleteTestProfile204Response | TestProfileAdministrationDeleteTestProfileDefaultResponse)
function isUnexpected(response: TestProfileAdministrationDeleteTestProfile204Response | TestProfileAdministrationDeleteTestProfileDefaultResponse): response
Parameters
Returns
response
isUnexpected(TestProfileAdministrationGetTestProfile200Response | TestProfileAdministrationGetTestProfileDefaultResponse)
function isUnexpected(response: TestProfileAdministrationGetTestProfile200Response | TestProfileAdministrationGetTestProfileDefaultResponse): response
Parameters
Returns
response
isUnexpected(TestProfileAdministrationListTestProfiles200Response | TestProfileAdministrationListTestProfilesDefaultResponse)
function isUnexpected(response: TestProfileAdministrationListTestProfiles200Response | TestProfileAdministrationListTestProfilesDefaultResponse): response
Parameters
Returns
response
isUnexpected(TriggerAdministrationGetTrigger200Response | TriggerAdministrationGetTriggerDefaultResponse)
function isUnexpected(response: TriggerAdministrationGetTrigger200Response | TriggerAdministrationGetTriggerDefaultResponse): response
Parameters
Returns
response
isUnexpected(TriggerAdministrationCreateOrUpdateTrigger200Response | TriggerAdministrationCreateOrUpdateTrigger201Response | TriggerAdministrationCreateOrUpdateTriggerDefaultResponse)
function isUnexpected(response: TriggerAdministrationCreateOrUpdateTrigger200Response | TriggerAdministrationCreateOrUpdateTrigger201Response | TriggerAdministrationCreateOrUpdateTriggerDefaultResponse): response
Parameters
Returns
response
isUnexpected(TriggerAdministrationDeleteTrigger204Response | TriggerAdministrationDeleteTriggerDefaultResponse)
function isUnexpected(response: TriggerAdministrationDeleteTrigger204Response | TriggerAdministrationDeleteTriggerDefaultResponse): response
Parameters
Returns
response
isUnexpected(TriggerAdministrationListTrigger200Response | TriggerAdministrationListTriggerDefaultResponse)
function isUnexpected(response: TriggerAdministrationListTrigger200Response | TriggerAdministrationListTriggerDefaultResponse): response
Parameters
Returns
response
isUnexpected(NotificationRuleAdministrationGetNotificationRule200Response | NotificationRuleAdministrationGetNotificationRuleDefaultResponse)
function isUnexpected(response: NotificationRuleAdministrationGetNotificationRule200Response | NotificationRuleAdministrationGetNotificationRuleDefaultResponse): response
Parameters
Returns
response
isUnexpected(NotificationRuleAdministrationCreateOrUpdateNotificationRule200Response | NotificationRuleAdministrationCreateOrUpdateNotificationRule201Response | NotificationRuleAdministrationCreateOrUpdateNotificationRuleDefaultResponse)
function isUnexpected(response: NotificationRuleAdministrationCreateOrUpdateNotificationRule200Response | NotificationRuleAdministrationCreateOrUpdateNotificationRule201Response | NotificationRuleAdministrationCreateOrUpdateNotificationRuleDefaultResponse): response
Parameters
Returns
response
isUnexpected(NotificationRuleAdministrationDeleteNotificationRule204Response | NotificationRuleAdministrationDeleteNotificationRuleDefaultResponse)
function isUnexpected(response: NotificationRuleAdministrationDeleteNotificationRule204Response | NotificationRuleAdministrationDeleteNotificationRuleDefaultResponse): response
Parameters
Returns
response
isUnexpected(NotificationRuleAdministrationListNotificationRule200Response | NotificationRuleAdministrationListNotificationRuleDefaultResponse)
function isUnexpected(response: NotificationRuleAdministrationListNotificationRule200Response | NotificationRuleAdministrationListNotificationRuleDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunGetTestRun200Response | LoadTestRunGetTestRunDefaultResponse)
function isUnexpected(response: LoadTestRunGetTestRun200Response | LoadTestRunGetTestRunDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunCreateOrUpdateTestRun200Response | LoadTestRunCreateOrUpdateTestRun201Response | LoadTestRunCreateOrUpdateTestRunDefaultResponse)
function isUnexpected(response: LoadTestRunCreateOrUpdateTestRun200Response | LoadTestRunCreateOrUpdateTestRun201Response | LoadTestRunCreateOrUpdateTestRunDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunDeleteTestRun204Response | LoadTestRunDeleteTestRunDefaultResponse)
function isUnexpected(response: LoadTestRunDeleteTestRun204Response | LoadTestRunDeleteTestRunDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunListTestRuns200Response | LoadTestRunListTestRunsDefaultResponse)
function isUnexpected(response: LoadTestRunListTestRuns200Response | LoadTestRunListTestRunsDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunGetTestRunFile200Response | LoadTestRunGetTestRunFileDefaultResponse)
function isUnexpected(response: LoadTestRunGetTestRunFile200Response | LoadTestRunGetTestRunFileDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunStop200Response | LoadTestRunStopDefaultResponse)
function isUnexpected(response: LoadTestRunStop200Response | LoadTestRunStopDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunGetLatestInsights200Response | LoadTestRunGetLatestInsightsDefaultResponse)
function isUnexpected(response: LoadTestRunGetLatestInsights200Response | LoadTestRunGetLatestInsightsDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunUpdateLatestInsights200Response | LoadTestRunUpdateLatestInsightsDefaultResponse)
function isUnexpected(response: LoadTestRunUpdateLatestInsights200Response | LoadTestRunUpdateLatestInsightsDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunGenerateInsights202Response | LoadTestRunGenerateInsightsDefaultResponse | LoadTestRunGenerateInsightsLogicalResponse)
function isUnexpected(response: LoadTestRunGenerateInsights202Response | LoadTestRunGenerateInsightsDefaultResponse | LoadTestRunGenerateInsightsLogicalResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunListMetricNamespaces200Response | LoadTestRunListMetricNamespacesDefaultResponse)
function isUnexpected(response: LoadTestRunListMetricNamespaces200Response | LoadTestRunListMetricNamespacesDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunListMetricDefinitions200Response | LoadTestRunListMetricDefinitionsDefaultResponse)
function isUnexpected(response: LoadTestRunListMetricDefinitions200Response | LoadTestRunListMetricDefinitionsDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunListMetrics200Response | LoadTestRunListMetricsDefaultResponse)
function isUnexpected(response: LoadTestRunListMetrics200Response | LoadTestRunListMetricsDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunListMetricDimensionValues200Response | LoadTestRunListMetricDimensionValuesDefaultResponse)
function isUnexpected(response: LoadTestRunListMetricDimensionValues200Response | LoadTestRunListMetricDimensionValuesDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunCreateOrUpdateAppComponents200Response | LoadTestRunCreateOrUpdateAppComponents201Response | LoadTestRunCreateOrUpdateAppComponentsDefaultResponse)
function isUnexpected(response: LoadTestRunCreateOrUpdateAppComponents200Response | LoadTestRunCreateOrUpdateAppComponents201Response | LoadTestRunCreateOrUpdateAppComponentsDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunGetAppComponents200Response | LoadTestRunGetAppComponentsDefaultResponse)
function isUnexpected(response: LoadTestRunGetAppComponents200Response | LoadTestRunGetAppComponentsDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunCreateOrUpdateServerMetricsConfig200Response | LoadTestRunCreateOrUpdateServerMetricsConfig201Response | LoadTestRunCreateOrUpdateServerMetricsConfigDefaultResponse)
function isUnexpected(response: LoadTestRunCreateOrUpdateServerMetricsConfig200Response | LoadTestRunCreateOrUpdateServerMetricsConfig201Response | LoadTestRunCreateOrUpdateServerMetricsConfigDefaultResponse): response
Parameters
Returns
response
isUnexpected(LoadTestRunGetServerMetricsConfig200Response | LoadTestRunGetServerMetricsConfigDefaultResponse)
function isUnexpected(response: LoadTestRunGetServerMetricsConfig200Response | LoadTestRunGetServerMetricsConfigDefaultResponse): response
Parameters
Returns
response
isUnexpected(TestProfileRunAdministrationGetTestProfileRun200Response | TestProfileRunAdministrationGetTestProfileRunDefaultResponse)
function isUnexpected(response: TestProfileRunAdministrationGetTestProfileRun200Response | TestProfileRunAdministrationGetTestProfileRunDefaultResponse): response
Parameters
Returns
response
isUnexpected(TestProfileRunAdministrationCreateOrUpdateTestProfileRun200Response | TestProfileRunAdministrationCreateOrUpdateTestProfileRun201Response | TestProfileRunAdministrationCreateOrUpdateTestProfileRunDefaultResponse)
function isUnexpected(response: TestProfileRunAdministrationCreateOrUpdateTestProfileRun200Response | TestProfileRunAdministrationCreateOrUpdateTestProfileRun201Response | TestProfileRunAdministrationCreateOrUpdateTestProfileRunDefaultResponse): response
Parameters
Returns
response
isUnexpected(TestProfileRunAdministrationDeleteTestProfileRun204Response | TestProfileRunAdministrationDeleteTestProfileRunDefaultResponse)
function isUnexpected(response: TestProfileRunAdministrationDeleteTestProfileRun204Response | TestProfileRunAdministrationDeleteTestProfileRunDefaultResponse): response
Parameters
Returns
response
isUnexpected(TestProfileRunAdministrationStop200Response | TestProfileRunAdministrationStopDefaultResponse)
function isUnexpected(response: TestProfileRunAdministrationStop200Response | TestProfileRunAdministrationStopDefaultResponse): response
Parameters
Returns
response
isUnexpected(TestProfileRunAdministrationListTestProfileRuns200Response | TestProfileRunAdministrationListTestProfileRunsDefaultResponse)
function isUnexpected(response: TestProfileRunAdministrationListTestProfileRuns200Response | TestProfileRunAdministrationListTestProfileRunsDefaultResponse): response
Parameters
Returns
response
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>>
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>>
- PagedAsyncIterableIterator to iterate the elements