Azure Native v3.1.0, Apr 8 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.sql.getDatabaseAdvisor

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Other available API versions: 2014-04-01, 2015-05-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

Using getDatabaseAdvisor

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getDatabaseAdvisor(args: GetDatabaseAdvisorArgs, opts?: InvokeOptions): Promise<GetDatabaseAdvisorResult>
function getDatabaseAdvisorOutput(args: GetDatabaseAdvisorOutputArgs, opts?: InvokeOptions): Output<GetDatabaseAdvisorResult>

def get_database_advisor(advisor_name: Optional[str] = None,
                         database_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         server_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetDatabaseAdvisorResult
def get_database_advisor_output(advisor_name: Optional[pulumi.Input[str]] = None,
                         database_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         server_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseAdvisorResult]

func LookupDatabaseAdvisor(ctx *Context, args *LookupDatabaseAdvisorArgs, opts ...InvokeOption) (*LookupDatabaseAdvisorResult, error)
func LookupDatabaseAdvisorOutput(ctx *Context, args *LookupDatabaseAdvisorOutputArgs, opts ...InvokeOption) LookupDatabaseAdvisorResultOutput

> Note: This function is named LookupDatabaseAdvisor in the Go SDK.

public static class GetDatabaseAdvisor 
{
    public static Task<GetDatabaseAdvisorResult> InvokeAsync(GetDatabaseAdvisorArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseAdvisorResult> Invoke(GetDatabaseAdvisorInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDatabaseAdvisorResult> getDatabaseAdvisor(GetDatabaseAdvisorArgs args, InvokeOptions options)
public static Output<GetDatabaseAdvisorResult> getDatabaseAdvisor(GetDatabaseAdvisorArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:sql:getDatabaseAdvisor
  arguments:
    # arguments dictionary

The following arguments are supported:

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.

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.

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.

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.

advisor_name str: The name of the Database Advisor.
database_name str: The name of the database.
resource_group_name str: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name str: The name of the server.

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.

getDatabaseAdvisor Result

The following output properties are available:

AdvisorStatus string: Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'.
AutoExecuteStatus string: Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'
AutoExecuteStatusInheritedFrom string: Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level).
AzureApiVersion string: The Azure API version of the resource.
Id string: Resource ID.
Kind string: Resource kind.
LastChecked string: Gets the time when the current resource was analyzed for recommendations by this advisor.
Location string: Resource location.
Name string: Resource name.
RecommendationsStatus string: Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available),LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc.
RecommendedActions List<Pulumi.AzureNative.Sql.Outputs.RecommendedActionResponse>: Gets the recommended actions for this advisor.
Type string: Resource type.

AdvisorStatus string: Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'.
AutoExecuteStatus string: Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'
AutoExecuteStatusInheritedFrom string: Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level).
AzureApiVersion string: The Azure API version of the resource.
Id string: Resource ID.
Kind string: Resource kind.
LastChecked string: Gets the time when the current resource was analyzed for recommendations by this advisor.
Location string: Resource location.
Name string: Resource name.
RecommendationsStatus string: Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available),LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc.
RecommendedActions []RecommendedActionResponse: Gets the recommended actions for this advisor.
Type string: Resource type.

advisorStatus String: Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'.
autoExecuteStatus String: Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'
autoExecuteStatusInheritedFrom String: Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level).
azureApiVersion String: The Azure API version of the resource.
id String: Resource ID.
kind String: Resource kind.
lastChecked String: Gets the time when the current resource was analyzed for recommendations by this advisor.
location String: Resource location.
name String: Resource name.
recommendationsStatus String: Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available),LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc.
recommendedActions List<RecommendedActionResponse>: Gets the recommended actions for this advisor.
type String: Resource type.

advisorStatus string: Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'.
autoExecuteStatus string: Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'
autoExecuteStatusInheritedFrom string: Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level).
azureApiVersion string: The Azure API version of the resource.
id string: Resource ID.
kind string: Resource kind.
lastChecked string: Gets the time when the current resource was analyzed for recommendations by this advisor.
location string: Resource location.
name string: Resource name.
recommendationsStatus string: Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available),LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc.
recommendedActions RecommendedActionResponse[]: Gets the recommended actions for this advisor.
type string: Resource type.

