Share via

@azure-rest/load-testing package

Interfaces

AppComponent

An Azure resource object (Refer azure generic resource model : https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource)
AppComponentOutput

An Azure resource object (Refer azure generic resource model : https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource)
CertificateMetadata

Certificates metadata
CertificateMetadataOutput

Certificates metadata
DimensionFilter

Dimension name and values to filter
DimensionValueListOutput

Metrics dimension values.
DimensionValueOutput

Represents a metric dimension value.
ErrorDetails

Error details if there is any failure in load test run
ErrorDetailsOutput

Error details if there is any failure in load test run
ErrorModelOutput

Error from a REST request.
ErrorResponseBodyOutput

The definition of an error object.
FileInfo

File info
FileInfoListOutput

Collection of files.
FileInfoOutput

File info
LoadTestConfiguration

The load test configuration.
LoadTestConfigurationOutput

The load test configuration.
MetricAvailabilityOutput

Metric availability specifies the time grain (aggregation interval or frequency)
MetricDefinitionCollectionOutput

Represents collection of metric definitions.
MetricDefinitionOutput

Metric definition
MetricNamespaceCollectionOutput

Represents collection of metric namespaces.
MetricNamespaceOutput

Metric namespace class specifies the metadata for a metric namespace.
MetricRequestPayload

Filters to fetch the set of metric
MetricValueOutput

Represents a metric value.
MetricsOutput

The response to a metrics query.
NameAndDescOutput

The name and description
OptionalLoadTestConfig

Optional load test config
OptionalLoadTestConfigOutput

Optional load test config
PagingOptions

Options for the paging helper
PassFailCriteria

Pass fail criteria for a test.
PassFailCriteriaOutput

Pass fail criteria for a test.
PassFailMetric

Pass fail metric
PassFailMetricOutput

Pass fail metric
PolledOperationOptions
ResourceMetric

Associated metric definition for particular metrics of the azure resource ( Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).
ResourceMetricOutput

Associated metric definition for particular metrics of the azure resource ( Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).
Routes
Secret

Secret
SecretOutput

Secret
Test

Load test model
TestAppComponents

Test app component
TestAppComponentsOutput

Test app component
TestCreateOrUpdate
TestCreateOrUpdate200Response

Create a new test or update an existing test.
TestCreateOrUpdate201Response

Create a new test or update an existing test.
TestCreateOrUpdateAppComponents
TestCreateOrUpdateAppComponents200Response

Associate an app component (collection of azure resources) to a test
TestCreateOrUpdateAppComponents201Response

Associate an app component (collection of azure resources) to a test
TestCreateOrUpdateAppComponentsBodyParam
TestCreateOrUpdateAppComponentsDefaultHeaders
TestCreateOrUpdateAppComponentsDefaultResponse

Associate an app component (collection of azure resources) to a test
TestCreateOrUpdateAppComponentsMediaTypesParam
TestCreateOrUpdateBodyParam
TestCreateOrUpdateDefaultHeaders
TestCreateOrUpdateDefaultResponse

Create a new test or update an existing test.
TestCreateOrUpdateMediaTypesParam
TestCreateOrUpdateServerMetricsConfig
TestCreateOrUpdateServerMetricsConfig200Response

Configure server metrics for a test
TestCreateOrUpdateServerMetricsConfig201Response

Configure server metrics for a test
TestCreateOrUpdateServerMetricsConfigBodyParam
TestCreateOrUpdateServerMetricsConfigDefaultHeaders
TestCreateOrUpdateServerMetricsConfigDefaultResponse

Configure server metrics for a test
TestCreateOrUpdateServerMetricsConfigMediaTypesParam
TestDelete204Response

Delete a test by its name.
TestDeleteDefaultHeaders
TestDeleteDefaultResponse

Delete a test by its name.
TestDeleteFile204Response

Delete file by the file name for a test
TestDeleteFileDefaultHeaders
TestDeleteFileDefaultResponse

Delete file by the file name for a test
TestGet200Response

Get load test details by test name
TestGetDefaultHeaders
TestGetDefaultResponse

Get load test details by test name
TestGetFile200Response

Get test file by the file name.
TestGetFileDefaultHeaders
TestGetFileDefaultResponse

