experiments

Creates, updates, deletes, gets or lists an experiments resource.

Overview

Name	experiments
Type	Resource
Id	azure.front_door.experiments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
description	string	The description of the details or intents of the Experiment.
enabledState	string	The state of the Experiment. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
endpointA	object	The endpoint A of an experiment.
endpointB	object	The endpoint B of an experiment.
location	string	Resource location.
resourceState	string	Resource status. Known values are: "Creating", "Enabling", "Enabled", "Disabling", "Disabled", and "Deleting". (Creating, Enabling, Enabled, Disabling, Disabled, Deleting)
scriptFileUri	string	The uri to the Script used in the Experiment.
status	string	The description of Experiment status from the server side.
tags	object	Resource tags.
type	string	Resource type.

list_by_profile

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
description	string	The description of the details or intents of the Experiment.
enabledState	string	The state of the Experiment. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
endpointA	object	The endpoint A of an experiment.
endpointB	object	The endpoint B of an experiment.
location	string	Resource location.
resourceState	string	Resource status. Known values are: "Creating", "Enabling", "Enabled", "Disabling", "Disabled", and "Deleting". (Creating, Enabling, Enabled, Disabling, Disabled, Deleting)
scriptFileUri	string	The uri to the Script used in the Experiment.
status	string	The description of Experiment status from the server side.
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, profile_name, experiment_name, subscription_id		Gets an Experiment by ExperimentName. Gets an Experiment by ExperimentName.
list_by_profile	select	resource_group_name, profile_name, subscription_id		Gets a list of Experiments. Gets a list of Experiments.
create_or_update	insert	resource_group_name, profile_name, experiment_name, subscription_id		Creates or updates an Experiment. Creates or updates an Experiment.
update	update	resource_group_name, profile_name, experiment_name, subscription_id		Updates an Experiment by Experiment id. Updates an Experiment.
create_or_update	replace	resource_group_name, profile_name, experiment_name, subscription_id		Creates or updates an Experiment. Creates or updates an Experiment.
delete	delete	resource_group_name, profile_name, experiment_name, subscription_id		Deletes an Experiment. Deletes an Experiment.

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
experiment_name	string	The Experiment identifier associated with the Experiment. Required.
profile_name	string	The Profile identifier associated with the Tenant and Partner. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets an Experiment by ExperimentName. Gets an Experiment by ExperimentName.

SELECT
id,
name,
description,
enabledState,
endpointA,
endpointB,
location,
resourceState,
scriptFileUri,
status,
tags,
type
FROM azure.front_door.experiments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND experiment_name = '{{ experiment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_profile

Gets a list of Experiments. Gets a list of Experiments.

SELECT
id,
name,
description,
enabledState,
endpointA,
endpointB,
location,
resourceState,
scriptFileUri,
status,
tags,
type
FROM azure.front_door.experiments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an Experiment. Creates or updates an Experiment.

INSERT INTO azure.front_door.experiments (
location,
tags,
properties,
resource_group_name,
profile_name,
experiment_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ profile_name }}',
'{{ experiment_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: experiments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the experiments resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the experiments resource.
  - name: experiment_name
    value: "{{ experiment_name }}"
    description: Required parameter for the experiments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the experiments resource.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      The properties of an Experiment.
    value:
      description: "{{ description }}"
      endpointA:
        name: "{{ name }}"
        endpoint: "{{ endpoint }}"
      endpointB:
        name: "{{ name }}"
        endpoint: "{{ endpoint }}"
      enabledState: "{{ enabledState }}"
      resourceState: "{{ resourceState }}"
      status: "{{ status }}"
      scriptFileUri: "{{ scriptFileUri }}"

UPDATE examples

update

Updates an Experiment by Experiment id. Updates an Experiment.

UPDATE azure.front_door.experiments
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND experiment_name = '{{ experiment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates an Experiment. Creates or updates an Experiment.

REPLACE azure.front_door.experiments
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND experiment_name = '{{ experiment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes an Experiment. Deletes an Experiment.

DELETE FROM azure.front_door.experiments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND experiment_name = '{{ experiment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;