advisor_status str: Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'.
auto_execute_status str: Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'
auto_execute_status_inherited_from str: Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level).
azure_api_version str: The Azure API version of the resource.
id str: Resource ID.
kind str: Resource kind.
last_checked str: Gets the time when the current resource was analyzed for recommendations by this advisor.
location str: Resource location.
name str: Resource name.
recommendations_status str: Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available),LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc.
recommended_actions Sequence[RecommendedActionResponse]: Gets the recommended actions for this advisor.
type str: Resource type.

advisorStatus String: Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'.
autoExecuteStatus String: Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'
autoExecuteStatusInheritedFrom String: Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level).
azureApiVersion String: The Azure API version of the resource.
id String: Resource ID.
kind String: Resource kind.
lastChecked String: Gets the time when the current resource was analyzed for recommendations by this advisor.
location String: Resource location.
name String: Resource name.
recommendationsStatus String: Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available),LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc.
recommendedActions List<Property Map>: Gets the recommended actions for this advisor.
type String: Resource type.

Supporting Types

RecommendedActionErrorInfoResponse

ErrorCode string: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists
IsRetryable string: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No

ErrorCode string: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists
IsRetryable string: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No

errorCode String: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists
isRetryable String: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No

errorCode string: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists
isRetryable string: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No

error_code str: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists
is_retryable str: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No

errorCode String: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists
isRetryable String: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No

RecommendedActionImpactRecordResponse

AbsoluteValue double: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected
ChangeValueAbsolute double: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes
ChangeValueRelative double: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage
DimensionName string: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
Unit string: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

AbsoluteValue float64: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected
ChangeValueAbsolute float64: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes
ChangeValueRelative float64: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage
DimensionName string: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
Unit string: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

absoluteValue Double: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected
changeValueAbsolute Double: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes
changeValueRelative Double: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage
dimensionName String: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit String: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

absoluteValue number: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected
changeValueAbsolute number: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes
changeValueRelative number: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage
dimensionName string: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit string: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

absolute_value float: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected
change_value_absolute float: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes
change_value_relative float: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage
dimension_name str: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit str: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

absoluteValue Number: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected
changeValueAbsolute Number: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes
changeValueRelative Number: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage
dimensionName String: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit String: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfoResponse

Method string: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell.
Script string: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database.

Method string: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell.
Script string: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database.

method String: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell.
script String: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database.

method string: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell.
script string: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database.

method str: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell.
script str: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database.

method String: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell.
script String: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database.

RecommendedActionMetricInfoResponse

MetricName string: Gets the name of the metric. e.g., CPU, Number of Queries.
StartTime string: Gets the start time of time interval given by this MetricInfo.
TimeGrain string: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour)
Unit string: Gets the unit in which metric is measured. e.g., DTU, Frequency
Value double: Gets the value of the metric in the time interval given by this MetricInfo.

MetricName string: Gets the name of the metric. e.g., CPU, Number of Queries.
StartTime string: Gets the start time of time interval given by this MetricInfo.
TimeGrain string: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour)
Unit string: Gets the unit in which metric is measured. e.g., DTU, Frequency
Value float64: Gets the value of the metric in the time interval given by this MetricInfo.

metricName String: Gets the name of the metric. e.g., CPU, Number of Queries.
startTime String: Gets the start time of time interval given by this MetricInfo.
timeGrain String: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour)
unit String: Gets the unit in which metric is measured. e.g., DTU, Frequency
value Double: Gets the value of the metric in the time interval given by this MetricInfo.

metricName string: Gets the name of the metric. e.g., CPU, Number of Queries.
startTime string: Gets the start time of time interval given by this MetricInfo.
timeGrain string: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour)
unit string: Gets the unit in which metric is measured. e.g., DTU, Frequency
value number: Gets the value of the metric in the time interval given by this MetricInfo.

