server_automatic_tuning

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

Overview

Name	server_automatic_tuning
Type	Resource
Id	azure.sql.server_automatic_tuning

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.
actualState	string	Automatic tuning actual state. Known values are: "Custom", "Auto", and "Unspecified". (Custom, Auto, Unspecified)
desiredState	string	Automatic tuning desired state. Known values are: "Custom", "Auto", and "Unspecified". (Custom, Auto, Unspecified)
options	object	Automatic tuning options definition.
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, subscription_id		Retrieves server automatic tuning options.
update	update	resource_group_name, server_name, subscription_id		Update automatic tuning options on server.

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

SELECT examples

get

Retrieves server automatic tuning options.

SELECT
id,
name,
actualState,
desiredState,
options,
systemData,
type
FROM azure.sql.server_automatic_tuning
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

UPDATE examples

update

Update automatic tuning options on server.

UPDATE azure.sql.server_automatic_tuning
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;