metrics

Creates, updates, deletes, gets or lists a metrics resource.

Overview

Name	metrics
Type	Resource
Id	azure.online_experimentation_dataplane.metrics

Fields

The following fields are returned by SELECT queries:

get_metric

Name	Datatype	Description
id	string	Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Required.
categories	array	Categories associated with the experiment metric. Used for organizing and filtering metrics. Required.
definition	object	The metric definition specifying how the metric value is calculated from event data. Required.
description	string	A detailed description of the experiment metric. Required.
desiredDirection	string	The desired direction for changes in the metric value. Required. Known values are: "Increase", "Decrease", and "Neutral". (Increase, Decrease, Neutral)
displayName	string	A user-friendly display name for the experiment metric shown in reports and dashboards. Required.
eTag	string	ETag of the experiment metric. Required.
lastModifiedAt	string (date-time)	The timestamp (UTC) of the last modification to the experiment metric resource. Required.
lifecycle	string	Determines whether it is included in experiment analysis. Required. Known values are: "Active" and "Inactive". (Active, Inactive)

list_metrics

Name	Datatype	Description
id	string	Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Required.
categories	array	Categories associated with the experiment metric. Used for organizing and filtering metrics. Required.
definition	object	The metric definition specifying how the metric value is calculated from event data. Required.
description	string	A detailed description of the experiment metric. Required.
desiredDirection	string	The desired direction for changes in the metric value. Required. Known values are: "Increase", "Decrease", and "Neutral". (Increase, Decrease, Neutral)
displayName	string	A user-friendly display name for the experiment metric shown in reports and dashboards. Required.
eTag	string	ETag of the experiment metric. Required.
lastModifiedAt	string (date-time)	The timestamp (UTC) of the last modification to the experiment metric resource. Required.
lifecycle	string	Determines whether it is included in experiment analysis. Required. Known values are: "Active" and "Inactive". (Active, Inactive)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_metric	select	experiment_metric_id, endpoint	If-Unmodified-Since, If-Modified-Since	Fetches an experiment metric by ID.
list_metrics	select	endpoint	top, skip, maxpagesize	Lists experiment metrics.
create_or_update_metric	insert	experiment_metric_id, endpoint, lifecycle, displayName, description, categories, desiredDirection, definition	If-Unmodified-Since, If-Modified-Since	Creates or updates an experiment metric.
create_or_update_metric	replace	experiment_metric_id, endpoint, lifecycle, displayName, description, categories, desiredDirection, definition	If-Unmodified-Since, If-Modified-Since	Creates or updates an experiment metric.
delete_metric	delete	experiment_metric_id, endpoint	If-Unmodified-Since, If-Modified-Since	Deletes an experiment metric.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
experiment_metric_id	string	Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Required.
If-Modified-Since	string	The request should only proceed if the entity was modified after this time. Default value is None.
If-Unmodified-Since	string	The request should only proceed if the entity was not modified after this time. Default value is None.
maxpagesize	integer
skip	integer	The number of result items to skip. Default value is None.
top	integer	The number of result items to return. Default value is None.

SELECT examples

get_metric

Fetches an experiment metric by ID.

SELECT
id,
categories,
definition,
description,
desiredDirection,
displayName,
eTag,
lastModifiedAt,
lifecycle
FROM azure.online_experimentation_dataplane.metrics
WHERE experiment_metric_id = '{{ experiment_metric_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND If-Unmodified-Since = '{{ If-Unmodified-Since }}'
AND If-Modified-Since = '{{ If-Modified-Since }}'
;

list_metrics

Lists experiment metrics.

SELECT
id,
categories,
definition,
description,
desiredDirection,
displayName,
eTag,
lastModifiedAt,
lifecycle
FROM azure.online_experimentation_dataplane.metrics
WHERE endpoint = '{{ endpoint }}' -- required
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND maxpagesize = '{{ maxpagesize }}'
;

INSERT examples

create_or_update_metric

Creates or updates an experiment metric.

