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

OK. Successfully retrieved zero or more configurations.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	The Advisor configuration data structure.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_subscription

OK. Successfully retrieved zero or more configurations.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	The Advisor configuration data structure.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_resource_group	select	subscriptionId, resourceGroup
list_by_subscription	select	subscriptionId		Retrieve Azure Advisor configurations and also retrieve configurations of contained resource groups.
create_in_resource_group	insert	subscriptionId, configurationName, resourceGroup
create_in_subscription	insert	subscriptionId, configurationName		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
configurationName	string	Advisor configuration name. Value must be 'default'
resourceGroup	string	The name of the Azure resource group.
subscriptionId	string	The Azure subscription ID.

SELECT examples

list_by_resource_group

OK. Successfully retrieved zero or more configurations.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.advisor.configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroup = '{{ resourceGroup }}' -- required
;

list_by_subscription

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

SELECT
id,
name,
properties,
systemData,
type
FROM azure.advisor.configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_in_resource_group

No description available.

INSERT INTO azure.advisor.configurations (
data__properties,
subscriptionId,
configurationName,
resourceGroup
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ configurationName }}',
'{{ resourceGroup }}'
RETURNING
id,
name,
properties,
systemData,
type
;

create_in_subscription

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

INSERT INTO azure.advisor.configurations (
data__properties,
subscriptionId,
configurationName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ configurationName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: configurations
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the configurations resource.
    - name: configurationName
      value: string
      description: Required parameter for the configurations resource.
    - name: resourceGroup
      value: string
      description: Required parameter for the configurations resource.
    - name: properties
      value: object
      description: |
        The Advisor configuration data structure.