Share via


OnlineExperimentationClient.UpdateMetric Method

Definition

Updates an experiment metric.

public virtual Azure.Response<Azure.Analytics.OnlineExperimentation.ExperimentMetric> UpdateMetric(string experimentMetricId, Azure.Analytics.OnlineExperimentation.ExperimentMetricUpdate metric, Azure.ETag? ifMatch = default, System.Threading.CancellationToken cancellationToken = default);
abstract member UpdateMetric : string * Azure.Analytics.OnlineExperimentation.ExperimentMetricUpdate * Nullable<Azure.ETag> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.OnlineExperimentation.ExperimentMetric>
override this.UpdateMetric : string * Azure.Analytics.OnlineExperimentation.ExperimentMetricUpdate * Nullable<Azure.ETag> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.OnlineExperimentation.ExperimentMetric>
Public Overridable Function UpdateMetric (experimentMetricId As String, metric As ExperimentMetricUpdate, Optional ifMatch As Nullable(Of ETag) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ExperimentMetric)

Parameters

experimentMetricId
String

Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.

metric
ExperimentMetricUpdate

A partial ExperimentMetric definition for incremental updates.

ifMatch
Nullable<ETag>

Optionally limit requests to resources that have a matching ETag.

cancellationToken
CancellationToken

The token to check for cancellation.

Returns

An awaitable task.

Exceptions

Thrown when experimentMetricId or metric parameter is null.

Thrown when experimentMetricId is empty.

Applies to