configurations

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

Overview

Name	configurations
Type	Resource
Id	azure.advisor.configurations

Fields

The following fields are returned by SELECT queries:

list_by_resource_group

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
digests	array	Advisor digest configuration. Valid only for subscriptions.
exclude	boolean	Exclude the resource from Advisor evaluations. Valid values: False (default) or True.
lowCpuThreshold	string	Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. Known values are: "5", "10", "15", and "20".
type	string	The type of the resource.

list_by_subscription

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
digests	array	Advisor digest configuration. Valid only for subscriptions.
exclude	boolean	Exclude the resource from Advisor evaluations. Valid values: False (default) or True.
lowCpuThreshold	string	Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. Known values are: "5", "10", "15", and "20".
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_resource_group	select	resource_group, subscription_id		Retrieve Azure Advisor configurations. Retrieve Azure Advisor configurations.
list_by_subscription	select	subscription_id		Retrieve Azure Advisor configurations. Retrieve Azure Advisor configurations and also retrieve configurations of contained resource groups.
create_in_resource_group	insert	configuration_name, resource_group, subscription_id		Create/Overwrite Azure Advisor configuration. Create/Overwrite Azure Advisor configuration.
create_in_subscription	insert	configuration_name, subscription_id		Create/Overwrite Azure Advisor configuration. Create/Overwrite Azure Advisor configuration and also delete all configurations of contained resource groups.

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
configuration_name	string	Advisor configuration name. Value must be 'default'. "default" Required.
resource_group	string	The name of the Azure resource group. Required.
subscription_id	string

SELECT examples

list_by_resource_group

Retrieve Azure Advisor configurations. Retrieve Azure Advisor configurations.

SELECT
id,
name,
digests,
exclude,
lowCpuThreshold,
type
FROM azure.advisor.configurations
WHERE resource_group = '{{ resource_group }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Retrieve Azure Advisor configurations. Retrieve Azure Advisor configurations and also retrieve configurations of contained resource groups.

SELECT
id,
name,
digests,
exclude,
lowCpuThreshold,
type
FROM azure.advisor.configurations
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_in_resource_group

Create/Overwrite Azure Advisor configuration. Create/Overwrite Azure Advisor configuration.

INSERT INTO azure.advisor.configurations (
properties,
configuration_name,
resource_group,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ configuration_name }}',
'{{ resource_group }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

create_in_subscription

Create/Overwrite Azure Advisor configuration. Create/Overwrite Azure Advisor configuration and also delete all configurations of contained resource groups.

INSERT INTO azure.advisor.configurations (
properties,
configuration_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: configurations
props:
  - name: configuration_name
    value: "{{ configuration_name }}"
    description: Required parameter for the configurations resource.
  - name: resource_group
    value: "{{ resource_group }}"
    description: Required parameter for the configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the configurations resource.
  - name: properties
    value:
      exclude: {{ exclude }}
      lowCpuThreshold: "{{ lowCpuThreshold }}"
      digests:
        - name: "{{ name }}"
          actionGroupResourceId: "{{ actionGroupResourceId }}"
          frequency: {{ frequency }}
          categories: "{{ categories }}"
          language: "{{ language }}"
          state: "{{ state }}"