metric_name str: Gets the name of the metric. e.g., CPU, Number of Queries.
start_time str: Gets the start time of time interval given by this MetricInfo.
time_grain str: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour)
unit str: Gets the unit in which metric is measured. e.g., DTU, Frequency
value float: Gets the value of the metric in the time interval given by this MetricInfo.

metricName String: Gets the name of the metric. e.g., CPU, Number of Queries.
startTime String: Gets the start time of time interval given by this MetricInfo.
timeGrain String: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour)
unit String: Gets the unit in which metric is measured. e.g., DTU, Frequency
value Number: Gets the value of the metric in the time interval given by this MetricInfo.

RecommendedActionResponse

Details Dictionary<string, string>: Gets additional details specific to this recommended action.
ErrorDetails Pulumi.AzureNative.Sql.Inputs.RecommendedActionErrorInfoResponse: Gets the error details if and why this recommended action is put to error state.
EstimatedImpact List<Pulumi.AzureNative.Sql.Inputs.RecommendedActionImpactRecordResponse>: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change
ExecuteActionDuration string: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation
ExecuteActionInitiatedBy string: Gets if approval for applying this recommended action was given by user/system.
ExecuteActionInitiatedTime string: Gets the time when this recommended action was approved for execution.
ExecuteActionStartTime string: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time
Id string: Resource ID.
ImplementationDetails Pulumi.AzureNative.Sql.Inputs.RecommendedActionImplementationInfoResponse: Gets the implementation details of this recommended action for user to apply it manually.
IsArchivedAction bool: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.
IsExecutableAction bool: Gets if this recommended action is actionable by user
IsRevertableAction bool: Gets if changes applied by this recommended action can be reverted by user
Kind string: Resource kind.
LastRefresh string: Gets time when this recommended action was last refreshed.
LinkedObjects List<string>: Gets the linked objects, if any.
Location string: Resource location.
Name string: Resource name.
ObservedImpact List<Pulumi.AzureNative.Sql.Inputs.RecommendedActionImpactRecordResponse>: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change
RecommendationReason string: Gets the reason for recommending this action. e.g., DuplicateIndex
RevertActionDuration string: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.
RevertActionInitiatedBy string: Gets if approval for reverting this recommended action was given by user/system.
RevertActionInitiatedTime string: Gets the time when this recommended action was approved for revert.
RevertActionStartTime string: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed.
Score int: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact
State Pulumi.AzureNative.Sql.Inputs.RecommendedActionStateInfoResponse: Gets the info of the current state the recommended action is in.
TimeSeries List<Pulumi.AzureNative.Sql.Inputs.RecommendedActionMetricInfoResponse>: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series
Type string: Resource type.
ValidSince string: Gets the time since when this recommended action is valid.

Details map[string]string: Gets additional details specific to this recommended action.
ErrorDetails RecommendedActionErrorInfoResponse: Gets the error details if and why this recommended action is put to error state.
EstimatedImpact []RecommendedActionImpactRecordResponse: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change
ExecuteActionDuration string: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation
ExecuteActionInitiatedBy string: Gets if approval for applying this recommended action was given by user/system.
ExecuteActionInitiatedTime string: Gets the time when this recommended action was approved for execution.
ExecuteActionStartTime string: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time
Id string: Resource ID.
ImplementationDetails RecommendedActionImplementationInfoResponse: Gets the implementation details of this recommended action for user to apply it manually.
IsArchivedAction bool: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.
IsExecutableAction bool: Gets if this recommended action is actionable by user
IsRevertableAction bool: Gets if changes applied by this recommended action can be reverted by user
Kind string: Resource kind.
LastRefresh string: Gets time when this recommended action was last refreshed.
LinkedObjects []string: Gets the linked objects, if any.
Location string: Resource location.
Name string: Resource name.
ObservedImpact []RecommendedActionImpactRecordResponse: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change
RecommendationReason string: Gets the reason for recommending this action. e.g., DuplicateIndex
RevertActionDuration string: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.
RevertActionInitiatedBy string: Gets if approval for reverting this recommended action was given by user/system.
RevertActionInitiatedTime string: Gets the time when this recommended action was approved for revert.
RevertActionStartTime string: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed.
Score int: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact
State RecommendedActionStateInfoResponse: Gets the info of the current state the recommended action is in.
TimeSeries []RecommendedActionMetricInfoResponse: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series
Type string: Resource type.
ValidSince string: Gets the time since when this recommended action is valid.

