database_recommended_actions

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

Overview

Name	database_recommended_actions
Type	Resource
Id	azure.sql.database_recommended_actions

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved details of specified database recommended action.

Name	Datatype	Description
kind	string	Resource kind.
location	string	Resource location.
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, databaseName, advisorName, recommendedActionName, subscriptionId		Gets a database recommended action.
update	update	resourceGroupName, serverName, databaseName, advisorName, recommendedActionName, subscriptionId		Updates a database recommended action.
list_by_database_advisor	exec	resourceGroupName, serverName, databaseName, advisorName, subscriptionId		Gets list of Database Recommended Actions.

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
advisorName	string	The name of the Database Advisor.
databaseName	string	The name of the database.
recommendedActionName	string	The name of Database Recommended Action.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a database recommended action.

SELECT
kind,
location,
properties
FROM azure.sql.database_recommended_actions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND advisorName = '{{ advisorName }}' -- required
AND recommendedActionName = '{{ recommendedActionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

UPDATE examples

update

Updates a database recommended action.

UPDATE azure.sql.database_recommended_actions
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND advisorName = '{{ advisorName }}' --required
AND recommendedActionName = '{{ recommendedActionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
kind,
location,
properties;

Lifecycle Methods

list_by_database_advisor

Gets list of Database Recommended Actions.

EXEC azure.sql.database_recommended_actions.list_by_database_advisor 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@advisorName='{{ advisorName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;