tuning_options

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

Overview

Name	tuning_options
Type	Resource
Id	azure.postgresql_flexible_servers.tuning_options

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
state	string	State of the tuning option.
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_server

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
state	string	State of the tuning option.
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
get	select	resource_group_name, server_name, tuning_option, subscription_id		Gets the tuning options of a server.
list_by_server	select	resource_group_name, server_name, subscription_id		Lists the tuning options of a server.
list_recommendations	exec	resource_group_name, server_name, tuning_option, subscription_id	recommendationType	Lists available object recommendations.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string
tuning_option	string	The name of the tuning option. Known values are: "index" and "table". Required.
recommendationType	string	Recommendations list filter. Retrieves recommendations based on type. Known values are: "CreateIndex", "DropIndex", "ReIndex", "AnalyzeTable", and "VacuumTable". Default value is None.

SELECT examples

get

Gets the tuning options of a server.

SELECT
id,
name,
state,
systemData,
type
FROM azure.postgresql_flexible_servers.tuning_options
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND tuning_option = '{{ tuning_option }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Lists the tuning options of a server.

SELECT
id,
name,
state,
systemData,
type
FROM azure.postgresql_flexible_servers.tuning_options
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

list_recommendations

Lists available object recommendations.

EXEC azure.postgresql_flexible_servers.tuning_options.list_recommendations 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@tuning_option='{{ tuning_option }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@recommendationType='{{ recommendationType }}'
;