details Map<String,String>: Gets additional details specific to this recommended action.
errorDetails RecommendedActionErrorInfoResponse: Gets the error details if and why this recommended action is put to error state.
estimatedImpact List<RecommendedActionImpactRecordResponse>: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change
executeActionDuration String: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation
executeActionInitiatedBy String: Gets if approval for applying this recommended action was given by user/system.
executeActionInitiatedTime String: Gets the time when this recommended action was approved for execution.
executeActionStartTime String: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time
id String: Resource ID.
implementationDetails RecommendedActionImplementationInfoResponse: Gets the implementation details of this recommended action for user to apply it manually.
isArchivedAction Boolean: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.
isExecutableAction Boolean: Gets if this recommended action is actionable by user
isRevertableAction Boolean: Gets if changes applied by this recommended action can be reverted by user
kind String: Resource kind.
lastRefresh String: Gets time when this recommended action was last refreshed.
linkedObjects List<String>: Gets the linked objects, if any.
location String: Resource location.
name String: Resource name.
observedImpact List<RecommendedActionImpactRecordResponse>: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change
recommendationReason String: Gets the reason for recommending this action. e.g., DuplicateIndex
revertActionDuration String: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.
revertActionInitiatedBy String: Gets if approval for reverting this recommended action was given by user/system.
revertActionInitiatedTime String: Gets the time when this recommended action was approved for revert.
revertActionStartTime String: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed.
score Integer: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact
state RecommendedActionStateInfoResponse: Gets the info of the current state the recommended action is in.
timeSeries List<RecommendedActionMetricInfoResponse>: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series
type String: Resource type.
validSince String: Gets the time since when this recommended action is valid.

details {[key: string]: string}: Gets additional details specific to this recommended action.
errorDetails RecommendedActionErrorInfoResponse: Gets the error details if and why this recommended action is put to error state.
estimatedImpact RecommendedActionImpactRecordResponse[]: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change
executeActionDuration string: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation
executeActionInitiatedBy string: Gets if approval for applying this recommended action was given by user/system.
executeActionInitiatedTime string: Gets the time when this recommended action was approved for execution.
executeActionStartTime string: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time
id string: Resource ID.
implementationDetails RecommendedActionImplementationInfoResponse: Gets the implementation details of this recommended action for user to apply it manually.
isArchivedAction boolean: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.
isExecutableAction boolean: Gets if this recommended action is actionable by user
isRevertableAction boolean: Gets if changes applied by this recommended action can be reverted by user
kind string: Resource kind.
lastRefresh string: Gets time when this recommended action was last refreshed.
linkedObjects string[]: Gets the linked objects, if any.
location string: Resource location.
name string: Resource name.
observedImpact RecommendedActionImpactRecordResponse[]: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change
recommendationReason string: Gets the reason for recommending this action. e.g., DuplicateIndex
revertActionDuration string: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.
revertActionInitiatedBy string: Gets if approval for reverting this recommended action was given by user/system.
revertActionInitiatedTime string: Gets the time when this recommended action was approved for revert.
revertActionStartTime string: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed.
score number: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact
state RecommendedActionStateInfoResponse: Gets the info of the current state the recommended action is in.
timeSeries RecommendedActionMetricInfoResponse[]: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series
type string: Resource type.
validSince string: Gets the time since when this recommended action is valid.

