This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.sql.getServerAdvisor
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
Gets a server advisor. Azure REST API version: 2021-11-01.
Other available API versions: 2014-04-01, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview.
Using getServerAdvisor
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.
function getServerAdvisor(args: GetServerAdvisorArgs, opts?: InvokeOptions): Promise<GetServerAdvisorResult>
function getServerAdvisorOutput(args: GetServerAdvisorOutputArgs, opts?: InvokeOptions): Output<GetServerAdvisorResult>def get_server_advisor(advisor_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       server_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetServerAdvisorResult
def get_server_advisor_output(advisor_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[GetServerAdvisorResult]func LookupServerAdvisor(ctx *Context, args *LookupServerAdvisorArgs, opts ...InvokeOption) (*LookupServerAdvisorResult, error)
func LookupServerAdvisorOutput(ctx *Context, args *LookupServerAdvisorOutputArgs, opts ...InvokeOption) LookupServerAdvisorResultOutput> Note: This function is named LookupServerAdvisor in the Go SDK.
public static class GetServerAdvisor 
{
    public static Task<GetServerAdvisorResult> InvokeAsync(GetServerAdvisorArgs args, InvokeOptions? opts = null)
    public static Output<GetServerAdvisorResult> Invoke(GetServerAdvisorInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetServerAdvisorResult> getServerAdvisor(GetServerAdvisorArgs args, InvokeOptions options)
public static Output<GetServerAdvisorResult> getServerAdvisor(GetServerAdvisorArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:sql:getServerAdvisor
  arguments:
    # arguments dictionaryThe following arguments are supported:
- AdvisorName string
- The name of the Server Advisor.
- ResourceGroup stringName 
- 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 Server Advisor.
- ResourceGroup stringName 
- 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 Server Advisor.
- resourceGroup StringName 
- 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 Server Advisor.
- resourceGroup stringName 
- 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 Server Advisor.
- resource_group_ strname 
- 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 Server Advisor.
- resourceGroup StringName 
- 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.
getServerAdvisor 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'.
- AutoExecute stringStatus 
- Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'
- AutoExecute stringStatus Inherited From 
- 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).
- 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.Azure Native. Sql. Outputs. Recommended Action Response> 
- 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'.
- AutoExecute stringStatus 
- Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'
- AutoExecute stringStatus Inherited From 
- 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).
- 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 []RecommendedAction Response 
- 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'.
- autoExecute StringStatus 
- Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'
- autoExecute StringStatus Inherited From 
- 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).
- 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<RecommendedAction Response> 
- 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'.
- autoExecute stringStatus 
- Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'
- autoExecute stringStatus Inherited From 
- 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).
- 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 RecommendedAction Response[] 
- 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_ strstatus 
- Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'
- auto_execute_ strstatus_ inherited_ from 
- 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).
- 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[RecommendedAction Response] 
- 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'.
- autoExecute StringStatus 
- Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'
- autoExecute StringStatus Inherited From 
- 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).
- 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
- ChangeValue doubleAbsolute 
- Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes
- ChangeValue doubleRelative 
- 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
- ChangeValue float64Absolute 
- Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes
- ChangeValue float64Relative 
- 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
- changeValue DoubleAbsolute 
- Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes
- changeValue DoubleRelative 
- 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
- changeValue numberAbsolute 
- Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes
- changeValue numberRelative 
- 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_ floatabsolute 
- Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes
- change_value_ floatrelative 
- 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
- changeValue NumberAbsolute 
- Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes
- changeValue NumberRelative 
- 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    
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, object>
- Gets additional details specific to this recommended action.
- ErrorDetails Pulumi.Azure Native. Sql. Inputs. Recommended Action Error Info Response 
- Gets the error details if and why this recommended action is put to error state.
- EstimatedImpact List<Pulumi.Azure Native. Sql. Inputs. Recommended Action Impact Record Response> 
- Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change
- ExecuteAction stringDuration 
- Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation
- ExecuteAction stringInitiated By 
- Gets if approval for applying this recommended action was given by user/system.
- ExecuteAction stringInitiated Time 
- Gets the time when this recommended action was approved for execution.
- ExecuteAction stringStart Time 
- 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.Azure Native. Sql. Inputs. Recommended Action Implementation Info Response 
- Gets the implementation details of this recommended action for user to apply it manually.
- IsArchived boolAction 
- Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.
- IsExecutable boolAction 
- Gets if this recommended action is actionable by user
- IsRevertable boolAction 
- 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.Azure Native. Sql. Inputs. Recommended Action Impact Record Response> 
- 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
- RevertAction stringDuration 
- Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.
- RevertAction stringInitiated By 
- Gets if approval for reverting this recommended action was given by user/system.
- RevertAction stringInitiated Time 
- Gets the time when this recommended action was approved for revert.
- RevertAction stringStart Time 
- 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.Azure Native. Sql. Inputs. Recommended Action State Info Response 
- Gets the info of the current state the recommended action is in.
- TimeSeries List<Pulumi.Azure Native. Sql. Inputs. Recommended Action Metric Info Response> 
- 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]interface{}
- Gets additional details specific to this recommended action.
- ErrorDetails RecommendedAction Error Info Response 
- Gets the error details if and why this recommended action is put to error state.
- EstimatedImpact []RecommendedAction Impact Record Response 
- Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change
- ExecuteAction stringDuration 
- Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation
- ExecuteAction stringInitiated By 
- Gets if approval for applying this recommended action was given by user/system.
- ExecuteAction stringInitiated Time 
- Gets the time when this recommended action was approved for execution.
- ExecuteAction stringStart Time 
- 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 RecommendedAction Implementation Info Response 
- Gets the implementation details of this recommended action for user to apply it manually.
- IsArchived boolAction 
- Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.
- IsExecutable boolAction 
- Gets if this recommended action is actionable by user
- IsRevertable boolAction 
- 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 []RecommendedAction Impact Record Response 
- 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
- RevertAction stringDuration 
- Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.
- RevertAction stringInitiated By 
- Gets if approval for reverting this recommended action was given by user/system.
- RevertAction stringInitiated Time 
- Gets the time when this recommended action was approved for revert.
- RevertAction stringStart Time 
- 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
RecommendedAction State Info Response 
- Gets the info of the current state the recommended action is in.
- TimeSeries []RecommendedAction Metric Info Response 
- 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,Object>
- Gets additional details specific to this recommended action.
- errorDetails RecommendedAction Error Info Response 
- Gets the error details if and why this recommended action is put to error state.
- estimatedImpact List<RecommendedAction Impact Record Response> 
- Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change
- executeAction StringDuration 
- Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation
- executeAction StringInitiated By 
- Gets if approval for applying this recommended action was given by user/system.
- executeAction StringInitiated Time 
- Gets the time when this recommended action was approved for execution.
- executeAction StringStart Time 
- 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 RecommendedAction Implementation Info Response 
- Gets the implementation details of this recommended action for user to apply it manually.
- isArchived BooleanAction 
- Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.
- isExecutable BooleanAction 
- Gets if this recommended action is actionable by user
- isRevertable BooleanAction 
- 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<RecommendedAction Impact Record Response> 
- 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
- revertAction StringDuration 
- Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.
- revertAction StringInitiated By 
- Gets if approval for reverting this recommended action was given by user/system.
- revertAction StringInitiated Time 
- Gets the time when this recommended action was approved for revert.
- revertAction StringStart Time 
- 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
RecommendedAction State Info Response 
- Gets the info of the current state the recommended action is in.
- timeSeries List<RecommendedAction Metric Info Response> 
- 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]: any}
- Gets additional details specific to this recommended action.
- errorDetails RecommendedAction Error Info Response 
- Gets the error details if and why this recommended action is put to error state.
- estimatedImpact RecommendedAction Impact Record Response[] 
- Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change
- executeAction stringDuration 
- Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation
- executeAction stringInitiated By 
- Gets if approval for applying this recommended action was given by user/system.
- executeAction stringInitiated Time 
- Gets the time when this recommended action was approved for execution.
- executeAction stringStart Time 
- 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 RecommendedAction Implementation Info Response 
- Gets the implementation details of this recommended action for user to apply it manually.
- isArchived booleanAction 
- Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.
- isExecutable booleanAction 
- Gets if this recommended action is actionable by user
- isRevertable booleanAction 
- 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 RecommendedAction Impact Record Response[] 
- 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
- revertAction stringDuration 
- Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.
- revertAction stringInitiated By 
- Gets if approval for reverting this recommended action was given by user/system.
- revertAction stringInitiated Time 
- Gets the time when this recommended action was approved for revert.
- revertAction stringStart Time 
- 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
RecommendedAction State Info Response 
- Gets the info of the current state the recommended action is in.
- timeSeries RecommendedAction Metric Info Response[] 
- 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, Any]
- Gets additional details specific to this recommended action.
- error_details RecommendedAction Error Info Response 
- Gets the error details if and why this recommended action is put to error state.
- estimated_impact Sequence[RecommendedAction Impact Record Response] 
- Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change
- execute_action_ strduration 
- Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation
- execute_action_ strinitiated_ by 
- Gets if approval for applying this recommended action was given by user/system.
- execute_action_ strinitiated_ time 
- Gets the time when this recommended action was approved for execution.
- execute_action_ strstart_ time 
- 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 RecommendedAction Implementation Info Response 
- Gets the implementation details of this recommended action for user to apply it manually.
- is_archived_ boolaction 
- 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_ boolaction 
- Gets if this recommended action is actionable by user
- is_revertable_ boolaction 
- 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[RecommendedAction Impact Record Response] 
- 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_ strduration 
- 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_ strinitiated_ by 
- Gets if approval for reverting this recommended action was given by user/system.
- revert_action_ strinitiated_ time 
- Gets the time when this recommended action was approved for revert.
- revert_action_ strstart_ time 
- 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
RecommendedAction State Info Response 
- Gets the info of the current state the recommended action is in.
- time_series Sequence[RecommendedAction Metric Info Response] 
- 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<Any>
- 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
- executeAction StringDuration 
- Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation
- executeAction StringInitiated By 
- Gets if approval for applying this recommended action was given by user/system.
- executeAction StringInitiated Time 
- Gets the time when this recommended action was approved for execution.
- executeAction StringStart Time 
- 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.
- isArchived BooleanAction 
- Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.
- isExecutable BooleanAction 
- Gets if this recommended action is actionable by user
- isRevertable BooleanAction 
- 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
- revertAction StringDuration 
- Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.
- revertAction StringInitiated By 
- Gets if approval for reverting this recommended action was given by user/system.
- revertAction StringInitiated Time 
- Gets the time when this recommended action was approved for revert.
- revertAction StringStart Time 
- 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    
- ActionInitiated stringBy 
- 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
- ActionInitiated stringBy 
- 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
- actionInitiated StringBy 
- 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
- actionInitiated stringBy 
- 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_ strby 
- 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
- actionInitiated StringBy 
- 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 v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi