@azure-rest/onlineexperimentation package
Interfaces
| AggregatedValue |
An event property value aggregated by a metric. |
| AggregatedValueOutput |
An event property value aggregated by a metric. |
| AverageMetricDefinition |
The definition of an Average metric definition. Calculates the average value of a specified event property. |
| AverageMetricDefinitionOutput |
The definition of an Average metric definition. Calculates the average value of a specified event property. |
| CreateOrUpdateMetric200Headers | |
| CreateOrUpdateMetric200Response |
The request has succeeded. |
| CreateOrUpdateMetric201Headers | |
| CreateOrUpdateMetric201Response |
The request has succeeded and a new resource has been created as a result. |
| CreateOrUpdateMetricBodyParam | |
| CreateOrUpdateMetricDefaultHeaders | |
| CreateOrUpdateMetricDefaultResponse | |
| CreateOrUpdateMetricHeaderParam | |
| CreateOrUpdateMetricHeaders | |
| CreateOrUpdateMetricMediaTypesParam | |
| DeleteMetric204Headers | |
| DeleteMetric204Response |
There is no content to send for this request, but the headers may be useful. |
| DeleteMetricDefaultHeaders | |
| DeleteMetricDefaultResponse | |
| DeleteMetricHeaderParam | |
| DeleteMetricHeaders | |
| DiagnosticDetailOutput |
Diagnostic details for validation errors. |
| EventCountMetricDefinition |
The definition of an EventCount metric definition. Counts the occurrences of a specified event. |
| EventCountMetricDefinitionOutput |
The definition of an EventCount metric definition. Counts the occurrences of a specified event. |
| EventRateMetricDefinition |
The definition of an EventRate metric definition. Calculates the percentage of events satisfying a specified condition. |
| EventRateMetricDefinitionOutput |
The definition of an EventRate metric definition. Calculates the percentage of events satisfying a specified condition. |
| ExperimentMetric |
Defines experiment metric metadata and computation details. |
| ExperimentMetricDefinitionOutputParent |
The metric definition, which determines how the metric value is calculated from event data. |
| ExperimentMetricDefinitionParent |
The metric definition, which determines how the metric value is calculated from event data. |
| ExperimentMetricOutput |
Defines experiment metric metadata and computation details. |
| ExperimentMetricValidationResultOutput |
The result of validating an experiment metric. |
| GetMetric | |
| GetMetric200Headers | |
| GetMetric200Response |
The request has succeeded. |
| GetMetricDefaultHeaders | |
| GetMetricDefaultResponse | |
| GetMetricHeaderParam | |
| GetMetricHeaders | |
| ListMetrics | |
| ListMetrics200Headers | |
| ListMetrics200Response |
The request has succeeded. |
| ListMetricsDefaultHeaders | |
| ListMetricsDefaultResponse | |
| ListMetricsHeaderParam | |
| ListMetricsHeaders | |
| ListMetricsQueryParam | |
| ListMetricsQueryParamProperties | |
| ObservedEvent |
An event observed by a metric. |
| ObservedEventOutput |
An event observed by a metric. |
| OnlineExperimentationClientOptions |
The optional parameters for the client |
| PageSettings |
An interface that tracks the settings for paged iteration |
| PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
| PagedExperimentMetricOutput |
Paged collection of ExperimentMetric items |
| PagingOptions |
Options for the paging helper |
| PercentileMetricDefinition |
The definition of a Percentile metric definition. Calculates a specified percentile of an event property. |
| PercentileMetricDefinitionOutput |
The definition of a Percentile metric definition. Calculates a specified percentile of an event property. |
| Routes | |
| SumMetricDefinition |
The definition of a Sum metric definition. Calculates the sum of a specified event property. Experiment analysis accounts for unequal traffic allocation. |
| SumMetricDefinitionOutput |
The definition of a Sum metric definition. Calculates the sum of a specified event property. Experiment analysis accounts for unequal traffic allocation. |
| UserCountMetricDefinition |
The definition of a UserCount metric definition. Counts unique users who encounter a specified event. |
| UserCountMetricDefinitionOutput |
The definition of a UserCount metric definition. Counts unique users who encounter a specified event. |
| UserRateMetricDefinition |
The definition of a UserRate metric definition. Calculates the percentage of users who encounter a start event and subsequently an end event. Users must encounter events in the specified order. |
| UserRateMetricDefinitionOutput |
The definition of a UserRate metric definition. Calculates the percentage of users who encounter a start event and subsequently an end event. Users must encounter events in the specified order. |
| ValidateMetric | |
| ValidateMetric200Headers | |
| ValidateMetric200Response |
The request has succeeded. |
| ValidateMetricBodyParam | |
| ValidateMetricDefaultHeaders | |
| ValidateMetricDefaultResponse | |
| ValidateMetricHeaderParam | |
| ValidateMetricHeaders | |
Type Aliases
| CreateOrUpdateMetricParameters | |
| DeleteMetricParameters | |
| DesiredDirection |
Alias for DesiredDirection |
| DesiredDirectionOutput |
Alias for DesiredDirectionOutput |
| DiagnosticCodeOutput |
Alias for DiagnosticCodeOutput |
| ExperimentMetricDefinition |
The metric definition, which determines how the metric value is calculated from event data. |
| ExperimentMetricDefinitionOutput |
The metric definition, which determines how the metric value is calculated from event data. |
| ExperimentMetricResourceMergeAndPatch |
The resource instance. |
| GetArrayType |
Helper type to extract the type of an array |
| GetMetricParameters | |
| GetPage |
The type of a custom function that defines how to get a page and a link to the next one if any. |
| LifecycleStage |
Alias for LifecycleStage |
| LifecycleStageOutput |
Alias for LifecycleStageOutput |
| ListMetricsParameters | |
| 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 |
| ValidateMetricParameters | |
Enums
| KnownDesiredDirection |
Desired direction for an experiment metric value. |
| KnownDiagnosticCode |
The diagnostic error codes. |
| KnownExperimentMetricType |
How the metric definition calculates metric values from event data. |
| KnownLifecycleStage |
Lifecycle stages of an experiment metric, determining whether the metric is included in experiment analysis. |
| KnownValidationResult |
The result of validating an experiment metric. |
Functions
| Online |
Initialize a new instance of |
| is |
|
| is |
|
| is |
|
| is |
|
| is |
|
| paginate<TResponse>(Client, TResponse, Paging |
Helper to paginate results from an initial response that follows the specification of Autorest |
Function Details
OnlineExperimentationClient(string, TokenCredential, OnlineExperimentationClientOptions)
Initialize a new instance of OnlineExperimentationClient
function OnlineExperimentationClient(endpointParam: string, credentials: TokenCredential, options?: OnlineExperimentationClientOptions): OnlineExperimentationClientParameters
- endpointParam
-
string
Endpoint URL for the Online Experimentation workspace.
- credentials
- TokenCredential
uniquely identify client credential
the parameter for all optional parameters
Returns
OnlineExperimentationClient
isUnexpected(GetMetric200Response | GetMetricDefaultResponse)
function isUnexpected(response: GetMetric200Response | GetMetricDefaultResponse): responseParameters
- response
Returns
response
isUnexpected(CreateOrUpdateMetric200Response | CreateOrUpdateMetric201Response | CreateOrUpdateMetricDefaultResponse)
function isUnexpected(response: CreateOrUpdateMetric200Response | CreateOrUpdateMetric201Response | CreateOrUpdateMetricDefaultResponse): responseParameters
Returns
response
isUnexpected(DeleteMetric204Response | DeleteMetricDefaultResponse)
function isUnexpected(response: DeleteMetric204Response | DeleteMetricDefaultResponse): responseParameters
Returns
response
isUnexpected(ValidateMetric200Response | ValidateMetricDefaultResponse)
function isUnexpected(response: ValidateMetric200Response | ValidateMetricDefaultResponse): responseParameters
Returns
response
isUnexpected(ListMetrics200Response | ListMetricsDefaultResponse)
function isUnexpected(response: ListMetrics200Response | ListMetricsDefaultResponse): responseParameters
- response
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
