database_advisors

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

Overview

Name	database_advisors
Type	Resource
Id	azure.sql.database_advisors

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved details of specified database advisor.

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, subscriptionId		Gets a database advisor.
update	update	resourceGroupName, serverName, databaseName, advisorName, subscriptionId		Updates a database advisor.
list_by_database	exec	resourceGroupName, serverName, databaseName, subscriptionId	$expand	Gets a list of database advisors.

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.
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.
$expand	string	The child resources to include in the response.

SELECT examples

get

Gets a database advisor.

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

UPDATE examples

update

Updates a database advisor.

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

Lifecycle Methods

list_by_database

Gets a list of database advisors.

EXEC azure.sql.database_advisors.list_by_database 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@$expand='{{ $expand }}'
;