details Mapping[str, str]: Gets additional details specific to this recommended action.
error_details RecommendedActionErrorInfoResponse: Gets the error details if and why this recommended action is put to error state.
estimated_impact Sequence[RecommendedActionImpactRecordResponse]: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change
execute_action_duration str: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation
execute_action_initiated_by str: Gets if approval for applying this recommended action was given by user/system.
execute_action_initiated_time str: Gets the time when this recommended action was approved for execution.
execute_action_start_time str: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time
id str: Resource ID.
implementation_details RecommendedActionImplementationInfoResponse: Gets the implementation details of this recommended action for user to apply it manually.
is_archived_action bool: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.
is_executable_action bool: Gets if this recommended action is actionable by user
is_revertable_action bool: Gets if changes applied by this recommended action can be reverted by user
kind str: Resource kind.
last_refresh str: Gets time when this recommended action was last refreshed.
linked_objects Sequence[str]: Gets the linked objects, if any.
location str: Resource location.
name str: Resource name.
observed_impact Sequence[RecommendedActionImpactRecordResponse]: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change
recommendation_reason str: Gets the reason for recommending this action. e.g., DuplicateIndex
revert_action_duration str: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.
revert_action_initiated_by str: Gets if approval for reverting this recommended action was given by user/system.
revert_action_initiated_time str: Gets the time when this recommended action was approved for revert.
revert_action_start_time str: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed.
score int: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact
state RecommendedActionStateInfoResponse: Gets the info of the current state the recommended action is in.
time_series Sequence[RecommendedActionMetricInfoResponse]: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series
type str: Resource type.
valid_since str: Gets the time since when this recommended action is valid.

details Map<String>: Gets additional details specific to this recommended action.
errorDetails Property Map: Gets the error details if and why this recommended action is put to error state.
estimatedImpact List<Property Map>: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change
executeActionDuration String: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation
executeActionInitiatedBy String: Gets if approval for applying this recommended action was given by user/system.
executeActionInitiatedTime String: Gets the time when this recommended action was approved for execution.
executeActionStartTime String: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time
id String: Resource ID.
implementationDetails Property Map: Gets the implementation details of this recommended action for user to apply it manually.
isArchivedAction Boolean: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.
isExecutableAction Boolean: Gets if this recommended action is actionable by user
isRevertableAction Boolean: Gets if changes applied by this recommended action can be reverted by user
kind String: Resource kind.
lastRefresh String: Gets time when this recommended action was last refreshed.
linkedObjects List<String>: Gets the linked objects, if any.
location String: Resource location.
name String: Resource name.
observedImpact List<Property Map>: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change
recommendationReason String: Gets the reason for recommending this action. e.g., DuplicateIndex
revertActionDuration String: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.
revertActionInitiatedBy String: Gets if approval for reverting this recommended action was given by user/system.
revertActionInitiatedTime String: Gets the time when this recommended action was approved for revert.
revertActionStartTime String: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed.
score Number: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact
state Property Map: Gets the info of the current state the recommended action is in.
timeSeries List<Property Map>: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series
type String: Resource type.
validSince String: Gets the time since when this recommended action is valid.

RecommendedActionStateInfoResponse

ActionInitiatedBy string: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it.
CurrentValue string: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action.
LastModified string: Gets the time when the state was last modified

ActionInitiatedBy string: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it.
CurrentValue string: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action.
LastModified string: Gets the time when the state was last modified

actionInitiatedBy String: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it.
currentValue String: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action.
lastModified String: Gets the time when the state was last modified

actionInitiatedBy string: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it.
currentValue string: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action.
lastModified string: Gets the time when the state was last modified

action_initiated_by str: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it.
current_value str: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action.
last_modified str: Gets the time when the state was last modified

actionInitiatedBy String: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it.
currentValue String: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action.
lastModified String: Gets the time when the state was last modified

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.sql.getDatabaseAdvisor

On this page

On this page

Using getDatabaseAdvisor

getDatabaseAdvisor Result

Supporting Types

RecommendedActionErrorInfoResponse

RecommendedActionImpactRecordResponse

RecommendedActionImplementationInfoResponse

RecommendedActionMetricInfoResponse

RecommendedActionResponse

RecommendedActionStateInfoResponse

Package Details

On this page

On this page