Get test file by the file name.
TestInputArtifacts

The input artifacts for the test.
TestInputArtifactsOutput

The input artifacts for the test.
TestList
TestList200Response

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

Get associated app component (collection of azure resources) for the given test.
TestListAppComponentsDefaultHeaders
TestListAppComponentsDefaultResponse

Get associated app component (collection of azure resources) for the given test.
TestListDefaultHeaders
TestListDefaultResponse

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

Get all test files.
TestListFilesDefaultHeaders
TestListFilesDefaultResponse

Get all test files.
TestListFilesQueryParam
TestListFilesQueryParamProperties
TestListQueryParam
TestListQueryParamProperties
TestListServerMetricsConfig200Response

List server metrics configuration for the given test.
TestListServerMetricsConfigDefaultHeaders
TestListServerMetricsConfigDefaultResponse

List server metrics configuration for the given test.
TestOutput

Load test model
TestRun

Load test run model
TestRunAppComponents

Test run app component
TestRunAppComponentsOutput

Test run app component
TestRunArtifacts

Collection of test run artifacts
TestRunArtifactsOutput

Collection of test run artifacts
TestRunCreateOrUpdate200Response

Create and start a new test run with the given name.
TestRunCreateOrUpdate201Response

Create and start a new test run with the given name.
TestRunCreateOrUpdateAppComponents
TestRunCreateOrUpdateAppComponents200Response

Associate an app component (collection of azure resources) to a test run
TestRunCreateOrUpdateAppComponents201Response

Associate an app component (collection of azure resources) to a test run
TestRunCreateOrUpdateAppComponentsBodyParam
TestRunCreateOrUpdateAppComponentsDefaultHeaders
TestRunCreateOrUpdateAppComponentsDefaultResponse

Associate an app component (collection of azure resources) to a test run
TestRunCreateOrUpdateAppComponentsMediaTypesParam
TestRunCreateOrUpdateBodyParam
TestRunCreateOrUpdateDefaultHeaders
TestRunCreateOrUpdateDefaultResponse

Create and start a new test run with the given name.
TestRunCreateOrUpdateMediaTypesParam
TestRunCreateOrUpdateQueryParam
TestRunCreateOrUpdateQueryParamProperties
TestRunCreateOrUpdateServerMetricsConfig
TestRunCreateOrUpdateServerMetricsConfig200Response

Configure server metrics for a test run
TestRunCreateOrUpdateServerMetricsConfig201Response

Configure server metrics for a test run
TestRunCreateOrUpdateServerMetricsConfigBodyParam
TestRunCreateOrUpdateServerMetricsConfigDefaultHeaders
TestRunCreateOrUpdateServerMetricsConfigDefaultResponse

Configure server metrics for a test run
TestRunCreateOrUpdateServerMetricsConfigMediaTypesParam
TestRunDelete
TestRunDelete204Response

Delete a test run by its name.
TestRunDeleteDefaultHeaders
TestRunDeleteDefaultResponse

Delete a test run by its name.
TestRunGet200Response

Get test run details by name.
TestRunGetDefaultHeaders
TestRunGetDefaultResponse

Get test run details by name.
TestRunGetFile
TestRunGetFile200Response

Get test run file by file name.
TestRunGetFileDefaultHeaders
TestRunGetFileDefaultResponse

Get test run file by file name.
TestRunInputArtifacts

The input artifacts for the test run.
TestRunInputArtifactsOutput

The input artifacts for the test run.
TestRunList
TestRunList200Response

Get all test runs with given filters
TestRunListAppComponents200Response

Get associated app component (collection of azure resources) for the given test run.
TestRunListAppComponentsDefaultHeaders
TestRunListAppComponentsDefaultResponse

Get associated app component (collection of azure resources) for the given test run.
TestRunListDefaultHeaders
TestRunListDefaultResponse

Get all test runs with given filters
TestRunListMetricDefinitions
TestRunListMetricDefinitions200Response

List the metric definitions for a load test run.
TestRunListMetricDefinitionsDefaultHeaders
TestRunListMetricDefinitionsDefaultResponse