INSERT INTO azure.online_experimentation_dataplane.metrics (
lifecycle,
displayName,
description,
categories,
desiredDirection,
definition,
experiment_metric_id,
endpoint,
If-Unmodified-Since,
If-Modified-Since
)
SELECT 
'{{ lifecycle }}' /* required */,
'{{ displayName }}' /* required */,
'{{ description }}' /* required */,
'{{ categories }}' /* required */,
'{{ desiredDirection }}' /* required */,
'{{ definition }}' /* required */,
'{{ experiment_metric_id }}',
'{{ endpoint }}',
'{{ If-Unmodified-Since }}',
'{{ If-Modified-Since }}'
RETURNING
id,
categories,
definition,
description,
desiredDirection,
displayName,
eTag,
lastModifiedAt,
lifecycle
;

Manifest

# Description fields are for documentation purposes
- name: metrics
props:
  - name: experiment_metric_id
    value: "{{ experiment_metric_id }}"
    description: Required parameter for the metrics resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the metrics resource.
  - name: lifecycle
    value: "{{ lifecycle }}"
    description: |
      Determines whether it is included in experiment analysis. Required. Known values are: "Active" and "Inactive".
    valid_values: ['Active', 'Inactive']
  - name: displayName
    value: "{{ displayName }}"
    description: |
      A user-friendly display name for the experiment metric shown in reports and dashboards. Required.
  - name: description
    value: "{{ description }}"
    description: |
      A detailed description of the experiment metric. Required.
  - name: categories
    value:
      - "{{ categories }}"
    description: |
      Categories associated with the experiment metric. Used for organizing and filtering metrics. Required.
  - name: desiredDirection
    value: "{{ desiredDirection }}"
    description: |
      The desired direction for changes in the metric value. Required. Known values are: "Increase", "Decrease", and "Neutral".
    valid_values: ['Increase', 'Decrease', 'Neutral']
  - name: definition
    description: |
      The metric definition specifying how the metric value is calculated from event data. Required.
    value:
      type: "{{ type }}"
  - name: If-Unmodified-Since
    value: "{{ If-Unmodified-Since }}"
    description: The request should only proceed if the entity was not modified after this time. Default value is None.
    description: The request should only proceed if the entity was not modified after this time. Default value is None.
  - name: If-Modified-Since
    value: "{{ If-Modified-Since }}"
    description: The request should only proceed if the entity was modified after this time. Default value is None.
    description: The request should only proceed if the entity was modified after this time. Default value is None.

REPLACE examples

create_or_update_metric

Creates or updates an experiment metric.

REPLACE azure.online_experimentation_dataplane.metrics
SET 
lifecycle = '{{ lifecycle }}',
displayName = '{{ displayName }}',
description = '{{ description }}',
categories = '{{ categories }}',
desiredDirection = '{{ desiredDirection }}',
definition = '{{ definition }}'
WHERE 
experiment_metric_id = '{{ experiment_metric_id }}' --required
AND endpoint = '{{ endpoint }}' --required
AND lifecycle = '{{ lifecycle }}' --required
AND displayName = '{{ displayName }}' --required
AND description = '{{ description }}' --required
AND categories = '{{ categories }}' --required
AND desiredDirection = '{{ desiredDirection }}' --required
AND definition = '{{ definition }}' --required
AND If-Unmodified-Since = '{{ If-Unmodified-Since}}'
AND If-Modified-Since = '{{ If-Modified-Since}}'
RETURNING
id,
categories,
definition,
description,
desiredDirection,
displayName,
eTag,
lastModifiedAt,
lifecycle;

DELETE examples

delete_metric

Deletes an experiment metric.

DELETE FROM azure.online_experimentation_dataplane.metrics
WHERE experiment_metric_id = '{{ experiment_metric_id }}' --required
AND endpoint = '{{ endpoint }}' --required
AND If-Unmodified-Since = '{{ If-Unmodified-Since }}'
AND If-Modified-Since = '{{ If-Modified-Since }}'
;