network_experiment_profiles

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

Overview

Name	network_experiment_profiles
Type	Resource
Id	azure.front_door.network_experiment_profiles

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
enabledState	string	The state of the Experiment. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
etag	string	Gets a unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
resourceState	string	Resource status. Known values are: "Creating", "Enabling", "Enabled", "Disabling", "Disabled", and "Deleting". (Creating, Enabling, Enabled, Disabling, Disabled, Deleting)
tags	object	Resource tags.
type	string	Resource type.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
enabledState	string	The state of the Experiment. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
etag	string	Gets a unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
resourceState	string	Resource status. Known values are: "Creating", "Enabling", "Enabled", "Disabling", "Disabled", and "Deleting". (Creating, Enabling, Enabled, Disabling, Disabled, Deleting)
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
enabledState	string	The state of the Experiment. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
etag	string	Gets a unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
resourceState	string	Resource status. Known values are: "Creating", "Enabling", "Enabled", "Disabling", "Disabled", and "Deleting". (Creating, Enabling, Enabled, Disabling, Disabled, Deleting)
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, subscription_id		Gets an NetworkExperiment Profile by ProfileName. Gets an NetworkExperiment Profile by ProfileName.
list_by_resource_group	select	resource_group_name, subscription_id		Gets a list of Network Experiment Profiles within a resource group under a subscription. Gets a list of Network Experiment Profiles within a resource group under a subscription.
list	select	subscription_id		Gets a list of Network Experiment Profiles under a subscription. Gets a list of Network Experiment Profiles under a subscription.
create_or_update	insert	profile_name, resource_group_name, subscription_id		Creates an NetworkExperiment Profile. Creates an NetworkExperiment Profile.
update	update	resource_group_name, profile_name, subscription_id		Updates an NetworkExperimentProfiles by NetworkExperimentProfile name. Updates an NetworkExperimentProfiles.
create_or_update	replace	profile_name, resource_group_name, subscription_id		Creates an NetworkExperiment Profile. Creates an NetworkExperiment Profile.
delete	delete	resource_group_name, profile_name, subscription_id		Deletes an NetworkExperiment Profile by ProfileName. Deletes an NetworkExperiment Profile by ProfileName.

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
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 NetworkExperiment Profile by ProfileName. Gets an NetworkExperiment Profile by ProfileName.

SELECT
id,
name,
enabledState,
etag,
location,
resourceState,
tags,
type
FROM azure.front_door.network_experiment_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of Network Experiment Profiles within a resource group under a subscription. Gets a list of Network Experiment Profiles within a resource group under a subscription.

SELECT
id,
name,
enabledState,
etag,
location,
resourceState,
tags,
type
FROM azure.front_door.network_experiment_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of Network Experiment Profiles under a subscription. Gets a list of Network Experiment Profiles under a subscription.

SELECT
id,
name,
enabledState,
etag,
location,
resourceState,
tags,
type
FROM azure.front_door.network_experiment_profiles
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates an NetworkExperiment Profile. Creates an NetworkExperiment Profile.

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

Manifest

# Description fields are for documentation purposes
- name: network_experiment_profiles
props:
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the network_experiment_profiles resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_experiment_profiles resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_experiment_profiles resource.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      The properties of a Profile.
    value:
      resourceState: "{{ resourceState }}"
      enabledState: "{{ enabledState }}"
  - name: etag
    value: "{{ etag }}"
    description: |
      Gets a unique read-only string that changes whenever the resource is updated.

UPDATE examples

update

Updates an NetworkExperimentProfiles by NetworkExperimentProfile name. Updates an NetworkExperimentProfiles.

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

REPLACE examples

create_or_update

Creates an NetworkExperiment Profile. Creates an NetworkExperiment Profile.

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

DELETE examples

delete

Deletes an NetworkExperiment Profile by ProfileName. Deletes an NetworkExperiment Profile by ProfileName.

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