ObjectRecommendation interface
Object recommendation properties.
- Extends
Properties
| analyzed |
Workload information for the recommended action. |
| current |
Current state. |
| details | Recommendation details for the recommended action. NOTE: This property will not be serialized. It can only be populated by the server. |
| estimated |
Estimated impact of this recommended action. NOTE: This property will not be serialized. It can only be populated by the server. |
| implementation |
Implementation details for the recommended action. |
| improved |
List of identifiers for all queries identified as targets for improvement if the recommendation is applied. The list is only populated for CREATE INDEX recommendations. |
| initial |
Creation time (UTC) of this recommendation. |
| kind | Always empty. |
| last |
Last time (UTC) that this recommendation was produced. |
| recommendation |
Reason for this recommendation. |
| recommendation |
Type for this recommendation. |
| times |
Number of times this recommendation has been produced. |
Inherited Properties
| id | Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server. |
| name | The name of the resource NOTE: This property will not be serialized. It can only be populated by the server. |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
analyzedWorkload
Workload information for the recommended action.
analyzedWorkload?: ObjectRecommendationPropertiesAnalyzedWorkload
Property Value
currentState
Current state.
currentState?: string
Property Value
string
details
Recommendation details for the recommended action. NOTE: This property will not be serialized. It can only be populated by the server.
details?: ObjectRecommendationDetails
Property Value
estimatedImpact
Estimated impact of this recommended action. NOTE: This property will not be serialized. It can only be populated by the server.
estimatedImpact?: ImpactRecord[]
Property Value
implementationDetails
Implementation details for the recommended action.
implementationDetails?: ObjectRecommendationPropertiesImplementationDetails
Property Value
improvedQueryIds
List of identifiers for all queries identified as targets for improvement if the recommendation is applied. The list is only populated for CREATE INDEX recommendations.
improvedQueryIds?: number[]
Property Value
number[]
initialRecommendedTime
Creation time (UTC) of this recommendation.
initialRecommendedTime?: Date
Property Value
Date
kind
Always empty.
kind?: string
Property Value
string
lastRecommendedTime
Last time (UTC) that this recommendation was produced.
lastRecommendedTime?: Date
Property Value
Date
recommendationReason
Reason for this recommendation.
recommendationReason?: string
Property Value
string
recommendationType
Type for this recommendation.
recommendationType?: string
Property Value
string
timesRecommended
Number of times this recommendation has been produced.
timesRecommended?: number
Property Value
number
Inherited Property Details
id
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
id?: string
Property Value
string
Inherited From ProxyResource.id
name
The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
Inherited From ProxyResource.name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
systemData?: SystemData
Property Value
Inherited From ProxyResource.systemData
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.
type?: string
Property Value
string
Inherited From ProxyResource.type