List the metric definitions for a load test run.
TestRunListMetricDefinitionsQueryParam
TestRunListMetricDefinitionsQueryParamProperties
TestRunListMetricDimensionValues
TestRunListMetricDimensionValues200Response

List the dimension values for the given metric dimension name.
TestRunListMetricDimensionValuesDefaultHeaders
TestRunListMetricDimensionValuesDefaultResponse

List the dimension values for the given metric dimension name.
TestRunListMetricDimensionValuesQueryParam
TestRunListMetricDimensionValuesQueryParamProperties
TestRunListMetricNamespaces
TestRunListMetricNamespaces200Response

List the metric namespaces for a load test run.
TestRunListMetricNamespacesDefaultHeaders
TestRunListMetricNamespacesDefaultResponse

List the metric namespaces for a load test run.
TestRunListMetrics
TestRunListMetrics200Response

List the metric values for a load test run.
TestRunListMetricsBodyParam
TestRunListMetricsDefaultHeaders
TestRunListMetricsDefaultResponse

List the metric values for a load test run.
TestRunListMetricsMediaTypesParam
TestRunListMetricsQueryParam
TestRunListMetricsQueryParamProperties
TestRunListQueryParam
TestRunListQueryParamProperties
TestRunListServerMetricsConfig200Response

List server metrics configuration for the given test run.
TestRunListServerMetricsConfigDefaultHeaders
TestRunListServerMetricsConfigDefaultResponse

List server metrics configuration for the given test run.
TestRunOutput

Load test run model
TestRunOutputArtifacts

The output artifacts for the test run.
TestRunOutputArtifactsOutput

The output artifacts for the test run.
TestRunServerMetricConfig

Test run server metrics configuration
TestRunServerMetricConfigOutput

Test run server metrics configuration
TestRunStatistics

Test run statistics.
TestRunStatisticsOutput

Test run statistics.
TestRunStop
TestRunStop200Response

Stop test run by name.
TestRunStopDefaultHeaders
TestRunStopDefaultResponse

Stop test run by name.
TestRunsListOutput

Collection of test runs
TestServerMetricConfig

Test server metrics configuration
TestServerMetricConfigOutput

Test server metrics configuration
TestUploadFile
TestUploadFile201Response

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 application/octet-stream.
TestUploadFileBodyParam
TestUploadFileDefaultHeaders
TestUploadFileDefaultResponse

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 application/octet-stream.
TestUploadFileMediaTypesParam
TestUploadFileQueryParam
TestUploadFileQueryParamProperties
TestsListOutput

Collection of tests
TimeSeriesElementOutput

The time series returned when a data query is performed.

Type Aliases

AzureLoadTestingClient
FileUploadAndValidatePoller

Describes a poller for NotificationHubJob types.
GetArrayType

Helper type to extract the type of an array
GetPage

The type of a custom function that defines how to get a page and a link to the next one if any.
PaginateReturn

Helper type to infer the Type of the paged elements from the response type This type is generated based on the swagger information for x-ms-pageable specifically on the itemName property which indicates the property of the response where the page items are found. The default value is value. This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
TestCreateOrUpdateAppComponentsParameters
TestCreateOrUpdateParameters
TestCreateOrUpdateServerMetricsConfigParameters
TestDeleteFileParameters
TestDeleteParameters
TestGetFileParameters
TestGetParameters
TestListAppComponentsParameters
TestListFilesParameters
TestListParameters
TestListServerMetricsConfigParameters
TestRunCompletionPoller
TestRunCreateOrUpdateAppComponentsParameters
TestRunCreateOrUpdateParameters
TestRunCreateOrUpdateServerMetricsConfigParameters
TestRunCreateOrUpdateSuccessResponse
TestRunDeleteParameters
TestRunGetFileParameters
TestRunGetParameters
TestRunListAppComponentsParameters
TestRunListMetricDefinitionsParameters
TestRunListMetricDimensionValuesParameters
TestRunListMetricNamespacesParameters
TestRunListMetricsParameters
TestRunListParameters
TestRunListServerMetricsConfigParameters
TestRunStopParameters
TestUploadFileParameters
TestUploadFileSuccessResponse

Functions

default(string, TokenCredential, ClientOptions)

Initialize a new instance of the class AzureLoadTestingClient class.
getLongRunningPoller(AzureLoadTestingClient, TestUploadFile201Response)
getLongRunningPoller(AzureLoadTestingClient, TestRunCreateOrUpdateSuccessResponse)
isUnexpected(TestCreateOrUpdate200Response | TestCreateOrUpdate201Response | TestCreateOrUpdateDefaultResponse)
isUnexpected(TestDelete204Response | TestDeleteDefaultResponse)
isUnexpected(TestGet200Response | TestGetDefaultResponse)
isUnexpected(TestList200Response | TestListDefaultResponse)
isUnexpected(TestUploadFile201Response | TestUploadFileDefaultResponse)
isUnexpected(TestGetFile200Response | TestGetFileDefaultResponse)
isUnexpected(TestDeleteFile204Response | TestDeleteFileDefaultResponse)
isUnexpected(TestListFiles200Response | TestListFilesDefaultResponse)
isUnexpected(TestCreateOrUpdateAppComponents200Response | TestCreateOrUpdateAppComponents201Response | TestCreateOrUpdateAppComponentsDefaultResponse)
isUnexpected(TestListAppComponents200Response | TestListAppComponentsDefaultResponse)
isUnexpected(TestCreateOrUpdateServerMetricsConfig200Response | TestCreateOrUpdateServerMetricsConfig201Response | TestCreateOrUpdateServerMetricsConfigDefaultResponse)
isUnexpected(TestListServerMetricsConfig200Response | TestListServerMetricsConfigDefaultResponse)
isUnexpected(TestRunDelete204Response | TestRunDeleteDefaultResponse)
isUnexpected(TestRunCreateOrUpdate200Response | TestRunCreateOrUpdate201Response | TestRunCreateOrUpdateDefaultResponse)
isUnexpected(TestRunGet200Response | TestRunGetDefaultResponse)
isUnexpected(TestRunGetFile200Response | TestRunGetFileDefaultResponse)
isUnexpected(TestRunList200Response | TestRunListDefaultResponse)
isUnexpected(TestRunStop200Response | TestRunStopDefaultResponse)
isUnexpected(TestRunListMetricNamespaces200Response | TestRunListMetricNamespacesDefaultResponse)
isUnexpected(TestRunListMetricDefinitions200Response | TestRunListMetricDefinitionsDefaultResponse)
isUnexpected(TestRunListMetrics200Response | TestRunListMetricsDefaultResponse)
isUnexpected(TestRunListMetricDimensionValues200Response | TestRunListMetricDimensionValuesDefaultResponse)
isUnexpected(TestRunCreateOrUpdateAppComponents200Response | TestRunCreateOrUpdateAppComponents201Response | TestRunCreateOrUpdateAppComponentsDefaultResponse)
isUnexpected(TestRunListAppComponents200Response | TestRunListAppComponentsDefaultResponse)
isUnexpected(TestRunCreateOrUpdateServerMetricsConfig200Response | TestRunCreateOrUpdateServerMetricsConfig201Response | TestRunCreateOrUpdateServerMetricsConfigDefaultResponse)
isUnexpected(TestRunListServerMetricsConfig200Response | 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 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

AzureLoadTestingClient

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

Parameters

response

TestCreateOrUpdate200Response | TestCreateOrUpdate201Response | TestCreateOrUpdateDefaultResponse

Returns

response

isUnexpected(TestDelete204Response | TestDeleteDefaultResponse) 

function isUnexpected(response: TestDelete204Response | TestDeleteDefaultResponse): response

Parameters

response

TestDelete204Response | TestDeleteDefaultResponse

Returns

response

isUnexpected(TestGet200Response | TestGetDefaultResponse) 

function isUnexpected(response: TestGet200Response | TestGetDefaultResponse): response

Parameters

response

TestGet200Response | TestGetDefaultResponse

Returns

response

isUnexpected(TestList200Response | TestListDefaultResponse) 

function isUnexpected(response: TestList200Response | TestListDefaultResponse): response

Parameters

response

TestList200Response | TestListDefaultResponse

Returns

response

isUnexpected(TestUploadFile201Response | TestUploadFileDefaultResponse) 

function isUnexpected(response: TestUploadFile201Response | TestUploadFileDefaultResponse): response

Parameters

response

TestUploadFile201Response | TestUploadFileDefaultResponse

Returns

response

isUnexpected(TestGetFile200Response | TestGetFileDefaultResponse) 

function isUnexpected(response: TestGetFile200Response | TestGetFileDefaultResponse): response

Parameters

response

TestGetFile200Response | TestGetFileDefaultResponse

Returns

response

isUnexpected(TestDeleteFile204Response | TestDeleteFileDefaultResponse) 

function isUnexpected(response: TestDeleteFile204Response | TestDeleteFileDefaultResponse): response

Parameters

response

TestDeleteFile204Response | TestDeleteFileDefaultResponse

Returns

response

isUnexpected(TestListFiles200Response | TestListFilesDefaultResponse) 

function isUnexpected(response: TestListFiles200Response | TestListFilesDefaultResponse): response

Parameters

response

TestListFiles200Response | TestListFilesDefaultResponse

Returns

response

isUnexpected(TestCreateOrUpdateAppComponents200Response | TestCreateOrUpdateAppComponents201Response | TestCreateOrUpdateAppComponentsDefaultResponse) 

function isUnexpected(response: TestCreateOrUpdateAppComponents200Response | TestCreateOrUpdateAppComponents201Response | TestCreateOrUpdateAppComponentsDefaultResponse): response

Parameters

response

TestCreateOrUpdateAppComponents200Response | TestCreateOrUpdateAppComponents201Response | TestCreateOrUpdateAppComponentsDefaultResponse

Returns

response

isUnexpected(TestListAppComponents200Response | TestListAppComponentsDefaultResponse) 

function isUnexpected(response: TestListAppComponents200Response | TestListAppComponentsDefaultResponse): response

Parameters

response

TestListAppComponents200Response | TestListAppComponentsDefaultResponse

Returns

response

isUnexpected(TestCreateOrUpdateServerMetricsConfig200Response | TestCreateOrUpdateServerMetricsConfig201Response | TestCreateOrUpdateServerMetricsConfigDefaultResponse) 

function isUnexpected(response: TestCreateOrUpdateServerMetricsConfig200Response | TestCreateOrUpdateServerMetricsConfig201Response | TestCreateOrUpdateServerMetricsConfigDefaultResponse): response

Parameters

response

TestCreateOrUpdateServerMetricsConfig200Response | TestCreateOrUpdateServerMetricsConfig201Response | TestCreateOrUpdateServerMetricsConfigDefaultResponse

Returns

response

isUnexpected(TestListServerMetricsConfig200Response | TestListServerMetricsConfigDefaultResponse) 

function isUnexpected(response: TestListServerMetricsConfig200Response | TestListServerMetricsConfigDefaultResponse): response

Parameters

response

TestListServerMetricsConfig200Response | TestListServerMetricsConfigDefaultResponse

Returns

response

isUnexpected(TestRunDelete204Response | TestRunDeleteDefaultResponse) 

function isUnexpected(response: TestRunDelete204Response | TestRunDeleteDefaultResponse): response

Parameters

response

TestRunDelete204Response | TestRunDeleteDefaultResponse

Returns

response

isUnexpected(TestRunCreateOrUpdate200Response | TestRunCreateOrUpdate201Response | TestRunCreateOrUpdateDefaultResponse) 

function isUnexpected(response: TestRunCreateOrUpdate200Response | TestRunCreateOrUpdate201Response | TestRunCreateOrUpdateDefaultResponse): response

Parameters

response

TestRunCreateOrUpdate200Response | TestRunCreateOrUpdate201Response | TestRunCreateOrUpdateDefaultResponse

Returns

response

isUnexpected(TestRunGet200Response | TestRunGetDefaultResponse) 

function isUnexpected(response: TestRunGet200Response | TestRunGetDefaultResponse): response

Parameters

response

TestRunGet200Response | TestRunGetDefaultResponse

Returns

response

isUnexpected(TestRunGetFile200Response | TestRunGetFileDefaultResponse) 

function isUnexpected(response: TestRunGetFile200Response | TestRunGetFileDefaultResponse): response

Parameters

response

TestRunGetFile200Response | TestRunGetFileDefaultResponse

Returns

response

isUnexpected(TestRunList200Response | TestRunListDefaultResponse) 

function isUnexpected(response: TestRunList200Response | TestRunListDefaultResponse): response

Parameters

response

TestRunList200Response | TestRunListDefaultResponse

Returns

response

isUnexpected(TestRunStop200Response | TestRunStopDefaultResponse) 

function isUnexpected(response: TestRunStop200Response | TestRunStopDefaultResponse): response

Parameters

response

TestRunStop200Response | TestRunStopDefaultResponse

Returns

response

isUnexpected(TestRunListMetricNamespaces200Response | TestRunListMetricNamespacesDefaultResponse) 

function isUnexpected(response: TestRunListMetricNamespaces200Response | TestRunListMetricNamespacesDefaultResponse): response

Parameters

response

TestRunListMetricNamespaces200Response | TestRunListMetricNamespacesDefaultResponse

Returns

response

isUnexpected(TestRunListMetricDefinitions200Response | TestRunListMetricDefinitionsDefaultResponse) 

function isUnexpected(response: TestRunListMetricDefinitions200Response | TestRunListMetricDefinitionsDefaultResponse): response

Parameters

response

TestRunListMetricDefinitions200Response | TestRunListMetricDefinitionsDefaultResponse

Returns

response

isUnexpected(TestRunListMetrics200Response | TestRunListMetricsDefaultResponse) 

function isUnexpected(response: TestRunListMetrics200Response | TestRunListMetricsDefaultResponse): response

Parameters

response

TestRunListMetrics200Response | TestRunListMetricsDefaultResponse

Returns

response

isUnexpected(TestRunListMetricDimensionValues200Response | TestRunListMetricDimensionValuesDefaultResponse) 

function isUnexpected(response: TestRunListMetricDimensionValues200Response | TestRunListMetricDimensionValuesDefaultResponse): response

Parameters

response

TestRunListMetricDimensionValues200Response | TestRunListMetricDimensionValuesDefaultResponse

Returns

response

isUnexpected(TestRunCreateOrUpdateAppComponents200Response | TestRunCreateOrUpdateAppComponents201Response | TestRunCreateOrUpdateAppComponentsDefaultResponse) 

function isUnexpected(response: TestRunCreateOrUpdateAppComponents200Response | TestRunCreateOrUpdateAppComponents201Response | TestRunCreateOrUpdateAppComponentsDefaultResponse): response

Parameters

response

TestRunCreateOrUpdateAppComponents200Response | TestRunCreateOrUpdateAppComponents201Response | TestRunCreateOrUpdateAppComponentsDefaultResponse

Returns

response

isUnexpected(TestRunListAppComponents200Response | TestRunListAppComponentsDefaultResponse) 

function isUnexpected(response: TestRunListAppComponents200Response | TestRunListAppComponentsDefaultResponse): response

Parameters

response

TestRunListAppComponents200Response | TestRunListAppComponentsDefaultResponse

Returns

response

isUnexpected(TestRunCreateOrUpdateServerMetricsConfig200Response | TestRunCreateOrUpdateServerMetricsConfig201Response | TestRunCreateOrUpdateServerMetricsConfigDefaultResponse) 

function isUnexpected(response: TestRunCreateOrUpdateServerMetricsConfig200Response | TestRunCreateOrUpdateServerMetricsConfig201Response | TestRunCreateOrUpdateServerMetricsConfigDefaultResponse): response

Parameters

response

TestRunCreateOrUpdateServerMetricsConfig200Response | TestRunCreateOrUpdateServerMetricsConfig201Response | TestRunCreateOrUpdateServerMetricsConfigDefaultResponse

Returns

response

isUnexpected(TestRunListServerMetricsConfig200Response | TestRunListServerMetricsConfigDefaultResponse) 

function isUnexpected(response: TestRunListServerMetricsConfig200Response | TestRunListServerMetricsConfigDefaultResponse): response

Parameters

response

TestRunListServerMetricsConfig200Response | TestRunListServerMetricsConfigDefaultResponse

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